Skip to content

Commit 434f6dc

Browse files
kcarmichael08openshift-cherrypick-robot
authored andcommitted
clarify automatic upgrades for secured clusters
1 parent e766c6a commit 434f6dc

7 files changed

+30
-20
lines changed

_topic_maps/_topic_map.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -168,7 +168,7 @@ Topics:
168168
File: enable-alert-data-retention
169169
- Name: Exposing the RHACS portal over HTTP
170170
File: expose-portal-over-http
171-
- Name: Configuring automatic upgrades for secured clusters
171+
- Name: Configuring automatic upgrades for manifest-installed secured clusters
172172
File: configure-automatic-upgrades
173173
- Name: Configuring automatic removal of nonactive clusters
174174
File: configure-inactive-cluster-deletion
Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,20 @@
11
[id="configure-automatic-upgrades"]
2-
= Configuring automatic upgrades for secured clusters
2+
= Configuring automatic upgrades for manifest-installed secured clusters
33
include::modules/common-attributes.adoc[]
44
:context: configure-automatic-upgrades
55

66
toc::[]
77

88
[role="_abstract"]
9-
You can automate the upgrade process for each secured cluster and view the upgrade status from the {product-title-short} portal.
9+
If you installed {product-title} by using the manifest installation method, also known as the _`roxctl` CLI method_ or the _legacy installation method_, you can automate the upgrade process for each secured cluster. You can also view the upgrade status from the {product-title-short} portal.
1010

11-
Automatic upgrades make it easier to stay up-to-date by automating the manual task of upgrading each secured cluster.
11+
[NOTE]
12+
====
13+
Automatic upgrades are only available for {product-title-short} systems that were installed by using the manifest installation method. If you installed {product-title-short} by using the Operator, upgrades are controlled by using {olm-first}. If you installed {product-title-short} by using Helm charts, you must use Helm to upgrade.
14+
====
1215

13-
With automatic upgrades, after you upgrade Central; Sensor, Collector, and Compliance services in all secured clusters, automatically upgrade to the latest version.
16+
Automatic upgrades make it easier to stay up-to-date by automating the manual task of upgrading each secured cluster. If you have automatic upgrades enabled, and the secured cluster is configured for receiving automated upgrades, the upgrader upgrades the entire secured cluster to the same version as Central.
1417

15-
{product-title} also enables centralized management of all your secured clusters from within the {product-title-short} portal.
1618
The new *Clusters* view displays information about all your secured clusters, the Sensor version for every cluster, and upgrade status messages.
1719
You can also use this view to selectively upgrade your secured clusters or change their configuration.
1820

@@ -21,8 +23,8 @@ You can also use this view to selectively upgrade your secured clusters or chang
2123
* The automatic upgrade feature is enabled by default.
2224
* If you are using a private image registry, you must first push the Sensor and Collector images to your private registry.
2325
* The Sensor must run with the default RBAC permissions.
24-
* Automatic upgrades do not preserve any patches that you have made to any {product-title} services running in your cluster.
25-
However, it preserves all labels and annotations that you have added to any {product-title} object.
26+
* Automatic upgrades do not preserve any patches that you have made to any {product-title-short} services running in your cluster.
27+
However, it preserves all labels and annotations that you have added to any {product-title-short} object.
2628
* By default, {product-title} creates a service account called `sensor-upgrader` in each secured cluster.
2729
This account is highly privileged but is only used during upgrades.
2830
If you remove this account, Sensor does not have enough permissions, and you must complete future upgrades manually.
@@ -36,4 +38,9 @@ include::modules/automatic-upgrade-status.adoc[leveloffset=+1]
3638

3739
include::modules/automatic-upgrade-failure.adoc[leveloffset=+1]
3840

41+
[role="_additional-resources"]
42+
.Additional resources
43+
44+
* xref:../upgrading/upgrade-roxctl.adoc#troubleshooting-upgrader_upgrade-roxctl[Troubleshooting the cluster upgrader]
45+
3946
include::modules/manual-upgrade-secured-clusters.adoc[leveloffset=+1]

modules/automatic-upgrade-failure.adoc

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,22 +3,22 @@
33
// * configuration/configure-automatic-upgrades.adoc
44
:_mod-docs-content-type: CONCEPT
55
[id="automatic-upgrade-failure_{context}"]
6-
= Automatic upgrade failure
6+
= Automatic upgrade failure for manifest-installed secured clusters
77

8-
Sometimes, {product-title} automatic upgrades might fail to install.
8+
Sometimes, {product-title-short} automatic upgrades might fail to install.
99
When an upgrade fails, the status message for the secured cluster changes to `Upgrade failed. Retry upgrade`.
10-
To view more information about the failure and understand why the upgrade failed, you can check the secured cluster row in the *Clusters* view.
10+
To view more information about the failure and understand why the upgrade failed, you can check the secured cluster row in the *Clusters* view. For more information, see "Troubleshooting the cluster upgrader".
1111

1212
Some common reasons for the failure are:
1313

1414
* The sensor-upgrader deployment might not have run because of a missing or a non-schedulable image.
1515
* The pre-flight checks may have failed, either because of insufficient RBAC permissions or because the cluster state is not recognizable.
1616
This can happen if you have edited {product-title} service configurations or the `auto-upgrade.stackrox.io/component` label is missing.
1717
* There might be errors in executing the upgrade. If this happens, the upgrade installer automatically attempts to roll back the upgrade.
18-
+
18+
1919
[NOTE]
2020
====
21-
Sometimes, the rollback can fail as well. For such cases view the cluster logs to identify the issue or contact support.
21+
Sometimes, the rollback can also fail. For these cases, view the cluster logs to identify the issue or contact support. For more information, see "Troubleshooting the cluster upgrader".
2222
====
2323

2424
After you identify and fix the root cause for the upgrade failure, you can use the *Retry Upgrade* option to upgrade your secured cluster.

modules/automatic-upgrade-status.adoc

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ The *Clusters* view lists all clusters and their upgrade statuses.
1111
|===
1212
|Upgrade status |Description
1313

14-
|Up to date with Central version
14+
|Up to date with Central
1515
|The secured cluster is running the same version as Central.
1616

1717
|Upgrade available
@@ -27,4 +27,7 @@ The *Clusters* view lists all clusters and their upgrade statuses.
2727
|Pre-flight checks complete
2828
|The upgrade is in progress. Before performing automatic upgrade, the upgrade installer runs a pre-flight check. During the pre-flight check, the installer verifies if certain conditions are satisfied and then only starts the upgrade process.
2929

30+
|Not applicable
31+
|{product-title-short} cannot communicate with the cluster.
32+
3033
|===

modules/disable-automatic-upgrades.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
// * configuration/configure-automatic-upgrades.adoc
44
:_mod-docs-content-type: PROCEDURE
55
[id="disable-automatic-upgrades_{context}"]
6-
= Disabling automatic upgrades
6+
= Disabling automatic upgrades of manifest-installed secured clusters
77

88
If you want to manage your secured cluster upgrades manually, you can disable automatic upgrades.
99

modules/enable-automatic-upgrades.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@
33
// * configuration/configure-automatic-upgrades.adoc
44
:_mod-docs-content-type: PROCEDURE
55
[id="enable-automatic-upgrades_{context}"]
6-
= Enabling automatic upgrades
6+
= Enabling automatic upgrades for manifest-installed secured clusters
77

8-
You can enable automatic upgrades for all secured clusters to automatically upgrade Collector and Compliance services in all secured clusters to the latest version.
8+
You can enable automatic upgrades for all secured clusters that were installed by using the manifest installation method, also known as the `roxctl` CLI method. This feature automatically upgrades Sensor, Admission Controller, Collector, and Compliance in all secured clusters to the same version as Central.
99

1010
.Procedure
1111

modules/manual-upgrade-secured-clusters.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,6 @@ To manually trigger upgrades for your secured clusters:
1212
.Procedure
1313

1414
. In the {product-title-short} portal, go to *Platform Configuration* -> *Clusters*.
15-
. Select the *Upgrade available* option under the *Upgrade status* column for the cluster you want to upgrade.
16-
. To upgrade multiple clusters at once, select the checkboxes in the *Cluster* column for the clusters you want to update.
17-
. Click *Upgrade*.
15+
. Take one of the following actions:
16+
* To upgrade a single cluster, select the *Upgrade available* option under the *Sensor Upgrade* column for the cluster you want to upgrade.
17+
* To upgrade multiple clusters at a time, select the checkboxes next to the *Name* column for the clusters you want to update, and then click *Upgrade*.

0 commit comments

Comments
 (0)