Skip to content

Commit 1cc9aa7

Browse files
authored
TELCODOCS-1191: Clean up of SNO references in TALM docs (#56826)
* TELCODOCS-1191: Clean up of SNO references in TALM docs * openshift-talm-pre-cache changed to openshift-talo-pre-cache
1 parent c69dcfe commit 1cc9aa7

6 files changed

+12
-8
lines changed

modules/cnf-about-topology-aware-lifecycle-manager-config.adoc

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,9 @@ The {cgu-operator-first} manages the deployment of {rh-rhacm-first} policies for
1616
* The order of policies remediated to the cluster
1717
* The assignment of a canary cluster
1818
19-
For {sno}, the {cgu-operator-first} can create a backup of a deployment before an upgrade. If the upgrade fails, you can recover the previous version and restore a cluster to a working state without requiring a reprovision of applications.
19+
For {sno}, the {cgu-operator-first} offers the following features:
20+
21+
* Create a backup of a deployment before an upgrade
22+
* Pre-caching images for clusters with limited bandwidth
2023
2124
{cgu-operator} supports the orchestration of the {product-title} y-stream and z-stream updates, and day-two operations on y-streams and z-streams.

modules/cnf-topology-aware-lifecycle-manager-about-cgu-crs.adoc

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -168,7 +168,7 @@ Policies are missing or invalid, or an invalid platform image has been specified
168168
[id="precaching_{context}"]
169169
== Pre-caching
170170

171-
Clusters might have limited bandwidth to access the container image registry, which can cause a timeout before the updates are completed. You can use pre-caching to avoid this. The container image pre-caching starts when you create a `ClusterGroupUpgrade` CR with the `preCaching` field set to `true`.
171+
Clusters might have limited bandwidth to access the container image registry, which can cause a timeout before the updates are completed. On {sno} clusters, you can use pre-caching to avoid this. The container image pre-caching starts when you create a `ClusterGroupUpgrade` CR with the `preCaching` field set to `true`.
172172

173173
{cgu-operator} uses the `PrecacheSpecValid` condition to report status information as follows:
174174

@@ -192,6 +192,7 @@ For more information see the "Using the container image pre-cache feature" secti
192192

193193
[id="creating_backup_{context}"]
194194
== Creating a backup
195+
195196
For {sno}, {cgu-operator} can create a backup of a deployment before an update. If the update fails, you can recover the previous version and restore a cluster to a working state without requiring a reprovision of applications. To use the backup feature you first create a `ClusterGroupUpgrade` CR with the `backup` field set to `true`. To ensure that the contents of the backup are up to date, the backup is not taken until you set the `enable` field in the `ClusterGroupUpgrade` CR to `true`.
196197

197198
{cgu-operator} uses the `BackupSucceeded` condition to report the status and reasons as follows:

modules/cnf-topology-aware-lifecycle-manager-backup-feature.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
[id="talo-backup-start_and_update_{context}"]
77
= Creating a ClusterGroupUpgrade CR with backup
88

9-
For {sno}, you can create a backup of a deployment before an upgrade. If the upgrade fails you can use the `upgrade-recovery.sh` script generated by {cgu-operator-first} to return the system to its preupgrade state.
9+
You can create a backup of a deployment before an upgrade on {sno} clusters. If the upgrade fails you can use the `upgrade-recovery.sh` script generated by {cgu-operator-first} to return the system to its preupgrade state.
1010
The backup consists of the following items:
1111

1212
Cluster backup:: A snapshot of `etcd` and static pod manifests.

modules/cnf-topology-aware-lifecycle-manager-precache-concept.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
[id="talo-precache-feature-concept_{context}"]
77
= Using the container image pre-cache feature
88

9-
Clusters might have limited bandwidth to access the container image registry, which can cause a timeout before the updates are completed.
9+
{sno-caps} clusters might have limited bandwidth to access the container image registry, which can cause a timeout before the updates are completed.
1010

1111
[NOTE]
1212
====
@@ -28,7 +28,7 @@ The pre-caching spec is incomplete.
2828

2929
* `true`
3030
+
31-
TALM has concluded the pre-caching process. If pre-caching fails for any cluster, the update fails for that cluster but proceeds for all other clusters. A message informs you if pre-caching has failed for any clusters.
31+
{cgu-operator} has concluded the pre-caching process. If pre-caching fails for any cluster, the update fails for that cluster but proceeds for all other clusters. A message informs you if pre-caching has failed for any clusters.
3232
* `false`
3333
+
3434
Pre-caching is still in progress for one or more clusters or has failed for all clusters.

modules/cnf-topology-aware-lifecycle-manager-precache-feature.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
[id="talo-precache-start_and_update_{context}"]
77
= Creating a ClusterGroupUpgrade CR with pre-caching
88

9-
The pre-cache feature allows the required container images to be present on the spoke cluster before the update starts.
9+
For {sno}, the pre-cache feature allows the required container images to be present on the spoke cluster before the update starts.
1010

1111
.Prerequisites
1212

@@ -111,7 +111,7 @@ $ oc get cgu -n ztp-group-du-sno du-upgrade-4918 -o jsonpath='{.status}'
111111
+
112112
[source,terminal]
113113
----
114-
$ oc get jobs,pods -n openshift-talm-pre-cache
114+
$ oc get jobs,pods -n openshift-talo-pre-cache
115115
----
116116
+
117117
.Example output

scalability_and_performance/cnf-talm-for-cluster-upgrades.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ include::_attributes/common-attributes.adoc[]
66

77
toc::[]
88

9-
You can use the {cgu-operator-first} to manage the software lifecycle of multiple {sno} clusters. {cgu-operator} uses {rh-rhacm-first} policies to perform changes on the target clusters.
9+
You can use the {cgu-operator-first} to manage the software lifecycle of multiple clusters. {cgu-operator} uses {rh-rhacm-first} policies to perform changes on the target clusters.
1010

1111
:FeatureName: {cgu-operator-full}
1212

0 commit comments

Comments
 (0)