Skip to content

Commit 3c9aed1

Browse files
committed
fix: [COO-1313] Add missing description for ObservabilityInstaller in OpenShift console
🤖 Assisted by Claude Code
1 parent e38a3f6 commit 3c9aed1

File tree

4 files changed

+60
-3
lines changed

4 files changed

+60
-3
lines changed

bundle/manifests/observability-operator.clusterserviceversion.yaml

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ metadata:
4242
categories: Monitoring
4343
certified: "false"
4444
containerImage: observability-operator:1.3.0
45-
createdAt: "2025-11-03T09:23:49Z"
45+
createdAt: "2025-11-07T04:13:59Z"
4646
description: A Go based Kubernetes operator to setup and manage highly available
4747
Monitoring Stack using Prometheus, Alertmanager and Thanos Querier.
4848
operatorframework.io/cluster-monitoring: "true"
@@ -80,7 +80,10 @@ spec:
8080
kind: MonitoringStack
8181
name: monitoringstacks.monitoring.rhobs
8282
version: v1alpha1
83-
- kind: ObservabilityInstaller
83+
- description: Provides end-to-end observability capabilities with minimal configuration.
84+
Simplifies deployment and management of observability components such as tracing.
85+
displayName: Observability Installer
86+
kind: ObservabilityInstaller
8487
name: observabilityinstallers.observability.openshift.io
8588
version: v1alpha1
8689
- description: Perses is the Schema for the perses API

deploy/olm/bases/observability-operator.clusterserviceversion.yaml

Lines changed: 36 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,37 @@ apiVersion: operators.coreos.com/v1alpha1
22
kind: ClusterServiceVersion
33
metadata:
44
annotations:
5-
alm-examples: "[]"
5+
alm-examples: |-
6+
[
7+
{
8+
"apiVersion": "observability.openshift.io/v1alpha1",
9+
"kind": "ObservabilityInstaller",
10+
"metadata": {
11+
"name": "sample-observability",
12+
"namespace": "observability"
13+
},
14+
"spec": {
15+
"capabilities": {
16+
"tracing": {
17+
"enabled": true,
18+
"storage": {
19+
"objectStorage": {
20+
"s3": {
21+
"bucket": "tempo",
22+
"endpoint": "http://minio.minio.svc:9000",
23+
"accessKeyID": "tempo",
24+
"accessKeySecret": {
25+
"name": "minio-secret",
26+
"key": "access_key_secret"
27+
}
28+
}
29+
}
30+
}
31+
}
32+
}
33+
}
34+
}
35+
]
636
capabilities: Basic Install
737
categories: Monitoring
838
certified: "false"
@@ -45,6 +75,11 @@ spec:
4575
kind: MonitoringStack
4676
name: monitoringstacks.monitoring.rhobs
4777
version: v1alpha1
78+
- description: Provides end-to-end observability capabilities with minimal configuration. Simplifies deployment and management of observability components such as tracing.
79+
displayName: Observability Installer
80+
kind: ObservabilityInstaller
81+
name: observabilityinstallers.observability.openshift.io
82+
version: v1alpha1
4883
- description: PodMonitor defines monitoring for a set of pods
4984
displayName: PodMonitor
5085
kind: PodMonitor
Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
apiVersion: observability.openshift.io/v1alpha1
2+
kind: ObservabilityInstaller
3+
metadata:
4+
name: sample-observability
5+
namespace: observability
6+
spec:
7+
capabilities:
8+
tracing:
9+
enabled: true
10+
storage:
11+
objectStorage:
12+
s3:
13+
bucket: tempo
14+
endpoint: http://minio.minio.svc:9000
15+
accessKeyID: tempo
16+
accessKeySecret:
17+
name: minio-secret
18+
key: access_key_secret

pkg/apis/observability/v1alpha1/types.go

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ import (
1616
// +kubebuilder:printcolumn:name="OpenTelemetry",type="string",JSONPath=".status.opentelemetry"
1717
// +kubebuilder:printcolumn:name="Tempo",type="string",JSONPath=".status.tempo"
1818
// +operator-sdk:csv:customresourcedefinitions:displayName="Observability Installer"
19+
// +operator-sdk:csv:customresourcedefinitions:description="Provides end-to-end observability capabilities with minimal configuration. Simplifies deployment and management of observability components such as tracing."
1920
// +kubebuilder:metadata:annotations="observability.openshift.io/api-support=TechPreview"
2021
type ObservabilityInstaller struct {
2122
metav1.TypeMeta `json:",inline"`

0 commit comments

Comments
 (0)