Document changing the sandbox image in CR #33660

domgoodwin · 2022-05-14T09:36:12Z

Adds documentation around how to overwrite the pause/sandbox image in an airgapped environment.

Also adds mention to these instructions in the kubeadm-init page

domgoodwin · 2022-05-14T09:36:44Z

content/en/docs/setup/production-environment/container-runtimes.md

@@ -266,6 +266,49 @@ visit [MCR Deployment Guide](https://docs.mirantis.com/mcr/20.10/install.html).
 Check the systemd unit named `cri-docker.socket` to find out the path to the CRI
 socket.

+## Overriding the sandbox (pause) image


I wasn't sure if this should be it's own section or sub headings under the other CR docs, felt nice to keep this separate.

I think these should be separate sub sections under the individual CRs.

netlify · 2022-05-14T09:49:24Z

✅ Pull request preview available for checking

Built without sensitive environment variables

Name	Link
🔨 Latest commit	`58f04be`
🔍 Latest deploy log	https://app.netlify.com/sites/kubernetes-io-main-staging/deploys/62a638358d4ad90008872c9c
😎 Deploy Preview	https://deploy-preview-33660--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 settings.

neolit123

Thanks for this PR @domgoodwin
Added a couple if comments but this looks good to me overall.

/sig node cluster-lifecycle

neolit123 · 2022-05-16T09:52:23Z

content/en/docs/setup/production-environment/container-runtimes.md

@@ -266,6 +266,49 @@ visit [MCR Deployment Guide](https://docs.mirantis.com/mcr/20.10/install.html).
 Check the systemd unit named `cri-docker.socket` to find out the path to the CRI
 socket.

+## Overriding the sandbox (pause) image


I think these should be separate sub sections under the individual CRs.

content/en/docs/reference/setup-tools/kubeadm/kubeadm-init.md

neolit123 · 2022-05-16T09:54:25Z

content/en/docs/reference/setup-tools/kubeadm/kubeadm-init.md

+#### Custom sandbox (pause) images
+
+Container runtimes are responsible for their sandbox images, a common default being `k8s.gcr.io/pause`.
+To set a custom image for these you need to [configure the container-runtime](/docs/setup/production-environment/container-runtimes/#overriding-the-sandbox-pause-image)


Here we can just link to the main CR page ALA "find how to setup the pause image for your CR of choice"

k8s-ci-robot · 2022-05-16T09:57:20Z

@neolit123: The label(s) /label tide/merge-merge-method-squash cannot be applied. These labels are supported: api-review, tide/merge-method-merge, tide/merge-method-rebase, tide/merge-method-squash, team/katacoda, refactor

In response to this:

/label tide/merge-merge-method-squash

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/test-infra repository.

neolit123 · 2022-05-16T09:58:08Z

/label tide/merge-method-squash

neolit123 · 2022-05-16T19:55:05Z

content/en/docs/setup/production-environment/container-runtimes.md

+### Docker Engine and Mirantis Container Runtime
+
+{{< note >}}
+If using the Docker Engine these instructions assume that you are using the
+[`cri-dockerd`](https://github.com/Mirantis/cri-dockerd) adapter to integrate
+Docker Engine with Kubernetes.
+{{< /note >}}
+


i think we can omit this addition given both sections ### Docker Engine and ### Mirantis Container Runtime already mention cri-dockerd?

content/en/docs/setup/production-environment/container-runtimes.md

neolit123 · 2022-05-16T19:57:53Z

content/en/docs/setup/production-environment/container-runtimes.md

+To overwrite the sandbox (pause) image the `cri-dockerd` adapter
+[accepts a flag](https://github.com/Mirantis/cri-dockerd/blob/master/src/config/options.go)
+to configure this `--pod-infra-container-image`.


Suggested change

To overwrite the sandbox (pause) image the `cri-dockerd` adapter

[accepts a flag](https://github.com/Mirantis/cri-dockerd/blob/master/src/config/options.go)

to configure this `--pod-infra-container-image`.

To overwrite the sandbox (pause) image the [`cri-dockerd`](https://github.com/Mirantis/cri-dockerd) adapter

accepts the `--pod-infra-container-image` flag.

instead of linking to the source code, suggesting that we link to the main cri-dockerd page with hopes that its documentation will enumerate flags eventually.

neolit123 · 2022-05-16T20:49:54Z

content/en/docs/setup/production-environment/container-runtimes.md

+#### Overriding the sandbox (pause) image
+
+To overwrite the sandbox (pause) image the `cri-dockerd` adapter
+[accepts a flag](https://github.com/Mirantis/cri-dockerd)
+to configure this `--pod-infra-container-image`.


we can just duplicate this section under ### Mirantis Container Runtime, given both use cri-dockerd.
this is what i meant here:
#33660 (comment)

neolit123 · 2022-05-16T20:52:26Z

You can assign the PR to them by writing /assign @sftim in a comment when ready.

/assign @sftim
as per the bot's suggestion.

k8s-ci-robot · 2022-05-16T20:53:18Z

LGTM label has been added.

Git tree hash: 70732dae0185672ccb22078b92b496474a91c49c

neolit123 · 2022-05-16T20:53:42Z

other than this detail the change LGTM. thanks!

/lgtm

neolit123

/lgtm

k8s-ci-robot · 2022-05-25T06:50:14Z

LGTM label has been added.

Git tree hash: a9577aa3c910675b3bf9283688c5b40750e6c4ba

sftim

I'd prefer not to have several headings in the same page that have identical text, unless we give them suitable custom fragment identifiers.

I also made some other style / content suggestions; these are less important.

content/en/docs/reference/setup-tools/kubeadm/kubeadm-init.md

sftim · 2022-05-26T12:40:08Z

content/en/docs/reference/setup-tools/kubeadm/kubeadm-init.md

+To set a custom image for these you need to configure this in your [container runtime](/docs/setup/production-environment/container-runtimes/)
+to use the image.
+


We don't document all container runtimes and we don't have a lot of capacity to maintain docs for
lots of container runtimes. Ideally we'd be able to link to container runtimes' docs on this, however those docs aren't there to link to.

So, we need to compromise.

How about:

Suggested change

To set a custom image for these you need to configure this in your [container runtime](/docs/setup/production-environment/container-runtimes/)

to use the image.

To set a custom image for these you need to configure this in your

{{< glossary_tooltip text="container runtime" term_id="container-runtime" >}}

to use the image.

Consult the documentation for your container runtime to find out how to change this setting;

for selected container runtimes, you can also find advice within the

[Container Runtimes]((/docs/setup/production-environment/container-runtimes/) topic.

💭 are there any container runtimes that work properly with Kubernetes and that don't use a pause image at all?

content/en/docs/setup/production-environment/container-runtimes.md

sftim · 2022-05-26T12:48:13Z

BTW, @domgoodwin: if you know how to do a squash on your side, please do. That's slightly tidier.

No worries though if you're not sure.

domgoodwin · 2022-05-26T15:13:58Z

Thanks @sftim I've added those changes now and merged all commits into 1. I'm too used to squashing on PR merge!

neolit123

/lgtm
@sftim PTAL again

k8s-ci-robot · 2022-06-07T12:14:08Z

LGTM label has been added.

Git tree hash: ed77052921705e0e937090f7cb975d2ff0cfb985

Sea-n · 2022-06-07T13:15:22Z

(Since the author force-pushed with squashed commit 12 days ago)
/remove-label tide/merge-method-squash

Previous review was stale

content/en/docs/setup/production-environment/container-runtimes.md

neolit123

/lgtm

k8s-ci-robot · 2022-06-13T08:11:18Z

LGTM label has been added.

Git tree hash: 9fbf1adb81f161b695396faea8b7d15c16a65749

Sea-n · 2022-06-13T08:13:27Z

Add back label if @domgoodwin are not going to squash commits by their-self.
/label tide/merge-method-squash

Note: Free to use /remove-label tide/merge-method-squash command after squash commits & force push.

zacharysarah · 2022-06-17T04:51:54Z

/approve

k8s-ci-robot · 2022-06-17T04:52:22Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: zacharysarah

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~~ [zacharysarah]

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 cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels May 14, 2022

domgoodwin commented May 14, 2022

View reviewed changes

k8s-ci-robot added the language/en Issues or PRs related to English language label May 14, 2022

k8s-ci-robot requested review from bart0sh and vincepri May 14, 2022 09:37

k8s-ci-robot added the sig/docs Categorizes an issue or PR as relevant to SIG Docs. label May 14, 2022

neolit123 reviewed May 16, 2022

View reviewed changes

k8s-ci-robot added sig/node Categorizes an issue or PR as relevant to SIG Node. sig/cluster-lifecycle Categorizes an issue or PR as relevant to SIG Cluster Lifecycle. labels May 16, 2022

k8s-ci-robot added the tide/merge-method-squash Denotes a PR that should be squashed by tide when it merges. label May 16, 2022

neolit123 reviewed May 16, 2022

View reviewed changes

content/en/docs/setup/production-environment/container-runtimes.md Show resolved Hide resolved

neolit123 reviewed May 16, 2022

View reviewed changes

k8s-ci-robot assigned sftim and neolit123 May 16, 2022

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label May 16, 2022

k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label May 16, 2022

k8s-ci-robot requested review from neolit123 and sftim May 16, 2022 21:25

neolit123 reviewed May 25, 2022

View reviewed changes

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label May 25, 2022

neolit123 mentioned this pull request May 25, 2022

1.24 kubeadm offline deployment pause version error kubernetes/kubeadm#2698

Closed

sftim previously requested changes May 26, 2022

View reviewed changes

sftim mentioned this pull request May 26, 2022

Document how to change pause image in CR page #33613

Closed

Document changing the sandbox image in CR

88885dd

domgoodwin force-pushed the docs-pause-container branch from 6dcf806 to 88885dd Compare May 26, 2022 15:13

k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label May 26, 2022

k8s-ci-robot requested review from neolit123 and sftim May 26, 2022 15:13

neolit123 reviewed Jun 7, 2022

View reviewed changes

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jun 7, 2022

k8s-ci-robot removed the tide/merge-method-squash Denotes a PR that should be squashed by tide when it merges. label Jun 7, 2022

sftim requested changes Jun 12, 2022

View reviewed changes

content/en/docs/setup/production-environment/container-runtimes.md Outdated Show resolved Hide resolved

content/en/docs/setup/production-environment/container-runtimes.md Outdated Show resolved Hide resolved

Update cri-dockerd section to be idiomatic

58f04be

k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jun 12, 2022

k8s-ci-robot requested review from neolit123 and sftim June 12, 2022 19:02

neolit123 reviewed Jun 13, 2022

View reviewed changes

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jun 13, 2022

k8s-ci-robot added the tide/merge-method-squash Denotes a PR that should be squashed by tide when it merges. label Jun 13, 2022

k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jun 17, 2022

k8s-ci-robot merged commit 1145cab into kubernetes:main Jun 17, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Document changing the sandbox image in CR #33660

Document changing the sandbox image in CR #33660

domgoodwin commented May 14, 2022 •

edited

Loading

domgoodwin May 14, 2022

neolit123 May 16, 2022

netlify bot commented May 14, 2022 •

edited

Loading

neolit123 left a comment

neolit123 May 16, 2022

neolit123 May 16, 2022

k8s-ci-robot commented May 16, 2022

neolit123 commented May 16, 2022

neolit123 May 16, 2022

neolit123 May 16, 2022

neolit123 May 16, 2022 •

edited

Loading

neolit123 commented May 16, 2022

k8s-ci-robot commented May 16, 2022

neolit123 commented May 16, 2022

neolit123 left a comment

k8s-ci-robot commented May 25, 2022

sftim left a comment

sftim May 26, 2022

sftim May 26, 2022

sftim commented May 26, 2022

domgoodwin commented May 26, 2022

neolit123 left a comment

k8s-ci-robot commented Jun 7, 2022

Sea-n commented Jun 7, 2022

neolit123 left a comment

k8s-ci-robot commented Jun 13, 2022

Sea-n commented Jun 13, 2022

zacharysarah commented Jun 17, 2022

k8s-ci-robot commented Jun 17, 2022

		To set a custom image for these you need to configure this in your [container runtime](/docs/setup/production-environment/container-runtimes/)
		to use the image.

Document changing the sandbox image in CR #33660

Document changing the sandbox image in CR #33660

Conversation

domgoodwin commented May 14, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

netlify bot commented May 14, 2022 • edited Loading

✅ Pull request preview available for checking

neolit123 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

k8s-ci-robot commented May 16, 2022

neolit123 commented May 16, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

neolit123 May 16, 2022 • edited Loading

Choose a reason for hiding this comment

neolit123 commented May 16, 2022

k8s-ci-robot commented May 16, 2022

neolit123 commented May 16, 2022

neolit123 left a comment

Choose a reason for hiding this comment

k8s-ci-robot commented May 25, 2022

sftim left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sftim commented May 26, 2022

domgoodwin commented May 26, 2022

neolit123 left a comment

Choose a reason for hiding this comment

k8s-ci-robot commented Jun 7, 2022

Sea-n commented Jun 7, 2022

neolit123 left a comment

Choose a reason for hiding this comment

k8s-ci-robot commented Jun 13, 2022

Sea-n commented Jun 13, 2022

zacharysarah commented Jun 17, 2022

k8s-ci-robot commented Jun 17, 2022

domgoodwin commented May 14, 2022 •

edited

Loading

netlify bot commented May 14, 2022 •

edited

Loading

neolit123 May 16, 2022 •

edited

Loading