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.

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

[SidecarContainer] provide sidecar best practices hints about exit code #48228

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

pegasas
Copy link
Contributor

@pegasas pegasas commented Oct 6, 2024

Description

This is a follow up from kubernetes/enhancements#753 (comment)

We need to improve the page https://kubernetes.io/docs/tutorials/configuration/pod-sidecar-containers/ with the best practices on how to implement sidecar containers. Things like exiting with 0 on SIGTERM

Issue

Closes: #47823

@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Oct 6, 2024
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign sftim for approval. For more information see the Kubernetes Code Review Process.

The full list of commands accepted by this bot can be found 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 language/en Issues or PRs related to English language label Oct 6, 2024
@k8s-ci-robot k8s-ci-robot added the size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. label Oct 6, 2024
@pegasas pegasas changed the title [SidecarContainer] provide sidecar implementation best practices hints [SidecarContainer] provide sidecar best practices hints about exit code Oct 6, 2024
Copy link

netlify bot commented Oct 6, 2024

Pull request preview available for checking

Built without sensitive environment variables

Name Link
🔨 Latest commit 9490d46
🔍 Latest deploy log https://app.netlify.com/sites/kubernetes-io-main-staging/deploys/6702a196b849ab00084e2f0b
😎 Deploy Preview https://deploy-preview-48228--kubernetes-io-main-staging.netlify.app
📱 Preview on mobile
Toggle QR Code...

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
Copy link
Contributor

sftim commented Oct 6, 2024

If we want to document good practice, I'd put that elsewhere (not inside a tutorial page).

@pegasas
Copy link
Contributor Author

pegasas commented Oct 7, 2024

If we want to document good practice, I'd put that elsewhere (not inside a tutorial page).

Any suggestions?
For me, I think this is a good place because it is near place which mentioned SIGTERM/SIGKILL fact.

@SergeyKanzhelev
Copy link
Member

Let's add it to this page: https://kubernetes.io/docs/concepts/workloads/pods/sidecar-containers/#differences-from-application-containers

And link the differences section from where you put this node to originally

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. language/en Issues or PRs related to English language size/XS Denotes a PR that changes 0-9 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[SidecarContainer] Need to provide sidecar implementation best practices
4 participants