Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Document SidecarContainers graduation to beta #43471

Merged
merged 1 commit into from
Nov 15, 2023
Merged

Document SidecarContainers graduation to beta #43471

merged 1 commit into from
Nov 15, 2023

Conversation

matthyx
Copy link
Contributor

@matthyx matthyx commented Oct 13, 2023

@k8s-ci-robot k8s-ci-robot added this to the 1.29 milestone Oct 13, 2023
@netlify
Copy link

netlify bot commented Oct 13, 2023 •
edited
Loading

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

Name Link
🔨 Latest commit
🔍 Latest deploy log https://app.netlify.com/sites/kubernetes-io-vnext-staging/deploys/65540a12422fac2e7b2caf63

@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Oct 13, 2023
@k8s-ci-robot 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 Oct 13, 2023
@matthyx matthyx mentioned this pull request Oct 13, 2023
Open
11 tasks
@tengqm
Copy link
Contributor

tengqm commented Oct 13, 2023

at least the content/en//docs/concepts/workloads/pods/init-containers.md file needs a change too.

@matthyx
Copy link
Contributor Author

matthyx commented Oct 13, 2023

at least the content/en//docs/concepts/workloads/pods/init-containers.md file needs a change too.

yes, I just opened the placeholder to meet the 19th deadline

@sftim
Copy link
Contributor

sftim commented Oct 13, 2023

/retitle [WIP] [Placeholder] Document SidecarContainers graduation to beta

@k8s-ci-robot k8s-ci-robot changed the title Placeholder - SidecarContainers graduating to beta [WIP] [Placeholder] Document SidecarContainers graduation to beta Oct 13, 2023
@k8s-ci-robot k8s-ci-robot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Oct 13, 2023
@sftim
Copy link
Contributor

sftim commented Oct 13, 2023

/sig node

@k8s-ci-robot k8s-ci-robot added the sig/node Categorizes an issue or PR as relevant to SIG Node. label Oct 13, 2023
@drewhagen
Copy link
Member

Hello @matthyx 👋, I see there is work in progress with these docs! 👍 Please take a look at Documenting for a release - PR Ready for Review to get your PR ready for review before Tuesday 14th November 2023. Thank you!

@k8s-ci-robot 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 Nov 12, 2023
@matthyx matthyx changed the title [WIP] [Placeholder] Document SidecarContainers graduation to beta Document SidecarContainers graduation to beta Nov 12, 2023
@k8s-ci-robot 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 Nov 12, 2023
@matthyx
Copy link
Contributor Author

matthyx commented Nov 12, 2023

/cc @SergeyKanzhelev @tzneal @gjkim42

gjkim42
gjkim42 reviewed Nov 13, 2023
View reviewed changes
content/en/docs/concepts/workloads/pods/pod-lifecycle.md Outdated
@@ -504,6 +504,19 @@ termination grace period _begins_. The behavior above is described when the
feature gate `EndpointSliceTerminatingCondition` is enabled.
{{</note>}}

{{<note>}}
Starting from Kubernetes 1.29, if your Pod has one or more sidecar containers,
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

End users may misunderstand the term "sidecar container" as it's been a while since we've called the regular container that supports the main container "the sidecar container".

Maybe it would be better to be written more clearly, like "an init container with Always restart policy".

content/en/docs/concepts/workloads/pods/pod-lifecycle.md Outdated
Please note that slow termination of the main container will also delay the
termination of the sidecar containers and may trigger emergency termination
of the Pod if the grace period expires. In such cases, all remaining containers
in the Pod will be terminated with SIGKILL simultaneously.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
in the Pod will be terminated with SIGKILL simultaneously.
in the Pod will be terminated with a short grace period simultaneously.

SergeyKanzhelev
SergeyKanzhelev approved these changes Nov 14, 2023
View reviewed changes
Copy link
Member

@SergeyKanzhelev SergeyKanzhelev left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/lgtm

we discussed a small addition we may want to this document, but it can be done later. It's important to update this part first

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Nov 14, 2023
@k8s-ci-robot
Copy link
Contributor

LGTM label has been added.

Git tree hash: 18dfebcb051b5c567a2d7dc29894c242dc5f47b8

@matthyx
modifying docs for SidecarContainers beta graduation
29dff23 
Signed-off-by: Matthias Bertschy <matthias.bertschy@gmail.com>
@k8s-ci-robot k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Nov 14, 2023
@k8s-ci-robot k8s-ci-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Nov 14, 2023
tzneal
tzneal approved these changes Nov 14, 2023
View reviewed changes
Copy link
Contributor

@tzneal tzneal left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Nov 14, 2023
@k8s-ci-robot
Copy link
Contributor

LGTM label has been added.

Git tree hash: c8a82c1be5c8225290d02f31ce9d73d10a905f2b

@tengqm
Copy link
Contributor

tengqm commented Nov 15, 2023

/approve
Double confirmed that the gate error is a temporary failure.

@tengqm tengqm merged commit 8f7cfdb into kubernetes:dev-1.29 Nov 15, 2023
0 of 3 checks passed
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: SergeyKanzhelev, tengqm, 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:

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 k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Nov 15, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@gjkim42 gjkim42 gjkim42 left review comments

@tengqm tengqm tengqm left review comments

@tzneal tzneal tzneal approved these changes

@dipesh-rawat dipesh-rawat Awaiting requested review from dipesh-rawat

@natalisucks natalisucks Awaiting requested review from natalisucks

@SergeyKanzhelev SergeyKanzhelev Awaiting requested review from SergeyKanzhelev

Assignees

@tzneal tzneal

@SergeyKanzhelev SergeyKanzhelev

Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. language/en Issues or PRs related to English language lgtm "Looks good to me", indicates that a PR is ready to be merged. sig/docs Categorizes an issue or PR as relevant to SIG Docs. sig/node Categorizes an issue or PR as relevant to SIG Node. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
SIG Node: code and documentation PRs
Archived in project
Milestone
1.29
Development

Successfully merging this pull request may close these issues.
8 participants
@matthyx @tengqm @sftim @drewhagen @k8s-ci-robot @tzneal @SergeyKanzhelev @gjkim42