-
Notifications
You must be signed in to change notification settings - Fork 1.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 documentation for kubernetes_state_core
core check
#12552
Conversation
The |
8493750
to
67f4515
Compare
The |
67f4515
to
a4fbd34
Compare
The |
a4fbd34
to
ddc60f1
Compare
The |
The |
The |
1 similar comment
The |
3e62540
to
1938955
Compare
The |
1938955
to
3fb3ca9
Compare
The |
The |
3fb3ca9
to
3819a15
Compare
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.
A few fixes to the readme
Co-authored-by: Kari Halsted <[email protected]> Co-authored-by: Florent Clarret <[email protected]>
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.
What's the plan for this page https://docs.datadoghq.com/integrations/kubernetes_state_core/?tab=helm ?
kubernetes_state_core/README.md
Outdated
### Installation | ||
|
||
The Kubernetes State Core check is included in the [Datadog Agent][2] package. | ||
No additional installation is needed on your server. | ||
|
||
### Configuration | ||
|
||
1. Edit the `kubernetes_state_core.d/conf.yaml` file, in the `conf.d/` folder at the root of your Agent's configuration directory to start collecting your kubernetes_state_core performance data. See the [sample kubernetes_state_core.d/conf.yaml][4] for all available configuration options. | ||
|
||
2. [Restart the Agent][5]. |
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.
IMHO this is not ideal, it's not adapted to containerized environments in general and specifically KSM Core as it runs as a single instance in the cluster. Can we use the same approach we have on this page https://docs.datadoghq.com/integrations/kubernetes_state_core/?tab=helm#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.
Based on your remark, I think that the best is just to move all the content of https://docs.datadoghq.com/integrations/kubernetes_state_core/?tab=helm here, except the metrics list that would be in metadata.csv
. The goal is to have the metrics list not only documented in the doc web site, but also in the app.
WDYT ?
-> 1a42622
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.
Sounds good, thank you!
One more comment on this. Tabs on integrations pages need to be coded like this, otherwise they don't show up correctly in-app:
|
794c36b
Kari is out of office today. I am approving this PR on her behalf.
1e796ae
What does this PR do?
Add standard documentation files for the
kubernetes_state_core
core check implemented in the datadog-agent repo.Motivation
We’d like to
kubernetes_state_core
check to benefit from the standard checks tooling for documentation.Additional Notes
Review checklist (to be filled by reviewers)
changelog/
andintegration/
labels attached