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

Specify steps to create service account for Grafana auth #560

Merged
merged 2 commits into from
Jan 16, 2025
Merged

Specify steps to create service account for Grafana auth #560

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
43409e2
Specify steps to create service account for Grafana auth
nikimanoledaki Jan 15, 2025
9fb9ccd
Update auth docs for clarity
nikimanoledaki Jan 16, 2025
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
45 changes: 39 additions & 6 deletions docs/content/configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,30 +25,63 @@ context first, then explain how to use multiple contexts thereafter.
Settings can be configured via Grizzly itself, using `grr config set`. They are stored
in an OS specific location.

## Grafana Itself
## Authenticate with a Grafana instance

Grizzly interacts with Grafana via its REST API. For this, you will need to
establish authentication credentials.

The minimum requirement is to set the URL of the Grafana instance to be used:
```sh
grr config set grafana.url http://localhost:3000 # URL for the root of your Grafana instance
grr config set grafana.user admin # (Optional) Username if using basic auth
```

Optionally, set the following field(s), depending our your [authentication method with the given Grafana instance](https://grafana.com/docs/grafana/latest/setup-grafana/configure-security/configure-authentication/):
- A [token](#token-or-password-optional) if using a [Grafana service account](https://grafana.com/docs/grafana/latest/administration/service-accounts) (recommended)
- A [username](#username-optional) and [password](#token-or-password-optional) if using basic authentication

Next, consider setting a [context](#using-grizzly-contexts) to save this configuration.

Once you have configured your authentication method, you are ready to use the [Grizzly server](./server.md) to view and/or edit resources.

### Token or password (optional)

To authenticate with a Grafana instance using a service account token, first [create a service account in the
Grafana instance](https://grafana.com/docs/grafana/latest/administration/service-accounts/#to-create-a-service-account).
Before clicking `Create` to create the service account, ensure that you have added the role that
best suits your use case. A role with `Viewer` permissions would be enough
to view resources. Use `Editor` or `Admin` to be able to edit resources.
Then,
[add a token to the new service account](https://grafana.com/docs/grafana/latest/administration/service-accounts/#add-a-token-to-a-service-account-in-grafana).
Copy the token and set it with Grizzly:

```sh
grr config set grafana.token abcd12345 # Service account token (or basic auth password)
```

## Grafana Cloud Prometheus
To interact with Grafana Cloud Prometheus (aka Mimir), use these settings:
Alternatively, set this field to a password if using [basic authentication](https://grafana.com/docs/grafana/latest/setup-grafana/configure-security/configure-authentication/#basic-authentication).

### Username (optional)

Optionally, set a username if using [basic authentication](https://grafana.com/docs/grafana/latest/setup-grafana/configure-security/configure-authentication/#basic-authentication).

```sh
grr config set grafana.user admin # (Optional) Username if using basic auth
```

## Authenticate with hosted Prometheus

To interact with [hosted Prometheus / Mimir](./prometheus.md) resources, use these settings:
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I replaced Grafana Cloud Prometheus with hosted Prometheus so that it's clearer that this is specifically for Prometheus/Mimir. That way folks don't wonder whether they need to do this if they want to use Grafana Cloud ☺️


```sh
grr config set mimir.address https://mimir.example.com # URL for Mimir instance or Grafana Cloud Prometheus instance
grr config set mimir.tenant-id myTenant # Tenant ID for your Grafana Cloud Prometheus account
grr config set mimir.api-key abcdef12345 # Authentication token (if you are using Grafana Cloud)
```

**Notes**
**Notes**
* Be sure to set `api-key` when you need to interact with Grafana Cloud.

## Grafana Synthetic Monitoring
## Authenticate with Grafana Synthetic Monitoring
To interact with Grafana Synthetic Monitoring, you must configure the below settings:

```sh
Expand Down
6 changes: 3 additions & 3 deletions docs/content/prometheus.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,12 @@ title: "With Prometheus"
---

## Which Prometheus' are supported?

Prometheus itself requires its configuration to be present in text files on
local disk. As Grizzly focuses on systems that can be managed via HTTP APIs,
local disk. Since Grizzly focuses on systems that can be managed via HTTP APIs,
Grizzly cannot (currently) work with Prometheus itself.

Various hosted Prometheus installations, such as Grafana Cloud Prometheus
are supported, as are systems running Mimir.
Various hosted Prometheus installations are supported, such as [Grafana Cloud Prometheus](https://grafana.com/go/grafana-cloud-prometheus-1/). Systems running [Grafana Mimir](https://grafana.com/docs/mimir/latest/) are supported as well.

## Configuring Prometheus
Prometheus alert and recording rules are both created using the same `kind`:
Expand Down
Loading