Feature Management: add documentation (#78108)

* Feature Management: add documentation

* lint docs

* Update docs/sources/administration/feature-management/index.md

Co-authored-by: Jack Baldry <jack.baldry@grafana.com>

* Update docs/sources/administration/feature-management/index.md

Co-authored-by: Jack Baldry <jack.baldry@grafana.com>

* Update docs/sources/administration/feature-management/index.md

Co-authored-by: Jack Baldry <jack.baldry@grafana.com>

* Update docs/sources/administration/feature-management/index.md

Co-authored-by: Jack Baldry <jack.baldry@grafana.com>

* Update docs/sources/administration/feature-management/index.md

Co-authored-by: Jack Baldry <jack.baldry@grafana.com>

* Update docs/sources/administration/feature-management/index.md

Co-authored-by: Jack Baldry <jack.baldry@grafana.com>

* Update docs/sources/administration/feature-management/index.md

Co-authored-by: Jack Baldry <jack.baldry@grafana.com>

* Update docs/sources/administration/feature-management/index.md

Co-authored-by: Jack Baldry <jack.baldry@grafana.com>

* Update docs/sources/setup-grafana/configure-grafana/feature-toggles/index.md

Co-authored-by: Jack Baldry <jack.baldry@grafana.com>

* Update docs/sources/setup-grafana/configure-grafana/feature-toggles/index.md

Co-authored-by: Jack Baldry <jack.baldry@grafana.com>

* Update docs/sources/setup-grafana/configure-grafana/feature-toggles/index.md

Co-authored-by: Jack Baldry <jack.baldry@grafana.com>

* Update docs/sources/administration/feature-management/index.md

Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com>

* Update docs/sources/administration/feature-management/index.md

Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com>

* update docs

* lint

* revise docs

---------

Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com>
Co-authored-by: Michael Mandrus <michael.mandrus@grafana.com>
pull/79699/head
João Calisto 2 years ago committed by GitHub
parent 82af0d6230
commit 65c3bb78a6
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
  1. 55
      docs/sources/administration/feature-toggles/index.md
  2. 1
      docs/sources/administration/roles-and-permissions/access-control/_index.md
  3. 28
      docs/sources/setup-grafana/configure-grafana/feature-toggles/index.md

@ -0,0 +1,55 @@
---
description: Describes how authorized users can manage feature toggles
keywords:
- feature
- toggle
labels:
products:
- enterprise
- oss
title: Feature toggles
weight: 900
---
# Feature toggles
Grafana incorporates feature toggles, enabling the introduction of new functionality safeguarded by control flags. This allows Grafana administrators the flexibility to determine the appropriate timing for enabling or disabling specific features.
For detailed information about particular features and how they operate, refer to [Configure Feature Toggles](https://grafana.com/docs/grafana/<GRAFANA_VERSION>/setup-grafana/configure-grafana/feature-toggles/).
## Manage feature toggles
In the **Administration** page, the **Feature Management** section enables authorized users to view and edit the various features that are active in their Grafana environment.
Authorized users include administrators, and users with the [fixed roles]({{< relref "../roles-and-permissions/access-control#fixed-roles" >}}) `featuremgmt.read` and `featuremgmt.write`.
There are different options for visibility and customization depending on the development stage of the feature.
| Stage | Visibility | Editable |
| -------------------- | ---------- | -------- |
| Experimental | Hidden | No |
| Private preview | Hidden | No |
| Public preview | Visible\* | No |
| General availability | Visible\* | Yes\* |
| Deprecated | Visible\* | Yes\* |
{{< admonition type="note" >}}
Options marked with an asterisk (\*) are defaults for the corresponding feature stage.
Each feature toggle owner can override its default behavior.
{{< /admonition >}}
## Edit feature toggles
You can only edit feature toggles if Grafana is configured with the proper feature management settings.
For more information, refer to [Configure feature management](https://grafana.com/docs/grafana/<GRAFANA_VERSION>/setup-grafana/configure-grafana/feature-toggles/#configure-feature-management).
Altering the state of a toggle may require restarting your Grafana instance, which can take a few minutes.
To edit a feature toggle, follow these steps:
1. Sign in to Grafana as a server administrator or authorized user.
1. Click **Administration** in the left-side menu, **General**, and then **Feature toggles**.
1. Navigate to the list of feature toggles and select your feature state overrides.
1. Click **Save changes** and wait for your Grafana instance to restart with the updated feature toggles.
{{% admonition type="note" %}}
Editing feature toggles with the feature toggle management page is available now in all tiers of [Grafana Cloud](/docs/grafana-cloud/)!
{{% /admonition %}}

@ -90,6 +90,7 @@ Assign fixed roles when the basic roles do not meet your permission requirements
- [Dashboards and folders]({{< relref "../../../dashboards/" >}})
- [Data sources]({{< relref "../../../datasources/" >}})
- [Explore]({{< relref "../../../explore/" >}})
- [Feature Toggles]({{< relref "../../feature-toggles/" >}})
- [Folders]({{< relref "../../../dashboards/manage-dashboards/#create-a-dashboard-folder" >}})
- [LDAP]({{< relref "../../../setup-grafana/configure-security/configure-authentication/ldap/" >}})
- [Licenses]({{< relref "../../stats-and-license/" >}})

@ -179,3 +179,31 @@ The following toggles require explicitly setting Grafana's [app mode]({{< relref
| `externalServiceAccounts` | Automatic service account and token setup for plugins |
| `panelTitleSearchInV1` | Enable searching for dashboards using panel title in search v1 |
| `ssoSettingsApi` | Enables the SSO settings API |
## Configure feature management
**Feature toggles** is an Administration page that allows authorized users to view and toggle the feature flags available in their Grafana instance. For more information, refer to [Feature toggles](https://grafana.com/docs/grafana/<GRAFANA_VERSION>/administration/feature-toggles/).
By default, feature toggles are in read-only mode.
Granting admin users the ability to alter the states of feature toggles requires configuring Grafana with the optional [`allow_editing`](https://grafana.com/docs/grafana/<GRAFANA_VERSION>/setup-grafana/configure-grafana/#allow_editing), [`update_webhook`](https://grafana.com/docs/grafana/<GRAFANA_VERSION>/setup-grafana/configure-grafana/#update_webhook) and [`update_webhook_token`](https://grafana.com/docs/grafana/<GRAFANA_VERSION>/setup-grafana/configure-grafana/#update_webhook_token) settings.
Those configurations allow the Grafana operator to set up a webhook that Grafana must call to propagate the configuration change.
**Example request**:
```http
POST $update_webhook
Accept: application/json
Content-Type: application/json
Authorization: Bearer $update_webhook_token
{
"feature_toggles": [
{
"featureToggle1": "true",
"featureToggle2": "false",
}
],
"user": "admin@example.test",
}
```

Loading…
Cancel
Save