Skip to content

Commit 33e99fc

Browse files
authored
OU-1055: Improve docs for Perses Dashboard (#999)
* docs: improve docs for perses dashboards * docs: improve docs for perses dashboards * docs: improve docs for perses dashboards
1 parent d79ea06 commit 33e99fc

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

docs/user-guides/perses-dashboards.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,9 @@ kubectl wait --for=condition=Available --timeout=10s uiplugins monitoring
3939

4040
If you open the OpenShift console, you should see the new `Observe > Dashboards (Perses)` menu. Once `PersesDashboard`, `PersesDatasource`, and `PersesGlobalDatasource` resources are created and the appropriate RBAC permissions are granted, a namespace selector will be available to show dashboards by the namespace(s) where the user has been granted RBAC permissions.
4141

42-
Once the Monitoring UI Plugin is installed with Perses enabled, the Cluster Observability Operator deploys the [Perses Operator](https://github.com/perses/perses-operator), which is responsible for managing Perses dashboards and datasources. The COO also installs the `PersesDashboard`, `PersesDatasource` and `PersesGlobalDatasource` Custom Resources Definitions (CRDs). These CRDs are namespaced-scoped which allows to setup RBAC policies for them using the standard Kubernetes RBAC model.
42+
Once the Monitoring UI Plugin is installed with Perses enabled, the Cluster Observability Operator deploys the [Perses Operator](https://github.com/rhobs/perses-operator), which is responsible for managing Perses dashboards and datasources. The COO also installs the `PersesDashboard`, `PersesDatasource` and `PersesGlobalDatasource` Custom Resources Definitions (CRDs). These CRDs are namespaced-scoped which allows to setup RBAC policies for them using the standard Kubernetes RBAC model.
43+
44+
See the [perses-operator user guide](https://github.com/rhobs/perses-operator/blob/main/docs/user-guide.md) for more information on perses custom resource management and example configurations.
4345

4446
Please refer to the [Monitoring UI Plugin](https://github.com/rhobs/observability-operator/blob/main/docs/user-guides/observability-ui-plugins.md#plugin-creation-4) documentation for more details.
4547

@@ -208,6 +210,8 @@ More examples can be found in the [community dashboards repository](https://gith
208210
> [!IMPORTANT]
209211
> **Automatic Datasource Detection**: Notice that the above example does not set a specific datasource for the dashboard. This is because Perses will automatically detect the available datasources in the namespace and use the default one it finds. A specific datasource can be set by adding a `datasource` field in the panel query or by adding a datasource variable to the dashboard so users can select the datasource they want to use.
210212
213+
```
214+
211215
## RBAC permissions
212216
213217
The Perses operator creates the following `ClusterRole`s for datasources and dashboards:

0 commit comments

Comments
 (0)