-
Notifications
You must be signed in to change notification settings - Fork 14.4k
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
Add tutorial about running Pods with sidecar containers #46825
Add tutorial about running Pods with sidecar containers #46825
Conversation
✅ Pull request preview available for checkingBuilt without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify site configuration. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It's great that we want to help people learn about running sidecars.
How about adding a tutorial page, eg https://k8s.io/docs/tutorials/pod-sidecar-containers/?
2c786b7
to
6727ef5
Compare
Updated. |
content/en/docs/tutorials/configuration/pod-sidecar-containers.md
Outdated
Show resolved
Hide resolved
content/en/docs/tutorials/configuration/pod-sidecar-containers.md
Outdated
Show resolved
Hide resolved
71124fd
to
e48c63d
Compare
Any advice what does this may mean:
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Any advice what does this may mean:
Error: error building site: assemble: "/opt/build/repo/content/en/docs/tutorials/configuration/pod-sidecar-containers.md:1:1": got positional parameter 'or'. Cannot mix named and positional parameters
See inline feedback (the feature-state
suggestion)
content/en/docs/tutorials/configuration/pod-sidecar-containers.md
Outdated
Show resolved
Hide resolved
content/en/docs/tutorials/configuration/pod-sidecar-containers.md
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Questions in my mind:
- After following all the steps in the tutorial, how many Pods are still running (did we explain how to clean up?)
- After following all the steps in the tutorial, how many Pods that have a sidecar container have started and become healthy?
- After following all the steps in the tutorial, how many other Pods started (eg to help make a point about failure handling)?
If we're not helping the reader to run any Pods that have sidecars, the tutorial needs expanding until that changes.
content/en/docs/tutorials/configuration/pod-sidecar-containers.md
Outdated
Show resolved
Hide resolved
content/en/docs/tutorials/configuration/pod-sidecar-containers.md
Outdated
Show resolved
Hide resolved
content/en/docs/tutorials/configuration/pod-sidecar-containers.md
Outdated
Show resolved
Hide resolved
content/en/docs/tutorials/configuration/pod-sidecar-containers.md
Outdated
Show resolved
Hide resolved
content/en/docs/tutorials/configuration/pod-sidecar-containers.md
Outdated
Show resolved
Hide resolved
content/en/docs/tutorials/configuration/pod-sidecar-containers.md
Outdated
Show resolved
Hide resolved
content/en/docs/tutorials/configuration/pod-sidecar-containers.md
Outdated
Show resolved
Hide resolved
content/en/docs/tutorials/configuration/pod-sidecar-containers.md
Outdated
Show resolved
Hide resolved
content/en/docs/tutorials/configuration/pod-sidecar-containers.md
Outdated
Show resolved
Hide resolved
content/en/docs/tutorials/configuration/pod-sidecar-containers.md
Outdated
Show resolved
Hide resolved
/retitle Add tutorial about running Pods with sidecar containers |
content/en/docs/tutorials/configuration/pod-sidecar-containers.md
Outdated
Show resolved
Hide resolved
My key feedback is (still) the “questions in my mind” from #46825 (review) |
/label tide/merge-method-squash @SergeyKanzhelev, |
88efb5a
to
46b47cb
Compare
/remove-label tide/merge-method-squash |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Some more feedback. Please address the existing feedback as well.
content/en/docs/tutorials/configuration/pod-sidecar-containers.md
Outdated
Show resolved
Hide resolved
content/en/docs/tutorials/configuration/pod-sidecar-containers.md
Outdated
Show resolved
Hide resolved
content/en/docs/tutorials/configuration/pod-sidecar-containers.md
Outdated
Show resolved
Hide resolved
46b47cb
to
6bb0e03
Compare
874ce3c
to
4bc6afb
Compare
@sftim I think I addressed most of comments. I really want this first step out. See https://kubernetes.slack.com/archives/C0EG7JC6T/p1723141448471749 I added a few follow up steps on top that can be done. @afro-coder I think it will be easiest if we can merge this PR and if you want to contribute, can do as a follow up. |
great write, 100% correct regarding technicalities, thanks Sergey! |
LGTM label has been added. Git tree hash: 86cedfc8871cdd6350c9c87996c2a12dba9b34f1
|
/approve |
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: tengqm 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 |
/sig node
more questions about sidecars warranted me to write this down.
It was discussed at Sidecar WG meeting: https://docs.google.com/document/d/1E1guvFJ5KBQIGcjCrQqFywU9_cBQHRtHvjuqcVbCXvU/edit#bookmark=id.u4zmu7j9vn31
This is the first step in this tutorial. It may require more work in the following areas: