docs: add Helm configuration instructions for metrics#43481
docs: add Helm configuration instructions for metrics#43481joestringer merged 1 commit intocilium:mainfrom
Conversation
joestringer
left a comment
There was a problem hiding this comment.
Thanks for the PR!
There's already some description about how to enable or disable specific metrics in the section around line 398. However, it's focused on how to configure this with direct agent flags rather than with Helm. Perhaps instead of adding a new section that duplicates the information, you could extend that earlier section to describe how to apply the configuration with Helm (preferred) or with commandline flags?
One possible way to render this would be to use .. tabs:: syntax so there's two tabs, one for each way to configure. You can find an example of this syntax in the Documentation/installation/k8s-install-helm.rst file.
I was gonna suggest at least grouping it closer to the existing docs, but I like the tabs approach. |
|
I'll mark this as draft until you get a chance to take another look @suunj . When you'd like more feedback, please click "Ready for review" at the bottom of the page to bring it back to the attention of reviews. Thanks for your contribution :) |
41a581c to
c0fa257
Compare
|
Commit c0fa257 does not match "(?m)^Signed-off-by:". Please follow instructions provided in https://docs.cilium.io/en/stable/contributing/development/contributing_guide/#developer-s-certificate-of-origin |
|
Commits c0fa257, 9b0ede3 do not match "(?m)^Signed-off-by:". Please follow instructions provided in https://docs.cilium.io/en/stable/contributing/development/contributing_guide/#developer-s-certificate-of-origin |
9b0ede3 to
0314b9d
Compare
|
Commit 91c47bf does not match "(?m)^Signed-off-by:". Please follow instructions provided in https://docs.cilium.io/en/stable/contributing/development/contributing_guide/#developer-s-certificate-of-origin |
Signed-off-by: SeungJu Cheon <suunj1331@gmail.com>
91c47bf to
8f878ea
Compare
joestringer
left a comment
There was a problem hiding this comment.
The changes here look good. I think we could probably improve the overall structure a bit more to pull this up to the top of the metrics reference section rather than being under the cilium-agent configuration section. I realize (now) that each component has its own configuration sections, but the main thing that differs is just the specific configuration flag and hopefully not the syntax for these advanced map-type configurations.
Either way the change itself looks good to me via:
https://deploy-preview-43481--docs-cilium-io.netlify.app/observability/metrics#configuration
|
/test |
|
Thanks @suunj! |
Please ensure your pull request adheres to the following guidelines:
description and a
Fixes: #XXXline if the commit addresses a particularGitHub issue.
Fixes: <commit-id>tag, thenplease add the commit author[s] as reviewer[s] to this issue.
Fixes: #21450