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.

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

Clarification and fixing typos in discovery.kubernetes.md #4509

Merged
merged 3 commits into from
Jul 20, 2023

Conversation

thampiotr
Copy link
Contributor

@thampiotr thampiotr commented Jul 19, 2023

PR Description

We've received a question regarding the selectors/role attribute - why wouldn't it always match the top-level role attribute.
Turns out there is a use case for this as documented in prometheus docs - porting this explanation to our docs with this PR.

Also fixes some typos and a broken link.

@thampiotr thampiotr marked this pull request as ready for review July 19, 2023 10:09
@thampiotr thampiotr changed the title Fix typos in discovery.kubernetes.md Clarification and fixing typos in discovery.kubernetes.md Jul 19, 2023
Comment on lines 293 to 296
The endpoints role supports pod, service and endpoints selectors.
The pod role supports node selectors when configured with `attach_metadata: {node: true}`.
Other roles only support selectors matching the role itself (e.g. node role can only contain node selectors).

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Copy link
Contributor

@spartan0x117 spartan0x117 left a comment

Choose a reason for hiding this comment

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

LGTM, though I'll defer to @clayton-cornell 😃

Co-authored-by: Mischa Thompson <mischabear@gmail.com>
@thampiotr
Copy link
Contributor Author

No rush with this one @clayton-cornell - feel free to merge it when you get to review it :)

Copy link
Contributor

@clayton-cornell clayton-cornell left a comment

Choose a reason for hiding this comment

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

Typos happen. LGTM, merging

@clayton-cornell clayton-cornell merged commit 76fee88 into main Jul 20, 2023
10 checks passed
@clayton-cornell clayton-cornell deleted the thampiotr/fix-k8s-docs branch July 20, 2023 20:52
grafanabot pushed a commit that referenced this pull request Jul 20, 2023
* Fix typos in discovery.kubernetes.md

* Update discovery.kubernetes.md

* Update docs/sources/flow/reference/components/discovery.kubernetes.md

Co-authored-by: Mischa Thompson <mischabear@gmail.com>

---------

Co-authored-by: Mischa Thompson <mischabear@gmail.com>
(cherry picked from commit 76fee88)
grafanabot pushed a commit that referenced this pull request Jul 20, 2023
* Fix typos in discovery.kubernetes.md

* Update discovery.kubernetes.md

* Update docs/sources/flow/reference/components/discovery.kubernetes.md

Co-authored-by: Mischa Thompson <mischabear@gmail.com>

---------

Co-authored-by: Mischa Thompson <mischabear@gmail.com>
(cherry picked from commit 76fee88)
grafanabot pushed a commit that referenced this pull request Jul 20, 2023
* Fix typos in discovery.kubernetes.md

* Update discovery.kubernetes.md

* Update docs/sources/flow/reference/components/discovery.kubernetes.md

Co-authored-by: Mischa Thompson <mischabear@gmail.com>

---------

Co-authored-by: Mischa Thompson <mischabear@gmail.com>
(cherry picked from commit 76fee88)
clayton-cornell pushed a commit that referenced this pull request Jul 20, 2023
)

* Fix typos in discovery.kubernetes.md

* Update discovery.kubernetes.md

* Update docs/sources/flow/reference/components/discovery.kubernetes.md

Co-authored-by: Mischa Thompson <mischabear@gmail.com>

---------

Co-authored-by: Mischa Thompson <mischabear@gmail.com>
(cherry picked from commit 76fee88)

Co-authored-by: Piotr <17101802+thampiotr@users.noreply.github.com>
clayton-cornell pushed a commit that referenced this pull request Jul 20, 2023
)

* Fix typos in discovery.kubernetes.md

* Update discovery.kubernetes.md

* Update docs/sources/flow/reference/components/discovery.kubernetes.md

Co-authored-by: Mischa Thompson <mischabear@gmail.com>

---------

Co-authored-by: Mischa Thompson <mischabear@gmail.com>
(cherry picked from commit 76fee88)

Co-authored-by: Piotr <17101802+thampiotr@users.noreply.github.com>
clayton-cornell pushed a commit that referenced this pull request Jul 20, 2023
)

* Fix typos in discovery.kubernetes.md

* Update discovery.kubernetes.md

* Update docs/sources/flow/reference/components/discovery.kubernetes.md

Co-authored-by: Mischa Thompson <mischabear@gmail.com>

---------

Co-authored-by: Mischa Thompson <mischabear@gmail.com>
(cherry picked from commit 76fee88)

Co-authored-by: Piotr <17101802+thampiotr@users.noreply.github.com>
clayton-cornell pushed a commit that referenced this pull request Aug 14, 2023
* Fix typos in discovery.kubernetes.md

* Update discovery.kubernetes.md

* Update docs/sources/flow/reference/components/discovery.kubernetes.md

Co-authored-by: Mischa Thompson <mischabear@gmail.com>

---------

Co-authored-by: Mischa Thompson <mischabear@gmail.com>
clayton-cornell pushed a commit that referenced this pull request Aug 14, 2023
* Fix typos in discovery.kubernetes.md

* Update discovery.kubernetes.md

* Update docs/sources/flow/reference/components/discovery.kubernetes.md

Co-authored-by: Mischa Thompson <mischabear@gmail.com>

---------

Co-authored-by: Mischa Thompson <mischabear@gmail.com>
@github-actions github-actions bot added the frozen-due-to-age Locked due to a period of inactivity. Please open new issues or PRs if more discussion is needed. label Feb 22, 2024
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Feb 22, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
backport release-v0.33 backport release-v0.34 backport release-v0.35 frozen-due-to-age Locked due to a period of inactivity. Please open new issues or PRs if more discussion is needed. type/docs Docs Squad label across all Grafana Labs repos
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants