Skip to content

Commit

Permalink
Move operator CRD installation to the crds/ folder via a subchart to …
Browse files Browse the repository at this point in the history
…resolve Helm install ordering issues
  • Loading branch information
jvoravong authored and atoulme committed Jan 10, 2025
1 parent 211d9d5 commit 41b80c3
Show file tree
Hide file tree
Showing 10 changed files with 12,934 additions and 12,101 deletions.
12 changes: 12 additions & 0 deletions .chloggen/move-operator-crd-install-method.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix'
change_type: bug_fix
# The name of the component, or a single word describing the area of concern, (e.g. agent, clusterReceiver, gateway, operator, chart, other)
component: operator
# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
note: Move operator CRD installation to the crds/ folder via a subchart to resolve Helm install ordering issues
# One or more tracking issues related to the change
issues: []
# (Optional) One or more lines of additional information to render under the primary note.
# These lines will be padded with 2 spaces and then inserted directly into the document.
# Use pipe (|) for multiline entries.
subtext:

Large diffs are not rendered by default.

9 changes: 7 additions & 2 deletions helm-charts/splunk-otel-collector/Chart.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -20,13 +20,18 @@ maintainers:
- name: atoulme
dependencies:
# Subchart Notes:
# - Avoid uppercase letters in names/aliases, they cause install failure due to subchart resource naming
# - Avoid hyphen characters in names/aliases, they introduce template rendering complications (https://github.com/helm/helm/issues/2192)
# - Avoid uppercase letters in aliases, they cause install failure due to subchart resource naming
# - Avoid hyphen characters in aliases, they introduce template rendering complications (https://github.com/helm/helm/issues/2192)
- name: cert-manager
version: v1.14.4
alias: certmanager
repository: https://charts.jetstack.io
condition: certmanager.enabled
- name: opentelemetry-operator-crds
version: "0.0.0"
alias: operatorcrds
# TODO: See if we can improve this conditional more
condition: operatorcrds.install
- name: opentelemetry-operator
version: 0.71.2
alias: operator
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
apiVersion: v2
name: opentelemetry-operator-crds
version: 0.0.0
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# OpenTelemetry Collector CRDs

This chart contains the CRDs for _*installation*_ only right now for the opentelemetry-operator. This allows the Splunk OpenTelemetry Collector chart to work on install. You can see more discussion about this [here](https://github.com/open-telemetry/opentelemetry-helm-charts/issues/677) and [here](https://github.com/open-telemetry/opentelemetry-helm-charts/pull/1203).

This approach is inspired by the [opentelemetry-kube-stack chart](https://github.com/open-telemetry/opentelemetry-helm-charts/tree/main/charts/opentelemetry-kube-stack) approach.

> [!NOTE]
> The splunk-otel-collector chart only supports and tests functionality related to the auto-instrumentation that requires the Instrumentation CRD.
> Other CRDs, such as OpenTelemetryCollector and OpAMPBridge, are included solely to allow the Operator to start up and are not currently supported or tested.
# Upgrade Notes

Right now, upgrades are NOT handled by this chart, however that could change in the future. This is what is run to bring in the CRDs today.

```bash
wget https://raw.githubusercontent.com/open-telemetry/opentelemetry-operator/main/config/crd/bases/opentelemetry.io_opentelemetrycollectors.yaml
wget https://raw.githubusercontent.com/open-telemetry/opentelemetry-operator/main/config/crd/bases/opentelemetry.io_opampbridges.yaml
wget https://raw.githubusercontent.com/open-telemetry/opentelemetry-operator/main/config/crd/bases/opentelemetry.io_instrumentations.yaml
```
Loading

0 comments on commit 41b80c3

Please sign in to comment.