Skip to content

refactor: use kustomize overlays for ObservabilityInstaller and UIPlugin - #1206

Closed
alanconway wants to merge 2 commits into
rhobs:mainfrom
alanconway:kustomize-stack
Closed

refactor: use kustomize overlays for ObservabilityInstaller and UIPlugin#1206
alanconway wants to merge 2 commits into
rhobs:mainfrom
alanconway:kustomize-stack

Conversation

@alanconway

Copy link
Copy Markdown
Contributor

Replace Go struct resources with kustomize overlay building in controllers.
See config/README.md for more info.

Add embedded kustomize component trees under config/ for

  • ObservabilityInstaller (operator subscriptions and CRD instances)
  • UIPlugin types (dashboards, distributed-tracing, logging, troubleshooting-panel, korrel8r).

Each capability is split into

  • operator/ (namespaces, operatorgroups, subscriptions)
  • resources/ (CRD instances, RBAC) directories.

Parity tests verify that:

  • generator output matches "golden output" based on COO 1.5.1
  • generator and operator output match each other.

Kustomize-style offline manifest generator (cmd/generator) transforms
ObservabilityInstaller and UIPlugin CRs plus support files
into the same resource set the operator would reconcile.

- Extract common GenerateInstallerObjects, GenerateUIPluginObjects for generator and reconciler.
- User secrets can be resolved offline as YAML resources or read from cluster with --cluster flag
  (Implemented by FallbackReader)
- Parity test for output of reconciler and generator.
Replace Go struct resources with kustomize overlay building in controllers.
See config/README.md for more info.

Add embedded kustomize component trees under config/ for
- ObservabilityInstaller (operator subscriptions and CRD instances)
- UIPlugin types (dashboards, distributed-tracing, logging, troubleshooting-panel, korrel8r).

Each capability is split into
- operator/ (namespaces, operatorgroups, subscriptions)
- resources/ (CRD instances, RBAC) directories.

Parity tests verify that:
- generator output matches "golden output" based on COO 1.5.1
- generator and operator output match each other.
@openshift-ci

openshift-ci Bot commented Aug 21, 2026

Copy link
Copy Markdown

[APPROVALNOTIFIER] This PR is NOT APPROVED

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

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

Details 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

@coderabbitai

coderabbitai Bot commented Aug 21, 2026

Copy link
Copy Markdown

Important

Review skipped

Too many files!

This PR contains 125 files, which is 25 over the limit of 100.

To get a review, reduce the PR to 100 files or fewer by splitting it into smaller PRs or changing its base branch.

Upgrade to a paid plan to raise the limit.

This review couldn't start because sufficient usage credits or metered capacity aren't available. Add credits or update usage-based reviews in the billing tab, then retry.

⚙️ Run configuration

Configuration used: Repository YAML (base), Organization UI (inherited)

Review profile: CHILL

Plan: Pro Plus

Run ID: 2caa1f2b-3ac7-4642-a8b6-1823d38aec98

📥 Commits

Reviewing files that changed from the base of the PR and between 20ac77b and 3b3b775.

⛔ Files ignored due to path filters (1)
  • go.sum is excluded by !**/*.sum
📒 Files selected for processing (125)
  • AGENT.md
  • AGENTS.md
  • Makefile
  • build/Dockerfile
  • cmd/generator/main.go
  • cmd/operator/main.go
  • config/README.md
  • config/fs.go
  • config/observabilityinstaller/base/kustomization.yaml
  • config/observabilityinstaller/components/tracing/collector/operator/kustomization.yaml
  • config/observabilityinstaller/components/tracing/collector/operator/subscription.yaml
  • config/observabilityinstaller/components/tracing/collector/resources/kustomization.yaml
  • config/observabilityinstaller/components/tracing/collector/resources/opentelemetrycollector.yaml
  • config/observabilityinstaller/components/tracing/collector/resources/rbac.yaml
  • config/observabilityinstaller/components/tracing/collector/resources/uiplugin.yaml
  • config/observabilityinstaller/components/tracing/store/operator/kustomization.yaml
  • config/observabilityinstaller/components/tracing/store/operator/subscription.yaml
  • config/observabilityinstaller/components/tracing/store/resources/kustomization.yaml
  • config/observabilityinstaller/components/tracing/store/resources/tempostack.yaml
  • config/uiplugins/components/consoleplugin/rhobs-v1/consoleplugin.yaml
  • config/uiplugins/components/consoleplugin/rhobs-v1/kustomization.yaml
  • config/uiplugins/components/consoleplugin/v1/consoleplugin.yaml
  • config/uiplugins/components/consoleplugin/v1/kustomization.yaml
  • config/uiplugins/components/consoleplugin/v1alpha1/consoleplugin.yaml
  • config/uiplugins/components/consoleplugin/v1alpha1/kustomization.yaml
  • config/uiplugins/components/dashboards/resources/deployment.yaml
  • config/uiplugins/components/dashboards/resources/kustomization.yaml
  • config/uiplugins/components/dashboards/resources/role.yaml
  • config/uiplugins/components/dashboards/resources/rolebinding.yaml
  • config/uiplugins/components/dashboards/resources/service.yaml
  • config/uiplugins/components/dashboards/resources/serviceaccount.yaml
  • config/uiplugins/components/distributed-tracing/resources/clusterrole.yaml
  • config/uiplugins/components/distributed-tracing/resources/clusterrolebinding.yaml
  • config/uiplugins/components/distributed-tracing/resources/configmap.yaml
  • config/uiplugins/components/distributed-tracing/resources/deployment.yaml
  • config/uiplugins/components/distributed-tracing/resources/kustomization.yaml
  • config/uiplugins/components/distributed-tracing/resources/service.yaml
  • config/uiplugins/components/distributed-tracing/resources/serviceaccount.yaml
  • config/uiplugins/components/logging/resources/clusterrole-application.yaml
  • config/uiplugins/components/logging/resources/clusterrole-audit.yaml
  • config/uiplugins/components/logging/resources/clusterrole-infrastructure.yaml
  • config/uiplugins/components/logging/resources/configmap.yaml
  • config/uiplugins/components/logging/resources/deployment.yaml
  • config/uiplugins/components/logging/resources/kustomization.yaml
  • config/uiplugins/components/logging/resources/service.yaml
  • config/uiplugins/components/logging/resources/serviceaccount.yaml
  • config/uiplugins/components/monitoring/health-analyzer/clusterrole.yaml
  • config/uiplugins/components/monitoring/health-analyzer/clusterrolebinding-cluster-monitoring-view.yaml
  • config/uiplugins/components/monitoring/health-analyzer/clusterrolebinding-components-health-view.yaml
  • config/uiplugins/components/monitoring/health-analyzer/clusterrolebinding-system-auth-delegator.yaml
  • config/uiplugins/components/monitoring/health-analyzer/configmap.yaml
  • config/uiplugins/components/monitoring/health-analyzer/deployment.yaml
  • config/uiplugins/components/monitoring/health-analyzer/kustomization.yaml
  • config/uiplugins/components/monitoring/health-analyzer/role-prometheus-k8s.yaml
  • config/uiplugins/components/monitoring/health-analyzer/rolebinding-alertmanager-view.yaml
  • config/uiplugins/components/monitoring/health-analyzer/rolebinding-prometheus-k8s.yaml
  • config/uiplugins/components/monitoring/health-analyzer/service.yaml
  • config/uiplugins/components/monitoring/health-analyzer/servicemonitor.yaml
  • config/uiplugins/components/monitoring/perses/clusterrole.yaml
  • config/uiplugins/components/monitoring/perses/clusterrolebinding-perses.yaml
  • config/uiplugins/components/monitoring/perses/clusterrolebinding-system-auth-delegator.yaml
  • config/uiplugins/components/monitoring/perses/kustomization.yaml
  • config/uiplugins/components/monitoring/perses/serviceaccount.yaml
  • config/uiplugins/components/monitoring/resources/deployment.yaml
  • config/uiplugins/components/monitoring/resources/kustomization.yaml
  • config/uiplugins/components/monitoring/resources/service.yaml
  • config/uiplugins/components/monitoring/resources/serviceaccount.yaml
  • config/uiplugins/components/troubleshooting-panel/korrel8r/korrel8r-clusterrole.yaml
  • config/uiplugins/components/troubleshooting-panel/korrel8r/korrel8r-clusterrolebinding.yaml
  • config/uiplugins/components/troubleshooting-panel/korrel8r/korrel8r-configmap.yaml
  • config/uiplugins/components/troubleshooting-panel/korrel8r/korrel8r-deployment.yaml
  • config/uiplugins/components/troubleshooting-panel/korrel8r/korrel8r-route.yaml
  • config/uiplugins/components/troubleshooting-panel/korrel8r/korrel8r-service.yaml
  • config/uiplugins/components/troubleshooting-panel/korrel8r/kustomization.yaml
  • config/uiplugins/components/troubleshooting-panel/resources/clusterrolebinding.yaml
  • config/uiplugins/components/troubleshooting-panel/resources/configmap.yaml
  • config/uiplugins/components/troubleshooting-panel/resources/deployment.yaml
  • config/uiplugins/components/troubleshooting-panel/resources/kustomization.yaml
  • config/uiplugins/components/troubleshooting-panel/resources/rolebinding.yaml
  • config/uiplugins/components/troubleshooting-panel/resources/service.yaml
  • config/uiplugins/components/troubleshooting-panel/resources/serviceaccount.yaml
  • deploy/operator/observability-operator-deployment.yaml
  • docs/design/kustomize-overlay-refactor.md
  • go.mod
  • hack/uninstall.sh
  • pkg/apis/observability/v1alpha1/types.go
  • pkg/controllers/observability/observability_controller.go
  • pkg/controllers/observability/overlay.go
  • pkg/controllers/observability/reconcilers.go
  • pkg/controllers/observability/reconcilers_test.go
  • pkg/controllers/observability/tempo_components.go
  • pkg/controllers/observability/tempo_components_test.go
  • pkg/controllers/observability/tracing_overlay.go
  • pkg/controllers/uiplugin/compatibility_matrix.go
  • pkg/controllers/uiplugin/components.go
  • pkg/controllers/uiplugin/components_test.go
  • pkg/controllers/uiplugin/config/korrel8r.yaml
  • pkg/controllers/uiplugin/controller.go
  • pkg/controllers/uiplugin/dashboards.go
  • pkg/controllers/uiplugin/distributed_tracing.go
  • pkg/controllers/uiplugin/logging.go
  • pkg/controllers/uiplugin/monitoring.go
  • pkg/controllers/uiplugin/overlay.go
  • pkg/controllers/uiplugin/plugin_info_builder.go
  • pkg/controllers/uiplugin/proxy.go
  • pkg/controllers/uiplugin/troubleshooting_panel.go
  • pkg/controllers/uiplugin/troubleshooting_panel_test.go
  • pkg/controllers/util/common.go
  • pkg/generator/fallback_reader.go
  • pkg/generator/fallback_reader_test.go
  • pkg/generator/generator.go
  • pkg/generator/generator_parity_test.go
  • pkg/generator/resource_set.go
  • pkg/generator/testdata/sample/expected-output.yaml
  • pkg/generator/testdata/sample/observability-installer.yaml
  • pkg/generator/testdata/sample/uiplugins.yaml
  • pkg/images/images.go
  • pkg/operator/operator.go
  • pkg/operator/scheme.go
  • pkg/overlay/overlay.go
  • pkg/overlay/overlay_test.go
  • pkg/reconciler/create_update_reconciler.go
  • pkg/reconciler/reconciler.go
  • test/e2e/generator_reconcile_parity_test.go
  • test/e2e/uiplugin_uninstall_test.go

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@alanconway
alanconway marked this pull request as draft August 21, 2026 19:10
@alanconway alanconway closed this Aug 21, 2026
@alanconway

Copy link
Copy Markdown
Contributor Author

Attempting to use github stacked PRs but they don't work from a fork.

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.

1 participant