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
docs: fix Helm documentation and doc checks #16737
Conversation
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.
The first commit checked in a binary file that's not needed, otherwise 👍
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.
Looks fine to me, just probably don't need to include the compiled python binary like Chris mentioned above (maybe this should be in a .gitignore somewhere?).
Will be ready-to-merge after addressing the above.
@@ -838,7 +842,7 @@ | |||
- object | |||
- ``{}`` | |||
* - monitor | |||
- Specify the CIDR for native routing (ie to avoid IP masquerade for). This value corresponds to the configured cluster-cidr. nativeRoutingCIDR: | |||
- Specify the IPv4 CIDR for native routing (ie to avoid IP masquerade for). This value corresponds to the configured cluster-cidr. ipv4NativeRoutingCIDR: |
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.
The placement of this option seems a bit odd like it's in the middle of the documentation for the monitor
option , but that's not a new problem introduced by this PR.
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.
Right, this should probably be addressed independently. The file is generated from the comments in install/kubernetes/cilium/values.yaml:
# -- Specify the IPv4 CIDR for native routing (ie to avoid IP masquerade for).
# This value corresponds to the configured cluster-cidr.
# ipv4NativeRoutingCIDR:
@bmcustodio do you know if there is a way to avoid appending the name of the variable from this comment to the generated reference? Do you think removing the space between the #
and the variable name would work?
Apologies for the python binary, that was obviously a mistake that I did not notice. I should probably add it to a .gitignore, I think it's generated from the custom filter for spelling I added for WireGuard (but I need to check first that it's still used and not some old artefact from a development version of that filter).
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.
Now updated to remove the binary.
Fix Helm documentation after a recent update of the Helm values. Update the spelling file accordingly. Fixes: 792ed5a ("daemon: rename native-routing-cidr option to ipv4-native-routing-cidr") Fixes: cilium#16646 Signed-off-by: Quentin Monnet <quentin@isovalent.com>
A spurious slash at the end of the pattern for files to watch for changes in the description of the GitHub workflow prevented the action to run on all changes of the Helm values. Fix it. Fixes: 4e5272b ("docs: run GitHub action when Charts are touched to check Helm values ref") Fixes: cilium#16577 Signed-off-by: Quentin Monnet <quentin@isovalent.com>
d05344a
to
8c848bc
Compare
First commit is an update of the Helm reference, so far omitted after some recent changes on the Helm values.
Second commit is a fix to the GitHub workflow conditions to run the Documentation action when Helm values are updated, in order to effectively catch similar omissions in the future.
Only the second commit should be backported, so I won't mark this PR for backports but will do it manually.