docs(tigera-operator): Update values.yaml & the readme #11546
Conversation
marvin-tigera
added
release-note-required
|
|
There was a problem hiding this comment.
Pull request overview
This PR improves the documentation and usability of the tigera-operator Helm chart by reorganizing configuration structure and adding comprehensive default values with inline documentation.
Key Changes:
- Relocated
kubeletVolumePluginPathfrom root level toinstallation.kubeletVolumePluginPathfor better organization - Added extensive documentation comments and default values for common configuration options (CNI, networking, dataplane, logging)
- Updated API documentation URL reference to use the correct anchor format (#installationspec)
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
| charts/tigera-operator/values.yaml | Added comprehensive default values with documentation for installation configuration including CNI settings, networking options, dataplane selection, control plane configuration, and logging settings; moved kubeletVolumePluginPath under installation section |
| charts/tigera-operator/README.md | Updated to reflect the new location of kubeletVolumePluginPath under installation section; removed obsolete root-level configuration reference |
caseydavenport
left a comment
caseydavenport
left a comment
There was a problem hiding this comment.
This is great, thank you!
I've added some thoughts and comments - please let me know what you think. My main concern is defaulting too many values that we typically allow the operator to auto-detect - I think including them but leaving them commented out is a good middleground?
|
@caseydavenport I didn't think of that, good catch! I haven't been in the operator code, so I'll take your word for it 😅. Leaving them as comments sounds perfect and would already help me as a user. |
|
@caseydavenport can you please take another look at this? Appreciate it! |
|
/sem-approve |
|
Thanks @tom-ludwig - sorry for the delay, I've been out for the holidays. I added two more comments on "magic" fields that probably can't be defaulted in the values.yaml file. This is looking pretty close, though! |
Co-authored-by: Casey Davenport <[email protected]>
|
@caseydavenport thanks for you time and the review. I commented the marked parameters out 👍🏻 |
|
/sem-approve |
|
whoops @tom-ludwig I think you'll need to run |
|
@caseydavenport I likely won't have the bandwidth to work on this until next week. Could you please try running the generation to see if it resolves the issue? |
4 participants
Description
Update the documentation for the tigera operator helm chart.
kubeletVolumePluginPathand move it toinstallation.kubeletVolumePluginPathvalues.yamlWhen I start with a poc of a new operator, I'll usually try to deploy it to our poc landscape as soon as possible.
For that I just copy the values.yaml and tweak them to my use case.
I think these changes will make it easier and more clearer where to start.
Related issues/PRs
Todos
Release Note
Reminder for the reviewer
Make sure that this PR has the correct labels and milestone set.
Every PR needs one
docs-*label.docs-pr-required: This change requires a change to the documentation that has not been completed yet.docs-completed: This change has all necessary documentation completed.docs-not-required: This change has no user-facing impact and requires no docs.Every PR needs one
release-note-*label.release-note-required: This PR has user-facing changes. Most PRs should have this label.release-note-not-required: This PR has no user-facing changes.Other optional labels:
cherry-pick-candidate: This PR should be cherry-picked to an earlier release. For bug fixes only.needs-operator-pr: This PR is related to install and requires a corresponding change to the operator.