mirror of
https://github.com/openshift/openshift-docs.git
synced 2026-02-05 12:46:18 +01:00
OBSDOCS-2571 Remove COO content
This commit is contained in:
Gabriel McGoldrick
committed by
openshift-cherrypick-robot
openshift-cherrypick-robot
parent
ee5011f66a
commit
40eb19e095
File diff suppressed because it is too large
Load Diff
@@ -1,637 +0,0 @@
|
||||
:_mod-docs-content-type: ASSEMBLY
|
||||
[id="api-observability-package"]
|
||||
= observability.openshift.io/v1alpha1
|
||||
include::_attributes/common-attributes.adoc[]
|
||||
:context: api-observability-package
|
||||
|
||||
toc::[]
|
||||
|
||||
The resource types are xref:#clusterobservability[`ClusterObservability`] and xref:#uiplugin[`UIPlugin`].
|
||||
|
||||
[[clusterobservability]]
|
||||
== ClusterObservability
|
||||
|
||||
ClusterObservability defines the desired state of the observability stack.
|
||||
|
||||
[cols="2,1,4,1"]
|
||||
|===
|
||||
|Name |Type |Description |Required
|
||||
|
||||
|`apiVersion`
|
||||
|string
|
||||
|`observability.openshift.io/v1alpha1`
|
||||
|true
|
||||
|
||||
|`kind`
|
||||
|string
|
||||
|`ClusterObservability`
|
||||
|true
|
||||
|
||||
|link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.32/#objectmeta-v1-meta[`metadata`]
|
||||
|object
|
||||
|Refer to the Kubernetes API documentation for the fields of the `metadata` field.
|
||||
|true
|
||||
|
||||
|xref:#clusterobservabilityspec[`spec`]
|
||||
|object
|
||||
|`Spec` defines the desired state of the cluster observability.
|
||||
|false
|
||||
|
||||
|`status`
|
||||
|object
|
||||
|Status of the signal manager.
|
||||
|false
|
||||
|===
|
||||
|
||||
[[clusterobservabilityspec]]
|
||||
== ClusterObservability.spec
|
||||
|
||||
|
||||
`Spec` defines the desired state of the cluster observability.
|
||||
|
||||
[cols="2,1,4,1"]
|
||||
|===
|
||||
|Name |Type |Description |Required
|
||||
|
||||
|xref:#clusterobservabilityspeccapabilities[`capabilities`]
|
||||
|object
|
||||
|`Capabilities` defines the observability capabilities. Each capability has to be enabled explicitly.
|
||||
|false
|
||||
|
||||
|xref:#clusterobservabilityspecstorage[`storage`]
|
||||
|object
|
||||
|`Storage` defines the storage for the capabilities that require a storage.
|
||||
|false
|
||||
|===
|
||||
|
||||
[[clusterobservabilityspeccapabilities]]
|
||||
== ClusterObservability.spec.capabilities
|
||||
|
||||
|
||||
`Capabilities` defines the observability capabilities. Each capability has to be enabled explicitly.
|
||||
|
||||
[cols="2,1,4,1"]
|
||||
|===
|
||||
|Name |Type |Description |Required
|
||||
|
||||
|xref:#clusterobservabilityspeccapabilitiesopentelemetry[`opentelemetry`]
|
||||
|object
|
||||
|`OpenTelemetry` defines the OpenTelemetry capabilities.
|
||||
|false
|
||||
|
||||
|xref:#clusterobservabilityspeccapabilitiestracing[`tracing`]
|
||||
|object
|
||||
|`Tracing` defines the tracing capabilities.
|
||||
|false
|
||||
|===
|
||||
|
||||
[[clusterobservabilityspeccapabilitiesopentelemetry]]
|
||||
== ClusterObservability.spec.capabilities.opentelemetry
|
||||
|
||||
|
||||
`OpenTelemetry` defines the OpenTelemetry capabilities.
|
||||
|
||||
[cols="2,1,4,1"]
|
||||
|===
|
||||
|Name |Type |Description |Required
|
||||
|
||||
|`enabled`
|
||||
|boolean
|
||||
|`Enabled` indicates whether the capability is enabled and it operator should deploy an instance. By default, it is set to false.
|
||||
|
||||
_Default_: false
|
||||
|false
|
||||
|
||||
|xref:#clusterobservabilityspeccapabilitiesopentelemetryexporter[`exporter`]
|
||||
|object
|
||||
|`Exporter` defines the OpenTelemetry exporter configuration. When defined the collector will export telemetry data to the specified endpoint.
|
||||
|false
|
||||
|
||||
|xref:#clusterobservabilityspeccapabilitiesopentelemetryoperators[`operators`]
|
||||
|object
|
||||
|`Operators` defines the operators installation for the capability.
|
||||
|false
|
||||
|===
|
||||
|
||||
[[clusterobservabilityspeccapabilitiesopentelemetryexporter]]
|
||||
== ClusterObservability.spec.capabilities.opentelemetry.exporter
|
||||
|
||||
`Exporter` defines the OpenTelemetry exporter configuration. When defined the collector will export telemetry data to the specified endpoint.
|
||||
|
||||
[cols="1,1,3,1"]
|
||||
|===
|
||||
|Name |Type |Description |Required
|
||||
|
||||
|`endpoint`
|
||||
|string
|
||||
|`Endpoint` is the OTLP endpoint.
|
||||
|false
|
||||
|===
|
||||
|
||||
[[clusterobservabilityspeccapabilitiesopentelemetryoperators]]
|
||||
== ClusterObservability.spec.capabilities.opentelemetry.operators
|
||||
|
||||
|
||||
`Operators` defines the operators installation for the capability.
|
||||
|
||||
[cols="1,1,3,1"]
|
||||
|===
|
||||
|Name |Type |Description |Required
|
||||
|
||||
|`install`
|
||||
|boolean
|
||||
|`Install` indicates whether the operator(s) used by the capability should be installed via OLM. When the capability is enabled, the install is set to true, otherwise it is set to false.
|
||||
|false
|
||||
|===
|
||||
|
||||
[[clusterobservabilityspeccapabilitiestracing]]
|
||||
== ClusterObservability.spec.capabilities.tracing
|
||||
|
||||
|
||||
`Tracing` defines the tracing capabilities.
|
||||
|
||||
[cols="2,1,4,1"]
|
||||
|===
|
||||
|Name |Type |Description |Required
|
||||
|
||||
|`enabled`
|
||||
|boolean
|
||||
|`Enabled` indicates whether the capability is enabled and it operator should deploy an instance. By default, it is set to false.
|
||||
|
||||
_Default_: false
|
||||
|false
|
||||
|
||||
|xref:#clusterobservabilityspeccapabilitiestracingoperators[`operators`]
|
||||
|object
|
||||
|`Operators` defines the operators installation for the capability.
|
||||
|false
|
||||
|===
|
||||
|
||||
[[clusterobservabilityspeccapabilitiestracingoperators]]
|
||||
== ClusterObservability.spec.capabilities.tracing.operators
|
||||
|
||||
|
||||
`Operators` defines the operators installation for the capability.
|
||||
|
||||
[cols="1,1,3,1"]
|
||||
|===
|
||||
|Name |Type |Description |Required
|
||||
|
||||
|`install`
|
||||
|boolean
|
||||
|`Install` indicates whether the operator(s) used by the capability should be installed via OLM. When the capability is enabled, the install is set to true, otherwise it is set to false.
|
||||
|false
|
||||
|===
|
||||
|
||||
[[clusterobservabilityspecstorage]]
|
||||
== ClusterObservability.spec.storage
|
||||
|
||||
|
||||
`Storage` defines the storage for the capabilities that require a storage.
|
||||
|
||||
[cols="2,1,4,1"]
|
||||
|===
|
||||
|Name |Type |Description |Required
|
||||
|
||||
|xref:#clusterobservabilityspecstoragesecret[`secret`]
|
||||
|object
|
||||
|`SecretSpec` defines the secret for the storage.
|
||||
|false
|
||||
|===
|
||||
|
||||
[[clusterobservabilityspecstoragesecret]]
|
||||
== ClusterObservability.spec.storage.secret
|
||||
|
||||
|
||||
`SecretSpec` defines the secret for the storage.
|
||||
|
||||
[cols="1,1,3,1"]
|
||||
|===
|
||||
|Name |Type |Description |Required
|
||||
|
||||
|`name`
|
||||
|string
|
||||
|`Name` is the name of the secret for the storage.
|
||||
|false
|
||||
|===
|
||||
|
||||
[[uiplugin]]
|
||||
== UIPlugin
|
||||
|
||||
|
||||
UIPlugin defines an observability console plugin.
|
||||
|
||||
[cols="2,1,4,1"]
|
||||
|===
|
||||
|Name |Type |Description |Required
|
||||
|
||||
|`apiVersion`
|
||||
|string
|
||||
|`observability.openshift.io/v1alpha1`
|
||||
|true
|
||||
|
||||
|`kind`
|
||||
|string
|
||||
|`UIPlugin`
|
||||
|true
|
||||
|
||||
|link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.32/#objectmeta-v1-meta[`metadata`]
|
||||
|object
|
||||
|Refer to the Kubernetes API documentation for the fields of the `metadata` field.
|
||||
|true
|
||||
|
||||
|xref:#uipluginspec[`spec`]
|
||||
|object
|
||||
|`UIPluginSpec` is the specification for desired state of UIPlugin.
|
||||
|false
|
||||
|
||||
|xref:#uipluginstatus[`status`]
|
||||
|object
|
||||
|`UIPluginStatus` defines the observed state of UIPlugin. It should always be reconstructable from the state of the cluster and/or outside world.
|
||||
|false
|
||||
|===
|
||||
|
||||
[[uipluginspec]]
|
||||
== UIPlugin.spec
|
||||
|
||||
`UIPluginSpec` is the specification for desired state of UIPlugin.
|
||||
|
||||
[cols="2,1,4,1"]
|
||||
|===
|
||||
|Name |Type |Description |Required
|
||||
|
||||
|`type`
|
||||
|enum
|
||||
|Type defines the UI plugin.
|
||||
|
||||
_Enum_: `Dashboards`, `TroubleshootingPanel`, `DistributedTracing`, `Logging`, `Monitoring`
|
||||
|true
|
||||
|
||||
|xref:#uipluginspecdeployment[`deployment`]
|
||||
|object
|
||||
|`Deployment` allows customizing aspects of the generated deployment hosting the UI Plugin.
|
||||
|false
|
||||
|
||||
|xref:#uipluginspecdistributedtracing[`distributedTracing`]
|
||||
|object
|
||||
|`DistributedTracing` contains configuration for the distributed tracing console plugin.
|
||||
|false
|
||||
|
||||
|xref:#uipluginspeclogging[`logging`]
|
||||
|object
|
||||
|`Logging` contains configuration for the logging console plugin.
|
||||
|
||||
It only applies to UIPlugin Type: `Logging`.
|
||||
|false
|
||||
|
||||
|xref:#uipluginspecmonitoring[`monitoring`]
|
||||
|object
|
||||
|`Monitoring` contains configuration for the monitoring console plugin.
|
||||
|false
|
||||
|
||||
|xref:#uipluginspectroubleshootingpanel[`troubleshootingPanel`]
|
||||
|object
|
||||
|`TroubleshootingPanel` contains configuration for the troubleshooting console plugin.
|
||||
|false
|
||||
|===
|
||||
|
||||
[[uipluginspecdeployment]]
|
||||
== UIPlugin.spec.deployment
|
||||
|
||||
|
||||
`Deployment` allows customizing aspects of the generated deployment hosting the UI Plugin.
|
||||
|
||||
[cols="2,2,4,1"]
|
||||
|===
|
||||
|Name |Type |Description |Required
|
||||
|
||||
|`nodeSelector`
|
||||
|`map[string]string`
|
||||
|Define a label-selector for nodes which the Pods should be scheduled on.
|
||||
|
||||
When no selector is specified it will default to a value only selecting Linux nodes (`"kubernetes.io/os=linux"`).
|
||||
|false
|
||||
|
||||
|xref:#uipluginspecdeploymenttolerationsindex[`tolerations`]
|
||||
|`[]object`
|
||||
|Define the tolerations used for the deployment.
|
||||
|false
|
||||
|===
|
||||
|
||||
[[uipluginspecdeploymenttolerationsindex]]
|
||||
== UIPlugin.spec.deployment.tolerations[index]
|
||||
|
||||
|
||||
The pod this `Toleration` is attached to tolerates any taint that matches the triple `<key,value,effect>` using the matching operator `<operator>`.
|
||||
|
||||
[cols="2,1,4,1"]
|
||||
|===
|
||||
|Name |Type |Description |Required
|
||||
|
||||
|`effect`
|
||||
|string
|
||||
|`Effect` indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are `NoSchedule`, `PreferNoSchedule` and `NoExecute`.
|
||||
|false
|
||||
|
||||
|`key`
|
||||
|string
|
||||
|`Key` is the taint key that the toleration applies to. Empty means match all taint keys. If the key is empty, operator must be `Exists`; this combination means to match all values and all keys.
|
||||
|false
|
||||
|
||||
|`operator`
|
||||
|string
|
||||
|`Operator` represents a key's relationship to the value. Valid operators are `Exists` and `Equal`. Defaults to `Equal`. `Exists` is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category.
|
||||
|false
|
||||
|
||||
|`tolerationSeconds`
|
||||
|integer
|
||||
|`TolerationSeconds` represents the period of time the toleration (which must be of effect `NoExecute`, otherwise this field is ignored) tolerates the taint. By default, it is not set, which means tolerate the taint forever (do not evict). Zero and negative values will be treated as 0 (evict immediately) by the system.
|
||||
|
||||
_Format_: int64
|
||||
|false
|
||||
|
||||
|`value`
|
||||
|string
|
||||
|`Value` is the taint value the toleration matches to. If the operator is `Exists`, the value should be empty, otherwise just a regular string.
|
||||
|false
|
||||
|===
|
||||
|
||||
[[uipluginspecdistributedtracing]]
|
||||
== UIPlugin.spec.distributedTracing
|
||||
|
||||
|
||||
`DistributedTracing` contains configuration for the distributed tracing console plugin.
|
||||
|
||||
[cols="1,1,4,1"]
|
||||
|===
|
||||
|Name |Type |Description |Required
|
||||
|
||||
|`timeout`
|
||||
|string
|
||||
|`Timeout` is the maximum duration before a query timeout.
|
||||
|
||||
The value is expected to be a sequence of digits followed by a unit suffix, which can be 's' (seconds) or 'm' (minutes).
|
||||
|false
|
||||
|===
|
||||
|
||||
[[uipluginspeclogging]]
|
||||
== UIPlugin.spec.logging
|
||||
|
||||
|
||||
`Logging` contains configuration for the logging console plugin.
|
||||
|
||||
* It only applies to UIPlugin Type: `Logging`.
|
||||
|
||||
[cols="2,1,4,1"]
|
||||
|===
|
||||
|Name |Type |Description |Required
|
||||
|
||||
|`logsLimit`
|
||||
|integer
|
||||
|`LogsLimit` is the max number of entries returned for a query.
|
||||
|
||||
_Format_: int32
|
||||
|
||||
_Minimum_: 0
|
||||
|false
|
||||
|
||||
|xref:#uipluginspeclogginglokistack[`lokiStack`]
|
||||
|object
|
||||
|`LokiStack` points to the `LokiStack` instance of which logs should be displayed. It always references a `LokiStack` in the "openshift-logging" namespace.
|
||||
|false
|
||||
|
||||
|`schema`
|
||||
|enum
|
||||
|`Schema` is the schema to use for logs querying and display.
|
||||
|
||||
Defaults to "viaq" if not specified.
|
||||
|
||||
_Enum_: `viaq`, `otel`, `select`
|
||||
|
||||
_Default_: `viaq`
|
||||
|false
|
||||
|
||||
|`timeout`
|
||||
|string
|
||||
|`Timeout` is the maximum duration before a query timeout.
|
||||
|
||||
The value is expected to be a sequence of digits followed by an optional unit suffix, which can be 's' (seconds) or 'm' (minutes). If the unit is omitted, it defaults to seconds.
|
||||
|false
|
||||
|===
|
||||
|
||||
[[uipluginspeclogginglokistack]]
|
||||
== UIPlugin.spec.logging.lokiStack
|
||||
|
||||
|
||||
`LokiStack` points to the LokiStack instance of which logs should be displayed. It always references a LokiStack in the "openshift-logging" namespace.
|
||||
|
||||
[cols="1,1,4,1"]
|
||||
|===
|
||||
|Name |Type |Description |Required
|
||||
|
||||
|`name`
|
||||
|string
|
||||
|Name of the `LokiStack` resource.
|
||||
|false
|
||||
|
||||
|`namespace`
|
||||
|string
|
||||
|
|
||||
|false
|
||||
|===
|
||||
|
||||
[[uipluginspecmonitoring]]
|
||||
== UIPlugin.spec.monitoring
|
||||
|
||||
|
||||
`Monitoring` contains configuration for the monitoring console plugin.
|
||||
|
||||
[cols="2,1,4,1"]
|
||||
|===
|
||||
|Name |Type |Description |Required
|
||||
|
||||
|xref:#uipluginspecmonitoringacm[`acm`]
|
||||
|object
|
||||
|`ACM` points to the alertmanager and thanosQuerier instance services of which it should create a proxy to.
|
||||
|false
|
||||
|
||||
|xref:#uipluginspecmonitoringincidents[`incidents`]
|
||||
|object
|
||||
|`Incidents` feature flag enablement
|
||||
|false
|
||||
|
||||
|xref:#uipluginspecmonitoringperses[`perses`]
|
||||
|object
|
||||
|`Perses` points to the perses instance service of which it should create a proxy to.
|
||||
|false
|
||||
|===
|
||||
|
||||
[[uipluginspecmonitoringacm]]
|
||||
== UIPlugin.spec.monitoring.acm
|
||||
|
||||
|
||||
`ACM` points to the alertmanager and thanosQuerier instance services of which it should create a proxy to.
|
||||
|
||||
[cols="2,1,4,1"]
|
||||
|===
|
||||
|Name |Type |Description |Required
|
||||
|
||||
|xref:#uipluginspecmonitoringacmalertmanager[`alertmanager`]
|
||||
|object
|
||||
|`Alertmanager` points to the alertmanager instance of which it should create a proxy to.
|
||||
|true
|
||||
|
||||
|`enabled`
|
||||
|boolean
|
||||
|Indicates if ACM-related feature(s) should be enabled
|
||||
|true
|
||||
|
||||
|xref:#uipluginspecmonitoringacmthanosquerier[`thanosQuerier`]
|
||||
|object
|
||||
|`ThanosQuerier` points to the thanos-querier service of which it should create a proxy to.
|
||||
|true
|
||||
|===
|
||||
|
||||
[[uipluginspecmonitoringacmalertmanager]]
|
||||
== UIPlugin.spec.monitoring.acm.alertmanager
|
||||
|
||||
`Alertmanager` points to the alertmanager instance of which it should create a proxy to.
|
||||
|
||||
[cols="1,1,3,1"]
|
||||
|===
|
||||
|Name |Type |Description |Required
|
||||
|
||||
|`url`
|
||||
|string
|
||||
|Url of the Alertmanager to proxy to.
|
||||
|true
|
||||
|===
|
||||
|
||||
[[uipluginspecmonitoringacmthanosquerier]]
|
||||
== UIPlugin.spec.monitoring.acm.thanosQuerier
|
||||
|
||||
|
||||
`ThanosQuerier` points to the thanos-querier service of which it should create a proxy to.
|
||||
|
||||
[cols="1,1,3,1"]
|
||||
|===
|
||||
|Name |Type |Description |Required
|
||||
|
||||
|`url`
|
||||
|string
|
||||
|Url of the ThanosQuerier to proxy to.
|
||||
|true
|
||||
|===
|
||||
|
||||
[[uipluginspecmonitoringincidents]]
|
||||
== UIPlugin.spec.monitoring.incidents
|
||||
|
||||
|
||||
`Incidents` feature flag enablement
|
||||
|
||||
[cols="1,1,3,1"]
|
||||
|===
|
||||
|Name |Type |Description |Required
|
||||
|
||||
|`enabled`
|
||||
|boolean
|
||||
|Indicates if incidents-related feature(s) should be enabled.
|
||||
|true
|
||||
|===
|
||||
|
||||
[[uipluginspecmonitoringperses]]
|
||||
== UIPlugin.spec.monitoring.perses
|
||||
|
||||
|
||||
`Perses` points to the perses instance service of which it should create a proxy to.
|
||||
|
||||
[cols="1,1,3,1"]
|
||||
|===
|
||||
|Name |Type |Description |Required
|
||||
|
||||
|`enabled`
|
||||
|boolean
|
||||
|Indicates if perses-related feature(s) should be enabled
|
||||
|true
|
||||
|===
|
||||
|
||||
[[uipluginspectroubleshootingpanel]]
|
||||
== UIPlugin.spec.troubleshootingPanel
|
||||
|
||||
|
||||
`TroubleshootingPanel` contains configuration for the troubleshooting console plugin.
|
||||
|
||||
[cols="1,1,4,1"]
|
||||
|===
|
||||
|Name |Type |Description |Required
|
||||
|
||||
|`timeout`
|
||||
|string
|
||||
|`Timeout` is the maximum duration before a query timeout.
|
||||
|
||||
The value is expected to be a sequence of digits followed by a unit suffix, which can be 's' (seconds) or 'm' (minutes).
|
||||
|false
|
||||
|===
|
||||
|
||||
[[uipluginstatus]]
|
||||
== UIPlugin.status
|
||||
|
||||
|
||||
`UIPluginStatus` defines the observed state of UIPlugin. It should always be reconstructable from the state of the cluster and/or outside world.
|
||||
|
||||
[cols="2,1,4,1"]
|
||||
|===
|
||||
|Name |Type |Description |Required
|
||||
|
||||
|xref:#uipluginstatusconditionsindex[`conditions`]
|
||||
|`[]object`
|
||||
|`Conditions` provide status information about the plugin.
|
||||
|true
|
||||
|===
|
||||
|
||||
[[uipluginstatusconditionsindex]]
|
||||
== UIPlugin.status.conditions[index]
|
||||
|
||||
|
||||
[cols="2,1,4,1"]
|
||||
|===
|
||||
|Name |Type |Description |Required
|
||||
|
||||
|`lastTransitionTime`
|
||||
|string
|
||||
|`lastTransitionTime` is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.
|
||||
|
||||
_Format_: date-time
|
||||
|true
|
||||
|
||||
|`message`
|
||||
|string
|
||||
|`message` is a human readable message indicating details about the transition. This may be an empty string.
|
||||
|true
|
||||
|
||||
|`reason`
|
||||
|string
|
||||
|`reason` contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.
|
||||
|true
|
||||
|
||||
|`status`
|
||||
|enum
|
||||
|status of the condition
|
||||
|
||||
_Enum_: `True`, `False`, `Unknown`, `Degraded`
|
||||
|true
|
||||
|
||||
|`type`
|
||||
|string
|
||||
|`type` of condition in CamelCase or in `foo.example.com/CamelCase`. The regex it matches is `(dns1123SubdomainFmt/)?(qualifiedNameFmt)`
|
||||
|true
|
||||
|
||||
|`observedGeneration`
|
||||
|integer
|
||||
|`observedGeneration` represents the `.metadata.generation` that the condition was set based upon. For instance, if `.metadata.generation` is currently 12, but the `.status.conditions[x].observedGeneration` is 9, the condition is out of date with respect to the current state of the instance.
|
||||
|
||||
_Format_: int64
|
||||
|
||||
_Minimum_: 0
|
||||
|false
|
||||
|===
|
||||
@@ -1,7 +1,7 @@
|
||||
:_mod-docs-content-type: ASSEMBLY
|
||||
[id="cluster-observability-operator-overview"]
|
||||
= {coo-full} overview
|
||||
include::_attributes/common-attributes.adoc[]
|
||||
= {coo-full} overview
|
||||
:context: cluster_observability_operator_overview
|
||||
|
||||
toc::[]
|
||||
@@ -9,26 +9,4 @@ toc::[]
|
||||
|
||||
The {coo-first} is an optional component of the {product-title} designed for creating and managing highly customizable monitoring stacks. It enables cluster administrators to automate configuration and management of monitoring needs extensively, offering a more tailored and detailed view of each namespace compared to the default {product-title} monitoring system.
|
||||
|
||||
The {coo-short} deploys the following monitoring components:
|
||||
|
||||
* **Prometheus** - A highly available Prometheus instance capable of sending metrics to an external endpoint by using remote write.
|
||||
* **Thanos Querier** (optional) - Enables querying of Prometheus instances from a central location.
|
||||
* **Alertmanager** (optional) - Provides alert configuration capabilities for different services.
|
||||
* **xref:../../observability/cluster_observability_operator/ui_plugins/observability-ui-plugins-overview.adoc#observability-ui-plugins-overview[UI plugins]** (optional) - Enhances the observability capabilities with plugins for monitoring, logging, distributed tracing and troubleshooting.
|
||||
* **Korrel8r** (optional) - Provides observability signal correlation, powered by the open source Korrel8r project.
|
||||
* **xref:../../observability/cluster_observability_operator/ui_plugins/monitoring-ui-plugin.adoc#coo-incident-detection-overview_monitoring-ui-plugin[Incident detection]** (optional) - Groups related alerts into incidents, to help you identify the root causes of alert bursts.
|
||||
|
||||
include::modules/coo-versus-default-ocp-monitoring.adoc[leveloffset=+1]
|
||||
|
||||
include::modules/coo-advantages.adoc[leveloffset=+1]
|
||||
|
||||
include::modules/coo-target-users.adoc[leveloffset=+1]
|
||||
|
||||
//include::modules/monitoring-understanding-the-cluster-observability-operator.adoc[leveloffset=+1]
|
||||
|
||||
include::modules/coo-server-side-apply.adoc[leveloffset=+1]
|
||||
|
||||
[role="_additional-resources"]
|
||||
.Additional resources
|
||||
|
||||
* link:https://kubernetes.io/docs/reference/using-api/server-side-apply/[Kubernetes documentation for Server-Side Apply (SSA)]
|
||||
The standalone {coo-short} documentation is available at link:https://docs.redhat.com/en/documentation/red_hat_openshift_cluster_observability_operator/1-latest/html/about_red_hat_openshift_cluster_observability_operator/index[].
|
||||
@@ -1,399 +0,0 @@
|
||||
// Cluster Observability Operator Release Notes
|
||||
:_mod-docs-content-type: ASSEMBLY
|
||||
include::_attributes/common-attributes.adoc[]
|
||||
[id="cluster-observability-operator-release-notes"]
|
||||
= {coo-full} release notes
|
||||
:context: cluster-observability-operator-release-notes
|
||||
|
||||
toc::[]
|
||||
|
||||
The {coo-first} is an optional {product-title} Operator that enables administrators to create standalone monitoring stacks that are independently configurable for use by different services and users.
|
||||
|
||||
The {coo-short} complements the built-in monitoring capabilities of {product-title}. You can deploy it in parallel with the default platform and user workload monitoring stacks managed by the {cmo-first}.
|
||||
|
||||
These release notes track the development of the {coo-full} in {product-title}.
|
||||
|
||||
The following table provides information about which features are available depending on the version of {coo-full} and {product-title}:
|
||||
|
||||
[cols="1,1,1,1,1,1,1", options="header"]
|
||||
|===
|
||||
| COO Version | OCP Versions | Distributed tracing | Logging | Troubleshooting panel | ACM alerts | Incident detection
|
||||
| 1.1+ | 4.12 - 4.14 | ✔ | ✔ | ✘ | ✘ | ✘
|
||||
| 1.1+ | 4.15 | ✔ | ✔ | ✘ | ✔ | ✘
|
||||
| 1.1+ | 4.16 - 4.18 | ✔ | ✔ | ✔ | ✔ | ✘
|
||||
| 1.2+ | 4.19+ | ✔ | ✔ | ✔ | ✔ | ✔
|
||||
|===
|
||||
|
||||
include::snippets/unified-perspective-web-console.adoc[]
|
||||
|
||||
[id="cluster-observability-operator-release-notes-1-2-2_{context}"]
|
||||
== {coo-full} 1.2.2
|
||||
|
||||
The following advisory is available for {coo-full} 1.2.2:
|
||||
|
||||
* link:https://access.redhat.com/errata/RHBA-2025:11689[RHBA-2025:11689 {coo-full} 1.2.2]
|
||||
|
||||
[id="cluster-observability-operator-1-2-2-bug-fixes_{context}"]
|
||||
=== Bug fixes
|
||||
|
||||
* Before this update, the installation of the incident detection feature could fail intermittently. The symptoms include the incident detection UI being visible but not including any data. In addition, the health-analyzer `ServiceMonitor` resource is in a failed state, with the error message `tls: failed to verify certificate: x509`. With this release, the incident detection feature installs correctly. (link:https://issues.redhat.com/browse/COO-1062[COO-1062])
|
||||
+
|
||||
If you are upgrading from 1.2.1 where the bug was occurring, you must recreate the monitoring UI plugin to resolve the issue.
|
||||
|
||||
[id="cluster-observability-operator-1-2-2-known-issues_{context}"]
|
||||
=== Known issues
|
||||
|
||||
These are the known issues in {coo-full} 1.2.2:
|
||||
|
||||
* When installing version 1.2.2 or when upgrading from version 1.2.0, the monitoring plugin's `UIPlugin` resource can be corrupted. This occurs when you have also deployed distributed tracing, the troubleshooting panel, and Advance Cluster Management (ACM), together with the monitoring UI plugin. You can resolve this issue by recreating the UI plugin. (link:https://issues.redhat.com/browse/COO-1051[COO-1051])
|
||||
+
|
||||
If you have previously resolved the issue in 1.2.1 and then upgrade to 1.2.2, this issue will not reoccur.
|
||||
|
||||
[id="cluster-observability-operator-release-notes-1-2-1_{context}"]
|
||||
== {coo-full} 1.2.1
|
||||
|
||||
The following advisory is available for {coo-full} 1.2.1:
|
||||
|
||||
* link:https://access.redhat.com/errata/RHBA-2025:10696[RHBA-2025:10696 {coo-full} 1.2.1]
|
||||
|
||||
[id="cluster-observability-operator-1-2-1-bug-fixes_{context}"]
|
||||
=== Bug fixes
|
||||
|
||||
* Before this update, an old version label matcher was retained during the Operator version 1.2 upgrade. This caused Perses dashboards to become unavailable. With this release, the version label is removed and Perses dashboards are correctly reconciled.
|
||||
|
||||
[id="cluster-observability-operator-1-2-1-known-issues_{context}"]
|
||||
=== Known issues
|
||||
|
||||
These are the known issues in {coo-full} 1.2.1:
|
||||
|
||||
* The installation of the incident detection feature could fail intermittently. The symptoms include the incident detection UI being visible but not including any data. In addition, the health-analyzer `ServiceMonitor` resource is in a failed state, with the error message `tls: failed to verify certificate: x509`. You can resolve this issue by upgrading to 1.2.2 and recreating the monitoring UI plugin. (link:https://issues.redhat.com/browse/COO-1062[COO-1062])
|
||||
|
||||
* When installing version 1.2.1 or when upgrading from version 1.2.0, the monitoring plugin's `UIPlugin` resource can be corrupted. This occurs when you have also deployed distributed tracing, the troubleshooting panel, and Advance Cluster Management (ACM), together with the monitoring UI plugin. You can resolve this issue by recreating the UI plugin. (link:https://issues.redhat.com/browse/COO-1051[COO-1051])
|
||||
|
||||
[id="cluster-observability-operator-release-notes-1-2_{context}"]
|
||||
== {coo-full} 1.2
|
||||
|
||||
The following advisory is available for {coo-full} 1.2:
|
||||
|
||||
* link:https://access.redhat.com/errata/RHBA-2025:8940[RHBA-2025:8940 {coo-full} 1.2]
|
||||
|
||||
[id="cluster-observability-operator-1-2-new-features-enhancements_{context}"]
|
||||
=== New features and enhancements
|
||||
|
||||
* The logging UI plugin now supports the OTEL format, in addition to the previously supported ViaQ scheme. (link:https://issues.redhat.com/browse/COO-816[COO-816])
|
||||
|
||||
* Accelerators Perses dashboards are deployed by default when you install the monitoring UI plugin. (link:https://issues.redhat.com/browse/COO-942[COO-942])
|
||||
|
||||
* Multiple results per graph node are now displayed for Korrel8r. (link:https://issues.redhat.com/browse/COO-785[COO-785])
|
||||
|
||||
* Direct navigation to individual incident detail is now supported in the incident detection panel, and this enables the incidents overview functionality in {rh-rhacm-first} 2.14. (link:https://issues.redhat.com/browse/COO-977[COO-977], link:https://issues.redhat.com/browse/ACM-18751[ACM-18751])
|
||||
|
||||
* Advanced filters have been added to the tracing view. (link:https://issues.redhat.com/browse/COO-979[COO-979])
|
||||
|
||||
* The status of the distributed tracing UI plugin is now General Availability (GA), supporting Patternfly 4, 5 and 6. (link:https://issues.redhat.com/browse/COO-873[COO-873])
|
||||
|
||||
[id="cluster-observability-operator-1-2-bug-fixes_{context}"]
|
||||
=== Bug fixes
|
||||
|
||||
* Previously, LokiStack was a prerequisite for installing the logging UI plugin. With this release, you can install the logging UI plugin without LokiStack. (link:https://issues.redhat.com/browse/COO-760[COO-760])
|
||||
|
||||
* Previously, the *Silence Alert* button in the **Incidents** -> **Component** section did not pre-populate the fields and was not usable. This release resolves the issue. (link:https://issues.redhat.com/browse/COO-970[COO-970])
|
||||
|
||||
|
||||
[id="cluster-observability-operator-1-2-known-issues_{context}"]
|
||||
=== Known issues
|
||||
|
||||
These are the known issues in {coo-full} 1.2.0:
|
||||
|
||||
* When upgrading from {coo-short} 1.1.1 to {coo-short} 1.2, the Perses dashboard is not correctly reconciled, and this requires the monitoring UI plugin to be reinstalled. (link:https://issues.redhat.com/browse/COO-978[COO-978])
|
||||
|
||||
|
||||
[id="cluster-observability-operator-release-notes-1-1-1_{context}"]
|
||||
== {coo-full} 1.1.1
|
||||
|
||||
// Back fill advisory when it is created by KOnflux
|
||||
// The following advisory is available for {coo-full} 1.1.1:
|
||||
//
|
||||
// * link:https://access.redhat.com/errata/RHBA-2025:????[RHBA-2025:??? {coo-full} 1.1.1]
|
||||
|
||||
|
||||
[id="cluster-observability-operator-1-1-1-bug-fixes_{context}"]
|
||||
=== Bug fixes
|
||||
|
||||
* Previously, `observability-operator` and `perses-operator` pods on many clusters entered a `CrashLoopBackOff` state due to `OutOfMemory` errors, after upgrading from {coo-full} 1.0. This release resolves the issue. (link:https://issues.redhat.com/browse/COO-784[*COO-784*])
|
||||
|
||||
[id="cluster-observability-operator-release-notes-1-1_{context}"]
|
||||
== {coo-full} 1.1
|
||||
|
||||
|
||||
The following advisory is available for {coo-full} 1.1:
|
||||
|
||||
* link:https://access.redhat.com/errata/RHBA-2025:4360[RHBA-2025:4360 {coo-full} 1.1]
|
||||
|
||||
|
||||
|
||||
[id="cluster-observability-operator-1-1-new-features-enhancements_{context}"]
|
||||
=== New features and enhancements
|
||||
|
||||
* You can now install the monitoring UI plugin using {coo-short}. (link:https://issues.redhat.com/browse/COO-262[*COO-262*])
|
||||
|
||||
* You can enable incident detection in the monitoring UI plugin. (link:https://issues.redhat.com/browse/COO-690[*COO-690*])
|
||||
|
||||
* TLS support for the Thanos web endpoint has been added. (link:https://issues.redhat.com/browse/COO-222[*COO-222*])
|
||||
|
||||
|
||||
|
||||
[id="cluster-observability-operator-1-1-known-issues_{context}"]
|
||||
=== Known issues
|
||||
|
||||
These are the known issues in {coo-full} 1.1.0:
|
||||
|
||||
* `observability-operator` and `perses-operator` pods enter a `CrashLoopBackOff` state due to `OutOfMemory` errors, after upgrading from {coo-full} 1.0.
|
||||
+
|
||||
A workaround is provided in the knowledge base article link:https://access.redhat.com/solutions/7113898[ClusterObservability and perses operator pod in CrashLoopBackOff due to OOMKilled in RHOCP4].
|
||||
+
|
||||
This issue is being tracked in link:https://issues.redhat.com/browse/COO-784[*COO-784*].
|
||||
|
||||
|
||||
[id="cluster-observability-operator-1-1-bug-fixes_{context}"]
|
||||
=== Bug fixes
|
||||
|
||||
* Previously, the logging UI plugin did not support setting a custom LokiStack name or namespace. This release resolves the issue. (link:https://issues.redhat.com/browse/COO-332[*COO-332*])
|
||||
|
||||
|
||||
[id="cluster-observability-operator-release-notes-1-0_{context}"]
|
||||
== {coo-full} 1.0
|
||||
|
||||
// Need to check if there is an advisory generated now that the build system has moved to Konflux
|
||||
// The following advisory is available for {coo-full} 1.0:
|
||||
//
|
||||
// * link:https://access.redhat.com/errata/RHSA-2024:????[RHEA-2024:??? {coo-full} 1.0]
|
||||
|
||||
|
||||
[id="cluster-observability-operator-1-0-new-features-enhancements_{context}"]
|
||||
=== New features and enhancements
|
||||
|
||||
* {coo-short} is now enabled for {product-title} platform monitoring. (link:https://issues.redhat.com/browse/COO-476[*COO-476*])
|
||||
** Implements HTTPS support for {coo-short} web server. (link:https://issues.redhat.com/browse/COO-480[*COO-480*])
|
||||
** Implements authn/authz for {coo-short} web server. (link:https://issues.redhat.com/browse/COO-481[*COO-481*])
|
||||
** Configures ServiceMonitor resource to collect metrics from {coo-short}. (link:https://issues.redhat.com/browse/COO-482[*COO-482*])
|
||||
** Adds `operatorframework.io/cluster-monitoring=true` annotation to the OLM bundle. (link:https://issues.redhat.com/browse/COO-483[*COO-483*])
|
||||
** Defines the alerting strategy for {coo-short} . (link:https://issues.redhat.com/browse/COO-484[*COO-484*])
|
||||
** Configures PrometheusRule for alerting. (link:https://issues.redhat.com/browse/COO-485[*COO-485*])
|
||||
|
||||
* Support level annotations have been added to the `UIPlugin` CR when created. The support level is based on the plugin type, with values of `DevPreview`, `TechPreview`, or `GeneralAvailability`. (link:https://issues.redhat.com/browse/COO-318[*COO-318*])
|
||||
|
||||
// must-gather postponed to 1.1
|
||||
//* You can now gather debugging information about {coo-short} by using the `oc adm must-gather` CLI command. (link:https://issues.redhat.com/browse/COO-194[*COO-194*])
|
||||
|
||||
* You can now configure the Alertmanager `scheme` and `tlsConfig` fields in the Prometheus CR. (link:https://issues.redhat.com/browse/COO-219[*COO-219*])
|
||||
|
||||
// Dev preview so cannot document
|
||||
//* You can now install the Monitoring UI plugin using {coo-short}. (link:https://issues.redhat.com/browse/COO-262[*COO-262*])
|
||||
|
||||
* The extended Technical Preview for the troubleshooting panel adds support for correlating traces with Kubernetes resources and directly with other observable signals including logs, alerts, metrics, and network events. (link:https://issues.redhat.com/browse/COO-450[*COO-450*])
|
||||
** You can select a Tempo instance and tenant when you navigate to the tracing page by clicking *Observe -> Tracing* in the web console. The preview troubleshooting panel only works with the `openshift-tracing / platform` instance and the `platform` tenant.
|
||||
** The troubleshooting panel works best in the *Administrator* perspective. It has limited functionality in the Developer perspective due to authorization issues with some back ends, most notably Prometheus for metrics and alerts. This will be addressed in a future release.
|
||||
|
||||
The following table provides information about which features are available depending on the version of {coo-full} and {product-title}:
|
||||
|
||||
[cols="1,1,1,1,1", options="header"]
|
||||
|===
|
||||
| COO Version | OCP Versions | Distributed Tracing | Logging | Troubleshooting Panel
|
||||
| 1.0 | 4.12 - 4.15 | ✔ | ✔ | ✘
|
||||
| 1.0 | 4.16+ | ✔ | ✔ | ✔
|
||||
|===
|
||||
|
||||
|
||||
[id="cluster-observability-operator-1-0-CVEs"]
|
||||
=== CVEs
|
||||
|
||||
* link:https://access.redhat.com/security/cve/CVE-2023-26159[CVE-2023-26159]
|
||||
* link:https://access.redhat.com/security/cve/CVE-2024-28849[CVE-2024-28849]
|
||||
* link:https://access.redhat.com/security/cve/CVE-2024-45338[CVE-2024-45338]
|
||||
|
||||
[id="cluster-observability-operator-1-0-bug-fixes_{context}"]
|
||||
=== Bug fixes
|
||||
|
||||
* Previously, the default namespace for the {coo-short} installation was `openshift-operators`. With this release, the defaullt namespace changes to `openshift-cluster-observability-operator`. (link:https://issues.redhat.com/browse/COO-32[*COO-32*])
|
||||
|
||||
* Previously, `korrel8r` was only able to parse time series selector expressions. With this release, `korrel8r` can parse any valid PromQL expression to extract the time series selectors that it uses for correlation. (link:https://issues.redhat.com/browse/COO-558[*COO-558*])
|
||||
|
||||
* Previously, when viewing a Tempo instance from the Distributed Tracing UI plugin, the scatter plot graph showing the traces duration was not rendered correctly. The bubble size was too large and overlapped the x and y axis. With this release, the graph is rendered correctly. (link:https://issues.redhat.com/browse/COO-319[*COO-319*])
|
||||
|
||||
== Features available on older, Technology Preview releases
|
||||
|
||||
The following table provides information about which features are available depending on older version of {coo-full} and {product-title}:
|
||||
|
||||
[cols="1,1,1,1,1,1", options="header"]
|
||||
|===
|
||||
| COO Version | OCP Versions | Dashboards | Distributed Tracing | Logging | Troubleshooting Panel
|
||||
|
||||
| 0.2.0 | 4.11 | ✔ | ✘ | ✘ | ✘
|
||||
| 0.3.0+, 0.4.0+ | 4.11 - 4.15 | ✔ | ✔ | ✔ | ✘
|
||||
| 0.3.0+, 0.4.0+ | 4.16+ | ✔ | ✔ | ✔ | ✔
|
||||
|===
|
||||
|
||||
[id="cluster-observability-operator-release-notes-0-4-1_{context}"]
|
||||
== {coo-full} 0.4.1
|
||||
|
||||
The following advisory is available for {coo-full} 0.4.1:
|
||||
|
||||
* link:https://access.redhat.com/errata/RHSA-2024:8040[RHEA-2024:8040 {coo-full} 0.4.1]
|
||||
|
||||
[id="cluster-observability-operator-0-4-1-new-features-enhancements_{context}"]
|
||||
=== New features and enhancements
|
||||
|
||||
* You can now configure WebTLS for Prometheus and Alertmanager.
|
||||
|
||||
[id="cluster-observability-operator-0-4-1-CVEs"]
|
||||
=== CVEs
|
||||
|
||||
* link:https://access.redhat.com/security/cve/CVE-2024-6104[CVE-2024-6104]
|
||||
* link:https://access.redhat.com/security/cve/CVE-2024-24786[CVE-2024-24786]
|
||||
|
||||
[id="cluster-observability-operator-0-4-1-bug-fixes_{context}"]
|
||||
=== Bug fixes
|
||||
|
||||
* Previously, when you deleted the dashboard UI plugin, the `consoles.operator.openshift.io` resource still contained `console-dashboards-plugin`. This release resolves the issue. (link:https://issues.redhat.com/browse/COO-152[*COO-152*])
|
||||
|
||||
* Previously, the web console did not display the correct icon for Red Hat {coo-short} . This release resolves the issue. (link:https://issues.redhat.com/browse/COO-353[*COO-353*])
|
||||
|
||||
* Previously, when you installed the {coo-short} from the web console, the support section contained an invalid link. This release resolves the issue. (link:https://issues.redhat.com/browse/COO-354[*COO-354*])
|
||||
|
||||
* Previously, the cluster service version (CSV) for {coo-short} linked to an unofficial version of the documentation. This release resolves the issue. (link:https://issues.redhat.com/browse/COO-356[*COO-356*])
|
||||
|
||||
[id="cluster-observability-operator-release-notes-0-4-0_{context}"]
|
||||
== {coo-full} 0.4.0
|
||||
|
||||
The following advisory is available for {coo-full} 0.4.0:
|
||||
|
||||
// Test the errata link just before publishing
|
||||
* link:https://access.redhat.com/errata/RHEA-2024:6699[RHEA-2024:6699 {coo-full} 0.4.0]
|
||||
|
||||
|
||||
[id="cluster-observability-operator-0-4-0-new-features-enhancements_{context}"]
|
||||
=== New features and enhancements
|
||||
|
||||
// COO-264
|
||||
==== Troubleshooting UI plugin
|
||||
|
||||
* The troubleshooting UI panel has been improved so you can now select and focus on a specific starting signal.
|
||||
* There is more visibility into Korrel8r queries, with the option of selecting the depth.
|
||||
* Users of {product-title} version 4.17+ can access the troubleshooting UI panel from the Application Launcher {launch}. Alternatively, on versions 4.16+, you can access it in the web console by clicking on **Observe** -> **Alerting**.
|
||||
|
||||
For more information, see xref:../../observability/cluster_observability_operator/ui_plugins/troubleshooting-ui-plugin.adoc#troubleshooting-ui-plugin[troubleshooting UI plugin].
|
||||
|
||||
// COO-263
|
||||
==== Distributed tracing UI plugin
|
||||
|
||||
* The distributed tracing UI plugin has been enhanced, with a Gantt chart now available for exploring traces.
|
||||
|
||||
For more information, see xref:../../observability/cluster_observability_operator/ui_plugins/distributed-tracing-ui-plugin.adoc#distributed-tracing-ui-plugin[distributed tracing UI plugin].
|
||||
|
||||
[id="cluster-observability-operator-0-4-0-bug-fixes_{context}"]
|
||||
=== Bug fixes
|
||||
|
||||
* Previously, metrics were not available to normal users when accessed in the Developer perspective of the web console, by clicking on **Observe** -> **Logs**.
|
||||
This release resolves the issue. (link:https://issues.redhat.com/browse/COO-288[*COO-288*])
|
||||
|
||||
* Previously, the troubleshooting UI plugin used the wrong filter for network observability.
|
||||
This release resolves the issue. (link:https://issues.redhat.com/browse/COO-299[*COO-299*])
|
||||
|
||||
* Previously, the troubleshooting UI plugin generated an incorrect URL for pod label searches.
|
||||
This release resolves the issue. (link:https://issues.redhat.com/browse/COO-298[*COO-298*])
|
||||
|
||||
* Previously, there was an authorization vulnerability in the Distributed tracing UI plugin.
|
||||
This release resolves the issue and the Distributed tracing UI plugin has been hardened by using only multi-tenant `TempoStack` and `TempoMonolithic` instances going forward.
|
||||
|
||||
[id="cluster-observability-operator-release-notes-0-3-2_{context}"]
|
||||
== {coo-full} 0.3.2
|
||||
|
||||
The following advisory is available for {coo-full} 0.3.2:
|
||||
|
||||
* link:https://access.redhat.com/errata/RHEA-2024:5985[RHEA-2024:5985 {coo-full} 0.3.2]
|
||||
|
||||
|
||||
[id="cluster-observability-operator-0-3-2-new-features-enhancements_{context}"]
|
||||
=== New features and enhancements
|
||||
|
||||
* With this release, you can now use tolerations and node selectors with `MonitoringStack` components.
|
||||
|
||||
|
||||
[id="cluster-observability-operator-0-3-2-bug-fixes_{context}"]
|
||||
=== Bug fixes
|
||||
|
||||
* Previously, the logging UIPlugin was not in the `Available` state and the logging pod was not created, when installed on a specific version of {product-title}.
|
||||
This release resolves the issue. (link:https://issues.redhat.com/browse/COO-260[*COO-260*])
|
||||
|
||||
[id="cluster-observability-operator-release-notes-0-3-0"]
|
||||
== {coo-full} 0.3.0
|
||||
The following advisory is available for {coo-full} 0.3.0:
|
||||
|
||||
* link:https://access.redhat.com/errata/RHEA-2024:4399[RHEA-2024:4399 {coo-full} 0.3.0]
|
||||
|
||||
[id="cluster-observability-operator-0-3-0-new-features-enhancements"]
|
||||
=== New features and enhancements
|
||||
* With this release, the {coo-full} adds backend support for future {product-title} observability web console UI plugins and observability components.
|
||||
|
||||
[id="cluster-observability-operator-release-notes-0-2-0"]
|
||||
== {coo-full} 0.2.0
|
||||
The following advisory is available for {coo-full} 0.2.0:
|
||||
|
||||
* link:https://access.redhat.com/errata/RHEA-2024:2662[RHEA-2024:2662 {coo-full} 0.2.0]
|
||||
|
||||
[id="cluster-observability-operator-0-2-0-new-features-enhancements"]
|
||||
=== New features and enhancements
|
||||
* With this release, the {coo-full} supports installing and managing observability-related plugins for the {product-title} web console user interface (UI). (link:https://issues.redhat.com/browse/COO-58[*COO-58*])
|
||||
|
||||
[id="cluster-observability-operator-release-notes-0-1-3"]
|
||||
== {coo-full} 0.1.3
|
||||
The following advisory is available for {coo-full} 0.1.3:
|
||||
|
||||
* link:https://access.redhat.com/errata/RHEA-2024:1744[RHEA-2024:1744 {coo-full} 0.1.3]
|
||||
|
||||
[id="cluster-observability-operator-0-1-3-bug-fixes"]
|
||||
=== Bug fixes
|
||||
|
||||
* Previously, if you tried to access the Prometheus web user interface (UI) at `\http://<prometheus_url>:9090/graph`, the following error message would display: `Error opening React index.html: open web/ui/static/react/index.html: no such file or directory`.
|
||||
This release resolves the issue, and the Prometheus web UI now displays correctly. (link:https://issues.redhat.com/browse/COO-34[*COO-34*])
|
||||
|
||||
[id="cluster-observability-operator-release-notes-0-1-2"]
|
||||
== {coo-full} 0.1.2
|
||||
The following advisory is available for {coo-full} 0.1.2:
|
||||
|
||||
* link:https://access.redhat.com/errata/RHEA-2024:1534[RHEA-2024:1534 {coo-full} 0.1.2]
|
||||
|
||||
[id="cluster-observability-operator-0-1-2-CVEs"]
|
||||
=== CVEs
|
||||
|
||||
* link:https://access.redhat.com/security/cve/CVE-2023-45142[CVE-2023-45142]
|
||||
|
||||
[id="cluster-observability-operator-0-1-2-bug-fixes"]
|
||||
=== Bug fixes
|
||||
|
||||
* Previously, certain cluster service version (CSV) annotations were not included in the metadata for {coo-short}.
|
||||
Because of these missing annotations, certain {coo-short} features and capabilities did not appear in the package manifest or in the OperatorHub user interface.
|
||||
This release adds the missing annotations, thereby resolving this issue. (link:https://issues.redhat.com/browse/COO-11[*COO-11*])
|
||||
|
||||
* Previously, automatic updates of the {coo-short} did not work, and a newer version of the Operator did not automatically replace the older version, even though the newer version was available in OperatorHub.
|
||||
This release resolves the issue. (link:https://issues.redhat.com/browse/COO-12[*COO-12*])
|
||||
|
||||
* Previously, Thanos Querier only listened for network traffic on port 9090 of 127.0.0.1 (`localhost`), which resulted in a `502 Bad Gateway` error if you tried to reach the Thanos Querier service.
|
||||
With this release, the Thanos Querier configuration has been updated so that the component now listens on the default port (10902), thereby resolving the issue.
|
||||
As a result of this change, you can also now modify the port via server side apply (SSA) and add a proxy chain, if required. (link:https://issues.redhat.com/browse/COO-14[*COO-14*])
|
||||
|
||||
[id="cluster-observability-operator-release-notes-0-1-1"]
|
||||
== {coo-full} 0.1.1
|
||||
The following advisory is available for {coo-full} 0.1.1:
|
||||
|
||||
* link:https://access.redhat.com/errata/RHEA-2024:0550[2024:0550 {coo-full} 0.1.1]
|
||||
|
||||
[id="cluster-observability-operator-0-1-1-new-features-enhancements"]
|
||||
=== New features and enhancements
|
||||
This release updates the {coo-full} to support installing the Operator in restricted networks or disconnected environments.
|
||||
|
||||
[id="cluster-observability-operator-release-notes-0-1"]
|
||||
== {coo-full} 0.1
|
||||
|
||||
This release makes a Technology Preview version of the {coo-full} available on OperatorHub.
|
||||
@@ -1,30 +0,0 @@
|
||||
:_mod-docs-content-type: ASSEMBLY
|
||||
[id="configuring-the-cluster-observability-operator-to-monitor-a-service"]
|
||||
= Configuring the {coo-full} to monitor a service
|
||||
include::_attributes/common-attributes.adoc[]
|
||||
:context: configuring_the_cluster_observability_operator_to_monitor_a_service
|
||||
|
||||
toc::[]
|
||||
|
||||
You can monitor metrics for a service by configuring monitoring stacks managed by the {coo-first}.
|
||||
|
||||
To test monitoring a service, follow these steps:
|
||||
|
||||
* Deploy a sample service that defines a service endpoint.
|
||||
* Create a `ServiceMonitor` object that specifies how the service is to be monitored by the {coo-short}.
|
||||
* Create a `MonitoringStack` object to discover the `ServiceMonitor` object.
|
||||
|
||||
// Deploy a sample service for Cluster Observability Operator
|
||||
include::modules/monitoring-deploying-a-sample-service-for-cluster-observability-operator.adoc[leveloffset=+1]
|
||||
|
||||
// Specify how the sample COO service is monitored
|
||||
include::modules/monitoring-specifying-how-a-service-is-monitored-by-cluster-observability-operator.adoc[leveloffset=+1]
|
||||
|
||||
// Create a MonitoringStack object to discover the service monitor
|
||||
include::modules/monitoring-creating-a-monitoringstack-object-for-cluster-observability-operator.adoc[leveloffset=+1]
|
||||
|
||||
// Validate a MonitoringStack
|
||||
include::modules/monitoring-validating-a-monitoringstack-for-cluster-observability-operator.adoc[leveloffset=+1]
|
||||
|
||||
// Scrape targets in multiple namespaces
|
||||
include::modules/monitoring-scrape-targets-in-multiple-namespaces.adoc[leveloffset=+1]
|
||||
@@ -1,19 +0,0 @@
|
||||
:_mod-docs-content-type: ASSEMBLY
|
||||
[id="installing-cluster-observability-operators"]
|
||||
= Installing the {coo-full}
|
||||
include::_attributes/common-attributes.adoc[]
|
||||
:context: installing_the_cluster_observability_operator
|
||||
|
||||
toc::[]
|
||||
|
||||
As a cluster administrator, you can install or remove the {coo-first} from the software catalog by using the {product-title} web console.
|
||||
The software catalog is a user interface that works in conjunction with Operator Lifecycle Manager (OLM), which installs and manages Operators on a cluster.
|
||||
|
||||
// Installing the COO using the OCP web console
|
||||
include::modules/monitoring-installing-cluster-observability-operator-using-the-web-console.adoc[leveloffset=+1]
|
||||
|
||||
.Additional resources
|
||||
xref:../../operators/admin/olm-adding-operators-to-cluster.adoc#olm-adding-operators-to-a-cluster[Adding Operators to a cluster]
|
||||
|
||||
// Uninstalling COO using the OCP web console
|
||||
include::modules/monitoring-uninstalling-cluster-observability-operator-using-the-web-console.adoc[leveloffset=+1]
|
||||
@@ -1 +0,0 @@
|
||||
../../../_attributes/
|
||||
@@ -1,21 +0,0 @@
|
||||
:_mod-docs-content-type: ASSEMBLY
|
||||
[id="dashboard-ui-plugin"]
|
||||
= Dashboard UI plugin
|
||||
include::_attributes/common-attributes.adoc[]
|
||||
:context: dashboard-ui-plugin
|
||||
|
||||
toc::[]
|
||||
|
||||
The dashboard UI plugin supports enhanced dashboards in the {product-title} web console at *Observe* -> *Dashboards* . You can add other Prometheus datasources from the cluster to the default dashboards, in addition to the in-cluster datasource. This results in a unified observability experience across different data sources.
|
||||
|
||||
The plugin searches for datasources from `ConfigMap` resources in the `openshift-config-managed` namespace, that have the label `console.openshift.io/dashboard-datasource: 'true'`.
|
||||
|
||||
include::modules/coo-dashboard-ui-plugin-install.adoc[leveloffset=+1]
|
||||
|
||||
include::modules/coo-dashboard-ui-plugin-configure.adoc[leveloffset=+1]
|
||||
|
||||
[role="_additional-resources"]
|
||||
[id="additional-resources_{context}"]
|
||||
== Additional resources
|
||||
|
||||
* See how to link:https://github.com/openshift/console-dashboards-plugin/blob/main/docs/add-datasource.md[add a new datasource] in the link:https://github.com/openshift/console-dashboards-plugin[console-dashboards-plugin] GitHub repository.
|
||||
@@ -1,15 +0,0 @@
|
||||
:_mod-docs-content-type: ASSEMBLY
|
||||
[id="distributed-tracing-ui-plugin"]
|
||||
= Distributed tracing UI plugin
|
||||
include::_attributes/common-attributes.adoc[]
|
||||
:context: distributed-tracing-ui-plugin
|
||||
|
||||
toc::[]
|
||||
|
||||
include::snippets/unified-perspective-web-console.adoc[]
|
||||
|
||||
The distributed tracing UI plugin adds tracing-related features to the {product-title} web console at **Observe** -> **Traces**. You can follow requests through the front end and into the backend of microservices, helping you identify code errors and performance bottlenecks in distributed systems.
|
||||
|
||||
include::modules/coo-distributed-tracing-ui-plugin-install.adoc[leveloffset=+1]
|
||||
|
||||
include::modules/coo-distributed-tracing-ui-plugin-using.adoc[leveloffset=+1]
|
||||
@@ -1 +0,0 @@
|
||||
../../../images/
|
||||
@@ -1,34 +0,0 @@
|
||||
:_mod-docs-content-type: ASSEMBLY
|
||||
[id="logging-ui-plugin"]
|
||||
= Logging UI plugin
|
||||
include::_attributes/common-attributes.adoc[]
|
||||
:context: logging-ui-plugin
|
||||
|
||||
toc::[]
|
||||
|
||||
include::snippets/unified-perspective-web-console.adoc[]
|
||||
|
||||
The logging UI plugin surfaces logging data in the {product-title} web console on the *Observe* -> *Logs* page.
|
||||
You can specify filters, queries, time ranges and refresh rates, with the results displayed as a list of collapsed logs, which can then be expanded to show more detailed information for each log.
|
||||
|
||||
If you also deploy the Troubleshooting UI plugin on {product-title} version 4.16+, it connects to the Korrel8r service and adds direct links to the web console, from the **Observe** -> **Logs** page, to the **Observe** -> **Metrics** page with a correlated PromQL query. The plugin also adds a **See Related Logs** link from the web console alerting detail page, at **Observe** -> **Alerting**, to the **Observe** -> **Logs** page with a correlated filter set selected.
|
||||
|
||||
The features of the plugin are categorized as:
|
||||
|
||||
dev-console:: Adds the logging view to the web console.
|
||||
alerts:: Merges the web console alerts with log-based alerts defined in the Loki ruler. Adds a log-based metrics chart in the alert detail view.
|
||||
dev-alerts:: Merges the web console alerts with log-based alerts defined in the Loki ruler. Adds a log-based metrics chart in the alert detail view for the web console.
|
||||
|
||||
|
||||
For {coo-first} versions, the support for these features in {product-title} versions is shown in the following table:
|
||||
|
||||
[cols="1,1,3", options="header"]
|
||||
|===
|
||||
| COO version | OCP versions | Features
|
||||
|
||||
| 0.3.0+ | 4.12 | `dev-console`
|
||||
| 0.3.0+ | 4.13 | `dev-console`, `alerts`
|
||||
| 0.3.0+ | 4.14+ | `dev-console`, `alerts`, `dev-alerts`
|
||||
|===
|
||||
|
||||
include::modules/coo-logging-ui-plugin-install.adoc[leveloffset=+1]
|
||||
@@ -1 +0,0 @@
|
||||
../../../modules/
|
||||
@@ -1,26 +0,0 @@
|
||||
:_mod-docs-content-type: ASSEMBLY
|
||||
[id="monitoring-ui-plugin"]
|
||||
= Monitoring UI plugin
|
||||
include::_attributes/common-attributes.adoc[]
|
||||
:context: monitoring-ui-plugin
|
||||
|
||||
toc::[]
|
||||
|
||||
:FeatureName: The {coo-full} monitoring UI plugin
|
||||
include::snippets/technology-preview.adoc[leveloffset=+2]
|
||||
|
||||
include::snippets/unified-perspective-web-console.adoc[]
|
||||
|
||||
The monitoring UI plugin adds monitoring features to the {product-title} web console.
|
||||
|
||||
* **{rh-rhacm}:** The monitoring plugin in {coo-first} allows it to function in {rh-rhacm-first} environments, providing {rh-rhacm} with the same alerting capabilities as {product-title}. You can configure the plugin to fetch alerts from the {rh-rhacm} Alertmanager backend. This enables seamless integration and user experience by aligning {rh-rhacm} and {product-title} monitoring workflows.
|
||||
|
||||
* **Incident detection:** The incident detection feature groups related alerts into incidents, to help you identify the root causes of alert bursts, instead of being overwhelmed by individual alerts. It presents a timeline of incidents, color-coded by severity, and you can drill down into the individual alerts within an incident. The system also categorizes alerts by affected component, grouped by severity. This helps you focus on the most critical areas first.
|
||||
+
|
||||
The incident detection feature is available in the {product-title} web console at **Observe** → **Incidents**.
|
||||
|
||||
include::modules/coo-monitoring-ui-plugin-install.adoc[leveloffset=+1]
|
||||
|
||||
include::modules/coo-incident-detection-overview.adoc[leveloffset=+1]
|
||||
|
||||
include::modules/coo-incident-detection-using.adoc[leveloffset=+1]
|
||||
@@ -1,64 +0,0 @@
|
||||
:_mod-docs-content-type: ASSEMBLY
|
||||
[id="observability-ui-plugins-overview"]
|
||||
= Observability UI plugins overview
|
||||
include::_attributes/common-attributes.adoc[]
|
||||
:context: observability-ui-plugins-overview
|
||||
|
||||
toc::[]
|
||||
|
||||
You can use the {coo-first} to install and manage UI plugins to enhance the observability capabilities of the {product-title} web console.
|
||||
The plugins extend the default functionality, providing new UI features for troubleshooting, distributed tracing, and cluster logging.
|
||||
|
||||
[id="monitoring_{context}"]
|
||||
== Monitoring
|
||||
|
||||
The monitoring UI plugin adds monitoring related UI features to the {product-title} web console, for the Advance Cluster Management (ACM) perspective and for incident detection.
|
||||
|
||||
* **ACM:** The monitoring plugin in {coo-first} allows it to function in {rh-rhacm-first} environments, providing ACM with the same monitoring capabilities as {product-title}.
|
||||
|
||||
* **Incident Detection:** The incident detection feature groups alerts into incidents to help you identify the root causes of alert bursts instead of being overwhelmed by individual alerts. It presents a timeline of incidents, color-coded by severity, and you can drill down into the individual alerts within an incident. The system also categorizes alerts by affected component to help you focus on the most critical areas first.
|
||||
|
||||
For more information, see the xref:../../../observability/cluster_observability_operator/ui_plugins/monitoring-ui-plugin.adoc#monitoring-ui-plugin[monitoring UI plugin] page.
|
||||
|
||||
[id="cluster-logging_{context}"]
|
||||
== Cluster logging
|
||||
|
||||
The logging UI plugin surfaces logging data in the web console on the *Observe* -> *Logs* page.
|
||||
You can specify filters, queries, time ranges and refresh rates. The results displayed a list of collapsed logs, which can then be expanded to show more detailed information for each log.
|
||||
|
||||
For more information, see the xref:../../../observability/cluster_observability_operator/ui_plugins/logging-ui-plugin.adoc#logging-ui-plugin[logging UI plugin] page.
|
||||
|
||||
[id="troubleshooting_{context}"]
|
||||
== Troubleshooting
|
||||
|
||||
:FeatureName: The {coo-full} troubleshooting panel UI plugin
|
||||
include::snippets/technology-preview.adoc[leveloffset=+2]
|
||||
|
||||
The troubleshooting panel UI plugin for {product-title} version 4.16+ provides observability signal correlation, powered by the open source Korrel8r project.
|
||||
You can use the troubleshooting panel available from the *Observe* -> *Alerting* page to easily correlate metrics, logs, alerts, netflows, and additional observability signals and resources, across different data stores.
|
||||
Users of {product-title} version 4.17+ can also access the troubleshooting UI panel from the Application Launcher {launch}.
|
||||
|
||||
The output of Korrel8r is displayed as an interactive node graph. When you click on a node, you are automatically redirected to the corresponding web console page with the specific information for that node, for example, metric, log, or pod.
|
||||
|
||||
For more information, see the xref:../../../observability/cluster_observability_operator/ui_plugins/troubleshooting-ui-plugin.adoc#troubleshooting-ui-plugin[troubleshooting UI plugin] page.
|
||||
|
||||
[id="distributed-tracing_{context}"]
|
||||
== Distributed tracing
|
||||
|
||||
The distributed tracing UI plugin adds tracing-related features to the web console on the *Observe* -> *Traces* page.
|
||||
You can follow requests through the front end and into the backend of microservices, helping you identify code errors and performance bottlenecks in distributed systems.
|
||||
You can select a supported `TempoStack` or `TempoMonolithic` multi-tenant instance running in the cluster and set a time range and query to view the trace data.
|
||||
|
||||
For more information, see the xref:../../../observability/cluster_observability_operator/ui_plugins/distributed-tracing-ui-plugin.adoc#distributed-tracing-ui-plugin[distributed tracing UI plugin] page.
|
||||
|
||||
////
|
||||
[id="dashboards_{context}"]
|
||||
== Dashboards
|
||||
|
||||
The dashboard UI plugin supports enhanced dashboards in the {product-title} web console at *Observe* -> *Dashboards*.
|
||||
You can add other Prometheus data sources from the cluster to the default dashboards, in addition to the in-cluster data source.
|
||||
This results in a unified observability experience across different data sources.
|
||||
|
||||
For more information, see the xref :../../../observability/cluster_observability_operator/ui_plugins/dashboard-ui-plugin.adoc#dashboard-ui-plugin[dashboard UI plugin] page.
|
||||
|
||||
////
|
||||
@@ -1 +0,0 @@
|
||||
../../../snippets/
|
||||
@@ -1,26 +0,0 @@
|
||||
:_mod-docs-content-type: ASSEMBLY
|
||||
[id="troubleshooting-ui-plugin"]
|
||||
= Troubleshooting UI plugin
|
||||
include::_attributes/common-attributes.adoc[]
|
||||
:context: troubleshooting-ui-plugin
|
||||
|
||||
toc::[]
|
||||
|
||||
:FeatureName: The {coo-full} troubleshooting panel UI plugin
|
||||
include::snippets/technology-preview.adoc[leveloffset=+2]
|
||||
|
||||
The troubleshooting UI plugin for {product-title} version 4.16+ provides observability signal correlation, powered by the open source Korrel8r project.
|
||||
With the troubleshooting panel that is available under *Observe* -> *Alerting*, you can easily correlate metrics, logs, alerts, netflows, and additional observability signals and resources, across different data stores.
|
||||
Users of {product-title} version 4.17+ can also access the troubleshooting UI panel from the Application Launcher {launch}.
|
||||
|
||||
When you install the troubleshooting UI plugin, a link:https://github.com/korrel8r/korrel8r[Korrel8r] service named `korrel8r` is deployed in the same namespace, and it is able to locate related observability signals and Kubernetes resources from its correlation engine.
|
||||
|
||||
The output of Korrel8r is displayed in the form of an interactive node graph in the {product-title} web console.
|
||||
Nodes in the graph represent a type of resource or signal, while edges represent relationships.
|
||||
When you click on a node, you are automatically redirected to the corresponding web console page with the specific information for that node, for example, metric, log, pod.
|
||||
|
||||
include::modules/coo-troubleshooting-ui-plugin-install.adoc[leveloffset=+1]
|
||||
|
||||
include::modules/coo-troubleshooting-ui-plugin-using.adoc[leveloffset=+1]
|
||||
|
||||
include::modules/coo-troubleshooting-ui-plugin-creating-alert.adoc[leveloffset=+1]
|
||||
Reference in New Issue
Block a user