Skip to content

Commit 8dfb087

Browse files
authored
Docs: removing docs debt in install docs (#101750)
* Docs: removing docs debt in install docs * cleaning up set up docs debt * fixing some vale errors * fixing broken admonition shortcode * fixing broken shortcode * fixing broken shortcode * working to the grafana authentication config * updating some more files * editing down to ldap in the repo * editing ldap doc except final section with link needed * Finishing doc debt cleanup through configure authetication * fixing shortcodes reverted by merge conflict fix * fixing admonition * fixing more broken shortcodes * adjusting some wordings ot make vale happy * updating feature toggle info
1 parent af6c536 commit 8dfb087

File tree

24 files changed

+243
-236
lines changed

24 files changed

+243
-236
lines changed

docs/sources/getting-started/build-first-dashboard.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,9 @@ weight: 200
1616

1717
This topic helps you get started with Grafana and build your first dashboard using the built-in `Grafana` data source. To learn more about Grafana, refer to [Introduction to Grafana](https://grafana.com/docs/grafana/<GRAFANA_VERSION>/introduction/).
1818

19-
{{% admonition type="note" %}}
19+
{{< admonition type="note" >}}
2020
Grafana also offers a [free account with Grafana Cloud](/signup/cloud/connect-account?pg=gsdocs) to help getting started even easier and faster. You can install Grafana to self-host or get a free Grafana Cloud account.
21-
{{% /admonition %}}
21+
{{< /admonition >}}
2222

2323
#### Install Grafana
2424

docs/sources/getting-started/get-started-grafana-prometheus.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -49,9 +49,9 @@ Prometheus Node exporter is a widely used tool that exposes system metrics. For
4949

5050
When you run Node exporter locally, navigate to `http://localhost:9100/metrics` to check that it is exporting metrics.
5151

52-
{{% admonition type="note" %}}
52+
{{< admonition type="note" >}}
5353
The instructions in the referenced topic are intended for Linux users. You may have to alter the instructions slightly depending on your operating system. For example, if you are on Windows, use the [windows_exporter](https://github.com/prometheus-community/windows_exporter) instead.
54-
{{% /admonition %}}
54+
{{< /admonition >}}
5555

5656
## Install and configure Prometheus
5757

@@ -115,9 +115,9 @@ remote_write:
115115
password: <Your Grafana.com API Key>
116116
```
117117

118-
{{% admonition type="note" %}}
118+
{{< admonition type="note" >}}
119119
To configure your Prometheus instance to work with Grafana locally instead of Grafana Cloud, install Grafana [here](/grafana/download) and follow the configuration steps listed [here](/docs/grafana/latest/datasources/prometheus/#configure-the-data-source).
120-
{{% /admonition %}}
120+
{{< /admonition >}}
121121

122122
## Troubleshooting
123123

docs/sources/setup-grafana/configure-security/_index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,9 +25,9 @@ You can configure Grafana to only allow certain IP addresses or hostnames to be
2525

2626
The request security configuration option allows users to limit requests from the Grafana server. It targets requests that are generated by users. For more information, refer to [Request security](configure-request-security/).
2727

28-
{{% admonition type="note" %}}
28+
{{< admonition type="note" >}}
2929
Request security is available in Grafana Enterprise v7.4 and later versions.
30-
{{% /admonition %}}
30+
{{< /admonition >}}
3131

3232
## Firewall rules
3333

docs/sources/setup-grafana/configure-security/configure-authentication/_index.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -160,9 +160,9 @@ oauth_allow_insecure_email_lookup = true
160160

161161
You can also enable email lookup using the API:
162162

163-
{{% admonition type="note" %}}
163+
{{< admonition type="note" >}}
164164
Available in [Grafana Enterprise](../../../introduction/grafana-enterprise/) and [Grafana Cloud](../../../introduction/grafana-cloud/) since Grafana v10.4.
165-
{{% /admonition %}}
165+
{{< /admonition >}}
166166

167167
```
168168
curl --request PUT \
@@ -226,9 +226,9 @@ a Grafana admin user, you can also do the same for any user from the Server Admi
226226

227227
### Protected roles
228228

229-
{{% admonition type="note" %}}
229+
{{< admonition type="note" >}}
230230
Available in [Grafana Enterprise](../../../introduction/grafana-enterprise/) and [Grafana Cloud](../../../introduction/grafana-cloud/).
231-
{{% /admonition %}}
231+
{{< /admonition >}}
232232

233233
By default, after you configure an authorization provider, Grafana will adopt existing users into the new authentication scheme. For example, if you have created a user with basic authentication having the login `[email protected]`, then set up SAML authentication where `[email protected]` is an account, the user's authentication type will be changed to SAML if they perform a SAML sign-in.
234234

docs/sources/setup-grafana/configure-security/configure-authentication/auth-proxy/index.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -150,7 +150,7 @@ header_property = username
150150
auto_sign_up = true
151151
```
152152

153-
Launch the Grafana container, using our custom grafana.ini to replace `/etc/grafana/grafana.ini`. We don't expose
153+
Launch the Grafana container, using our custom `grafana.ini` to replace `/etc/grafana/grafana.ini`. We don't expose
154154
any ports for this container as it will only be connected to by our Apache container.
155155

156156
```bash
@@ -161,7 +161,7 @@ docker run -i -v $(pwd)/grafana.ini:/etc/grafana/grafana.ini --name grafana graf
161161

162162
For this example we use the official Apache docker image available at [Docker Hub](https://hub.docker.com/_/httpd/)
163163

164-
- Create a file `httpd.conf` with the following contents
164+
- Create a file named `httpd.conf` with the following contents
165165

166166
```bash
167167
ServerRoot "/usr/local/apache2"
@@ -216,25 +216,25 @@ ProxyPass / http://grafana:3000/
216216
ProxyPassReverse / http://grafana:3000/
217217
```
218218

219-
- Create a htpasswd file. We create a new user **anthony** with the password **password**
219+
- Create a `htpasswd` file. We create a new user **anthony** with the password **password**
220220

221221
```bash
222222
htpasswd -bc htpasswd anthony password
223223
```
224224

225-
- Launch the httpd container using our custom httpd.conf and our htpasswd file. The container will listen on port 80, and we create a link to the **grafana** container so that this container can resolve the hostname **grafana** to the Grafana container’s IP address.
225+
- Launch the Apache HTTP server container using our custom `httpd.conf` and our `htpasswd` file. The container will listen on port 80, and we create a link to the **grafana** container so that this container can resolve the hostname **grafana** to the Grafana container’s IP address.
226226

227227
```bash
228228
docker run -i -p 80:80 --link grafana:grafana -v $(pwd)/httpd.conf:/usr/local/apache2/conf/httpd.conf -v $(pwd)/htpasswd:/tmp/htpasswd httpd:2.4
229229
```
230230

231231
### Use grafana.
232232

233-
With our Grafana and Apache containers running, you can now connect to http://localhost/ and log in using the username/password we created in the htpasswd file.
233+
With our Grafana and Apache containers running, you can now connect to http://localhost/ and log in using the username and password we created in the `htpasswd` file.
234234

235-
{{% admonition type="note" %}}
235+
{{< admonition type="note" >}}
236236
If the user is deleted from Grafana, the user will be not be able to login and resync until after the `sync_ttl` has expired.
237-
{{% /admonition %}}
237+
{{< /admonition >}}
238238

239239
### Team Sync (Enterprise only)
240240

@@ -309,9 +309,9 @@ curl -H "X-WEBAUTH-USER: leonard" -H "X-WEBAUTH-GROUPS: lokiteamOnExternalSystem
309309
310310
With this, the user `leonard` will be automatically placed into the Loki team as part of Grafana authentication.
311311
312-
{{% admonition type="note" %}}
312+
{{< admonition type="note" >}}
313313
An empty `X-WEBAUTH-GROUPS` or the absence of a groups header will remove the user from all teams.
314-
{{% /admonition %}}
314+
{{< /admonition >}}
315315
316316
[Learn more about Team Sync](../../configure-team-sync/)
317317
@@ -321,5 +321,5 @@ With `enable_login_token` set to `true` Grafana will, after successful auth prox
321321
a login token and cookie. You only have to configure your auth proxy to provide headers for the /login route.
322322
Requests via other routes will be authenticated using the cookie.
323323
324-
Use settings `login_maximum_inactive_lifetime_duration` and `login_maximum_lifetime_duration` under `[auth]` to control session
324+
Use the settings `login_maximum_inactive_lifetime_duration` and `login_maximum_lifetime_duration` under `[auth]` to control session
325325
lifetime.

docs/sources/setup-grafana/configure-security/configure-authentication/azuread/index.md

Lines changed: 27 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,9 @@ weight: 800
2121

2222
The Azure AD authentication allows you to use a Microsoft Entra ID (formerly known as Azure Active Directory) tenant as an identity provider for Grafana. You can use Entra ID application roles to assign users and groups to Grafana roles from the Azure Portal.
2323

24-
{{% admonition type="note" %}}
24+
{{< admonition type="note" >}}
2525
If Users use the same email address in Microsoft Entra ID that they use with other authentication providers (such as Grafana.com), you need to do additional configuration to ensure that the users are matched correctly. Please refer to [Using the same email address to login with different identity providers](../#using-the-same-email-address-to-login-with-different-identity-providers) for more information.
26-
{{% /admonition %}}
26+
{{< /admonition >}}
2727

2828
## Create the Microsoft Entra ID application
2929

@@ -37,7 +37,7 @@ To enable the Azure AD/Entra ID OAuth, register your application with Entra ID.
3737

3838
1. Under **Redirect URI**, select the app type **Web**.
3939

40-
1. Add the following redirect URLs `https://<grafana domain>/login/azuread` and `https://<grafana domain>` then click **Register**. The app's **Overview** page opens.
40+
1. Add the redirect URLs `https://<grafana domain>/login/azuread` and `https://<grafana domain>`, then click **Register**. The app's **Overview** page opens.
4141

4242
1. Note the **Application ID**. This is the OAuth client ID.
4343

@@ -94,9 +94,9 @@ To enable the Azure AD/Entra ID OAuth, register your application with Entra ID.
9494
1. Click **Users and Groups**.
9595
1. Click **Add user/group** to add a user or group to the Grafana roles.
9696

97-
{{% admonition type="note" %}}
97+
{{< admonition type="note" >}}
9898
When assigning a group to a Grafana role, ensure that users are direct members of the group. Users in nested groups will not have access to Grafana due to limitations within Azure AD/Entra ID side. For more information, see [Microsoft Entra service limits and restrictions](https://learn.microsoft.com/en-us/entra/identity/users/directory-service-limits-restrictions).
99-
{{% /admonition %}}
99+
{{< /admonition >}}
100100

101101
### Configure application roles for Grafana in the Azure Portal
102102

@@ -128,9 +128,9 @@ If you prefer to configure the application roles for Grafana in the manifest fil
128128

129129
1. Add a Universally Unique Identifier to each role.
130130

131-
{{% admonition type="note" %}}
131+
{{< admonition type="note" >}}
132132
Every role requires a [Universally Unique Identifier](https://en.wikipedia.org/wiki/Universally_unique_identifier) which you can generate on Linux with `uuidgen`, and on Windows through Microsoft PowerShell with `New-Guid`.
133-
{{% /admonition %}}
133+
{{< /admonition >}}
134134

135135
1. Replace each "SOME_UNIQUE_ID" with the generated ID in the manifest file:
136136

@@ -205,25 +205,25 @@ Ensure that you have followed the steps in [Create the Microsoft Entra ID applic
205205

206206
## Configure Azure AD authentication client using the Grafana UI
207207

208-
{{% admonition type="note" %}}
208+
{{< admonition type="note" >}}
209209
Available in Public Preview in Grafana 10.4 behind the `ssoSettingsApi` feature toggle.
210-
{{% /admonition %}}
210+
{{< /admonition >}}
211211

212212
As a Grafana Admin, you can configure your Azure AD/Entra ID OAuth client from within Grafana using the Grafana UI. To do this, navigate to the **Administration > Authentication > Azure AD** page and fill in the form. If you have a current configuration in the Grafana configuration file, the form will be pre-populated with those values. Otherwise the form will contain default values.
213213

214214
After you have filled in the form, click **Save** to save the configuration. If the save was successful, Grafana will apply the new configurations.
215215

216216
If you need to reset changes you made in the UI back to the default values, click **Reset**. After you have reset the changes, Grafana will apply the configuration from the Grafana configuration file (if there is any configuration) or the default values.
217217

218-
{{% admonition type="note" %}}
218+
{{< admonition type="note" >}}
219219
If you run Grafana in high availability mode, configuration changes may not get applied to all Grafana instances immediately. You may need to wait a few minutes for the configuration to propagate to all Grafana instances.
220-
{{% /admonition %}}
220+
{{< /admonition >}}
221221

222222
## Configure Azure AD authentication client using the Terraform provider
223223

224-
{{% admonition type="note" %}}
224+
{{< admonition type="note" >}}
225225
Available in Public Preview in Grafana 10.4 behind the `ssoSettingsApi` feature toggle. Supported in the Terraform provider since v2.12.0.
226-
{{% /admonition %}}
226+
{{< /admonition >}}
227227

228228
```terraform
229229
resource "grafana_sso_settings" "azuread_sso_settings" {
@@ -292,9 +292,9 @@ GF_AUTH_AZUREAD_MANAGED_IDENTITY_CLIENT_ID
292292
GF_AUTH_AZUREAD_FEDERATED_CREDENTIAL_AUDIENCE
293293
```
294294

295-
{{% admonition type="note" %}}
295+
{{< admonition type="note" >}}
296296
Verify that the Grafana [root_url](../../../configure-grafana/#root_url) is set in your Azure Application Redirect URLs.
297-
{{% /admonition %}}
297+
{{< /admonition >}}
298298

299299
### Configure refresh token
300300

@@ -304,12 +304,14 @@ Grafana uses a refresh token to obtain a new access token without requiring the
304304

305305
Refresh token fetching and access token expiration check is enabled by default for the AzureAD provider since Grafana v10.1.0. If you would like to disable access token expiration check then set the `use_refresh_token` configuration value to `false`.
306306

307-
> **Note:** The `accessTokenExpirationCheck` feature toggle has been removed in Grafana v10.3.0 and the `use_refresh_token` configuration value will be used instead for configuring refresh token fetching and access token expiration check.
307+
{{< admonition type="note" >}}
308+
The `accessTokenExpirationCheck` feature toggle has been removed in Grafana v10.3.0 and the `use_refresh_token` configuration value will be used instead for configuring refresh token fetching and access token expiration check.
309+
{{< /admonition >}}
308310

309311
### Configure allowed tenants
310312

311313
To limit access to authenticated users who are members of one or more tenants, set `allowed_organizations`
312-
to a comma- or space-separated list of tenant IDs. You can find tenant IDs on the Azure portal under **Microsoft Entra ID -> Overview**.
314+
to a _comma-_ or _space-separated_ list of tenant IDs. You can find tenant IDs on the Azure portal under **Microsoft Entra ID -> Overview**.
313315

314316
Make sure to include the tenant IDs of all the federated Users' root directory if your Entra ID contains external identities.
315317

@@ -324,7 +326,7 @@ allowed_organizations = 8bab1c86-8fba-33e5-2089-1d1c80ec267d
324326
Microsoft Entra ID groups can be used to limit user access to Grafana. For more information about managing groups in Entra ID, refer to [Manage Microsoft Entra groups and group membership](https://learn.microsoft.com/en-us/entra/fundamentals/how-to-manage-groups).
325327

326328
To limit access to authenticated users who are members of one or more Entra ID groups, set `allowed_groups`
327-
to a **comma-** or **space-separated** list of group object IDs.
329+
to a _comma-_ or _space-separated_ list of group object IDs.
328330

329331
1. To find object IDs for a specific group on the Azure portal, go to **Microsoft Entra ID > Manage > Groups**.
330332

@@ -348,9 +350,9 @@ To configure group membership claims from the Azure Portal UI, complete the foll
348350

349351
For more information, see [Configure groups optional claims](https://learn.microsoft.com/en-us/entra/identity-platform/optional-claims#configure-groups-optional-claims).
350352

351-
{{% admonition type="note" %}}
353+
{{< admonition type="note" >}}
352354
If the user is a member of more than 200 groups, Entra ID does not emit the groups claim in the token and instead emits a group overage claim. To set up a group overage claim, see [Users with over 200 Group assignments](#users-with-over-200-group-assignments).
353-
{{% /admonition %}}
355+
{{< /admonition >}}
354356

355357
#### Configure group membership claim in the manifest file
356358

@@ -424,9 +426,9 @@ The Entra ID `App registration` must include the following API permissions for g
424426

425427
Admin consent is required for the `GroupMember.Read.All` permission. To grant admin consent, navigate to **API permissions** in the **App registration** and select **Grant admin consent for [your-organization]**.
426428

427-
{{% admonition type="note" %}}
429+
{{< admonition type="note" >}}
428430
You can make Grafana always get group information from the Microsoft Graph API by turning on the [`force_use_graph_api`](./#force-fetching-groups-from-microsoft-graph-api) setting in the configuration.
429-
{{% /admonition %}}
431+
{{< /admonition >}}
430432

431433
#### Configure the required Graph API permissions
432434

@@ -441,9 +443,9 @@ You can make Grafana always get group information from the Microsoft Graph API b
441443
1. In the **Select permissions** pane, under the **User** section, select **User.Read**.
442444
1. Click the **Add permissions** button at the bottom of the page.
443445

444-
{{% admonition type="note" %}}
446+
{{< admonition type="note" >}}
445447
Admin consent may be required for this permission.
446-
{{% /admonition %}}
448+
{{< /admonition >}}
447449

448450
### Force fetching groups from Microsoft Graph API
449451

@@ -463,7 +465,7 @@ You can disable this default role assignment by setting `role_attribute_strict =
463465

464466
You can use the `org_mapping` configuration option to assign the user to multiple organizations and specify their role based on their Entra ID group membership. For more information, refer to [Org roles mapping example](#org-roles-mapping-example). If the org role mapping (`org_mapping`) is specified and Entra ID returns a valid role, then the user will get the highest of the two roles.
465467

466-
**On every login** the user organization role will be reset to match Entra ID's application role and
468+
_On every login_ the user organization role will be reset to match Entra ID's application role and
467469
their organization membership will be reset to the default organization.
468470

469471
#### Org roles mapping example

docs/sources/setup-grafana/configure-security/configure-authentication/enhanced-ldap/index.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,10 @@ weight: 400
2323

2424
The enhanced LDAP integration adds additional functionality on top of the [LDAP integration](../ldap/) available in the open source edition of Grafana.
2525

26-
> **Note:** Available in [Grafana Enterprise](../../../../introduction/grafana-enterprise/) and [Grafana Cloud](/docs/grafana-cloud).
27-
> If you are a Grafana Cloud customer, please [open a support ticket in the Cloud Portal](/profile/org#support) to request this feature.
26+
{{< admonition type="note" >}}
27+
Available in [Grafana Enterprise](../../../../introduction/grafana-enterprise/) and [Grafana Cloud](/docs/grafana-cloud).
28+
If you are a Grafana Cloud customer, please [open a support ticket in the Cloud Portal](/profile/org#support) to request this feature.
29+
{{< /admonition >}}
2830

2931
> To control user access with role-based permissions, refer to [role-based access control](../../../../administration/roles-and-permissions/access-control/).
3032
@@ -51,7 +53,7 @@ With active LDAP synchronization, you can configure Grafana to actively sync use
5153

5254
Users with updated role and team membership will need to refresh the page to get access to the new features.
5355

54-
Removed users are automatically logged out and their account disabled. These accounts are displayed in the Server Admin > Users page with a `disabled` label. Disabled users keep their custom permissions on dashboards, folders, and data sources, so if you add them back in your LDAP database, they have access to the application with the same custom permissions as before.
56+
Removed users are automatically logged out and their account disabled. These accounts are displayed in the **Server Admin > Users** page with a `disabled` label. Disabled users keep their custom permissions on dashboards, folders, and data sources, so if you add them back in your LDAP database, they have access to the application with the same custom permissions as before.
5557

5658
```bash
5759
[auth.ldap]
@@ -74,7 +76,7 @@ active_sync_enabled = true # enabled by default
7476

7577
Single bind configuration (as in the [Single bind example](../ldap/#single-bind-example)) is not supported with active LDAP synchronization because Grafana needs user information to perform LDAP searches.
7678

77-
For the synchronization to work, the `servers.search_filter` and `servers.attributes.username` in the ldap.toml config file must match. By default, the `servers.attributes.username` is `cn`, so if you use another attribute as the search filter, you must also update the username attribute.
79+
For the synchronization to work, the `servers.search_filter` and `servers.attributes.username` in the `ldap.toml` configuration file must match. By default, the `servers.attributes.username` is `cn`, so if you use another attribute as the search filter, you must also update the username attribute.
7880

7981
For example:
8082

0 commit comments

Comments
 (0)