Skip to content

Update /docs/tutorials/hello-minikube image from echoserver to agnhost #51364

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

bourgeoisor
Copy link

Description

In 2022, the image used for the hello-minikube tutorial was updated from k8s.gcr.io/echoserver to registry.k8s.io/e2e-test-images/agnhost since the latter was multi-platform and had generally less compatibility issues (see #37383 for details and reasoning). The localization pages, though, had never been updated, and so to this day are not compatible with all platforms (see linked bug below).

This PR updates the image on all localizations to be in-line with /en/. I've also taken the liberty to bump /en/ from :1.39 to latest (1.53) (see https://hub.docker.com/r/opsdockerimage/e2e-test-images-agnhost/tags).

Testing

Tested the new release on ARM64, it still works as it did in 1.39:

~ kubectl create deployment hello-node --image=registry.k8s.io/e2e-test-images/agnhost:2.53 -- /agnhost netexec --http-port=8080
deployment.apps/hello-node created

~ kubectl get pods
NAME                          READY   STATUS    RESTARTS   AGE
hello-node-67d8c64dcd-mfwvc   1/1     Running   0          20s

~ kubectl logs hello-node-67d8c64dcd-mfwvc
I0624 01:38:27.153103       1 log.go:245] Started HTTP server on port 8080
I0624 01:38:27.153243       1 log.go:245] Started UDP server on port  8081

Issue

Closes: #51324

@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Jun 24, 2025
@k8s-ci-robot
Copy link
Contributor

Welcome @bourgeoisor!

It looks like this is your first PR to kubernetes/website 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes/website has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

@k8s-ci-robot k8s-ci-robot added area/localization General issues or PRs related to localization language/bn Issues or PRs related to Bengali language language/de Issues or PRs related to German language labels Jun 24, 2025
@k8s-ci-robot k8s-ci-robot requested review from Arhell and bene2k1 June 24, 2025 02:00
@k8s-ci-robot k8s-ci-robot added language/en Issues or PRs related to English language size/S Denotes a PR that changes 10-29 lines, ignoring generated files. language/es Issues or PRs related to Spanish language language/hi Issues or PRs related to Hindi language language/id Issues or PRs related to Indonesian language language/it Issues or PRs related to Italian language language/pt Issues or PRs related to Portuguese language language/uk Issues or PRs related to Ukrainian language sig/docs Categorizes an issue or PR as relevant to SIG Docs. labels Jun 24, 2025
Copy link

netlify bot commented Jun 24, 2025

Pull request preview available for checking

Built without sensitive environment variables

Name Link
🔨 Latest commit 64364ab
🔍 Latest deploy log https://app.netlify.com/projects/kubernetes-io-main-staging/deploys/685a06989489f90008263cb7
😎 Deploy Preview https://deploy-preview-51364--kubernetes-io-main-staging.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

Copy link
Member

@dipesh-rawat dipesh-rawat left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@bourgeoisor Thanks for your contribution. It appears that this PR includes changes to files across multiple languages (English, Bengali, German, Hindi, Italian etc). However, docs follows different processes for each localization, and we typically don't accept pull requests that impact multiple languages simultaneously. I would recommend modify only the primary website content (which means only English content) initially with this PR. Localization updates can be addressed separately after merge of English content.

@dipesh-rawat
Copy link
Member

Explicit hold until this PR only covers one language.
(Ok to unhold once that's done)
/hold

@k8s-ci-robot k8s-ci-robot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Jun 24, 2025
@bourgeoisor
Copy link
Author

@dipesh-rawat to clarify, this same one-line bug fix across 9 localizations requires nine (9) individual 1-line PRs? If so, I can definitely do that if that's what's required, but it's going to take a little bit.


I understand that this is the process in place, but thinking about it from the lens of me being a first-time contributor, my first two thoughts are:

  • "that sounds like 9x the effort on both me, and the already over-burdened reviewers"
  • "no wonder this has been a bug since 2022..."

Not intentionally trying to go against the status quo (I'm a first time contributor, after all), but are we sure this process doesn't alienate potential contributions, at the expense of docs quality? In this particular case, this bug was fixed in /en/ in 2022 but has remained buggy in all localizations ever since, perhaps because the initial contributor didn't want to, didn't have time to, or simply forgot, to create the additional 8 PRs to port the line-change to localizations.

@shannonxtreme
Copy link
Contributor

Does the rule about one localization per PR apply when the string that's being changed isn't actually localized content? It's the image path in a kubectl command, so it's verbatim across the localized files.

Copy link
Contributor

@apeabody apeabody left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @bourgeoisor!

LGTM - non-localized image path

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: apeabody
Once this PR has been reviewed and has the lgtm label, please assign divya-mohan0209 for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

Copy link
Member

@BenTheElder BenTheElder left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could we move this out to be stored in a data file or param / referenced by a shortcut so future updates can be replicated across source files?

We avoid breaking changes to this image, but eventually having an old unpatched version in the docs won't be great ... it would probably be easier to keep up to date if we could centrally approve a new version and verbatim auto-include it in the relevant examples.

My suggestion as a maintainer of this image but NOT of kubernetes/website 😅

kubernetes-sigs/kind@bb66a15

@bourgeoisor
Copy link
Author

I'll defer to @dipesh-rawat (does kubernetes/website support vars, and is that something commonplace for image version in docs / tutorials?)

@BenTheElder
Copy link
Member

I'll defer to @dipesh-rawat (does kubernetes/website support vars, and is that something commonplace for image version in docs / tutorials?)

Absolutely re: defer. This just reminded me to raise it 😅

From a technical perspective, the commit I linked is using the same tooling (hugo), it's definitely possible.
But this is a decision for the maintainers to make.

@bourgeoisor
Copy link
Author

@dipesh-rawat there seems to be potential for exceptions in the one-PR-per-language guideline when changes are purely mechanical and identical (like in this PR). For instance in #51398.

Can you confirm whether my PR still needs to be split in nine (9) separate one-line PRs?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/localization General issues or PRs related to localization cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. language/bn Issues or PRs related to Bengali language language/de Issues or PRs related to German language language/en Issues or PRs related to English language language/es Issues or PRs related to Spanish language language/hi Issues or PRs related to Hindi language language/id Issues or PRs related to Indonesian language language/it Issues or PRs related to Italian language language/pt Issues or PRs related to Portuguese language language/uk Issues or PRs related to Ukrainian language sig/docs Categorizes an issue or PR as relevant to SIG Docs. size/S Denotes a PR that changes 10-29 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Issue with k8s.io/pt-br/docs/tutorials/hello-minikube/
6 participants