Skip to content

Latest commit

 

History

History
112 lines (72 loc) · 8.15 KB

UPGRADING.md

File metadata and controls

112 lines (72 loc) · 8.15 KB
Raw

Upgrade guidelines

0.74.0 to 0.74.1

Prior to 0.72.1, feature gates could be enabled via the manager.featureGates property. As feature gates may require extra configuration to work properly, e.g. deploying extra permissions on the ClusterRole, the chart has been updated to make use of the manager.featureGatesMap property which allows the chart to smartly configure feature gates. If the manager.featureGatesMap property is set, the old manager.featureGates property will be ignored.

0.57.0 to 0.58.0

OpenTelemetry Operator 0.99.0 includes a new version of the OpenTelemetryCollector CRD. See this document for upgrade instructions for the new Operator CRD. Please make sure you also follow the helm upgrade instructions for helm chart 0.57.0.

0.56.0 to 0.57.0

This Chart now installs CRDs as templates. If you were managing CRDs separately by using the --skip-crds Helm flag, you need to set crds.create=false in your values.yaml.

The reason for this change is OpenTelemetry Operator rolling out a new version of the OpenTelemetryCollector CRD. For information about this, see the following document. The new CRD version includes a conversion webhook, which needs to reference a namespaced webhook Service, and therefore needs to include the release namespace. See the following issue for more information on the CRD change.

As a result, manual steps are necessary to convince Helm to manage existing CRDs. This involves adding some annotations and labels, and needs to be done before upgrading - otherwise the upgrade will fail.

Set RELEASE_NAME and RELEASE_NAMESPACE to the values you're using for your Helm release, respectively:

RELEASE_NAME=my-opentelemetry-operator
RELEASE_NAMESPACE=opentelemetry-operator-system
kubectl annotate crds instrumentations.opentelemetry.io opentelemetrycollectors.opentelemetry.io opampbridges.opentelemetry.io \
  meta.helm.sh/release-name=${RELEASE_NAME} \
  meta.helm.sh/release-namespace=${RELEASE_NAMESPACE}
kubectl label crds instrumentations.opentelemetry.io opentelemetrycollectors.opentelemetry.io opampbridges.opentelemetry.io app.kubernetes.io/managed-by=Helm

You can also delete the CRDs and let Helm recreate them, but doing so will also delete any Custom Resources in your cluster.

0.55.3 to 0.56.0

Warning

As part of working towards using the OpenTelemetry Collector Kubernetes Distro by default, the chart now requires users to explicitly set a collector image repository. If you are already explicitly setting a collector image repository this breaking change does not affect you.

If you are using a OpenTelemetry Community distribution of the Collector we recommend you use otel/opentelemetry-collector-k8s, but carefully review the components included in this distribution to make sure it includes all the components you use in your configuration. In the future this distribution will become the default image used for the chart.

You can use the OpenTelemetry Collector Kubernetes Distro by adding these lines to your values.yaml:

manager:
  collectorImage:
    repository: "otel/opentelemetry-collector-k8s"

If you want to stick with using the Contrib distribution, add these lines to your values.yaml:

manager:
  collectorImage:
    repository: "otel/opentelemetry-collector-contrib"

For more details see #1153.

<0.54.0 to 0.55.2

NOTE: Versions 0.54.0 to 0.55.1 of the opentelemetry-operator helm chart should be avoided if providing user-managed certificates as file paths.

Changes to functionality, and variable names used for providing user-managed webhook certificates

Below variables have been renamed to be consistent with the chart's naming format. v0.54.0 also has a bug fix which makes the chart now read the contents of the file paths provided by these variables, instead of just using the value of the variables.

admissionWebhooks.ca_file -> admissionWebhooks.caFile
admissionWebhooks.cert_file -> admissionWebhooks.certFile
admissionWebhooks.key_file -> admissionWebhooks.keyFile

<0.50.0 to 0.50.0

Additional properties are not allowed anymore, so care must be taken that no old or misspelled ones are present anymore. helm show values open-telemetry/opentelemetry-operator --version 0.50.0 can be used to list the allowed values.

<0.42.3 to 0.42.3

A type of flag autoGenerateCert has been changed, now it is an object with two attributes enabled and recreate. If you previously set autoGenerateCert to true or false you have to set autoGenerateCert.enabled accordingly.

<0.35.0 to 0.35.0

OpenTelemetry Operator 0.82.0 includes a change that allows setting the management state of custom resources PR 1888. Since helm doesn't upgrade CRDs (documented) it is critical to manually update CRDs from chart 0.35.0 or above, possibly using this procedure. If this step isn't taken existing otelcol CRs won't be reconciled by the operator.

0.27 to 0.28

Allow using own self-signed certificate

A new flag admissionWebhooks.autoGenerateCert has been added. If you want to keep benefiting from the helm generated certificate as in previous versions, you must set admissionWebhooks.certManager.enabled to false and admissionWebhooks.autoGenerateCert to true.

0.21 to 0.22.0

Kubernetes resource names will now use {{opentelemetry-operator.fullname}} as the default value which will change the name of many resources. Some CI/CD tools might create duplicate resources when upgrading from an older version because of this change. fullnameOverride can be used to keep deployment resource consistent with the same name during an upgrade.

0.16.0 to 0.17.0

The v0.17.0 helm chart version changes OpenTelemetry Collector image to the contrib version. If you want to use the core version, set manager.collectorImage.repository to otel/opentelemetry-collector.

0.15.0 to 0.16.0

Jaeger receiver no longer supports remote sampling. To be able to perform an update, it must be deactivated or replaced by a configuration of the jaegerremotesampling extension.
It is important that the jaegerremotesampling extension and the jaegerreceiver do not use the same port.
To increase the collector version afterwards, the update must be triggered again by restarting the operator. Alternatively, the OpenTelemetryCollector CRD can be re-created. otel-contrib#14707

0.13.0 to 0.14.0

Allow byo webhooks and cert

The ability to use admission webhooks has been moved from admissionWebhooks.enabled to admissionWebhooks.create as it now supports more use cases.

In order to completely disable admission webhooks you need to explicitly set the environment variable ENABLE_WEBHOOKS: "false" in .Values.manager.env .