Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(upgrade): updates upgrade of Cluster Operator watching multiple namespaces #10319

Merged
merged 2 commits into from
Jul 13, 2024
Merged

docs(upgrade): updates upgrade of Cluster Operator watching multiple namespaces #10319

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e13babd
docs(upgrade): adds instructions for file-based upgrade of Cluster Op…
PaulRMellor Jul 9, 2024
4cb6856
docs(review): updates to doc from comments by JS
PaulRMellor Jul 12, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions ...n/modules/deploying/proc-deploy-cluster-operator-watch-multiple-namespaces.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,13 +45,13 @@ spec:

. For each namespace listed, install the `RoleBindings`.
+
In this example, we replace `_watched-namespace_` in these commands with the namespaces listed in the previous step,
In this example, we replace `watched-namespace` in these commands with the namespaces listed in the previous step,
repeating them for `watched-namespace-1`, `watched-namespace-2`, `watched-namespace-3`:
+
[source,shell,subs="+quotes,attributes+"]
kubectl create -f install/cluster-operator/020-RoleBinding-strimzi-cluster-operator.yaml -n _<watched_namespace>_
kubectl create -f install/cluster-operator/023-RoleBinding-strimzi-cluster-operator.yaml -n _<watched_namespace>_
kubectl create -f install/cluster-operator/031-RoleBinding-strimzi-cluster-operator-entity-operator-delegation.yaml -n _<watched_namespace>_
[source,shell]
kubectl create -f install/cluster-operator/020-RoleBinding-strimzi-cluster-operator.yaml -n <watched_namespace>
kubectl create -f install/cluster-operator/023-RoleBinding-strimzi-cluster-operator.yaml -n <watched_namespace>
kubectl create -f install/cluster-operator/031-RoleBinding-strimzi-cluster-operator-entity-operator-delegation.yaml -n <watched_namespace>

. Deploy the Cluster Operator:
+
Expand Down
5 changes: 3 additions & 2 deletions documentation/modules/upgrading/proc-downgrade-cluster-operator.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,10 @@ If a feature gate is permanently enabled, you may need to downgrade to a version

.Procedure

. Take note of any configuration changes made to the existing Cluster Operator resources (in the `/install/cluster-operator` directory).
Any changes will be *overwritten* by the previous version of the Cluster Operator.
. Take note of any configuration changes made during the previous Cluster Operator installation.
+
Any changes will be *overwritten* by the previous version of the Cluster Operator.

. Revert your custom resources to reflect the supported configuration options available for the version of Strimzi you are downgrading to.

. Update the Cluster Operator.
Expand Down
59 changes: 43 additions & 16 deletions documentation/modules/upgrading/proc-upgrade-cluster-operator.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,8 @@
[role="_abstract"]
This procedure describes how to upgrade a Cluster Operator deployment to use Strimzi {ProductVersion}.

Follow this procedure if you deployed the Cluster Operator using the installation YAML files.
Follow this procedure if you deployed the Cluster Operator using the installation YAML files in the `install/cluster-operator/` directory.
The steps include the necessary configuration changes when the Cluster Operator watches multiple or all namespaces.

The availability of Kafka clusters managed by the Cluster Operator is not affected by the upgrade operation.

Expand All @@ -18,22 +19,49 @@ NOTE: Refer to the documentation supporting a specific version of Strimzi for in

* An existing Cluster Operator deployment is available.
* You have xref:downloads-{context}[downloaded the release artifacts for Strimzi {ProductVersion}].
* You need an account with permission to create and manage `CustomResourceDefinition` and RBAC (`ClusterRole`, and `RoleBinding`) resources.

.Procedure

. Take note of any configuration changes made to the existing Cluster Operator resources (in the `/install/cluster-operator` directory).
. Take note of any configuration changes made during the previous Cluster Operator installation.
+
Any changes will be *overwritten* by the new version of the Cluster Operator.

. Update your custom resources to reflect the supported configuration options available for Strimzi version {ProductVersion}.

. Update the Cluster Operator.

.. Modify the installation files for the new Cluster Operator version according to the namespace the Cluster Operator is running in.
. Modify the installation files for the new Cluster Operator version to reflect the namespace in which the Cluster Operator is running.
+
include::../../shared/snip-cluster-operator-namespace-sed.adoc[]

. If you modified environment variables in the `Deployment` configuration, edit the
`060-Deployment-strimzi-cluster-operator.yaml` file to use those environment variables.
+
** If the Cluster Operator is watching multiple namespaces, add the list of namespaces to the `STRIMZI_NAMESPACE` environment variable.
** If the Cluster Operator is watching all namespaces, specify `value: "*"` for the `STRIMZI_NAMESPACE` environment variable.

. If the Cluster Operator is watching more than one namespace, update the role bindings.
+
** If watching multiple namespaces, replace the `namespace` in the `RoleBinding` installation files with the actual namespace name and create the role bindings for *each* namespace:
+
.Creating role bindings for a namespace
[source,shell]
----
kubectl create -f install/cluster-operator/020-RoleBinding-strimzi-cluster-operator.yaml -n <watched_namespace>
kubectl create -f install/cluster-operator/023-RoleBinding-strimzi-cluster-operator.yaml -n <watched_namespace>
kubectl create -f install/cluster-operator/031-RoleBinding-strimzi-cluster-operator-entity-operator-delegation.yaml -n <watched_namespace>
----
+
For example, if the Cluster Operator is watching three namespaces, create three sets of role bindings by substituting `<watched_namespace>` with the name of each namespace.
+
.. If you modified one or more environment variables in your existing Cluster Operator `Deployment`, edit the
`install/cluster-operator/060-Deployment-strimzi-cluster-operator.yaml` file to use those environment variables.
** If watching all namespaces, recreate the cluster role bindings that grant cluster-wide access (if needed):
+
.Granting cluster-wide access using role bindings
[source,shell]
----
kubectl create clusterrolebinding strimzi-cluster-operator-namespaced --clusterrole=strimzi-cluster-operator-namespaced --serviceaccount my-cluster-operator-namespace:strimzi-cluster-operator
kubectl create clusterrolebinding strimzi-cluster-operator-watched --clusterrole=strimzi-cluster-operator-watched --serviceaccount my-cluster-operator-namespace:strimzi-cluster-operator
kubectl create clusterrolebinding strimzi-cluster-operator-entity-operator-delegation --clusterrole=strimzi-entity-operator --serviceaccount my-cluster-operator-namespace:strimzi-cluster-operator
----

. When you have an updated configuration, deploy it along with the rest of the installation resources:
+
Expand All @@ -44,17 +72,16 @@ kubectl replace -f install/cluster-operator
+
Wait for the rolling updates to complete.

. If the new Operator version no longer supports the Kafka version you are upgrading from, the Cluster Operator returns an error message to say the version is not supported.
Otherwise, no error message is returned.

* If the error message is returned, upgrade to a Kafka version that is supported by the new Cluster Operator version:

. If the new operator version no longer supports the Kafka version you are upgrading from, an error message is returned.
+
To resolve this, upgrade to a supported Kafka version:
+
--
.. Edit the `Kafka` custom resource.

.. Change the `spec.kafka.version` property to a supported Kafka version.

* If the error message is _not_ returned, go to the next step.
You will upgrade the Kafka version later.
--
+
If no error message is returned, you can proceed to the next step and upgrade the Kafka version later.

. Get the image for the Kafka pod to ensure the upgrade was successful:
+
Expand Down
Loading