kubernetes / website

Kubernetes website and documentation repo:
https://kubernetes.io
Creative Commons Attribution 4.0 International
4.45k stars 14.34k forks source link

centralize updating utility / debug image version in samples #47875

Open BenTheElder opened 1 week ago

BenTheElder commented 1 week ago

This is a Feature Request

What would you like to be added

Why is this needed

In cases like https://github.com/kubernetes/website/pull/47735/files we're using somewhat arbitrary tags for the util / debug image.

Setting aside for a moment which image we should use, and the naming ... I think maybe we should store the current tag in one place and reference it with a shortcut, that way we can bump all references at once.

The test commands used should be stable, things like dig, so we can just update the references and avoid complaints about "the sample image isn't patched".

WDYT?

Comments

I suspect @sftim is a good person to ask here, if they have time :-)

cc @aojea @pohly @thockin @dims

k8s-ci-robot commented 1 week ago

This issue is currently awaiting triage.

SIG Docs takes a lead on issue triage for this website, but any Kubernetes member can accept issues by applying the triage/accepted label.

The triage/accepted label can be added by org members by writing /triage accepted in a comment.

Instructions for interacting with me using PR comments are available [here](https://git.k8s.io/community/contributors/guide/pull-requests.md). If you have questions or suggestions related to my behavior, please file an issue against the [kubernetes-sigs/prow](https://github.com/kubernetes-sigs/prow/issues/new?title=Prow%20issue:) repository.
sftim commented 1 week ago

We can put a file inside data/ that contains this information. And, because it can be TOML or YAML (or JSON or CSV), we don't have to store just the data for one image, we can actually store it for several.

Then make a shortcode to look up the tag (or image URL including tag) based on that data file.

BenTheElder commented 1 week ago

We did something like that in kind for the install docs to refer to the current version and it has been really nice.

/assign