fix: add description field to CSV base (#366)

* fix: add description field to CSV base Signed-off-by: Mario Fernandez <[email protected]> * fix: delete dots at the end of the description Signed-off-by: Mario Fernandez <[email protected]> * fix: improve AlertmanagerConfig Signed-off-by: Mario Fernandez <[email protected]> --------- Signed-off-by: Mario Fernandez <[email protected]>
rhobs · Oct 5, 2023 · 22bb08b · 22bb08b
1 parent 5cc74ba
commit 22bb08b
Show file tree

Hide file tree

Showing 2 changed files with 105 additions and 13 deletions.
diff --git a/bundle/manifests/observability-operator.clusterserviceversion.yaml b/bundle/manifests/observability-operator.clusterserviceversion.yaml
@@ -42,7 +42,7 @@ metadata:
     categories: Monitoring
     certified: "false"
     containerImage: observability-operator:0.0.25
-    createdAt: "2023-09-19T09:54:01Z"
+    createdAt: "2023-10-04T08:52:37Z"
     description: A Go based Kubernetes operator to setup and manage highly available
       Monitoring Stack using Prometheus, Alertmanager and Thanos Querier.
     operators.operatorframework.io/builder: operator-sdk-v1.31.0
@@ -59,40 +59,68 @@ spec:
   apiservicedefinitions: {}
   customresourcedefinitions:
     owned:
-    - kind: AlertmanagerConfig
+    - description: AlertmanagerConfig configures the Prometheus Alertmanager, specifying
+        how alerts should be grouped, inhibited and notified to external systems
+      displayName: AlertmanagerConfig
+      kind: AlertmanagerConfig
       name: alertmanagerconfigs.monitoring.rhobs
       version: v1alpha1
-    - kind: Alertmanager
+    - description: Alertmanager describes an Alertmanager cluster
+      displayName: Alertmanager
+      kind: Alertmanager
       name: alertmanagers.monitoring.rhobs
       version: v1
-    - kind: MonitoringStack
+    - description: MonitoringStack is the Schema for the monitoringstacks API
+      displayName: MonitoringStack
+      kind: MonitoringStack
       name: monitoringstacks.monitoring.rhobs
       version: v1alpha1
-    - kind: PodMonitor
+    - description: PodMonitor defines monitoring for a set of pods
+      displayName: PodMonitor
+      kind: PodMonitor
       name: podmonitors.monitoring.rhobs
       version: v1
-    - kind: Probe
+    - description: Probe defines monitoring for a set of static targets or ingresses
+      displayName: Probe
+      kind: Probe
       name: probes.monitoring.rhobs
       version: v1
-    - kind: PrometheusAgent
+    - description: PrometheusAgent defines a Prometheus agent deployment
+      displayName: PrometheusAgent
+      kind: PrometheusAgent
       name: prometheusagents.monitoring.rhobs
       version: v1alpha1
-    - kind: Prometheus
+    - description: Prometheus defines a Prometheus deployment
+      displayName: Prometheus
+      kind: Prometheus
       name: prometheuses.monitoring.rhobs
       version: v1
-    - kind: PrometheusRule
+    - description: PrometheusRule defines recording and alerting rules for a Prometheus
+        instance
+      displayName: PrometheusRule
+      kind: PrometheusRule
       name: prometheusrules.monitoring.rhobs
       version: v1
-    - kind: ScrapeConfig
+    - description: ScrapeConfig defines a namespaced Prometheus scrape_config to be
+        aggregated across multiple namespaces into the Prometheus configuration
+      displayName: ScrapeConfig
+      kind: ScrapeConfig
       name: scrapeconfigs.monitoring.rhobs
       version: v1alpha1
-    - kind: ServiceMonitor
+    - description: ServiceMonitor defines monitoring for a set of services
+      displayName: ServiceMonitor
+      kind: ServiceMonitor
       name: servicemonitors.monitoring.rhobs
       version: v1
-    - kind: ThanosQuerier
+    - description: ThanosQuerier outlines the Thanos querier components, managed by
+        this stack
+      displayName: ThanosQuerier
+      kind: ThanosQuerier
       name: thanosqueriers.monitoring.rhobs
       version: v1alpha1
-    - kind: ThanosRuler
+    - description: ThanosRuler defines a ThanosRuler deployment
+      displayName: ThanosRuler
+      kind: ThanosRuler
       name: thanosrulers.monitoring.rhobs
       version: v1
   description: |2+

diff --git a/deploy/olm/bases/observability-operator.clusterserviceversion.yaml b/deploy/olm/bases/observability-operator.clusterserviceversion.yaml
@@ -21,6 +21,70 @@ metadata:
   namespace: placeholder
 spec:
   apiservicedefinitions: {}
+  customresourcedefinitions:
+    owned:
+    - description: AlertmanagerConfig configures the Prometheus Alertmanager, specifying how alerts should be grouped,
+        inhibited and notified to external systems
+      displayName: AlertmanagerConfig
+      kind: AlertmanagerConfig
+      name: alertmanagerconfigs.monitoring.rhobs
+      version: v1alpha1
+    - description: Alertmanager describes an Alertmanager cluster
+      displayName: Alertmanager
+      kind: Alertmanager
+      name: alertmanagers.monitoring.rhobs
+      version: v1
+    - description: MonitoringStack is the Schema for the monitoringstacks API
+      displayName: MonitoringStack
+      kind: MonitoringStack
+      name: monitoringstacks.monitoring.rhobs
+      version: v1alpha1
+    - description: PodMonitor defines monitoring for a set of pods
+      displayName: PodMonitor
+      kind: PodMonitor
+      name: podmonitors.monitoring.rhobs
+      version: v1
+    - description: Probe defines monitoring for a set of static targets or ingresses
+      displayName: Probe
+      kind: Probe
+      name: probes.monitoring.rhobs
+      version: v1
+    - description: PrometheusAgent defines a Prometheus agent deployment
+      displayName: PrometheusAgent
+      kind: PrometheusAgent
+      name: prometheusagents.monitoring.rhobs
+      version: v1alpha1
+    - description: Prometheus defines a Prometheus deployment
+      displayName: Prometheus
+      kind: Prometheus
+      name: prometheuses.monitoring.rhobs
+      version: v1
+    - description: PrometheusRule defines recording and alerting rules for a Prometheus instance
+      displayName: PrometheusRule
+      kind: PrometheusRule
+      name: prometheusrules.monitoring.rhobs
+      version: v1
+    - description: ScrapeConfig defines a namespaced Prometheus scrape_config to be aggregated across 
+        multiple namespaces into the Prometheus configuration
+      displayName: ScrapeConfig
+      kind: ScrapeConfig
+      name: scrapeconfigs.monitoring.rhobs
+      version: v1alpha1
+    - description: ServiceMonitor defines monitoring for a set of services
+      displayName: ServiceMonitor
+      kind: ServiceMonitor
+      name: servicemonitors.monitoring.rhobs
+      version: v1
+    - description: ThanosQuerier outlines the Thanos querier components, managed by this stack
+      displayName: ThanosQuerier
+      kind: ThanosQuerier
+      name: thanosqueriers.monitoring.rhobs
+      version: v1alpha1
+    - description: ThanosRuler defines a ThanosRuler deployment
+      displayName: ThanosRuler
+      kind: ThanosRuler
+      name: thanosrulers.monitoring.rhobs
+      version: v1
   description: >+
 
     Observability Operator is a Go based Kubernetes operator to setup and