|
This is unreleased documentation for Runtime Enforcer 0.12-dev. |
Upgrade path
Versioning
Runtime Enforcer uses semantic versioning. A version
follows the MAJOR.MINOR.PATCH pattern. The supported version is the
latest release.
Two deliverables follow this version:
-
The
runtime-enforcerHelm chart, in itsappVersionfield. The controller, the agent, and the debugger images carry this version as their tag. -
The
kubectl runtime-enforcerplugin binary.
Version compatibility among components
The Helm chart appVersion and the kubectl runtime-enforcer plugin must
run the same MAJOR.MINOR.PATCH version. If the chart runs appVersion
0.10.1, install the plugin binary from the v0.10.1 release.
Helm chart versions
A Helm chart has two version fields. The appVersion field holds the
Runtime Enforcer version described above. The version field is the
version of the chart itself. It also follows semantic versioning, and it
describes changes to the chart templates and to values.yaml.
The two fields do not move together. When you
plan an upgrade, read the appVersion of the target chart.
Upgrade paths
You can upgrade across several PATCH versions in one operation. You
cannot upgrade across more than one MINOR or MAJOR version in one
operation.
For example, you can upgrade from 0.10.0 to 0.10.1 in one step. You
cannot upgrade from 0.9.0 to 0.11.0 in one step. Upgrade from 0.9.0
to 0.10.x first, then from 0.10.x to 0.11.0. To move across a
MAJOR version, apply every MINOR version between the two.
Breaking and important changes between versions
This section records breaking changes and other important changes that you must review before you upgrade to a specific version.
v0.10 to v0.11
-
The Helm chart no longer deploys an OpenTelemetry collector. The upgrade removes the collector and its Prometheus endpoint on port 9090. The telemetry export is then off until you set
global.otel.endpoint. To keep the violation events and theruntime_enforcer_violations_totalcounter, deploy your own collector before the upgrade. For more information, refer to Export telemetry to an OpenTelemetry collector. -
The
global.otelblock replaces thetelemetryblock:-
global.otel.endpointreplacestelemetry.externalCollector.endpoint. -
global.otel.caSecretNamereplacestelemetry.externalCollector.otelCollectorCertificateSecret. -
global.otel.clientCertificateSecretNamereplacestelemetry.externalCollector.otelCollectorClientCertificateSecret. -
The chart no longer has the
telemetry.collectorStrategy,telemetry.externalCollector.protocol, andtelemetry.defaultCollectorvalues. The export uses gRPC.
-
-
The telemetry endpoint must be a URL that starts with
http://orhttps://. With a value such ascollector:4317, the controller and the agent do not start. -
An
https://endpoint without a CA Secret trusts only public certificate authorities. In v0.10, the chart turned off TLS verification when you set no CA Secret. If a private CA signed the certificate of the collector, setglobal.otel.caSecretName. -
The chart has a new
globalblock that holds the values for all workloads. These values moved or changed:-
global.imagePullSecretsreplaces the top-levelimagePullSecrets. -
controller.podDisruptionBudgetreplacescontroller.pdb. The new block has noenabledkey. SetminAvailableormaxUnavailablein it. -
extraEnvreplacesenvin thecontroller,agent, anddebuggerblocks. -
The chart no longer has the
controller.argsandagent.argsvalues. -
image.registryholds the registry of each image, for exampleghcr.io.image.repositoryholds the path without the registry, for examplekubewarden/runtime-enforcer/agent. -
image.pullPolicyis empty by default. The chart then usesglobal.imagePullPolicy.
For more information, refer to The layers of the chart values.
-
-
The chart gives no error for a value that it does not know. After the upgrade, an old value has no effect. Update your Helm values file before you upgrade.
-
The controller no longer serves a metrics endpoint on port 8443. The chart no longer creates the
metrics-authandmetrics-readerClusterRoles.
|
Do not use |
Upgrade order
Upgrade the runtime-enforcer Helm chart first. The chart upgrades the
controller, the agent, and the debugger together. Then install the
kubectl runtime-enforcer plugin binary from the same release.
The agent DaemonSet uses a rolling update with a surge. The new agent pod on a node loads every policy and binds every running pod before the old pod stops. Protection does not lapse during the upgrade. See Architecture for the sequence.