Make image registry hostname more obvious in example #42446

pacoxu · 2023-08-08T08:13:47Z

Fixes kubernetes/kubernetes#119650

website/content/en/docs/tasks/configure-pod-container/configure-service-account.md

Lines 273 to 277 in c818b27

    
             ```shell 
        
             kubectl create secret docker-registry myregistrykey --docker-server=DUMMY_SERVER \ 
        
                     --docker-username=DUMMY_USERNAME --docker-password=DUMMY_DOCKER_PASSWORD \ 
        
                     --docker-email=DUMMY_DOCKER_EMAIL 
        
             ```

netlify · 2023-08-08T08:26:24Z

✅ Pull request preview available for checking

Built without sensitive environment variables

Name	Link
🔨 Latest commit	`9e09739`
🔍 Latest deploy log	https://app.netlify.com/sites/kubernetes-io-main-staging/deploys/6584f512fc4c8f0008fe5136
😎 Deploy Preview	https://deploy-preview-42446--kubernetes-io-main-staging.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

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

divya-mohan0209

Instead of making this change, it'd be valuable to spell it out like you've done in the linked issue.

Something on the lines of the below?

There is no global registry prefix configuration for Kubernetes. Without any prefix appended to the image name, the image will be pulled from docker.io/library.

sftim

I'm afraid I think we need a bigger change here.

sftim · 2023-10-05T22:02:34Z

content/en/docs/tasks/configure-pod-container/configure-service-account.md

@@ -341,7 +341,7 @@ Now, when a new Pod is created in the current namespace and using the default
 ServiceAccount, the new Pod has its `spec.imagePullSecrets` field set automatically:

 ```shell
-kubectl run nginx --image=nginx --restart=Never
+kubectl run nginx --image=DUMMY_SERVER/nginx --restart=Never


_ isn't common in hostnames. Can we swap DUMMY_SERVER with image-registry.some.example or something like that?

sftim · 2023-10-05T22:04:11Z

There is no global registry prefix configuration for Kubernetes. Without any prefix appended to the image name, the image will be pulled from docker.io/library.

We should document that somewhere; also, we should document where the defaulting happens (is it within the API server, the kubelet, or the thing at the other end of the CRI socket?)

pacoxu · 2023-10-07T08:20:47Z

There is no global registry prefix configuration for Kubernetes. Without any prefix appended to the image name, the image will be pulled from docker.io/library.

We should document that somewhere; also, we should document where the defaulting happens (is it within the API server, the kubelet, or the thing at the other end of the CRI socket?)

This is more likely a logic in container runtime. Docker is the initial runtime and it uses it as the default one.

This can be configured using the registry-mirror in docker.

Some other references:

tengqm · 2023-10-10T02:43:22Z

content/en/docs/tasks/configure-pod-container/configure-service-account.md

@@ -341,7 +341,7 @@ Now, when a new Pod is created in the current namespace and using the default
 ServiceAccount, the new Pod has its `spec.imagePullSecrets` field set automatically:

 ```shell
-kubectl run nginx --image=nginx --restart=Never
+kubectl run nginx --image=image-registry.some.example/nginx --restart=Never


How about this? I mean, making it "fail" explicitly.

Suggested change

kubectl run nginx --image=image-registry.some.example/nginx --restart=Never

kubectl run nginx --image=<registry name>/nginx --restart=Never

Whatever we pick, we should change this:

kubectl create secret docker-registry myregistrykey --docker-server=DUMMY_SERVER \ --docker-username=DUMMY_USERNAME --docker-password=DUMMY_DOCKER_PASSWORD \ --docker-email=DUMMY_DOCKER_EMAIL

to match.

Using <registry name> is more clear.

kbhawkey · 2023-12-20T13:40:05Z

Hello, @pacoxu .
Do you have more changes to add to your pull request? Can you send a commit to restart the preview build?
Thanks

pacoxu · 2023-12-22T02:32:25Z

Do you have more changes to add to your pull request? Can you send a commit to restart the preview build?

rebased with latest main branch and force pushed.

sftim

/lgtm

k8s-ci-robot · 2024-01-01T17:50:13Z

LGTM label has been added.

Git tree hash: adc9fa459e1be0921bf3fa8052c16134d09d23b2

sftim · 2024-01-07T22:01:52Z

/retitle Make image registry hostname more obvious in example
/approve

k8s-ci-robot · 2024-01-07T22:01:59Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: sftim

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

The pull request process is described here

Needs approval from an approver in each of these files:

~~content/en/OWNERS~~ [sftim]

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

k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Aug 8, 2023

k8s-ci-robot requested review from liggitt and thockin August 8, 2023 08:13

k8s-ci-robot added language/en Issues or PRs related to English language sig/docs Categorizes an issue or PR as relevant to SIG Docs. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Aug 8, 2023

divya-mohan0209 reviewed Aug 16, 2023

View reviewed changes

sftim reviewed Oct 5, 2023

View reviewed changes

pacoxu force-pushed the pacoxu-patch-1 branch from 6fee27e to 791f391 Compare October 7, 2023 07:48

tengqm reviewed Oct 10, 2023

View reviewed changes

pacoxu force-pushed the pacoxu-patch-1 branch from 791f391 to 810272b Compare October 12, 2023 10:46

use image from DUMMY_SERVER in the example

9e09739

pacoxu force-pushed the pacoxu-patch-1 branch from 810272b to 9e09739 Compare December 22, 2023 02:31

sftim reviewed Jan 1, 2024

View reviewed changes

k8s-ci-robot assigned sftim Jan 1, 2024

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jan 1, 2024

k8s-ci-robot changed the title ~~use image from DUMMY_SERVER in the example~~ Make image registry hostname more obvious in example Jan 7, 2024

k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jan 7, 2024

k8s-ci-robot merged commit a416215 into kubernetes:main Jan 7, 2024
6 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Make image registry hostname more obvious in example #42446

Make image registry hostname more obvious in example #42446

pacoxu commented Aug 8, 2023 •

edited

Loading

netlify bot commented Aug 8, 2023 •

edited

Loading

divya-mohan0209 left a comment

sftim left a comment

sftim Oct 5, 2023

pacoxu Oct 7, 2023

sftim commented Oct 5, 2023

pacoxu commented Oct 7, 2023

tengqm Oct 10, 2023

sftim Oct 10, 2023

pacoxu Oct 12, 2023

kbhawkey commented Dec 20, 2023

pacoxu commented Dec 22, 2023

sftim left a comment

k8s-ci-robot commented Jan 1, 2024

sftim commented Jan 7, 2024

k8s-ci-robot commented Jan 7, 2024

	```shell
	kubectl create secret docker-registry myregistrykey --docker-server=DUMMY_SERVER \
	--docker-username=DUMMY_USERNAME --docker-password=DUMMY_DOCKER_PASSWORD \
	--docker-email=DUMMY_DOCKER_EMAIL
	```

	kubectl run nginx --image=image-registry.some.example/nginx --restart=Never
	kubectl run nginx --image=<registry name>/nginx --restart=Never

Make image registry hostname more obvious in example #42446

Make image registry hostname more obvious in example #42446

Conversation

pacoxu commented Aug 8, 2023 • edited Loading

netlify bot commented Aug 8, 2023 • edited Loading

✅ Pull request preview available for checking

divya-mohan0209 left a comment

Choose a reason for hiding this comment

sftim left a comment

Choose a reason for hiding this comment

sftim Oct 5, 2023

Choose a reason for hiding this comment

pacoxu Oct 7, 2023

Choose a reason for hiding this comment

sftim commented Oct 5, 2023

pacoxu commented Oct 7, 2023

tengqm Oct 10, 2023

Choose a reason for hiding this comment

sftim Oct 10, 2023

Choose a reason for hiding this comment

pacoxu Oct 12, 2023

Choose a reason for hiding this comment

kbhawkey commented Dec 20, 2023

pacoxu commented Dec 22, 2023

sftim left a comment

Choose a reason for hiding this comment

k8s-ci-robot commented Jan 1, 2024

sftim commented Jan 7, 2024

k8s-ci-robot commented Jan 7, 2024

pacoxu commented Aug 8, 2023 •

edited

Loading

netlify bot commented Aug 8, 2023 •

edited

Loading