Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: add description field to CSV base #366

Merged
merged 3 commits into from
Oct 5, 2023
Merged

fix: add description field to CSV base #366

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b95c5d6
fix: add description field to CSV base
marioferh Sep 28, 2023
447fa95
fix: delete dots at the end of the description
marioferh Sep 28, 2023
3120119
fix: improve AlertmanagerConfig
marioferh Oct 4, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 41 additions & 13 deletions bundle/manifests/observability-operator.clusterserviceversion.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ metadata:
categories: Monitoring
certified: "false"
containerImage: observability-operator:0.0.25
createdAt: "2023-09-19T09:54:01Z"
createdAt: "2023-09-28T09:06:52Z"
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
Expand All @@ -59,40 +59,68 @@ spec:
apiservicedefinitions: {}
customresourcedefinitions:
owned:
- kind: AlertmanagerConfig
- description: AlertmanagerConfig defines a namespaced AlertmanagerConfig to be
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Did you take a look at the UI rendering? I think it should be shorter to fit into the box, like in Gabriel's example

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It is ok, thanks!

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

image

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You can use https://operatorhub.io/preview to preview the bundle/csv.yaml
I think we can improve the AlertmanagerConfig a bit .. (ask chatgpt :D )

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

BTW, are we now supporting all these API?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In a cluster this is the result:
image

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"AlertmanagerConfig is used to define configurations for Prometheus Alertmanager, specifying how alerts are handled and routed for notifications."

Something like this?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@simonpasquier would be the best judge of this :) .. BTW, for the record, this was only a suggestion and shouldn't block the PR from merging.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

small suggestion compared to @marioferh

... specifying how alerts are grouped and notified to external systems.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@simonpasquier prometheus-operator/prometheus-operator#5955

aggregated across multiple namespaces configuring one Alertmanager cluster.
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+
Expand Down
64 changes: 64 additions & 0 deletions deploy/olm/bases/observability-operator.clusterserviceversion.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,70 @@ metadata:
namespace: placeholder
spec:
apiservicedefinitions: {}
customresourcedefinitions:
owned:
- description: AlertmanagerConfig defines a namespaced AlertmanagerConfig to
be aggregated across multiple namespaces configuring one Alertmanager cluster.
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
Expand Down