Documentation change for container restart rules #51467

yuanwang04 · 2025-07-01T22:42:57Z

Description

Add documentation for container restart policy and container restart rules for 1.34.

Issue

Closes: #

netlify · 2025-07-01T22:43:03Z

👷 Deploy Preview for kubernetes-io-vnext-staging processing.

Name	Link
🔨 Latest commit	`5a0ebb3`
🔍 Latest deploy log	https://app.netlify.com/projects/kubernetes-io-vnext-staging/deploys/6892e5ad052cb30007408393

k8s-ci-robot · 2025-07-01T22:43:06Z

Welcome @yuanwang04!

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

yuanwang04 · 2025-07-28T22:34:25Z

/cc @SergeyKanzhelev The doc change is ready for review, PTAL, thanks!

content/en/docs/concepts/workloads/pods/pod-lifecycle.md

content/en/docs/reference/command-line-tools-reference/feature-gates/ContainerRestartRules.md

michellengnx · 2025-08-02T19:40:53Z

Hello @yuanwang04 👋! I'm reaching out from the Docs team. Just checking in as we approach Docs Freeze on Wednesday August 6, 2025 18:00 PDT. This documentation appears to still be under review. To meet the Docs Freeze, this PR must have a technical review as well as lgtm and approve labels applied, without any unaddressed comments or concerns from SIG Docs. Thank you!

lmktfy · 2025-08-03T12:11:47Z

Also see: issue #51757

lmktfy

/lgtm

I think we should merge this and then iterate. The suggestions in this review show some of the iterating we could do.

content/en/docs/concepts/workloads/pods/pod-lifecycle.md

k8s-ci-robot · 2025-08-03T12:22:39Z

LGTM label has been added.

Git tree hash: 52c47db6223e2cc2fb2c8967988f6d4e0cf74c09

SergeyKanzhelev

/lgtm

I like @lmktfy 's suggestions, but it is ok to follow up later with them

windsonsea

Nits

windsonsea · 2025-08-06T05:39:04Z

content/en/docs/concepts/workloads/pods/pod-lifecycle.md

+{{< feature-state
+feature_gate_name="ContainerRestartRules" >}}


Suggested change

{{< feature-state

feature_gate_name="ContainerRestartRules" >}}

{{< feature-state feature_gate_name="ContainerRestartRules" >}}

Put the shortcode onto a single line.

Ideally yes

windsonsea · 2025-08-06T05:40:49Z

content/en/docs/concepts/workloads/pods/pod-lifecycle.md

+    command: ['sh', '-c', 'echo "Keep restarting" && sleep 1800 && exit 1']
+```
+
+A Pod with Always restart policy with an init container that only execute once. If the init


Suggested change

A Pod with Always restart policy with an init container that only execute once. If the init

A Pod with `Always` restart policy with an init container that only execute once. If the init

Use a consistent style for those values

windsonsea · 2025-08-06T05:41:05Z

content/en/docs/concepts/workloads/pods/pod-lifecycle.md

+    command: ['sh', '-c', 'sleep 1800 && exit 0']
+```
+
+A Pod with Never restart policy with a container that ignores and restarts on specific exit codes.


Suggested change

A Pod with Never restart policy with a container that ignores and restarts on specific exit codes.

A Pod with `Never` restart policy with a container that ignores and restarts on specific exit codes.

windsonsea · 2025-08-06T05:43:01Z

content/en/docs/concepts/workloads/pods/pod-lifecycle.md

+If none of the rules’ conditions matched, Kubernetes fallback to container’s configured
+`restartPolicy`.
+
+For example, a Pod with OnFailure restart policy that have a `try-once` container. This allows


Suggested change

For example, a Pod with OnFailure restart policy that have a `try-once` container. This allows

For example, a Pod with `OnFailure` restart policy that have a `try-once` container. This allows

windsonsea · 2025-08-06T05:44:06Z

content/en/docs/concepts/workloads/pods/pod-lifecycle.md

+You can configure restarts as a policy that applies to all Pods, or using container-level configuration (for example: when you define a 
+{{< glossary_tooltip text="sidecar container" term_id="sidecar-container" >}}).


Suggested change

You can configure restarts as a policy that applies to all Pods, or using container-level configuration (for example: when you define a

{{< glossary_tooltip text="sidecar container" term_id="sidecar-container" >}}).

You can configure restarts as a policy that applies to all Pods, or using container-level configuration

(for example: when you define a {{< glossary_tooltip text="sidecar container" term_id="sidecar-container" >}}).

drewhagen · 2025-08-06T16:53:17Z

Hello @yuanwang04 👋!

I'm reaching out on behalf of the Release Docs team.

It looks like this PR is still actively in review with new feedback, although both SIG Node and SIG Docs have given lgtm prior to its removal on recent commits.

A friendly reminder that Docs Freeze is approaching today, at 18:00 PT (less than 9 hours). This documentation appears to still be under review. To meet the Docs Freeze, this PR must complete a technical review with SIG Node as well as lgtm and approve labels applied, without any unaddressed comments or concerns from SIG Docs.

If you wish to include this enhancement in 1.34 but are concerned about meeting the deadline, please consider proactively filing an exception request. Thanks!

cc: @kubernetes/sig-node-leads FYSA

lmktfy · 2025-08-06T18:04:43Z

content/en/docs/concepts/workloads/pods/pod-lifecycle.md

+{{< feature-state
+feature_gate_name="ContainerRestartRules" >}}
+
+If your cluster has the feature gate `ContainerRestartRules` enabled, you can specify 


We really recommend hyperlinking the phrase "feature gates" to the list of feature gates.

lmktfy

/lgtm
/approve

k8s-ci-robot · 2025-08-06T18:05:24Z

LGTM label has been added.

Git tree hash: b82434731d66a53810f9852c8dba7ccbcc661c3f

k8s-ci-robot · 2025-08-06T18:05:35Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: lmktfy, SergeyKanzhelev

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

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

lmktfy · 2025-08-06T18:05:44Z

Good to merge; follow up PRs welcome!

k8s-ci-robot added this to the 1.34 milestone Jul 1, 2025

k8s-ci-robot added do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Jul 1, 2025

k8s-ci-robot requested a review from divya-mohan0209 July 1, 2025 22:43

k8s-ci-robot added the language/en Issues or PRs related to English language label Jul 1, 2025

k8s-ci-robot requested a review from windsonsea July 1, 2025 22:43

k8s-ci-robot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Jul 1, 2025

yuanwang04 mentioned this pull request Jul 1, 2025

Container restart rules to customize the pod restart policy kubernetes/enhancements#5307

Open

12 tasks

yuanwang04 force-pushed the container_restart_rules branch from 1584f3a to fb64460 Compare July 28, 2025 21:54

yuanwang04 force-pushed the container_restart_rules branch from fb64460 to 07b2126 Compare July 28, 2025 21:58

k8s-ci-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. labels Jul 28, 2025

yuanwang04 force-pushed the container_restart_rules branch from 07b2126 to c686fc1 Compare July 28, 2025 22:33

yuanwang04 marked this pull request as ready for review July 28, 2025 22:33

k8s-ci-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Jul 28, 2025

k8s-ci-robot requested review from lmktfy and nate-double-u July 28, 2025 22:34

yuanwang04 force-pushed the container_restart_rules branch from 0e5cb33 to 595e00e Compare July 29, 2025 21:59

k8s-ci-robot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Jul 29, 2025

SergeyKanzhelev reviewed Jul 29, 2025

View reviewed changes

content/en/docs/concepts/workloads/pods/pod-lifecycle.md Show resolved Hide resolved

dipesh-rawat reviewed Jul 30, 2025

View reviewed changes

content/en/docs/reference/command-line-tools-reference/feature-gates/ContainerRestartRules.md Show resolved Hide resolved

yuanwang04 force-pushed the container_restart_rules branch 2 times, most recently from 76110f3 to bff050f Compare July 31, 2025 22:39

lmktfy reviewed Aug 3, 2025

View reviewed changes

k8s-ci-robot assigned lmktfy Aug 3, 2025

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Aug 3, 2025

SergeyKanzhelev approved these changes Aug 5, 2025

View reviewed changes

k8s-ci-robot assigned SergeyKanzhelev Aug 5, 2025

Add documentation for container restart rules

5a0ebb3

yuanwang04 force-pushed the container_restart_rules branch from bff050f to 5a0ebb3 Compare August 6, 2025 05:18

k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Aug 6, 2025

k8s-ci-robot requested review from SergeyKanzhelev and lmktfy August 6, 2025 05:18

windsonsea reviewed Aug 6, 2025

View reviewed changes

lmktfy reviewed Aug 6, 2025

View reviewed changes

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Aug 6, 2025

k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Aug 6, 2025

k8s-ci-robot merged commit a29bca9 into kubernetes:dev-1.34 Aug 6, 2025
6 checks passed

		{{< feature-state
		feature_gate_name="ContainerRestartRules" >}}

	{{< feature-state
	feature_gate_name="ContainerRestartRules" >}}
	{{< feature-state feature_gate_name="ContainerRestartRules" >}}

	A Pod with Always restart policy with an init container that only execute once. If the init
	A Pod with `Always` restart policy with an init container that only execute once. If the init

	A Pod with Never restart policy with a container that ignores and restarts on specific exit codes.
	A Pod with `Never` restart policy with a container that ignores and restarts on specific exit codes.

	For example, a Pod with OnFailure restart policy that have a `try-once` container. This allows
	For example, a Pod with `OnFailure` restart policy that have a `try-once` container. This allows

		You can configure restarts as a policy that applies to all Pods, or using container-level configuration (for example: when you define a
		{{< glossary_tooltip text="sidecar container" term_id="sidecar-container" >}}).

Uh oh!

Documentation change for container restart rules #51467

Documentation change for container restart rules #51467

Uh oh!

Conversation

yuanwang04 commented Jul 1, 2025

Description

Issue

Uh oh!

netlify bot commented Jul 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

👷 Deploy Preview for kubernetes-io-vnext-staging processing.

Uh oh!

k8s-ci-robot commented Jul 1, 2025

Uh oh!

yuanwang04 commented Jul 28, 2025

Uh oh!

Uh oh!

Uh oh!

michellengnx commented Aug 2, 2025

Uh oh!

lmktfy commented Aug 3, 2025

Uh oh!

lmktfy left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

k8s-ci-robot commented Aug 3, 2025

Uh oh!

SergeyKanzhelev left a comment

Choose a reason for hiding this comment

Uh oh!

windsonsea left a comment

Choose a reason for hiding this comment

Uh oh!

windsonsea Aug 6, 2025

Choose a reason for hiding this comment

Uh oh!

lmktfy Aug 6, 2025

Choose a reason for hiding this comment

Uh oh!

windsonsea Aug 6, 2025

Choose a reason for hiding this comment

Uh oh!

windsonsea Aug 6, 2025

Choose a reason for hiding this comment

Uh oh!

windsonsea Aug 6, 2025

Choose a reason for hiding this comment

Uh oh!

windsonsea Aug 6, 2025

Choose a reason for hiding this comment

Uh oh!

drewhagen commented Aug 6, 2025

Uh oh!

lmktfy Aug 6, 2025

Choose a reason for hiding this comment

Uh oh!

lmktfy left a comment

Choose a reason for hiding this comment

Uh oh!

k8s-ci-robot commented Aug 6, 2025

Uh oh!

k8s-ci-robot commented Aug 6, 2025

Uh oh!

lmktfy commented Aug 6, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

8 participants

netlify bot commented Jul 1, 2025 •

edited

Loading