feat(logs): make operator optional (#1238)

timojohlo · web-flow · commit 106ccbad1d68 · 2025-10-30T09:50:27.000+01:00
* feat(logs): make operator optional

* update docs

* enable custom CRDs

* update deps, move tests

* update operator image for test-values

* add nameOverride operator

* add -operator for tests

* start crd versioning with 0.0.1
diff --git a/.github/workflows/ci-pr-build.yaml b/.github/workflows/ci-pr-build.yaml
@@ -45,7 +45,7 @@ jobs:
           - chartDir: opensearch/chart
             chartName: opensearch
           - chartDir: logs/charts
-            chartName: opentelemetry-operator
+            chartName: logs
           - chartDir: perses/charts
             chartName: perses
           - chartDir: plutono/charts
diff --git a/.github/workflows/helm-release.yaml b/.github/workflows/helm-release.yaml
@@ -61,7 +61,7 @@ jobs:
           - chartDir: opensearch/chart
             chartName: opensearch
           - chartDir: logs/charts
-            chartName: opentelemetry-operator
+            chartName: logs
           - chartDir: perses/charts
             chartName: perses
           - chartDir: plutono/charts
diff --git a/logs/README.md b/logs/README.md
@@ -51,7 +51,8 @@ You can install the `Logs` package in your cluster by installing it with [Helm](
 
 **Step 2:**
 
-The package will deploy the OpenTelemetry Operator which works as a manager for the collectors and auto-instrumentation of the workload. By default, the package will include a configuration for collecting metrics and logs. The log-collector is currently processing data from the [preconfigured receivers](#Overview):
+You can choose if you want to deploy the OpenTelemetry Operator including the collectors or set `opentelemetry-operator.enabled` to `false` in case you already have an existing Operator deployed in your cluster. The OpenTelemetry Operator works as a manager for the collectors and auto-instrumentation of the workload.
+By default, the package will include a configuration for collecting metrics and logs. The log-collector is currently processing data from the [preconfigured receivers](#Overview):
 - Files via the Filelog Receiver
 - Kubernetes Events from the Kubernetes API server
 - Journald events from systemd journal
@@ -80,7 +81,11 @@ The **Logs** Plugin comes with a [Failover Connector](https://github.com/open-te
 | Key | Type | Default | Description |
 |-----|------|---------|-------------|
 | commonLabels | object | `{}` | common labels to apply to all resources. |
+| customCRDs.enabled | bool | `true` | The required CRDs used by this dependency are version-controlled in this repository under ./charts/crds.  |
 | openTelemetry.cluster | string | `nil` | Cluster label for Logging |
+| openTelemetry.collectorImage | object | `{"repository":"ghcr.io/cloudoperators/opentelemetry-collector-contrib","tag":"2016982"}` | OpenTelemetry Collector image configuration |
+| openTelemetry.collectorImage.repository | string | `"ghcr.io/cloudoperators/opentelemetry-collector-contrib"` | Image repository for OpenTelemetry Collector |
+| openTelemetry.collectorImage.tag | string | `"2016982"` | Image tag for OpenTelemetry Collector |
 | openTelemetry.customLabels | object | `{}` | custom Labels applied to servicemonitor, secrets and collectors |
 | openTelemetry.logsCollector.cephConfig | object | `{"enabled":false}` | Activates the configuration for Ceph logs (requires logsCollector to be enabled). |
 | openTelemetry.logsCollector.enabled | bool | `true` | Activates the standard configuration for Logs. |
@@ -107,10 +112,9 @@ The **Logs** Plugin comes with a [Failover Connector](https://github.com/open-te
 | opentelemetry-operator.admissionWebhooks.autoGenerateCert.recreate | bool | `false` | Activate to recreate the cert after a defined period (certPeriodDays default is 365). |
 | opentelemetry-operator.admissionWebhooks.certManager | object | `{"enabled":false}` | Activate to use the CertManager for generating self-signed certificates. |
 | opentelemetry-operator.admissionWebhooks.failurePolicy | string | `"Ignore"` | Defines if the admission webhooks should `Ignore` errors or `Fail` on errors when communicating with the API server. |
-| opentelemetry-operator.crds.create | bool | `false` | The required CRDs used by this dependency are version-controlled in this repository under ./crds. If you want to use the upstream CRDs, set this variable to `true``. |
+| opentelemetry-operator.crds.create | bool | `false` | If you want to use the upstream CRDs, set this variable to `true``. |
+| opentelemetry-operator.enabled | bool | `true` | Set to true to enable the installation of the OpenTelemetry Operator. |
 | opentelemetry-operator.kubeRBACProxy | object | `{"enabled":false}` | the kubeRBACProxy can be enabled to allow the operator perform RBAC authorization against the Kubernetes API. |
-| opentelemetry-operator.manager.collectorImage.repository | string | `"ghcr.io/cloudoperators/opentelemetry-collector-contrib"` | overrides the default image repository for the OpenTelemetry Collector image. |
-| opentelemetry-operator.manager.collectorImage.tag | string | `"2016982"` | overrides the default image tag for the OpenTelemetry Collector image. |
 | opentelemetry-operator.manager.image.repository | string | `"ghcr.io/open-telemetry/opentelemetry-operator/opentelemetry-operator"` | overrides the default image repository for the OpenTelemetry Operator image. |
 | opentelemetry-operator.manager.image.tag | string | `"v0.131.0"` | overrides the default tag repository for the OpenTelemetry Operator image. |
 | opentelemetry-operator.manager.serviceMonitor.enabled | bool | `true` | Enable serviceMonitor for Prometheus metrics scrape |
diff --git a/logs/README.md.gotmpl b/logs/README.md.gotmpl
@@ -51,7 +51,8 @@ You can install the `Logs` package in your cluster by installing it with [Helm](
 
 **Step 2:**
 
-The package will deploy the OpenTelemetry Operator which works as a manager for the collectors and auto-instrumentation of the workload. By default, the package will include a configuration for collecting metrics and logs. The log-collector is currently processing data from the [preconfigured receivers](#Overview): 
+You can choose if you want to deploy the OpenTelemetry Operator including the collectors or set `opentelemetry-operator.enabled` to `false` in case you already have an existing Operator deployed in your cluster. The OpenTelemetry Operator works as a manager for the collectors and auto-instrumentation of the workload. 
+By default, the package will include a configuration for collecting metrics and logs. The log-collector is currently processing data from the [preconfigured receivers](#Overview): 
 - Files via the Filelog Receiver
 - Kubernetes Events from the Kubernetes API server
 - Journald events from systemd journal
diff --git a/logs/charts/Chart.lock b/logs/charts/Chart.lock
@@ -2,5 +2,8 @@ dependencies:
 - name: opentelemetry-operator
   repository: https://open-telemetry.github.io/opentelemetry-helm-charts
   version: 0.93.0
-digest: sha256:9b0c09a70eabe6f91c21fd0abb215aa2a4f75b9b1f1f3c1c4fc4f2df1f940e31
-generated: "2025-08-26T12:42:03.116014+02:00"
+- name: crds
+  repository: ""
+  version: 0.0.0
+digest: sha256:f1ccc3df203ca775f5314c5e3d9f8edd37e86a11b33bdfe57de45d374a9cbeb3
+generated: "2025-10-29T09:09:37.869018+01:00"
diff --git a/logs/charts/Chart.yaml b/logs/charts/Chart.yaml
@@ -2,8 +2,8 @@
 # SPDX-License-Identifier: Apache-2.0
 
 apiVersion: v2
-name: opentelemetry-operator
-version: 0.11.12
+name: logs
+version: 0.0.1
 description: OpenTelemetry Operator Helm chart for Kubernetes
 icon: https://raw.githubusercontent.com/cncf/artwork/a718fa97fffec1b9fd14147682e9e3ac0c8817cb/projects/opentelemetry/icon/color/opentelemetry-icon-color.png
 type: application
@@ -17,3 +17,7 @@ dependencies:
 - name: opentelemetry-operator
   repository: https://open-telemetry.github.io/opentelemetry-helm-charts
   version: 0.93.0
+  condition: opentelemetry-operator.enabled
+- name: crds
+  version: 0.0.1
+  condition: customCRDs.enabled
diff --git a/logs/charts/charts/crds/Chart.yaml b/logs/charts/charts/crds/Chart.yaml
@@ -0,0 +1,3 @@
+apiVersion: v2
+name: crds
+version: 0.0.1
diff --git a/logs/charts/charts/crds/crds/opentelemetry.io_instrumentations.yaml b/logs/charts/charts/crds/crds/opentelemetry.io_instrumentations.yaml
diff --git a/logs/charts/charts/crds/crds/opentelemetry.io_opampbridges.yaml b/logs/charts/charts/crds/crds/opentelemetry.io_opampbridges.yaml
diff --git a/logs/charts/charts/crds/crds/opentelemetry.io_opentelemetrycollectors.yaml b/logs/charts/charts/crds/crds/opentelemetry.io_opentelemetrycollectors.yaml
diff --git a/logs/charts/charts/crds/crds/opentelemetry.io_targetallocators.yaml b/logs/charts/charts/crds/crds/opentelemetry.io_targetallocators.yaml
diff --git a/logs/charts/ci/test-values.yaml b/logs/charts/ci/test-values.yaml
@@ -2,6 +2,8 @@
 # SPDX-License-Identifier: Apache-2.0
 
 opentelemetry-operator:
+  enabled: true
+  nameOverride: "operator"
   crds:
     create: false
   admissionWebhooks:
@@ -13,12 +15,9 @@ opentelemetry-operator:
       enabled: true
       recreate: false
   manager:
-    collectorImage:
-      repository: ghcr.io/cloudoperators/opentelemetry-collector-contrib
-      tag: main
     image:
       repository: ghcr.io/open-telemetry/opentelemetry-operator/opentelemetry-operator
-      tag: v0.114.1
+      tag: v0.131.0
     prometheusRule:
       enabled: false
       defaultRules:
@@ -28,7 +27,13 @@ opentelemetry-operator:
   kubeRBACProxy:
     enabled: false
 
+customCRDs:
+  enabled: true
+
 openTelemetry:
+  collectorImage:
+    repository: ghcr.io/cloudoperators/opentelemetry-collector-contrib
+    tag: main
   openSearchLogs:
     endpoint: test
     failover_username_a: test
@@ -52,7 +57,6 @@ openTelemetry:
     additionalLabels:
       key1: value1
       key2: value2
-
     rules:
       enabled:
         - FilelogRefusedLogs
diff --git a/logs/charts/templates/alerts.yaml b/logs/charts/templates/alerts.yaml
@@ -69,7 +69,7 @@ spec:
           description: 'OTel on {{`{{ $labels.k8s_cluster_name }}`}} in {{`{{ $labels.region }}`}} is sending 4 times fewer logs in the last 2h. Please check.'
   {{- end }}
 
-  {{- if (has "ReconcileErrors" .Values.openTelemetry.prometheus.rules.enabled) }}
+{{- if and (has "ReconcileErrors" .Values.openTelemetry.prometheus.rules.enabled) (".Values.opentelemetry-operator.enabled") }}
       - alert: ReconcileErrors
         expr: rate(controller_runtime_reconcile_total{controller="opentelemetrycollector",result="error"}[5m]) > 0
         for: 5m
@@ -82,7 +82,7 @@ spec:
           description: Reconciliation errors for opentelemetrycollector are increasing
   {{- end }}
 
-  {{- if (has "WorkqueueDepth" .Values.openTelemetry.prometheus.rules.enabled) }}
+  {{- if and (has "WorkqueueDepth" .Values.openTelemetry.prometheus.rules.enabled) (".Values.opentelemetry-operator.enabled") }}
       - alert: WorkqueueDepth
         expr: rate(controller_runtime_reconcile_total{controller="opentelemetrycollector",result="error"}[5m]) > 0
         for: 5m
diff --git a/logs/charts/templates/logs-collector.yaml b/logs/charts/templates/logs-collector.yaml
@@ -45,7 +45,7 @@ spec:
     - name: prometheus
       port: 8888
 {{- end }}
-  image: {{ index .Values "opentelemetry-operator" "manager" "collectorImage" "repository" }}:{{ index .Values "opentelemetry-operator" "manager" "collectorImage" "tag" }}
+  image: {{ index .Values "openTelemetry" "collectorImage" "repository" }}:{{ index .Values "openTelemetry" "collectorImage" "tag" }}
   volumeMounts:
   - mountPath: /var/log
     name: varlog
diff --git a/logs/charts/templates/tests/test-opentelemetry-config.yaml b/logs/charts/templates/tests/test-opentelemetry-config.yaml
@@ -19,14 +19,16 @@ data:
     
     DETIK_CLIENT_NAME="kubectl"
     
+    {{- if ".Values.opentelemetry-operator.enabled" }}
     @test "Verify successful deployment and running status of the {{ .Release.Name }} pod" {
         verify "there is 1 deployment named '{{ .Release.Name }}'"
         try "at most 4 times every 5s to get pods named '{{ .Release.Name }}-[a-zA-Z0-9]{9,10}-[a-zA-Z0-9]{5}$' and verify that '.status.phase' is 'running'" 
     }
 
-    @test "Verify successful deployment of the {{ .Release.Name }} service" {
-        verify "there is 1 service named '{{ .Release.Name }}\$'"
+    @test "Verify successful deployment of the {{ .Release.Name }}-operator service" {
+        verify "there is 1 service named '{{ .Release.Name }}-operator\$'"
     }
+    {{- end -}}
 
     {{- if .Values.openTelemetry.logsCollector.enabled }}
     @test "Verify successful deployment and running status of the logs-collector" {
@@ -39,10 +41,12 @@ data:
         try "at most 5 times every 10s to get pods named 'metrics-collector' and verify that '.status.phase' is 'running'"
     }
     {{- end }}
+
     @test "Verify presence of custom resource definitions (CRDs) for {{ .Release.Name }}" {
         verify "there is 1 customresourcedefinition named 'instrumentations.opentelemetry.io'"
         verify "there is 1 customresourcedefinition named 'opampbridges.opentelemetry.io'"
         verify "there is 1 customresourcedefinition named 'opentelemetrycollectors.opentelemetry.io'"
         verify "there is 1 customresourcedefinition named 'targetallocators.opentelemetry.io'"
     }
+
 {{- end -}}
diff --git a/logs/charts/values.yaml b/logs/charts/values.yaml
@@ -6,12 +6,14 @@ commonLabels: {}
 
 # opentelemetry-operator is an upstream dependency, it is required that it is a separate block. This is customised configuration of the dependency.
 opentelemetry-operator:
+  # -- Set to true to enable the installation of the OpenTelemetry Operator.
+  enabled: true
   # -- Provide a name in place of the default name `opentelemetry-operator`.
   nameOverride: "operator"
 
   crds:
     # This is required because there is no other Plugin that would install them, and because automatic CRD installs are not supported due to a limitation with helm, see [HIP0011](https://github.com/helm/community/blob/main/hips/hip-0011.md).
-    # --  The required CRDs used by this dependency are version-controlled in this repository under ./crds. If you want to use the upstream CRDs, set this variable to `true``.
+    # --  If you want to use the upstream CRDs, set this variable to `true``.
     create: false
   admissionWebhooks:
     # -- Defines if the admission webhooks should `Ignore` errors or `Fail` on errors when communicating with the API server.
@@ -26,11 +28,6 @@ opentelemetry-operator:
     # -- Activate to recreate the cert after a defined period (certPeriodDays default is 365).
       recreate: false
   manager:
-    collectorImage:
-    # -- overrides the default image repository for the OpenTelemetry Collector image.
-      repository: ghcr.io/cloudoperators/opentelemetry-collector-contrib
-    # -- overrides the default image tag for the OpenTelemetry Collector image.
-      tag: "2016982"
     image:
     # -- overrides the default image repository for the OpenTelemetry Operator image.
       repository: ghcr.io/open-telemetry/opentelemetry-operator/opentelemetry-operator
@@ -45,8 +42,19 @@ opentelemetry-operator:
   kubeRBACProxy:
     enabled: false
 
+customCRDs:
+  # -- The required CRDs used by this dependency are version-controlled in this repository under ./charts/crds. 
+  enabled: true
+
 # Empty variables will fail during rollout
 openTelemetry:
+  # -- OpenTelemetry Collector image configuration
+  collectorImage:
+    # -- Image repository for OpenTelemetry Collector
+    repository: ghcr.io/cloudoperators/opentelemetry-collector-contrib
+    # -- Image tag for OpenTelemetry Collector
+    tag: "2016982"
+
   # -- custom Labels applied to servicemonitor, secrets and collectors
   customLabels: {}
 
diff --git a/logs/plugindefinition.yaml b/logs/plugindefinition.yaml
@@ -6,15 +6,25 @@ kind: ClusterPluginDefinition
 metadata:
   name: logs
 spec:
-  version: 0.11.12
+  version: 0.11.13
   displayName: Logs
   description: Observability framework for instrumenting, generating, collecting, and exporting logs.
   icon: https://raw.githubusercontent.com/cloudoperators/greenhouse-extensions/main/logs/logo.png
   helmChart:
-    name: opentelemetry-operator
+    name: logs
     repository: oci://ghcr.io/cloudoperators/greenhouse-extensions/charts
-    version: 0.11.12
+    version: 0.0.1
   options:
+    - default: true
+      description: Set to true to enable the installation of the OpenTelemetry Operator.
+      name: opentelemetry-operator.enabled
+      required: false
+      type: bool
+    - default: true
+      description: Set this to true to create the custom CRDs required by the OpenTelemetry Operator. Set to false if another chart is already installing the CRDs.
+      name: customCRDs.enabled
+      required: false
+      type: bool
     - default: true
       description: Activates the standard configuration for logs
       name: openTelemetry.logsCollector.enabled
@@ -104,12 +114,12 @@ spec:
       required: false
       type: bool
     - default: ghcr.io/cloudoperators/opentelemetry-collector-contrib
-      description: openTelemetry.manager.collectorImage.repository
-      name: openTelemetry.manager.collectorImage.repository
+      description: openTelemetry.collectorImage.repository
+      name: openTelemetry.collectorImage.repository
       required: false
       type: string
     - default: "2016982"
-      description: openTelemetry.manager.collectorImage.tag
-      name: openTelemetry.manager.collectorImage.tag
+      description: openTelemetry.collectorImage.tag
+      name: openTelemetry.collectorImage.tag
       required: false
       type: string

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+apiVersion: v2`
	`2`	`+name: crds`
	`3`	`+version: 0.0.1`