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.

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

feat: make operator publishable to openshift community-catalog #295

Merged
merged 2 commits into from
May 31, 2023

Conversation

sthaha
Copy link
Collaborator

@sthaha sthaha commented May 26, 2023

The changes made here aligns with the 0.0.21 bundle submitted to community catalog - redhat-openshift-ecosystem/community-operators-prod#2712

@sthaha sthaha requested a review from a team as a code owner May 26, 2023 04:59
@@ -39,6 +39,10 @@ metadata:
}
]
capabilities: Basic Install
categories: Monitoring, Observability
certified: "false"
description: A go based operator to create and manage highly available Prometheus
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
description: A go based operator to create and manage highly available Prometheus
description: A Go based operator to create and manage highly available Prometheus

observability.
description: |2+

Observability Operator is an operator created in Go to setup and manage highly available Monitoring Stack using Prometheus and Thanos Querier.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
Observability Operator is an operator created in Go to setup and manage highly available Monitoring Stack using Prometheus and Thanos Querier.
Observability Operator is an operator created in Go to setup and manage highly available Prometheus monitoring stack.

Copy link
Member

Choose a reason for hiding this comment

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

I felt its better to have description similar on line 44 and 97 since we didn't mention about Thanos querier earlier. I felt its bit confusing seeing two different descriptions. Leaving up to you which one to choose :)

Copy link
Collaborator Author

@sthaha sthaha May 29, 2023

Choose a reason for hiding this comment

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

I will change the description (short) above to

      A Go based operator to setup and manage highly available Monitoring Stack
      using Prometheus and Thanos Querier.

Both descriptions are different since they appear in different places on UI. The first one has to be concise.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Use: https://operatorhub.io/preview to preview how OLM renders this.

Observability Operator is an operator created in Go to setup and manage highly available Monitoring Stack using Prometheus and Thanos Querier.
### Supported Features
- Setup multiple Highly Available Prometheus monitoring stack
- Customizable configuration for managing Prometheus deployments
Copy link
Member

Choose a reason for hiding this comment

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

Also supports Thanos Querier and Ruler deployment as well?

Copy link
Contributor

Choose a reason for hiding this comment

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

I'd mention Alertmanager and Thanos Querier. It doesn't support Thanos Ruler directly.

description: >+

Observability Operator is an operator created in Go to setup and manage
highly available Monitoring Stack using Prometheus and Thanos Querier.
Copy link
Member

Choose a reason for hiding this comment

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

Same description related comment above

@sthaha sthaha marked this pull request as draft May 29, 2023 05:00
@sthaha
Copy link
Collaborator Author

sthaha commented May 29, 2023

I have converted this to draft to avoid multiple reviews of this PR.
Lets wait for redhat-openshift-ecosystem/community-operators-prod#2712 to merge first. Please feel free to comment on that PR 🙏 .

sthaha added 2 commits May 30, 2023 16:05
This PR incorporates all changes required for the operator to be
published to the community-catalog (see PR) such as ...
  - requirement to add CSV.metadata.annotation.containerImage
  - proper description
  - links to repo

PR: redhat-openshift-ecosystem/community-operators-prod#2712
@sthaha sthaha changed the title feat: improve operator CSV documentation and metadata feat: feat: make operator publishable to openshift community-catalog May 30, 2023
@sthaha sthaha changed the title feat: feat: make operator publishable to openshift community-catalog feat: make operator publishable to openshift community-catalog May 30, 2023
@sthaha sthaha marked this pull request as ready for review May 30, 2023 06:34
@sthaha sthaha merged commit 5e0f6c3 into rhobs:main May 31, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants