Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Add documentation for kubernetes_state_core core check #12552

Merged
merged 10 commits into from
Oct 27, 2022
Merged

Add documentation for kubernetes_state_core core check #12552

merged 10 commits into from
Oct 27, 2022

Conversation

L3n41c
Copy link
Member

@L3n41c L3n41c commented Jul 20, 2022

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)

  • Feature or bugfix MUST have appropriate tests (unit, integration, e2e)
  • PR title must be written as a CHANGELOG entry (see why)
  • Files changes must correspond to the primary purpose of the PR as described in the title (small unrelated changes should have their own PR)
  • PR must have changelog/ and integration/ labels attached

@github-actions
Copy link

The validations job has failed; please review the Files changed tab for possible suggestions to resolve.

@github-actions
Copy link

The validations job has failed; please review the Files changed tab for possible suggestions to resolve.

@github-actions
Copy link

github-actions bot commented Aug 3, 2022

The validations job has failed; please review the Files changed tab for possible suggestions to resolve.

@github-actions
Copy link

The validations job has failed; please review the Files changed tab for possible suggestions to resolve.

@ghost ghost added the dev/tooling label Sep 13, 2022
@github-actions
Copy link

The validations job has failed; please review the Files changed tab for possible suggestions to resolve.

@github-actions
Copy link

The validations job has failed; please review the Files changed tab for possible suggestions to resolve.

1 similar comment
@github-actions
Copy link

The validations job has failed; please review the Files changed tab for possible suggestions to resolve.

@ghost ghost removed the changelog/no-changelog label Sep 14, 2022
@github-actions
Copy link

The validations job has failed; please review the Files changed tab for possible suggestions to resolve.

@ghost ghost removed the changelog/no-changelog label Sep 14, 2022
@github-actions
Copy link

The validations job has failed; please review the Files changed tab for possible suggestions to resolve.

@github-actions
Copy link

The validations job has failed; please review the Files changed tab for possible suggestions to resolve.

kayayarai
kayayarai previously requested changes Sep 14, 2022
View reviewed changes
Copy link
Contributor

@kayayarai kayayarai left a 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

kubernetes_state_core/README.md Outdated Show resolved Hide resolved
kubernetes_state_core/README.md Outdated Show resolved Hide resolved
kubernetes_state_core/README.md Outdated Show resolved Hide resolved
@L3n41c L3n41c requested a review from a team as a code owner September 15, 2022 08:58
ahmed-mez
ahmed-mez reviewed Sep 15, 2022
View reviewed changes
Copy link
Contributor

@ahmed-mez ahmed-mez left a 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 ?

ahmed-mez
ahmed-mez reviewed Sep 15, 2022
View reviewed changes
kubernetes_state_core/README.md Outdated
Comment on lines 17 to 26
### 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].
Copy link
Contributor

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 ?

Copy link
Member Author

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

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sounds good, thank you!

ahmed-mez
ahmed-mez previously approved these changes Sep 15, 2022
View reviewed changes
FlorentClarret
FlorentClarret previously approved these changes Sep 15, 2022
View reviewed changes
@kayayarai
Copy link
Contributor

One more comment on this. Tabs on integrations pages need to be coded like this, otherwise they don't show up correctly in-app:

<!-- xxx tabs xxx -->
<!-- xxx tab "Tab name" xxx -->

Text inside tab. [Link references][x] continue from main page.

<!-- xxz tab xxx -->
<!-- xxz tabs xxx -->

[x]: /agent/guide/agent-commands/

urseberry
urseberry previously approved these changes Oct 25, 2022
View reviewed changes
@urseberry urseberry dismissed kayayarai’s stale review October 25, 2022 19:27

Kari is out of office today. I am approving this PR on her behalf.

ahmed-mez
ahmed-mez previously approved these changes Oct 26, 2022
View reviewed changes
@L3n41c L3n41c merged commit caa471d into master Oct 27, 2022
@L3n41c L3n41c deleted the lenaic/ksm_core_doc branch October 27, 2022 08:13
github-actions bot pushed a commit that referenced this pull request Oct 27, 2022
@L3n41c
Add documentation for kubernetes_state_core core check (#12552) caa…
ea758ad 
…471d
steveny91 pushed a commit that referenced this pull request Oct 27, 2022
@L3n41c @steveny91
Add documentation for kubernetes_state_core core check (#12552)
0bbe39b
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@FlorentClarret FlorentClarret FlorentClarret approved these changes

@kayayarai kayayarai kayayarai left review comments

@ahmed-mez ahmed-mez ahmed-mez left review comments

@urseberry urseberry urseberry left review comments

@cedricvanrompay-datadog cedricvanrompay-datadog cedricvanrompay-datadog left review comments

Assignees
No one assigned
Labels
dev/tooling documentation integration/kubernetes_state_core integration/kubernetes_state
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@L3n41c @kayayarai @FlorentClarret @ahmed-mez @urseberry @cedricvanrompay-datadog