From c2f1e575a04e383a4eb965858a9bb9ae42eecae8 Mon Sep 17 00:00:00 2001 From: Kerry Carmichael Date: Fri, 11 Aug 2023 10:15:24 -0400 Subject: [PATCH 1/2] Update upgrade info --- modules/prepare-operator-upgrades.adoc | 9 ++++++++- upgrading/upgrade-operator.adoc | 6 +++++- 2 files changed, 13 insertions(+), 2 deletions(-) diff --git a/modules/prepare-operator-upgrades.adoc b/modules/prepare-operator-upgrades.adoc index 9380b2571f8b..9f2025271dd4 100644 --- a/modules/prepare-operator-upgrades.adoc +++ b/modules/prepare-operator-upgrades.adoc @@ -6,7 +6,14 @@ = Preparing to upgrade [role="_abstract"] -Before you upgrade {rh-rhacs-first} version, you must: +Before you upgrade the {rh-rhacs-first} version, you must perform the following steps: * Verify that you are running the latest patch release version of the {product-title-short} Operator 3.74. * Backup your existing Central database. +* If the `SecuredCluster` custom resource is present in the cluster, ensure the per node collection setting is set to EBPF by following these steps: +. In the {ocp} web console, navigate to the {rh-rhacs-first} Operator page. +. Select *Secured Cluster* in the top navigation bar, and then select the instance by clicking on the name (for example, *stackrox-secured-cluster-services*). +. Click *YAML* to open the YAML editor view. +. Locate the `spec.perNode.collector.collection` attribute. +. If the value of this attribute is `KernelModule`, change it to `EBPF`. +. Click `Save`. diff --git a/upgrading/upgrade-operator.adoc b/upgrading/upgrade-operator.adoc index fd685f00d060..b773f6c3e30e 100644 --- a/upgrading/upgrade-operator.adoc +++ b/upgrading/upgrade-operator.adoc @@ -7,7 +7,11 @@ include::modules/common-attributes.adoc[] toc::[] [role="_abstract"] -Upgrades through the {rh-rhacs-first} Operator are performed automatically or manually, depending on the *Update approval* option you chose at installation. +Upgrades through the {rh-rhacs-first} Operator are performed automatically or manually, depending on the *Update approval* option you chose at installation. Upgrading from version 3.74 to 4.x requires some additional steps that are described on this page. Upgrading within 4.y versions requires no additional steps. + +[discrete] +[id="upgrading-from-version-3x-to-4x_{context}"] +== Upgrading from version 3.74 to 4.x {product-title-short} 4.0 includes a significant architectural change, moving Central’s database to PostgreSQL. Because of this change, {product-title-short} 4.0 Operator is published by a new subscription channel. Therefore, as part of the upgrade instructions, you must manually change the subscription channel to upgrade from {product-title-short} 3.74 to {product-title-short} 4.0. From 0888dc142960b6b7d32fead73936f916aa0f8974 Mon Sep 17 00:00:00 2001 From: Kerry Carmichael Date: Mon, 14 Aug 2023 10:13:41 -0400 Subject: [PATCH 2/2] fix language around secured cluster and central version matching --- modules/install-acs-operator.adoc | 2 +- modules/updates-and-upgrades.adoc | 3 +-- modules/upgrade-helm-chart.adoc | 2 +- upgrading/upgrade-helm.adoc | 2 +- upgrading/upgrade-operator.adoc | 13 ++++++------- 5 files changed, 10 insertions(+), 12 deletions(-) diff --git a/modules/install-acs-operator.adoc b/modules/install-acs-operator.adoc index ee488fe6b70d..bd082b7b5e6b 100644 --- a/modules/install-acs-operator.adoc +++ b/modules/install-acs-operator.adoc @@ -33,7 +33,7 @@ If you choose manual updates, when a newer version of the Operator is available, + [IMPORTANT] ==== -If you choose manual updates, you must update the {product-title-short} Operator in all secured clusters when you update the {product-title-short} Operator in the cluster where Central is installed. The secured clusters and the cluster where Central is installed must have the same version to ensure optimal functionality. +If you choose manual updates, you must update the {product-title-short} Operator in all secured clusters when you update the {product-title-short} Operator in the cluster where Central is installed. The secured clusters and the cluster where Central is installed must have the same version to ensure optimal functionality. For {product-title-managed-short}, use the latest version of the software that is available. (The software version for Central is automatically updated.) ==== . Click *Install*. diff --git a/modules/updates-and-upgrades.adoc b/modules/updates-and-upgrades.adoc index 3d1128c1024a..81c7c058ad57 100644 --- a/modules/updates-and-upgrades.adoc +++ b/modules/updates-and-upgrades.adoc @@ -11,5 +11,4 @@ The decision regarding the need for a Service update to the Central instance and Customers have no control over when a Central service update occurs. For more information, see link:https://www.redhat.com/licenses/Appendix_4_Red_Hat_Online_Services_20221213.pdf[PRODUCT APPENDIX 4 RED HAT ONLINE SERVICES]. Upgrades to the version of {rh-rhacscs-first} are considered part of the service update. -The version of {product-title-managed-short} used on Secured Clusters must match the version of the Central instance of {product-title-managed-short} to ensure compatibility. -Customers are responsible for Secured Cluster services upgrades required to maintain this version compatibility. \ No newline at end of file +To ensure optimal functionality and compatibility between Central and secured clusters, upgrade your secured clusters to the latest software version available. (The software version for Central is automatically updated.) \ No newline at end of file diff --git a/modules/upgrade-helm-chart.adoc b/modules/upgrade-helm-chart.adoc index b2ea2e4de8fa..7f9a7878996b 100644 --- a/modules/upgrade-helm-chart.adoc +++ b/modules/upgrade-helm-chart.adoc @@ -9,7 +9,7 @@ You can use the `helm upgrade` command to update {rh-rhacs-first}. .Prerequisites -* You must have access to the `values-private.yaml` configuration file that you have used to install {rh-rhacs-first}. Otherwise, you must generate the `values-private.yaml` configuration file containg root certificates, before proceeding with the commands here. +* You must have access to the `values-private.yaml` configuration file that you have used to install {rh-rhacs-first}. Otherwise, you must generate the `values-private.yaml` configuration file containing root certificates, before proceeding with the commands here. .Procedure * Run the helm upgrade command and specify the configuration files by using the `-f` option: diff --git a/upgrading/upgrade-helm.adoc b/upgrading/upgrade-helm.adoc index 1f8e381e1052..831b8a519825 100644 --- a/upgrading/upgrade-helm.adoc +++ b/upgrading/upgrade-helm.adoc @@ -19,7 +19,7 @@ If you have installed {product-title} by using Helm charts, to upgrade to the la [IMPORTANT] ==== -To ensure optimal functionality, use the same version for your secured-cluster-services Helm chart and central-services Helm chart. +To ensure optimal functionality, use the same version for your secured-cluster-services Helm chart and central-services Helm chart. For {product-title-managed-short}, use the latest version of the secured-cluster-services Helm chart that is available. (The software version for Central is automatically updated.) ==== include::modules/back-up-central-database.adoc[leveloffset=+1] diff --git a/upgrading/upgrade-operator.adoc b/upgrading/upgrade-operator.adoc index b773f6c3e30e..ed54f55ccaa0 100644 --- a/upgrading/upgrade-operator.adoc +++ b/upgrading/upgrade-operator.adoc @@ -9,7 +9,6 @@ toc::[] [role="_abstract"] Upgrades through the {rh-rhacs-first} Operator are performed automatically or manually, depending on the *Update approval* option you chose at installation. Upgrading from version 3.74 to 4.x requires some additional steps that are described on this page. Upgrading within 4.y versions requires no additional steps. -[discrete] [id="upgrading-from-version-3x-to-4x_{context}"] == Upgrading from version 3.74 to 4.x @@ -23,22 +22,22 @@ Upgrades through the {rh-rhacs-first} Operator are performed automatically or ma * You must be using {product-title-short} 3.74 to upgrade to {product-title-short} 4.0. If you are using a version older than 3.74, you must first upgrade to {product-title-short} 3.74 and then upgrade to {product-title-short} 4.0. ==== -include::modules/prepare-operator-upgrades.adoc[leveloffset=+1] +include::modules/prepare-operator-upgrades.adoc[leveloffset=+2] [role="_additional-resources"] .Additional resources * link:https://docs.openshift.com/container-platform/latest/operators/admin/olm-upgrading-operators.html[Updating installed Operators] * xref:../backup_and_restore/backing-up-acs.adoc[Backing up {product-title}] -include::modules/operator-upgrade-modify-central-custom-resource.adoc[leveloffset=+1] +include::modules/operator-upgrade-modify-central-custom-resource.adoc[leveloffset=+3] -include::modules/operator-upgrade-modify-central-custom-resource-tech-preview.adoc[leveloffset=+1] +include::modules/operator-upgrade-modify-central-custom-resource-tech-preview.adoc[leveloffset=+3] -include::modules/operator-upgrade-change-subscription-channel.adoc[leveloffset=+1] +include::modules/operator-upgrade-change-subscription-channel.adoc[leveloffset=+3] -include::modules/remove-central-attached-pv-overview.adoc[leveloffset=+1] +include::modules/remove-central-attached-pv-overview.adoc[leveloffset=+3] -include::modules/remove-central-attached-pv-operator.adoc[leveloffset=+2] +include::modules/remove-central-attached-pv-operator.adoc[leveloffset=+4] [id="rollback-operator-upgrade"] == Rolling back an Operator upgrade