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

Update docs and links #39

Merged
merged 1 commit into from
Nov 28, 2023
Merged

Update docs and links #39

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 2 additions & 22 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ juju add-model cos
The Grafana agent may be deployed using the juju command line:

```bash
juju deploy grafana-agent --trust
juju deploy grafana-agent
```

If required, you can remove the deployment completely:
Expand All @@ -47,27 +47,7 @@ juju destroy-model -y cos --no-wait --force --destroy-storage

## Relations

Currently supported relations are:

```yaml
requires:
send-remote-write:
interface: prometheus_remote_write
metrics-endpoint:
interface: prometheus_scrape
logging-consumer:
interface: loki_push_api

provides:
self-metrics-endpoint:
interface: prometheus_scrape
grafana-dashboard:
interface: grafana_dashboard
logging-provider:
interface: loki_push_api
```

More detailed information about these relations can be found in [Charmhub docs page](https://charmhub.io/grafana-agent/docs/relations).
Detailed information about the relations can be found in [Charmhub integrations page](https://charmhub.io/grafana-agent/integrations).


## OCI Images
Expand Down
6 changes: 3 additions & 3 deletions metadata.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,10 @@ maintainers:
- Luca Bello <[email protected]>
- Simon Aronsson <[email protected]>

#docs: https://discourse.charmhub.io/t/grafana-agent-k8s-docs-index/5605
docs: https://github.com/canonical/grafana-agent-operator/blob/main/README.md
Copy link
Contributor

Choose a reason for hiding this comment

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

  • When there is no docs key, charmhub automatically renderes the readme.
  • Currently there are no discourse docs so the docs key should be omitted.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@sed-i I'm not sure that's the case any more? Currently the readme is not rendered on charmhub for grafana-agent: https://charmhub.io/grafana-agent

Copy link
Contributor

Choose a reason for hiding this comment

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

Ha, you're right. Alrighty, let's give this a try.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks, and thanks for reviewing and merging! :)

website: https://charmhub.io/grafana-agent
#source: https://github.com/canonical/grafana-agent-k8s-operator
#issues: https://github.com/canonical/grafana-agent-k8s-operator/issues
source: https://github.com/canonical/grafana-agent-operator
issues: https://github.com/canonical/grafana-agent-operator/issues

subordinate: true
series:
Expand Down
Loading