[release-12.2.2] Docs: Admin tweaks - Edits, weights (#113089)

Co-authored-by: Anna Urbiztondo <anna.urbiztondo@grafana.com>
This commit is contained in:
grafana-delivery-bot[bot]
2025-10-28 13:24:16 +01:00
committed by GitHub
co-authored by Anna Urbiztondo
parent d76881cc92
commit 0f6741ff29
18 changed files with 45 additions and 36 deletions
@@ -9,6 +9,7 @@ labels:
menuTitle: Announcement banner menuTitle: Announcement banner
title: Create and configure announcement banner title: Create and configure announcement banner
description: How to create an announcement banner to show important updates and information at the top of every Grafana page. description: How to create an announcement banner to show important updates and information at the top of every Grafana page.
weight: 5500
--- ---
# Create an announcement banner # Create an announcement banner
@@ -8,7 +8,7 @@ labels:
- enterprise - enterprise
- oss - oss
title: Back up Grafana title: Back up Grafana
weight: 80 weight: 100
menuTitle: Back up Grafana menuTitle: Back up Grafana
--- ---
+20 -17
View File
@@ -1,45 +1,43 @@
--- ---
aliases: aliases:
- ../cli/ # /docs/grafana/latest/cli/ - ../cli/ # /docs/grafana/latest/cli/
description: Guide to using grafana server cli description: Guide to using the Grafana server CLI
keywords: keywords:
- grafana - grafana
- cli - cli
- grafana cli - grafana cli
- command line interface - command line interface
- admin
labels: labels:
products: products:
- enterprise - enterprise
- oss - oss
title: Grafana server CLI title: Grafana server CLI
weight: 1100 menuTitle: Admin with Grafana server CLI
weight: 4000
--- ---
# Grafana server CLI # Administer Grafana with the Grafana server CLI
Grafana server CLI is a small executable that's bundled with Grafana server. You can administer your Grafana instance with the Grafana server CLI, a small executable bundled with Grafana server.
You can run it on the same machine Grafana server is running on.
Grafana server CLI has `plugins` and `admin` commands, as well as global options.
To list all commands and options: The Grafana server CLI has `plugins` and `admin` commands, as well as global options. To list them, run:
``` ```
grafana cli -h grafana cli -h
``` ```
## Run Grafana server CLI For more details read on.
To run Grafana server CLI, add the path to the Grafana binaries in your `PATH` environment variable. ## Run the Grafana server CLI
Alternately, if your current directory is the `bin` directory, run `./grafana cli`.
Otherwise, you can specify full path to the binary.
For example, on Linux `/usr/share/grafana/bin/grafana` and on Windows `C:\Program Files\GrafanaLabs\grafana\bin\grafana.exe`, and run it with `grafana cli`.
{{< admonition type="note" >}} You can run the Grafana server CLI on the same machine Grafana server is running on.
Some commands, such as installing or removing plugins, require `sudo` on Linux.
If you're on Windows, run Windows PowerShell as Administrator.
{{< /admonition >}}
## Grafana CLI command syntax To run the CLI you have the following options:
- Add the path to the Grafana binaries in your `PATH` environment variable.
- If your current directory is the `bin` directory, run `./grafana cli`.
- Otherwise, you can specify full path to the binary. For example, `/usr/share/grafana/bin/grafana` on Linux and `C:\Program Files\GrafanaLabs\grafana\bin\grafana.exe` on Windows.
The general syntax for commands in Grafana server CLI is: The general syntax for commands in Grafana server CLI is:
@@ -47,6 +45,11 @@ The general syntax for commands in Grafana server CLI is:
grafana cli [global options] command [command options] [arguments...] grafana cli [global options] command [command options] [arguments...]
``` ```
{{< admonition type="note" >}}
Some commands, such as installing or removing plugins, require `sudo` on Linux.
If you're on Windows, run Windows PowerShell as Administrator.
{{< /admonition >}}
## Global options ## Global options
Grafana server CLI allows you to temporarily override certain Grafana default settings. Except for `--help` and `--version`, most global options are only used by developers. Grafana server CLI allows you to temporarily override certain Grafana default settings. Except for `--help` and `--version`, most global options are only used by developers.
@@ -7,7 +7,7 @@ labels:
- enterprise - enterprise
- oss - oss
title: Correlations title: Correlations
weight: 900 weight: 6000
--- ---
# Correlations # Correlations
@@ -12,7 +12,7 @@ labels:
- enterprise - enterprise
- cloud - cloud
title: Data source management title: Data source management
weight: 100 weight: 500
--- ---
# Data source management # Data source management
@@ -18,7 +18,7 @@ labels:
- enterprise - enterprise
- oss - oss
title: Grafana Enterprise license title: Grafana Enterprise license
weight: 500 weight: 5500
--- ---
# Grafana Enterprise license # Grafana Enterprise license
@@ -1,7 +1,7 @@
--- ---
title: Grafana Advisor title: Grafana Advisor
description: Learn more about Grafana Advisor, the app to monitor the health of your Grafana instance description: Learn more about Grafana Advisor, the app to monitor the health of your Grafana instance
weight: 300 weight: 700
labels: labels:
products: products:
- oss - oss
@@ -9,6 +9,7 @@ keywords:
- Grafana OSS - Grafana OSS
menuTitle: Migrate from Grafana OSS/Enterprise to Grafana Cloud menuTitle: Migrate from Grafana OSS/Enterprise to Grafana Cloud
title: Migrate from Grafana OSS/Enterprise to Grafana Cloud title: Migrate from Grafana OSS/Enterprise to Grafana Cloud
weight: 7000
--- ---
# Migrate from Grafana OSS/Enterprise to Grafana Cloud # Migrate from Grafana OSS/Enterprise to Grafana Cloud
@@ -14,7 +14,7 @@ labels:
- oss - oss
menuTitle: Manage organizations menuTitle: Manage organizations
title: Manage organizations title: Manage organizations
weight: 200 weight: 3500
--- ---
# Manage organizations # Manage organizations
@@ -11,7 +11,7 @@ labels:
- enterprise - enterprise
- oss - oss
title: Organization preferences title: Organization preferences
weight: 500 weight: 3600
--- ---
# Organization preferences # Organization preferences
@@ -11,7 +11,8 @@ labels:
- enterprise - enterprise
- oss - oss
title: Provision Grafana title: Provision Grafana
weight: 600 menuTitle: Provision Grafana
weight: 4100
--- ---
# Provision Grafana # Provision Grafana
@@ -11,11 +11,12 @@ labels:
products: products:
- cloud - cloud
- enterprise - enterprise
title: Recorded queries title: Recorded queries (deprecated)
weight: 300 menuTitle: Recorded queries (deprecated)
weight: 9000
--- ---
# DEPRECATED Recorded queries # Recorded queries (deprecated)
{{< admonition type="warning" >}} {{< admonition type="warning" >}}
Recorded queries are deprecated. Please use the new [Grafana-managed recording rules](/docs/grafana/latest/alerting/alerting-rules/create-recording-rules/create-grafana-managed-recording-rules) instead. Recorded queries are deprecated. Please use the new [Grafana-managed recording rules](/docs/grafana/latest/alerting/alerting-rules/create-recording-rules/create-grafana-managed-recording-rules) instead.
@@ -12,7 +12,7 @@ labels:
- oss - oss
- cloud - cloud
title: Roles and permissions title: Roles and permissions
weight: 300 weight: 3100
--- ---
# Roles and permissions # Roles and permissions
@@ -15,6 +15,7 @@ labels:
- oss - oss
menutitle: Search menutitle: Search
title: Search title: Search
weight: 8000
--- ---
# Grafana search # Grafana search
@@ -15,7 +15,7 @@ labels:
- cloud - cloud
menuTitle: Service accounts menuTitle: Service accounts
title: Service accounts title: Service accounts
weight: 800 weight: 4200
refs: refs:
service-accounts: service-accounts:
- pattern: /docs/grafana/ - pattern: /docs/grafana/
@@ -16,7 +16,8 @@ labels:
- cloud - cloud
- enterprise - enterprise
title: View server statistics and license title: View server statistics and license
weight: 400 menutitle: Server stats and license
weight: 5000
--- ---
# View server statistics and license # View server statistics and license
@@ -15,11 +15,11 @@ keywords:
- microservices - microservices
- architecture - architecture
menuTitle: Grafana Teams menuTitle: Grafana Teams
title: Grafana Teams title: Manage teams with Grafana Teams
weight: 100 weight: 2000
--- ---
# Grafana Teams # Manage teams with Grafana Teams
Grafana Teams makes it easy to organize and administer groups of users in your enterprise. Teams allows you to grant permissions to a group of users instead of granting permissions to individual users one at a time. Grafana Teams makes it easy to organize and administer groups of users in your enterprise. Teams allows you to grant permissions to a group of users instead of granting permissions to individual users one at a time.
@@ -5,8 +5,8 @@ labels:
products: products:
- enterprise - enterprise
- oss - oss
title: User management title: Manage users
weight: 200 weight: 3000
--- ---
# User management # User management