Skip to content

Commit 710a840

Browse files
committed
docs(monitoring): rewrite Grafana OIDC guide to match Phase-1 users-Job architecture
The website doc was written against the initial PR#3176 shape (three chart-owned KeycloakRealmGroups + role_attribute_path mapping groups to Admin/Editor/Viewer). Later commits on the code PR dropped that architecture entirely — chart-owned groups gone (commit 3b36966e2), role_attribute_path replaced with skip_org_role_sync + app-side users-map reconciled by a Job (commit sequence 2b3751edc / 7e2ac3cb8 / 4e8c5f4ed / e47308961 / b370998fc / efc27b33c). The website guide had drifted six revisions behind the code. Rewrite covers the actual current surface: - spec.oidc.users[] with Grafana org-role (Admin/Editor/Viewer) is the assignment mechanism; users-Job reconciles it on every helm action. - Login authorization is separate: allowed_groups gate on the tenant-scoped <ns>-{view,use,admin,super-admin} groups from the platform-managed cozy realm. - groups_attribute_path=groups is REQUIRED on Grafana v11.x+ alongside allowed_groups (matches the code fix committed on the cozystack side). - CustomConfig inline vs secretRef with the users[] compatibility contract (secretRef requires users: []). - Mode-toggle gotcha now describes the users-Job's ephemeral-account cleanup, not the deleted KeycloakRealmGroups. Also drops the stale role_attribute_path example that used a grafana-admins group name that this chart never provisioned. Signed-off-by: IvanHunters <[email protected]>
1 parent 3aa9c29 commit 710a840

1 file changed

Lines changed: 49 additions & 24 deletions

File tree

‎content/en/docs/next/operations/services/monitoring/oidc-authentication.md‎

Lines changed: 49 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11
---
22
title: "OIDC authentication for Grafana"
33
linkTitle: "OIDC authentication"
4-
description: "Give tenant users per-identity Grafana access with per-instance audience isolation."
4+
description: "Give tenant users per-identity Grafana access with per-instance audience isolation and tenant-membership gating."
55
weight: 5
66
---
77

8-
Cozystack Grafana instances can authenticate users through OIDC instead of the shared `admin_user` / `admin_password` Secret. Each user then has their own identity, per-user audit, and a role that can be revoked by removing them from a Keycloak group.
8+
Cozystack Grafana instances can authenticate users through OIDC instead of the shared `admin_user` / `admin_password` Secret. Each user then has their own identity, per-user audit, and a role that can be revoked by removing them from `spec.oidc.users` on the `Monitoring` CR.
99

10-
The identity model is deliberately **per-instance** rather than per-tenant: each Monitoring release (per-tenant `monitoring`, plus the platform's `monitoring-system`) gets its own OIDC audience, and a token minted for instance A is rejected by instance B's Grafana. That gives cross-tenant isolation without provisioning a Keycloak realm per tenant. The full rationale (why per-cluster audience and not per-tenant realm; how it relates to Keycloak Organizations; what BYO-OIDC looks like) is in the [design proposal](https://github.com/cozystack/community/pull/24). The tenant kube-apiserver's Phase 1 ([cozystack/cozystack#3044](https://github.com/cozystack/cozystack/pull/3044)) uses the same shape; this Grafana integration is the Phase-1 follow-up called out in that PR's body.
10+
The identity model is deliberately **per-instance** rather than per-tenant: each Monitoring release (per-tenant `monitoring`, plus the platform's `monitoring-system`) gets its own OIDC audience, and a token minted for instance A is rejected by instance B's Grafana. Cross-tenant sign-in is additionally blocked by a `allowed_groups` gate on the release's namespace-scoped `<ns>-{view,use,admin,super-admin}` groups (chart-owned in the tenant chart; the platform-managed `groups` scope in the `cozy` realm makes them visible on every token). The full rationale is in the [design proposal](https://github.com/cozystack/community/pull/24). The tenant kube-apiserver's Phase 1 ([cozystack/cozystack#3044](https://github.com/cozystack/cozystack/pull/3044)) uses the same shape; this Grafana integration is the Phase-1 follow-up called out in that PR's body.
1111

1212
{{% alert color="info" %}}
13-
The `grafana-admin-password` Secret in the tenant namespace stays available as a break-glass path regardless of whether OIDC is enabled. `disable_login_form` is not flipped by the selector.
13+
The `grafana-admin-password` Secret in the release namespace stays available as a break-glass path regardless of whether OIDC is enabled. `disable_login_form` is not flipped by the selector.
1414
{{% /alert %}}
1515

1616
## Modes
@@ -32,18 +32,42 @@ metadata:
3232
spec:
3333
oidc:
3434
mode: System
35+
users:
36+
37+
role: Admin
38+
39+
role: Editor
40+
41+
role: Viewer
3542
# ...
3643
```
3744

3845
Cozystack provisions:
3946

40-
- A per-instance `KeycloakClient` in the `cozy` realm with `clientId` set to `<namespace>-<release>` (for the CR above: `tenant-acme-monitoring`). `public: false`, `directAccess: false`, `secret` sourced from a chart-owned Kubernetes Secret. `redirectUris` locked to `https://grafana.<host>/login/generic_oauth`.
41-
- A per-instance `KeycloakClientScope` whose audience mapper pins the token's `aud` claim to that same `clientId` — the isolation primitive.
42-
- Three `KeycloakRealmGroup` objects — `<namespace>-<release>-admin`, `-editor`, `-viewer`. The chart owns the groups; membership is managed out-of-band by a Keycloak operator.
43-
- A persistent Kubernetes Secret carrying the confidential `client-secret` (random on first install, preserved on upgrades).
44-
- The Grafana CR's `spec.config.auth.generic_oauth` section wired to the cozy realm issuer, per-instance audience scope, and a `role_attribute_path` that maps the three groups above to Grafana's `Admin` / `Editor` / `Viewer` roles.
47+
- A per-instance **`KeycloakClient`** in the `cozy` realm with `clientId` set to `<namespace>-<release>` (for the CR above: `tenant-acme-monitoring-system`). Confidential (`clientAuthenticatorType: client-secret`), `secret` sourced from a chart-owned Kubernetes Secret. `redirectUris` locked to `https://grafana.<host>/login/generic_oauth`.
48+
- A per-instance **`KeycloakClientScope`** whose audience mapper pins the token's `aud` claim to that same `clientId` — the isolation primitive.
49+
- A persistent Kubernetes **Secret** carrying the confidential `client-secret` (random on first install, preserved on upgrades).
50+
- A chart-owned **users-reconcile Job** (`<release>-oidc-users`) that syncs `spec.oidc.users[]` into the Grafana instance on every reconcile: creates missing Grafana accounts, patches roles, and prunes stale org members. Runs as a post-install / post-upgrade hook when `users[]` is non-empty; omitted otherwise (BYO-IdP-friendly).
51+
- The Grafana CR's **`spec.config.auth.generic_oauth`** section wired to the cozy realm issuer, per-instance audience scope, and the tenant-membership gate:
4552

46-
Server-level `GrafanaAdmin` promotion is opt-in via `spec.oidc.grafanaAdmin: true` — the chart then sets `allow_assign_grafana_admin: true` on the rendered `[auth.generic_oauth]` block, so an `<clientId>-admin` group member becomes a `GrafanaAdmin` on first login. The platform bundle flips this on for the platform Grafana release (`monitoring-system` in `cozy-monitoring`); tenant Grafana releases inherit the chart default `false` and stay at org-level Admin.
53+
```
54+
allowed_groups = <namespace>-view <namespace>-use <namespace>-admin <namespace>-super-admin
55+
groups_attribute_path = groups
56+
```
57+
58+
`groups_attribute_path` is REQUIRED alongside `allowed_groups` on Grafana v11.x+: without it Grafana leaves the extracted `user.Groups` slice empty regardless of what the userinfo endpoint returns, and the gate rejects every login with "user not a member of one of the required groups" even when the token carries the correct claim. The JMESPath expression `groups` reads the top-level `groups` array from userinfo — the shape Keycloak's `oidc-group-membership-mapper` emits.
59+
60+
When `spec.oidc.users[]` is non-empty the chart additionally forces:
61+
62+
```
63+
skip_org_role_sync = true
64+
oauth_allow_insecure_email_lookup = true
65+
allow_sign_up = false
66+
```
67+
68+
`skip_org_role_sync=true` keeps a login from overwriting the users-Job's role assignments; `oauth_allow_insecure_email_lookup=true` lets Grafana attach the OIDC identity to the pre-provisioned local account by email; `allow_sign_up=false` is the isolation lever — without it, Grafana's default `allow_sign_up=true` combined with `skip_org_role_sync=true` would mint a Viewer account for every `cozy`-realm identity that hits the login flow.
69+
70+
Server-level `GrafanaAdmin` promotion is opt-in via `spec.oidc.grafanaAdmin: true` — the chart then sets `allow_assign_grafana_admin: true` on the rendered `[auth.generic_oauth]` block. The platform bundle flips this on for the platform Grafana release (`monitoring-system` in `cozy-monitoring`); tenant Grafana releases inherit the chart default `false` and stay at org-level Admin.
4771

4872
### Prerequisite
4973

@@ -65,7 +89,9 @@ spec:
6589
token_url: https://idp.acme.example/protocol/openid-connect/token
6690
api_url: https://idp.acme.example/protocol/openid-connect/userinfo
6791
scopes: openid email profile groups
68-
role_attribute_path: "contains(groups[*], 'grafana-admins') && 'Admin' || 'Viewer'"
92+
users:
93+
94+
role: Admin
6995
```
7096
7197
…or via a pre-existing Secret in the tenant namespace holding a ready-made `[auth.generic_oauth]` ini fragment in the `auth.ini` key:
@@ -81,18 +107,17 @@ spec:
81107

82108
Setting both `config` and `secretRef.name` (or neither) fails the render. In `CustomConfig` mode no Keycloak objects are provisioned in `cozy`; the Grafana instance trusts the operator-supplied issuer directly.
83109

110+
The `secretRef` path is authoritative — the chart does not overlay any keys onto the operator-supplied ini fragment. If you use `secretRef`, `spec.oidc.users[]` MUST be empty (the chart fails the render otherwise) because the users-Job cannot reason about a config it cannot see.
111+
112+
The `inline config` path merges the operator's map on top of the chart-forced users-map contract (`skip_org_role_sync=true`, `oauth_allow_insecure_email_lookup=true`, `allow_sign_up=false`) when `users[]` is non-empty. If your BYO IdP does not emit `groups` in the shape Grafana expects, add `groups_attribute_path` to your inline map to point at the right JMESPath.
113+
84114
## Assigning roles
85115

86-
Grafana has three org-level roles — `Admin`, `Editor`, `Viewer` — and the chart drives them via `role_attribute_path`:
116+
Roles are driven by **`spec.oidc.users[]`**, not by group membership: each entry has an `email` (matched against the OIDC `email` claim on login) and a `role` (Grafana org-level: `Admin`, `Editor`, or `Viewer`). The users-Job creates or updates the local Grafana account on every reconcile and prunes stale members. Removing a user from the list demotes them (users-Job deletes the account) on the next chart apply; adding a user re-provisions them.
87117

88-
```text
89-
contains(groups[*], '<ns>-<release>-admin') && 'Admin' ||
90-
contains(groups[*], '<ns>-<release>-editor') && 'Editor' ||
91-
contains(groups[*], '<ns>-<release>-viewer') && 'Viewer' ||
92-
'Viewer'
93-
```
118+
Login authorization is separate: the token owner MUST be a member of one of the release's tenant-scoped `cozy`-realm groups (`<namespace>-view`, `<namespace>-use`, `<namespace>-admin`, `<namespace>-super-admin`) for `allowed_groups` to accept the login. That gate is unconditional in `System` mode, independent of `users[]`.
94119

95-
Authenticated users with none of the three groups default to `Viewer`. To give a user a role, add them to the corresponding `KeycloakRealmGroup` in the `cozy` realm — either through the Keycloak UI or with a `KeycloakRealmUser` CR:
120+
Add a user to the appropriate tenant-scoped group in `cozy` — via the Keycloak UI or with a `KeycloakRealmUser` CR:
96121

97122
```yaml
98123
apiVersion: v1.edp.epam.com/v1
@@ -107,27 +132,27 @@ spec:
107132
emailVerified: true
108133
password: "…"
109134
groups:
110-
- tenant-acme-monitoring-admin
135+
- tenant-acme-admin
111136
```
112137

113-
Removing a user from the group demotes them on the next login; deleting them from `cozy` revokes access outright.
114-
115138
## Sign in
116139

117-
Open `https://grafana.<host>` and use the "Sign in with Keycloak" button under the login form. Grafana runs the Authorization Code + PKCE flow against `cozy`, receives a token whose `aud` matches this Monitoring instance's clientId, and creates or updates the local Grafana user on the first successful login with the role from `role_attribute_path`.
140+
Open `https://grafana.<host>` and press "Sign in with Keycloak" under the login form. Grafana runs the OAuth Authorization Code flow against `cozy`, receives a token whose `aud` matches this Monitoring instance's clientId, checks the `groups` claim against `allowed_groups`, then looks up the pre-provisioned Grafana account by email and grants the users-Job-assigned role.
118141

119142
The `admin_user` / `admin_password` field on the form stays wired to `grafana-admin-password` and continues to work.
120143

121144
## Prerequisites and gotchas
122145

123146
- **`emailVerified: true` on Keycloak users.** Phase 1 does not add a `claimValidationRules` entry — so `email_verified` is not chart-enforced. Set `emailVerified: true` on the `KeycloakRealmUser` (or complete the email-verify flow through the Keycloak UI) so the identity holding a given email is guaranteed authentic. The `cozy` realm's default `duplicateEmails: false` prevents a second account from claiming an already-registered address. CEL `claimValidationRules` to make this a hard gate is a follow-up hardening path.
147+
- **`groups_attribute_path` is not optional on Grafana v11.x+.** The chart wires it automatically for `System` mode; in `CustomConfig` inline the operator must add it explicitly (`groups_attribute_path: groups`) if their IdP emits a top-level `groups` array. Otherwise `allowed_groups` becomes a silent no-op and every login fails.
124148
- **BYO issuer with a self-signed CA.** In `CustomConfig` mode the `secretRef` path is the way to ship a CA bundle alongside the `[auth.generic_oauth]` block — you package `auth.ini` and any `ca-cert` files into the Secret and mount both under `/etc/grafana/oidc`.
125149
- **`admin_user` stays a break-glass path.** Even under `mode: System` the login form and the `grafana-admin-password` Secret remain wired. Locking the form off is a follow-up hardening.
126-
- **Mode toggle wipes `KeycloakRealmGroup` membership.** The three `<clientId>-{admin,editor,viewer}` groups are chart-owned. Flipping `spec.oidc.mode` from `System` to `CustomConfig` or `None` deletes them on the next `helm upgrade` — and every user's membership goes with them. Flipping back recreates the groups empty; the platform operator has to re-populate them by hand. Treat mode toggle like an admin-Secret rotation.
150+
- **Mode toggle drops the users-Job's local accounts.** Flipping `spec.oidc.mode` from `System` to `None` prunes every user the users-Job provisioned (the accounts are ephemeral shadows of `spec.oidc.users[]`). Any dashboards those users starred / owned move to their original creators; the local passwords / API keys go away. Flipping back re-provisions them empty. Treat mode toggle like an admin-Secret rotation.
127151

128152
## What's out of scope for this feature
129153

130154
- **Per-tenant Keycloak realms.** Managed multi-tenant identity is a separate proposal, evaluated against Keycloak Organizations. Track it in the [community proposal](https://github.com/cozystack/community/pull/24).
131155
- **Federating an external IdP into the platform `cozy` realm.** BYO-for-Cozystack-itself is a distinct problem — this feature is BYO-for-a-managed-service.
132156
- **Full-logout through Keycloak's end-session endpoint.** Native `auth.generic_oauth` covers the OAuth part; `backend-logout-url` wiring is a follow-up.
133157
- **CEL `claimValidationRules` for `email_verified`.** Explicit-gate hardening; not required for Phase 1 given the layered guarantees above.
158+
- **Role granularity beyond Admin/Editor/Viewer.** Grafana org roles are the assignment surface; team memberships / dashboard-level permissions stay out-of-band.

0 commit comments

Comments
 (0)