From c8bc981caf728bc16b9bc099734c169887b43ad6 Mon Sep 17 00:00:00 2001 From: Jakub Scholz Date: Fri, 7 May 2021 18:18:28 +0200 Subject: [PATCH] Update Helm upgrade docs - closes #3877 Signed-off-by: Jakub Scholz --- ...oc-deploy-cluster-operator-helm-chart.adoc | 7 +++++++ documentation/shared/attributes.adoc | 1 + .../helm3/strimzi-kafka-operator/README.md | 20 ++++++++++++++++--- 3 files changed, 25 insertions(+), 3 deletions(-) diff --git a/documentation/modules/deploying/proc-deploy-cluster-operator-helm-chart.adoc b/documentation/modules/deploying/proc-deploy-cluster-operator-helm-chart.adoc index 2a65675ed51..aa124bc6cd9 100644 --- a/documentation/modules/deploying/proc-deploy-cluster-operator-helm-chart.adoc +++ b/documentation/modules/deploying/proc-deploy-cluster-operator-helm-chart.adoc @@ -31,3 +31,10 @@ helm install {ChartReleaseCoordinate} + [source,shell] helm ls + +== Upgrading the Cluster Operator using Helm Chart + +To upgrade the Strimzi operator, you can use the `helm upgrade` command. +`helm upgrade` at this time does not support upgrading the custom resource definitions (for more details, see {HelmCustomResourceDefinitions}). +So after upgrading the Strimzi operator, you have to manually install the new CRDs. +You can find them on our {ReleaseDownload} or in the `crd` subdirectory inside the Helm Chart. diff --git a/documentation/shared/attributes.adoc b/documentation/shared/attributes.adoc index 08b27a2da28..399b4c461c7 100644 --- a/documentation/shared/attributes.adoc +++ b/documentation/shared/attributes.adoc @@ -108,6 +108,7 @@ :OpenTracingDocs: link:https://opentracing.io/docs/overview/[OpenTracing documentation^] :LatestBridgeAPIDocs: link:https://strimzi.io/docs/bridge/latest/[Kafka Bridge API reference^] :external-cors-link: https://www.w3.org/TR/cors/ +:HelmCustomResourceDefinitions: link:https://helm.sh/docs/chart_best_practices/custom_resource_definitions/[Helm - Custom Resource Definitions^] // Container image names and repositories :DockerOrg: quay.io/strimzi diff --git a/packaging/helm-charts/helm3/strimzi-kafka-operator/README.md b/packaging/helm-charts/helm3/strimzi-kafka-operator/README.md index a7a0748351c..9e174fdf148 100644 --- a/packaging/helm-charts/helm3/strimzi-kafka-operator/README.md +++ b/packaging/helm-charts/helm3/strimzi-kafka-operator/README.md @@ -1,9 +1,17 @@ -# Strimzi: Kafka as a Service +# Strimzi: Apache Kafka on Kubernetes Strimzi provides a way to run an [Apache Kafka®](https://kafka.apache.org) cluster on [Kubernetes](https://kubernetes.io/) or [OpenShift](https://www.openshift.com/) in various deployment configurations. See our [website](https://strimzi.io) for more details about the project. +## CRD Upgrades + +**!!! IMPORTANT !!!** +Strimzi 0.23 and newer supports only the API version `v1beta2` of all Strimzi custom resources. +This is a required as part of the migration to `apiextensionsk8s.io/v1` which is needed because Kubernetes 1.22 will remove support for `apiextensions.k8s.io/v1beta1`. +Migration to `v1beta2` needs to be completed for all Strimzi CRDs and CRs before the upgrade to 0.23 or newer. +For more details about the CRD upgrades, see the [documentation](https://strimzi.io/docs/operators/0.22.1/deploying.html#assembly-upgrade-resources-str). + ## Introduction This chart bootstraps the Strimzi Cluster Operator Deployment, Cluster Roles, Cluster Role Bindings, Service Accounts, and @@ -17,12 +25,18 @@ cluster using the [Helm](https://helm.sh) package manager. * **Topic Management** - Creates and manages Kafka Topics within the cluster. * **User Management** - Creates and manages Kafka Users within the cluster. * **Connector Management** - Creates and manages Kafka Connect connectors. -* **Includes Kafka Mirror Maker** - Allows for mirroring data between different Apache Kafka® clusters. +* **Includes Kafka Mirror Maker 1 and 2** - Allows for mirroring data between different Apache Kafka® clusters. * **Includes HTTP Kafka Bridge** - Allows clients to send and receive messages through an Apache Kafka® cluster via the HTTP protocol. * **Includes Cruise Control** - Automates the process of balancing partitions across an Apache Kafka® cluster. +* **Prometheus monitoring** - Built-in support for monitoring using Prometheus. ### Upgrading your Clusters +To upgrade the Strimzi operator, you can use the `helm upgrade` command. +`helm upgrade` at this time does not support upgrading the custom resource definitions (for more details, see [Custom Resource Definitions](https://helm.sh/docs/chart_best_practices/custom_resource_definitions/)). +So after upgrading the Strimzi operator, you have to manually install the new CRDs. +You can find them on our [GitHub release page](https://github.com/strimzi/strimzi-kafka-operator/releases) or in the `crd` subdirectory inside the Helm Chart. + The Strimzi Operator understands how to run and upgrade between a set of Kafka versions. When specifying a new version in your config, check to make sure you aren't using any features that may have been removed. See [the upgrade guide](https://strimzi.io/docs/latest/#assembly-upgrading-kafka-versions-str) for more information. @@ -43,7 +57,7 @@ Strimzi is licensed under the [Apache License, Version 2.0](https://github.com/s ## Prerequisites -- Kubernetes 1.11+ +- Kubernetes 1.16+ ## Installing the Chart