Skip to content

feat: add controller for clusterobservability #784

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

pavolloffay
Copy link
Member

@pavolloffay pavolloffay commented Jun 20, 2025

Updates #757

This PR adds controller for the ClusterObservability CR. The controller is enabled only on Openshift - when --openshift.enabled=true.

This PR does not add ClusterObservability CR to the bundle so even when the --openshift.enabled=true the implementation is not usable. This is on purpose, the feature will be enabled later on once all items from #757 are resolved.

To deploy the operator with this feature set --openshift.enabled=true and enable the CR

- observability.openshift.io_uiplugins.yaml

Copy link

openshift-ci bot commented Jun 20, 2025

Skipping CI for Draft Pull Request.
If you want CI signal for your change, please convert it to an actual PR.
You can still manually trigger a test run with /test all

Copy link

openshift-ci bot commented Jun 20, 2025

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: pavolloffay
Once this PR has been reviewed and has the lgtm label, please assign alanconway for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@pavolloffay pavolloffay mentioned this pull request Jun 20, 2025
9 tasks
@pavolloffay pavolloffay force-pushed the cluster-obser-controller branch from c456486 to fe833c8 Compare June 20, 2025 11:59
@pavolloffay pavolloffay marked this pull request as ready for review June 20, 2025 12:13
@pavolloffay pavolloffay requested a review from a team as a code owner June 20, 2025 12:13
@pavolloffay pavolloffay requested review from simonpasquier and PeterYurkovich and removed request for a team June 20, 2025 12:13
@openshift-ci openshift-ci bot requested a review from marioferh June 20, 2025 12:13
@pavolloffay pavolloffay force-pushed the cluster-obser-controller branch from fe833c8 to f8413ee Compare June 20, 2025 12:24
@pavolloffay pavolloffay force-pushed the cluster-obser-controller branch from f8413ee to e1177ba Compare June 20, 2025 15:49
Copy link

openshift-ci bot commented Jun 20, 2025

@pavolloffay: The following test failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name Commit Details Required Rerun command
ci/prow/observability-operator-e2e e1177ba link true /test observability-operator-e2e

Full PR test history. Your PR dashboard.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here.

@simonpasquier simonpasquier requested review from jan--f and removed request for PeterYurkovich and marioferh June 23, 2025 08:19
@jan--f
Copy link
Collaborator

jan--f commented Jun 26, 2025

Thanks and apologies for the latency in reviewing this. Since iiuc the original design doc is a bit outdated I'll leave some stuff here for now, but perhaps its worth it updating the original doc or setup a new one.

I think we can discuss three facets of this for a bit of structure: sane default configurations for operators, an API that covers multiple signals and the (perhaps optional) installation of additional operators via Subscriptions.
Currently all of these are wrapped up in a single API and while those three features certainly have dependencies, I think a bit more separation would be good to have.

  1. We had discussions before that perhaps it would be better for default configs to not just exist in an operator. There are OpenShift flavors that don't bring OLM but rely on other install methods. Can we address this within this proposal?

  2. I'm not sure I understand the CommonCapabilitiesSpec type very well. What is the use case to disable capabilities but install them? Wouldn't that just duplicate the functionality the user has already by creating a Subscription CR?
    Perhaps it might be better to ask the user to supply names of subscription CRs to use for a given signal. If the CR exists there is no need to install, otherwise we create the Subscription. If there is no subscription configured for a given signal, the components will not be deployed.
    We can then also require at least on operator subscription to be present to avoid a CR that has no effect.

  3. The install flow would be addressed by directly referencing a subscription and creating it if its not found. Additionally identifying an existing subscription would allow us to get some information from it and create more detailed status entries, e.g. about compatibility issues.

@openshift-merge-robot
Copy link
Collaborator

PR needs rebase.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

OpenTelemetry string `json:"opentelemetry,omitempty"`
// Tempo defines the status of the Tempo capability.
// +optional
Tempo string `json:"tempo,omitempty"`
Copy link
Contributor

Choose a reason for hiding this comment

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

Just out of curiosity. What would be the value of these strings?

Is the idea here (in the ClusterObservabilityStatus) to somehow aggregate the status of all the capabilities/components involved? I think it can be quite complicated and with an unclear outcome.

@@ -94,5 +120,5 @@ type OperatorsSpec struct {
// When the capability is enabled, the install is set to true, otherwise it is set to false.
// +optional
// +kubebuilder:validation:Optional
Install bool `json:"install,omitempty"`
Install *bool `json:"install,omitempty"`
Copy link
Contributor

Choose a reason for hiding this comment

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

I think this is related to Jan's comment and I am not sure I understand it (and yes I probably missed that in the previous PR so apologies). I thought when a capability is enabled then everything required is installed. It's not the case?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants