Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

centralize updating utility / debug image version in samples #47875

Open
BenTheElder opened this issue Sep 10, 2024 · 3 comments
Open

centralize updating utility / debug image version in samples #47875

BenTheElder opened this issue Sep 10, 2024 · 3 comments
Assignees
Labels
kind/feature Categorizes issue or PR as related to a new feature. needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one.

Comments

@BenTheElder
Copy link
Member

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

@BenTheElder BenTheElder added the kind/feature Categorizes issue or PR as related to a new feature. label Sep 10, 2024
@k8s-ci-robot
Copy link
Contributor

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. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

@k8s-ci-robot k8s-ci-robot added the needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. label Sep 10, 2024
@sftim
Copy link
Contributor

sftim commented Sep 11, 2024

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
Copy link
Member Author

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

/assign

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/feature Categorizes issue or PR as related to a new feature. needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one.
Projects
None yet
Development

No branches or pull requests

3 participants