You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: docs/user-guides/observability-ui-plugins.md
+5-7
Original file line number
Diff line number
Diff line change
@@ -136,20 +136,21 @@ spec:
136
136
137
137
### Monitoring
138
138
139
-
The plugin adds monitoring related UI features to the OpenShift web console, related to the Advance Cluster Management (ACM) perspective and [Perses](https://github.com/perses/perses). A number of new pages and features are enabled through this plugin. Including, but not limited to:
139
+
The plugin adds monitoring related UI features to the OpenShift web console, related to the Advance Cluster Management (ACM) perspective, incidents (cluster health analysis), and [Perses](https://github.com/perses/perses). A number of new pages and features are enabled through this plugin. Including, but not limited to:
140
140
- `ACM > Observe > Alerting`
141
141
- `ACM > Observe > Alerting > Silences`
142
142
- `ACM > Observe > Alerting > Alert rules`
143
143
- `OCP > Observe > Perses Dashboards`
144
+
- `OCP > Observe > Incidents`
144
145
145
146
To deploy ACM related features the `acm-alerting` configuration must be enabled. In the UIPlugin Custom Resource (CR) you must pass the Alertmanager and ThanosQuerier Service endpoint (e.g. `https://alertmanager.open-cluster-management-observability.svc:9095` and `https://rbac-query-proxy.open-cluster-management-observability.svc:8443`). See the example in the next section `Plugin Creation.`
146
147
147
148
To deploy the Perses dashboard feature, the `perses-dashboards` configuration must be enabled. In the UIPlugin CR, you can optionally pass the service name and namespace of your Perses instance (e.g., `serviceName: perses-api-http` and `namespace: perses`). If these fields are left blank and `spec.monitoring.perses.enabled: true`, then default values will be assigned. These default values are `serviceName: perses-api-http` and `namespace: perses`. See the example in the next section, `Plugin Creation.`
149
+
150
+
To deploy the Incidents festure, the `incidents` configuration must be enabled. See the example in the next section, `Plugin Creation.`
148
151
149
152
Other pages which are typically distributed with the monitoring-plugin, such as `Admin > Observe > Dashboards`, are only available in the monitoring-plugin when deployed through [CMO](https://github.com/openshift/cluster-monitoring-operator).
150
153
151
-
[Note about Incidents](#notes-about-incidents)
152
-
153
154
#### Plugin Creation
154
155
155
156
To enable to monitoring console plugin, create a `UIPlugin` CR. The following example shows how to create a CR to enable the monitoring console plugin:
| `acm-alerting` | Adds alerting UI to multi-cluster view. Configures proxies to connect with any alertmanager and thanos-querier. |
184
-
| `incidents` | Adds incidents UI to `Observe` section of OpenShift Console Platform. Deploys the health analyzer and configures proxies in the plugin to connect with it. |
183
+
| `incidents` | Adds incidents UI to `Observe` section of OpenShift Console Platform. Deploys the [Cluster Health Analyzer](https://github.com/openshift/cluster-health-analyzer) and configures proxies in the plugin to connect with it. |
185
184
| `perses-dashboards` | Adds perses UI to `Observe` section of OpenShift Console Platform. Configures proxies to connect with a Perses instance. |
186
-
| `incidents` | [Note about Incidents](#notes-about-incidents) |
0 commit comments