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

docs for the Grafana Agent Operator #651

Merged
merged 6 commits into from
Jun 15, 2021
Merged

Conversation

rfratto
Copy link
Member

@rfratto rfratto commented Jun 14, 2021

Adds docs for the Grafana Agent Operator introduced in #549.

@rfratto rfratto requested a review from mapno June 14, 2021 15:56
serviceAccountName: grafana-agent-operator
containers:
- name: operator
image: grafana/agent-operator:v0.15.0
Copy link
Member Author

Choose a reason for hiding this comment

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

(This image doesn't exist yet, if you're going to test this out locally you'll need to make agent-operator-image , re-tag it, and apply it to the k3d cluster using k3d image import -c agent-operator grafana/agent-operator:v0.15.0)

Copy link
Member

@mapno mapno left a comment

Choose a reason for hiding this comment

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

LGTM overall, just left some minor comments

docs/operator/README.md Outdated Show resolved Hide resolved
docs/operator/README.md Show resolved Hide resolved
docs/operator/getting-started.md Show resolved Hide resolved

Two labels are added by default to every metric:

- `cluster`, representing the `GrafanaAgent` deployment. Holds the value of
Copy link
Member

Choose a reason for hiding this comment

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

Does this override the cluster label from k8s SD?

Copy link
Member Author

Choose a reason for hiding this comment

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

No, k8s SD doesn't actually have a cluster label, but it's a common pattern to manually add one

@rfratto rfratto requested a review from mapno June 15, 2021 12:16
Copy link
Member

@mapno mapno left a comment

Choose a reason for hiding this comment

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

LGTM!

@rfratto rfratto merged commit d1a6a39 into grafana:main Jun 15, 2021
@mattdurham mattdurham mentioned this pull request Sep 7, 2021
3 tasks
mattdurham pushed a commit that referenced this pull request Nov 11, 2021
* docs for the Grafana Agent Operator

* fix identation of nested lists

* Update docs/operator/README.md

Co-authored-by: Mario <mariorvinas@gmail.com>

* more detail in README

* describe why CRDs

* mirror docs/operator/README.md intro to cmd/agent-operator/README.md

Co-authored-by: Mario <mariorvinas@gmail.com>
@rfratto rfratto deleted the operator-docs branch March 14, 2022 18:19
@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 2, 2024
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Apr 2, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
frozen-due-to-age Locked due to a period of inactivity. Please open new issues or PRs if more discussion is needed.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants