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

kubernetes docs improvements #6187

Merged
merged 12 commits into from
Mar 18, 2024
Merged

kubernetes docs improvements #6187

merged 12 commits into from
Mar 18, 2024

Conversation

thampiotr
Copy link
Contributor

@thampiotr thampiotr commented Jan 18, 2024 •
edited

PR Description

This PR is a set of tweaks that address some of the feedback on k8s docs:

  • Don't use default namespace when installing on k8s, to follow best practices.
  • Clarify the configure k8s page is for applying an existing config. Refer to other docs that help write that config.
  • Explain how users can modify the agent config when using Helm chart. Support two methods: inline config in values.yaml and custom config map created from a file.

@thampiotr thampiotr mentioned this pull request Jan 18, 2024
Closed
@thampiotr thampiotr force-pushed the thampiotr/k8s-docs-improvements branch from 9031556 to 031a0d6 Compare January 22, 2024 13:57
@clayton-cornell clayton-cornell added the type/docs Docs Squad label across all Grafana Labs repos label Jan 23, 2024
@thampiotr thampiotr force-pushed the thampiotr/k8s-docs-improvements branch 2 times, most recently from e9a0ab1 to 561c56f Compare March 6, 2024 11:13
@thampiotr thampiotr changed the title WIP: kubernetes docs improvements kubernetes docs improvements Mar 6, 2024
@thampiotr thampiotr marked this pull request as ready for review March 6, 2024 11:20
clayton-cornell
clayton-cornell reviewed Mar 11, 2024
View reviewed changes
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.

Some doc input and suggestions

docs/sources/flow/get-started/install/kubernetes.md Outdated Show resolved Hide resolved
docs/sources/flow/get-started/install/kubernetes.md Outdated Show resolved Hide resolved
docs/sources/flow/get-started/install/kubernetes.md Outdated Show resolved Hide resolved
docs/sources/flow/get-started/install/kubernetes.md Outdated Show resolved Hide resolved
docs/sources/flow/get-started/install/kubernetes.md Outdated Show resolved Hide resolved
docs/sources/flow/get-started/install/kubernetes.md Outdated Show resolved Hide resolved
docs/sources/flow/tasks/configure/configure-kubernetes.md Outdated Show resolved Hide resolved
docs/sources/flow/tasks/configure/configure-kubernetes.md Outdated Show resolved Hide resolved
@clayton-cornell
Copy link
Contributor

Doe we want this backported at least to 0.40?

@thampiotr
Copy link
Contributor Author

Doe we want this backported at least to 0.40?

I think porting to 0.40 is a good plan.

@thampiotr thampiotr force-pushed the thampiotr/k8s-docs-improvements branch from 857568b to f65b310 Compare March 18, 2024 10:28
clayton-cornell
clayton-cornell approved these changes Mar 18, 2024
View reviewed changes
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.

One small change and it's good from a doc standpoint

docs/sources/flow/get-started/install/kubernetes.md Outdated Show resolved Hide resolved
@thampiotr @clayton-cornell
Update docs/sources/flow/get-started/install/kubernetes.md
b466b0f 
Co-authored-by: Clayton Cornell <131809008+clayton-cornell@users.noreply.github.com>
@thampiotr thampiotr merged commit c68ec7c into main Mar 18, 2024
10 checks passed
@thampiotr thampiotr deleted the thampiotr/k8s-docs-improvements branch March 18, 2024 15:42
grafanabot pushed a commit that referenced this pull request Mar 18, 2024
@thampiotr @grafanabot
kubernetes docs improvements (#6187)
38ffc4e 
* WIP

* feedback, ty

* feedback

* Write about config changes to agent using helm chart

* generic install done

* generic configure done

* wip

* simplify

* cleanup

* Update docs/sources/flow/get-started/install/kubernetes.md

Co-authored-by: Clayton Cornell <131809008+clayton-cornell@users.noreply.github.com>

* Clayton's review, thanks!

Co-authored-by: Clayton Cornell <131809008+clayton-cornell@users.noreply.github.com>

* Update docs/sources/flow/get-started/install/kubernetes.md

Co-authored-by: Clayton Cornell <131809008+clayton-cornell@users.noreply.github.com>

---------

Co-authored-by: Clayton Cornell <131809008+clayton-cornell@users.noreply.github.com>
(cherry picked from commit c68ec7c)
@grafanabot grafanabot mentioned this pull request Mar 18, 2024
Merged
@thampiotr thampiotr mentioned this pull request Mar 18, 2024
Closed
clayton-cornell pushed a commit that referenced this pull request Mar 18, 2024
@grafanabot @thampiotr
kubernetes docs improvements (#6187) (#6716)
04b84d4 
* WIP

* feedback, ty

* feedback

* Write about config changes to agent using helm chart

* generic install done

* generic configure done

* wip

* simplify

* cleanup

* Update docs/sources/flow/get-started/install/kubernetes.md

Co-authored-by: Clayton Cornell <131809008+clayton-cornell@users.noreply.github.com>

* Clayton's review, thanks!

Co-authored-by: Clayton Cornell <131809008+clayton-cornell@users.noreply.github.com>

* Update docs/sources/flow/get-started/install/kubernetes.md

Co-authored-by: Clayton Cornell <131809008+clayton-cornell@users.noreply.github.com>

---------

Co-authored-by: Clayton Cornell <131809008+clayton-cornell@users.noreply.github.com>
(cherry picked from commit c68ec7c)

Co-authored-by: Piotr <17101802+thampiotr@users.noreply.github.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 Apr 21, 2024
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Apr 21, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@mattdurham mattdurham mattdurham left review comments

@clayton-cornell clayton-cornell clayton-cornell approved these changes

Assignees

@clayton-cornell clayton-cornell

Labels
backport release-v0.40 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
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@thampiotr @clayton-cornell @mattdurham