Clarify init container concept #47946

vishnuswmech · 2024-09-16T01:48:23Z

I have made the Init container concepts from both Pod and Deployment perspective.

and This is my first contribution and let me know if any changes needs to be done on PR.

Issue

Fixes: #38271

linux-foundation-easycla · 2024-09-16T01:48:27Z

The committers listed above are authorized under a signed CLA.

✅ login: vishnuswmech / name: Sri Vishnuvardhan A (27779ce)

k8s-ci-robot · 2024-09-16T01:48:32Z

Welcome @vishnuswmech!

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. 😃

netlify · 2024-09-16T01:57:14Z

✅ Pull request preview available for checking

Built without sensitive environment variables

Name	Link
🔨 Latest commit	`27779ce`
🔍 Latest deploy log	https://app.netlify.com/sites/kubernetes-io-main-staging/deploys/66ea44daaac37d0008f2aa35
😎 Deploy Preview	https://deploy-preview-47946--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.

sftim

Thank you for the PR.

Here's some feedback

avoid implying that manifests have to be YAML; other formats can work too (notably JSON)
Use the active voice
you don't need to explain too much about how Deployments work; signposting to https://kubernetes.io/docs/concepts/workloads/controllers/ may be enough
(bear in mind that Deployment is only one of several workload management APIs in Kubernetes)

We shouldn't merge this as-is, but I hope we can help you tweak it so it's good to go in.

vishnuswmech · 2024-09-17T16:00:54Z

Thanks @sftim for the suggestions.

Sure, Will work on it.

vishnuswmech · 2024-09-17T16:33:14Z

@sftim I have made the changes based on your suggestions. Kindly review this and let me know if any further corrections needed.

sftim

/lgtm

I think there's room to improve, but I want to be clear: further tweaks are optional.

sftim · 2024-09-17T16:59:11Z

content/en/docs/concepts/workloads/pods/init-containers.md

@@ -291,10 +291,9 @@ is in the `Pending` state but should have a condition `Initialized` set to false
 If the Pod [restarts](#pod-restart-reasons), or is restarted, all init containers
 must execute again.

-Changes to the init container spec are limited to the container image field.
-Altering an init container image field is equivalent to restarting the Pod.
+Changes to the init container spec are limited to the container image field. Altering the image field of the init container does not restart or recreate the Pod.


Try this:

Suggested change

Changes to the init container spec are limited to the container image field. Altering the image field of the init container does not restart or recreate the Pod.

Changes to the init container spec are limited to the container image field.

Directly altering the `image` field of an init container does _not_ restart the

Pod or trigger its recreation. If the Pod has yet to start, that change may

have an effect on how the Pod boots up.

For a [pod template](/docs/concepts/workloads/pods/#pod-templates)

you can typically change any field for an init container; the impact of making

that change depends on where the pod template is used.

It is done.

sftim · 2024-09-17T16:59:32Z

content/en/docs/concepts/workloads/pods/init-containers.md


-Because init containers can be restarted, retried, or re-executed, init container
+However, since init containers can be restarted, retried, or re-executed, init container


The original text was good here I think:

Suggested change

However, since init containers can be restarted, retried, or re-executed, init container

Because init containers can be restarted, retried, or re-executed, init container

sftim · 2024-09-17T17:00:03Z

content/en/docs/concepts/workloads/pods/init-containers.md


-Because init containers can be restarted, retried, or re-executed, init container
+However, since init containers can be restarted, retried, or re-executed, init container
 code should be idempotent. In particular, code that writes to files on `EmptyDirs`


(optionally)

Suggested change

code should be idempotent. In particular, code that writes to files on `EmptyDirs`

code should be idempotent. In particular, code that writes into any `emptyDir` volume

Make sense. It is done.

k8s-ci-robot · 2024-09-17T17:02:35Z

LGTM label has been added.

Git tree hash: 0fb00a4522491e0b3a7b6e0b37ff13633cde1b6a

reylejano · 2024-09-17T19:43:15Z

@vishnuswmech , what do you think of sftim's suggestions

vishnuswmech · 2024-09-18T02:54:07Z

Thanks @sftim , now got some idea.

@reylejano I will make the necessary changes and will commit it shortly.

vishnuswmech · 2024-09-18T03:15:20Z

@sftim @reylejano Made the required changes based on your suggestions. Kindly check now and let me know if any further modifications needed.

vishnuswmech · 2024-09-20T07:29:50Z

@sftim Kindly approve this.

T-Lakshmi · 2024-09-20T09:12:02Z

All suggestions are seems incorporated and preview looks good to me.
Preview page
/lgtm

k8s-ci-robot · 2024-09-20T09:12:10Z

LGTM label has been added.

Git tree hash: 0e0b7bfc2d6569d882e71a68460d6ad9127d9c53

vishnuswmech · 2024-09-20T12:03:50Z

Thanks @T-Lakshmi for your review.

vishnuswmech · 2024-09-23T07:44:20Z

@sftim Kindly approve this PR.

sftim

Thanks

/approve

k8s-ci-robot · 2024-09-23T08:28:00Z

[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/docs/OWNERS~~ [sftim]

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

sftim · 2024-09-23T08:28:06Z

/retitle Clarify init container concept

k8s-ci-robot added the cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. label Sep 16, 2024

k8s-ci-robot added the language/en Issues or PRs related to English language label Sep 16, 2024

k8s-ci-robot requested review from reylejano and shannonxtreme September 16, 2024 01:48

k8s-ci-robot added the size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. label Sep 16, 2024

k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. and removed cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. labels Sep 16, 2024

vishnuswmech mentioned this pull request Sep 16, 2024

Init containers concept page is confusing - https://k8s.io/docs/concepts/workloads/pods/init-containers/ #38271

Closed

sftim reviewed Sep 17, 2024

View reviewed changes

vishnuswmech force-pushed the feature/38271-init-container-concepts branch from 5729147 to b1a1a97 Compare September 17, 2024 16:30

sftim reviewed Sep 17, 2024

View reviewed changes

k8s-ci-robot assigned sftim Sep 17, 2024

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

vishnuswmech force-pushed the feature/38271-init-container-concepts branch from b1a1a97 to 80ae398 Compare September 18, 2024 03:07

k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Sep 18, 2024

k8s-ci-robot requested a review from sftim September 18, 2024 03:07

k8s-ci-robot added size/S Denotes a PR that changes 10-29 lines, ignoring generated files. and removed size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Sep 18, 2024

38271 - Init Container concept clarity

27779ce

vishnuswmech force-pushed the feature/38271-init-container-concepts branch from 80ae398 to 27779ce Compare September 18, 2024 03:11

k8s-ci-robot assigned T-Lakshmi Sep 20, 2024

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

sftim reviewed Sep 23, 2024

View reviewed changes

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

k8s-ci-robot changed the title ~~38271 - Init Container concept clarity~~ Clarify init container concept Sep 23, 2024

k8s-ci-robot merged commit 29d3fe6 into kubernetes:main Sep 23, 2024
6 checks passed

vishnuswmech deleted the feature/38271-init-container-concepts branch September 23, 2024 09:17

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Clarify init container concept #47946

Clarify init container concept #47946

vishnuswmech commented Sep 16, 2024 •

edited

Loading

linux-foundation-easycla bot commented Sep 16, 2024 •

edited

Loading

k8s-ci-robot commented Sep 16, 2024

netlify bot commented Sep 16, 2024 •

edited

Loading

sftim left a comment

vishnuswmech commented Sep 17, 2024

vishnuswmech commented Sep 17, 2024

sftim left a comment

sftim Sep 17, 2024

vishnuswmech Sep 18, 2024

sftim Sep 17, 2024

vishnuswmech Sep 18, 2024

sftim Sep 17, 2024

vishnuswmech Sep 18, 2024

k8s-ci-robot commented Sep 17, 2024

reylejano commented Sep 17, 2024

vishnuswmech commented Sep 18, 2024

vishnuswmech commented Sep 18, 2024

vishnuswmech commented Sep 20, 2024

T-Lakshmi commented Sep 20, 2024

k8s-ci-robot commented Sep 20, 2024

vishnuswmech commented Sep 20, 2024

vishnuswmech commented Sep 23, 2024

sftim left a comment

k8s-ci-robot commented Sep 23, 2024

sftim commented Sep 23, 2024

-Changes to the init container spec are limited to the container image field. Altering the image field of the init container does not restart or recreate the Pod.
+Changes to the init container spec are limited to the container image field.
+Directly altering the `image` field of  an init container does _not_ restart the
+Pod or trigger its recreation. If the Pod has yet to start, that change may
+have an effect on how the Pod boots up.
+For a [pod template](/docs/concepts/workloads/pods/#pod-templates)
+you can typically change any field for an init container; the impact of making
+that change depends on where the pod template is used.


		Because init containers can be restarted, retried, or re-executed, init container
		However, since init containers can be restarted, retried, or re-executed, init container

	code should be idempotent. In particular, code that writes to files on `EmptyDirs`
	code should be idempotent. In particular, code that writes into any `emptyDir` volume

Clarify init container concept #47946

Clarify init container concept #47946

Conversation

vishnuswmech commented Sep 16, 2024 • edited Loading

linux-foundation-easycla bot commented Sep 16, 2024 • edited Loading

k8s-ci-robot commented Sep 16, 2024

netlify bot commented Sep 16, 2024 • edited Loading

✅ Pull request preview available for checking

sftim left a comment

Choose a reason for hiding this comment

vishnuswmech commented Sep 17, 2024

vishnuswmech commented Sep 17, 2024

sftim left a comment

Choose a reason for hiding this comment

sftim Sep 17, 2024

Choose a reason for hiding this comment

vishnuswmech Sep 18, 2024

Choose a reason for hiding this comment

sftim Sep 17, 2024

Choose a reason for hiding this comment

vishnuswmech Sep 18, 2024

Choose a reason for hiding this comment

sftim Sep 17, 2024

Choose a reason for hiding this comment

vishnuswmech Sep 18, 2024

Choose a reason for hiding this comment

k8s-ci-robot commented Sep 17, 2024

reylejano commented Sep 17, 2024

vishnuswmech commented Sep 18, 2024

vishnuswmech commented Sep 18, 2024

vishnuswmech commented Sep 20, 2024

T-Lakshmi commented Sep 20, 2024

k8s-ci-robot commented Sep 20, 2024

vishnuswmech commented Sep 20, 2024

vishnuswmech commented Sep 23, 2024

sftim left a comment

Choose a reason for hiding this comment

k8s-ci-robot commented Sep 23, 2024

sftim commented Sep 23, 2024

vishnuswmech commented Sep 16, 2024 •

edited

Loading

linux-foundation-easycla bot commented Sep 16, 2024 •

edited

Loading

netlify bot commented Sep 16, 2024 •

edited

Loading