Add initial (alpha) documentation about sidecar containers #41802

matthyx · 2023-06-29T06:00:35Z

kubernetes/enhancements#753
kubernetes/kubernetes#116429

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

sftim · 2023-06-30T15:20:02Z

/sig node

tzneal · 2023-07-03T13:39:47Z

/cc

k8s-ci-robot · 2023-07-31T15:00:49Z

LGTM label has been added.

Git tree hash: e4105ebb73dc503576586b77f4a0944af241601b

content/en/docs/concepts/workloads/pods/_index.md

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

content/en/docs/concepts/workloads/pods/_index.md

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

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

sftim · 2023-08-01T14:46:23Z

/hold
To make merges (and conflict resolution) easier, let's squash commits on this one.

OK to unhold once squashed.

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

content/en/docs/concepts/workloads/pods/_index.md

matthyx · 2023-08-01T15:05:38Z

@sftim @tengqm thanks for your valuable inputs, I have updated the PR

Signed-off-by: Matthias Bertschy <[email protected]>

tzneal

/lgtm

k8s-ci-robot · 2023-08-07T15:38:48Z

LGTM label has been added.

Git tree hash: 92203e45be15c15477f73f2f3d0bb2e1c2485e4b

sftim · 2023-08-07T15:44:38Z

/hold cancel

It's squashed

sftim

This could use polish but is good enough for alpha.

/lgtm
/approve

sftim · 2023-08-07T15:45:18Z

content/en/docs/concepts/workloads/pods/_index.md

+
+{{< feature-state for_k8s_version="v1.28" state="alpha" >}}
+
+Enabling the [SidecarContainers feature gate](/docs/reference/command-line-tools-reference/feature-gates/)


(nit

Suggested change

Enabling the [SidecarContainers feature gate](/docs/reference/command-line-tools-reference/feature-gates/)

Enabling the SidecarContainers` [feature gate](/docs/reference/command-line-tools-reference/feature-gates/)

sftim · 2023-08-07T15:46:09Z

content/en/docs/concepts/workloads/pods/_index.md

+{{< feature-state for_k8s_version="v1.28" state="alpha" >}}
+
+Enabling the [SidecarContainers feature gate](/docs/reference/command-line-tools-reference/feature-gates/)
+allows specifying a <code>restartPolicy=Always</code> to init containers, making sure they are


Suggested change

allows specifying a <code>restartPolicy=Always</code> to init containers, making sure they are

allows you to specify `restartPolicy: Always` for init containers. Setting the `Always` restart policy

ensures that the init containers where you set it are

sftim · 2023-08-07T15:46:33Z

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

+{{< feature-state for_k8s_version="v1.28" state="alpha" >}}
+
+Starting with Kubernetes 1.28 in alpha, a feature gate named `SidecarContainers`
+allows to specify a `restartPolicy` for init containers which is independent of


(nit)

Suggested change

allows to specify a `restartPolicy` for init containers which is independent of

allows you to specify a `restartPolicy` for init containers which is independent of

sftim · 2023-08-07T15:48:32Z

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

+The only difference is that they are not required to complete before the next
+init container starts, so a next init container will start after the current
+container status has been set to `Pod.status.containerStatuses[id of container].started=true`


Suggested change

The only difference is that they are not required to complete before the next

init container starts, so a next init container will start after the current

container status has been set to `Pod.status.containerStatuses[id of container].started=true`

Compared to regular init containers, sidecar-style init containers continue to

run and the next init container can being starting once the kubet has set

the `started` container status for the sidecar-style init container to true.

That status either becomes true because there is a process running in the

container and no startup probe defined, or

k8s-ci-robot · 2023-08-07T15:49:49Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: sftim, tzneal

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

matthyx · 2023-08-08T06:25:11Z

This could use polish but is good enough for alpha.

/lgtm /approve

Thanks @sftim should I open a new PR with your suggestions?

sftim · 2023-08-08T09:20:07Z

Should I open a new PR with your suggestions?

Please do if you've got the capacity for that.

matthyx · 2023-08-08T09:55:37Z

Please do if you've got the capacity for that.

#42447

Add initial (alpha) documentation about sidecar containers

k8s-ci-robot added this to the 1.28 milestone Jun 29, 2023

k8s-ci-robot requested review from onlydole and tengqm June 29, 2023 06:00

k8s-ci-robot added the sig/docs Categorizes an issue or PR as relevant to SIG Docs. label Jun 29, 2023

matthyx mentioned this pull request Jun 29, 2023

Sidecar Containers kubernetes/enhancements#753

Open

11 tasks

matthyx force-pushed the sidecar branch 2 times, most recently from 4737fc1 to 8e7bae7 Compare June 29, 2023 10:19

k8s-ci-robot added size/S Denotes a PR that changes 10-29 lines, ignoring generated files. area/blog Issues or PRs related to the Kubernetes Blog subproject and removed size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Jun 29, 2023

sftim reviewed Jun 30, 2023

View reviewed changes

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

k8s-ci-robot added sig/node Categorizes an issue or PR as relevant to SIG Node. needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. labels Jun 30, 2023

k8s-ci-robot requested a review from tzneal July 3, 2023 13:39

matthyx force-pushed the sidecar branch from 8e7bae7 to 16f09f4 Compare July 4, 2023 15:32

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jul 31, 2023

tengqm reviewed Aug 1, 2023

View reviewed changes

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

k8s-ci-robot requested a review from tzneal August 1, 2023 14:14

k8s-ci-robot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Aug 1, 2023

sftim reviewed Aug 1, 2023

View reviewed changes

content/en/docs/concepts/workloads/pods/init-containers.md Outdated Show resolved Hide resolved

sftim reviewed Aug 1, 2023

View reviewed changes

content/en/docs/concepts/workloads/pods/_index.md Show resolved Hide resolved

matthyx force-pushed the sidecar branch from 1d62271 to 8a44573 Compare August 1, 2023 15:05

adding Sidecar Containers alpha feature

fde22b5

Signed-off-by: Matthias Bertschy <[email protected]>

matthyx force-pushed the sidecar branch from 8a44573 to fde22b5 Compare August 1, 2023 15:13

tzneal approved these changes Aug 7, 2023

View reviewed changes

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

k8s-ci-robot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Aug 7, 2023

sftim reviewed Aug 7, 2023

View reviewed changes

k8s-ci-robot assigned sftim Aug 7, 2023

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

k8s-ci-robot merged commit 962bf89 into kubernetes:dev-1.28 Aug 7, 2023
4 checks passed

matthyx deleted the sidecar branch August 8, 2023 09:46

gjkim42 mentioned this pull request Aug 10, 2023

Add feature blog post for sidecar containers #42323

Merged

Rishit-dagli pushed a commit to Rishit-dagli/website that referenced this pull request Aug 12, 2023

Merge pull request kubernetes#41802 from matthyx/sidecar

f6550e6

Add initial (alpha) documentation about sidecar containers

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add initial (alpha) documentation about sidecar containers #41802

Add initial (alpha) documentation about sidecar containers #41802

matthyx commented Jun 29, 2023

sftim commented Jun 30, 2023

tzneal commented Jul 3, 2023

k8s-ci-robot commented Jul 31, 2023

sftim commented Aug 1, 2023

matthyx commented Aug 1, 2023

tzneal left a comment

k8s-ci-robot commented Aug 7, 2023

sftim commented Aug 7, 2023

sftim left a comment

sftim Aug 7, 2023

sftim Aug 7, 2023

sftim Aug 7, 2023

sftim Aug 7, 2023

k8s-ci-robot commented Aug 7, 2023

matthyx commented Aug 8, 2023

sftim commented Aug 8, 2023

matthyx commented Aug 8, 2023


		{{< feature-state for_k8s_version="v1.28" state="alpha" >}}

		Enabling the [SidecarContainers feature gate](/docs/reference/command-line-tools-reference/feature-gates/)

	Enabling the [SidecarContainers feature gate](/docs/reference/command-line-tools-reference/feature-gates/)
	Enabling the SidecarContainers` [feature gate](/docs/reference/command-line-tools-reference/feature-gates/)

	allows specifying a <code>restartPolicy=Always</code> to init containers, making sure they are
	allows you to specify `restartPolicy: Always` for init containers. Setting the `Always` restart policy
	ensures that the init containers where you set it are

	allows to specify a `restartPolicy` for init containers which is independent of
	allows you to specify a `restartPolicy` for init containers which is independent of

-The only difference is that they are not required to complete before the next
-init container starts, so a next init container will start after the current
-container status has been set to `Pod.status.containerStatuses[id of container].started=true`
+Compared to regular init containers, sidecar-style init containers continue to
+run and the next init container can being starting once the kubet has set
+the `started` container status for the sidecar-style init container to true.
+That status either becomes true because there is a process running in the
+container and no startup probe defined, or

Add initial (alpha) documentation about sidecar containers #41802

Add initial (alpha) documentation about sidecar containers #41802

Conversation

matthyx commented Jun 29, 2023

sftim commented Jun 30, 2023

tzneal commented Jul 3, 2023

k8s-ci-robot commented Jul 31, 2023

sftim commented Aug 1, 2023

matthyx commented Aug 1, 2023

tzneal left a comment

Choose a reason for hiding this comment

k8s-ci-robot commented Aug 7, 2023

sftim commented Aug 7, 2023

sftim left a comment

Choose a reason for hiding this comment

sftim Aug 7, 2023

Choose a reason for hiding this comment

sftim Aug 7, 2023

Choose a reason for hiding this comment

sftim Aug 7, 2023

Choose a reason for hiding this comment

sftim Aug 7, 2023

Choose a reason for hiding this comment

k8s-ci-robot commented Aug 7, 2023

matthyx commented Aug 8, 2023

sftim commented Aug 8, 2023

matthyx commented Aug 8, 2023