Skip to content

Commit 0e31df8

Browse files
committed
Fixing typos, punctuation, style
according to Style Guide
1 parent 0a0768c commit 0e31df8

File tree

1 file changed

+71
-61
lines changed

1 file changed

+71
-61
lines changed

adoc/SAP-Edge-Upgrade.adoc

Lines changed: 71 additions & 61 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,15 @@
22
# tag::intro[]
33
== Upgrade guidance
44

5-
When upgrading your SAP edge application related clusters, SUSE advices to follow the order of upgrading Rancher first, then Kubernetes and afterwards the OS.
6-
At https://www.suse.com/support/kb/doc/?id=000020061 you can find some information that will help you to prepare the upgrade.
5+
When upgrading your SAP edge application clusters, SUSE advises upgrading Rancher first, followed by Kubernetes,
6+
and finally the operating system. For helpful preparation guidelines, refer to
7+
https://www.suse.com/support/kb/doc/?id=000020061.
78
# end::intro[]
89

910
# tag::eic[]
1011
=== Upgrading {eic}
1112

12-
Before upgrading your {eic} instance, please make sure that the target version was release for your {rke} cluster version:
13+
Before upgrading your {eic} instance, ensure the target version was release for your {rke} cluster version:
1314
https://me.sap.com/notes/3247839
1415

1516

@@ -20,17 +21,17 @@ https://help.sap.com/docs/integration-suite/sap-integration-suite/upgrade-edge-i
2021
To upgrade your {eic} instance, navigate to the Edge Nodes of your {break elm} UI.
2122
Select the edge node you want to upgrade. In the Deployments view, you should see your deployed solutions and their version.
2223

23-
To upgrade, click on the ... and select *Upgrade* as show in the picture below:
24+
To upgrade, click the three dots *...* and select *Upgrade* as show in the image below:
2425

2526
image::SAP-EIC-Upgrade-EIC.png[title=EIC Upgrade example,scaledwidth=99%,opts=inline,Embedded]
2627

27-
In the next couple of steps, you will be guided through the upgrade process, including the selection of the version you want to upgrade to.
28-
If there are dependencies between your deployments, {elm} will show you those and upgrade the dependencies as well.
28+
The following steps guide you through the upgrade process, including selecting the target version you want to upgrade to.
29+
If there are dependencies between your deployments, {elm} will display them and include them in the upgrade.
2930

3031
image::SAP-EIC-Upgrade-Dependencies.png[title=EIC Upgrade example,scaledwidth=99%,opts=inline,Embedded]
3132

32-
If you skipped some versions of {eic}, it might be the case that you will need to take intermidiate steps before you can upgrade to the desired version.
33-
In this case, you will need to repeat the steps to upgrade {eic} until you have reached your desired version.
33+
If you have skipped multiple versions of {eic}, you might need to perform intermediate upgrades before installing the desired version.
34+
In this case, repeat the upgrade steps for {eic} until you reach your target version.
3435

3536
# end::eic[]
3637

@@ -41,73 +42,73 @@ In this case, you will need to repeat the steps to upgrade {eic} until you have
4142
++++
4243
=== Upgrading {rke}
4344

44-
In this chapter we will describe how to upgrade {rke}.
45-
46-
IMPORTANT: It is highly recommended to upgrade one minor version after another. Furthermore you should always upgrade to the highest patch level before upgrading the minor version.
45+
In this chapter, we describe how to upgrade {rke}.
4746

47+
IMPORTANT: It is highly recommended sequentially through each minor version.
48+
Additionally, always upgrade to the latest patch level of your current version before proceeding to the next minor version.
4849

4950
==== Upgrading {rke} using {rancher}
5051

51-
IMPORTANT: This is the prefered way to upgrade all {rke} clusters managed by {rancher}.
52+
IMPORTANT: This is the preferred way to upgrade all {rke} clusters managed by {rancher}.
5253

53-
When you deployed your {rke} cluster using {rancher}, you can also upgrade the cluster using {rancher}.
54-
Therefore enter your *Cluster Management* view in {rancher}.
54+
If you deployed your {rke} cluster using {rancher}, you can also upgrade it through the same interface.
55+
To begin, navigate to the *Cluster Management* view.
5556

5657
image::SAP-Edge-Cluster-Management.png[title=Cluster Management Overview,scaledwidth=99%,opts=inline,Embedded]
5758

5859
++++
5960
<?pdfpagebreak?>
6061
++++
6162

62-
Click on the burger menu of the cluster you want to upgrade and click *Edit Config*.
63+
Click the menu icon ("hamburger menu") for the cluster you wish to upgrade and select *Edit Config*.
6364

6465
image::SAP-Edge-Cluster-Management-Edit.png[title=Cluster Management Edit Config,scaledwidth=99%,opts=inline,Embedded]
6566

6667
++++
6768
<?pdfpagebreak?>
6869
++++
6970

70-
Scroll down to the *Cluster Configuration* section, wher you can find the field *Kubernetes Version*.
71+
Scroll down to the *Cluster Configuration* section, where you find the field *Kubernetes Version*.
7172

7273
image::SAP-Edge-Cluster-Management-Edit-K8s.png[title=Upgrade Kubernetes,scaledwidth=99%,opts=inline,Embedded]
7374

74-
Select the Kubernetes Version you want to upgrade to and click on *Save* in the bottom right corner of your window.
75+
Select the Kubernetes version you want to upgrade to and click *Save* at the bottom right corner of your window.
7576

7677
++++
7778
<?pdfpagebreak?>
7879
++++
7980

8081
==== Upgrading {rke} without {rancher}
8182

82-
When upgrading {rke} wihtout {rancher} there are two strategies to be considered:
83+
When upgrading {rke} without {rancher}, consider the following two strategies:
8384

84-
1. Upgrading the existing nodes one by one
85-
2. Adding an additional (temporary) node that already holds the upgrade
85+
1. In-place upgrade: Upgrading the existing nodes one by one.
86+
2. Rolling upgrade: Adding a temporary node already running the new version.
8687

87-
WARNING: Whatever strategy you choose, it is highly recommended to upgrade the control plane nodes before upgrading the worker nodes.
88-
Furthermore you should upgrade one node at a time.
88+
WARNING: Regardless of the strategy choosen, it is highly recommended to upgrade the control plane nodes
89+
before the worker nodes. Furthermore, you should always upgrade nodes sequentially (one at a time).
8990

9091

9192
===== Upgrading with temporary nodes
9293

93-
When upgrading the cluster with temporary nodes, you'll add a new node to the cluster that already holds the upgrades.
94+
When upgrading the cluster with temporary nodes, you add a new node to the cluster that already runs the new version.
9495

95-
So initially you will have a landscape like this:
96+
Initially, your landscape will look as shown in the following image:
9697

9798
image::SAP-Edge-Upgrade-init.svg[title=Upgrade RKE2 init,scaledwidth=99%,opts=inline,Embedded]
9899

99-
And after adding the new node, the landscape will look like this:
100+
After having added the new node, the landscape will look as shown below:
100101

101102
image::SAP-Edge-Upgrade-add-CP.svg[title=Upgrade RKE2 add,scaledwidth=99%,opts=inline,Embedded]
102103

103-
Once the node was added and all mandatory components have been deployed on it, another non-upgraded node can be removed from the cluster:
104+
After the new node has been added and all mandatory components are successfully deployed, you can remove a non-upgraded node from the cluster:
104105

105106
image::SAP-Edge-Upgrade-rm-CP.svg[title=Upgrade RKE2 rm,scaledwidth=99%,opts=inline,Embedded]
106107

107-
IMPORTANT: Before you remove the node from the cluster, you should cordon and drain it.
108-
Cordoning a node will prevent new workloads to be scheduled on the node, while draining will reschedule the already running workloads.
108+
Before removing a node from the cluster, you must cordon and drain it.
109+
Cordoning prevents new workloads from being scheduled on the node, while draining evicts running workloads so they can be rescheduled elsewhere.
109110

110-
The same procedure can be done for the upgrades of the worker nodes:
111+
Follow the same procedure to upgrade the worker nodes:
111112

112113
image::SAP-Edge-Upgrade-worker.svg[title=Upgrade RKE2 worker,scaledwidth=99%,opts=inline,Embedded]
113114

@@ -122,16 +123,16 @@ kubectl cordon <node-name>
122123
kubectl drain <node-name> --grace-period=600
123124
----
124125

125-
Depending on the way you installed {rke}, the upgrade is performed differently.
126-
For more information about the manual upgrade please refer to https://docs.rke2.io/upgrades/manual_upgrade.
126+
The upgrade method depends on how you originally installed {rke}.
127+
For details on manual upgrades, refer to https://docs.rke2.io/upgrades/manual_upgrade.
127128

128-
IMPORTANT: Don't use another method for upgrading than you used to install.
129-
If you installed {rke} using the RPM, you should not try to upgrade using the installation script.
129+
IMPORTANT: You must upgrade using the same method used for installation.
130+
For example, if you installed {rke} via RPM, do not attempt to upgrade using the installation script.
130131

131-
In this guide we'll give you an example how to upgrade using the installation script.
132+
In this guide, we demonstrate how to upgrade using the installation script.
132133

133-
To upgrade {rke} using the installation script, connect to your {rke} node and run the command below. Make sure to replace the version
134-
with your desired target version.
134+
To proceed, connect to your {rke} node and run the command below.
135+
Ensure you replace the version placeholder with your desired target version.
135136

136137
[source, bash]
137138
----
@@ -155,14 +156,14 @@ To restart the service on a worker node, run:
155156
sudo systemctl restart rke2-agent
156157
----
157158

158-
After the service was restarted, you can uncordon your node, so it can be used for scheduling again:
159+
When the service has restarted, uncordon the node to resume scheduling:
159160

160161
[source, bash]
161162
----
162163
kubectl uncordon <node-name>
163164
----
164165

165-
These steps need to be repeated for every machine of the cluster.
166+
Repeat these steps for every machine of the cluster.
166167

167168
++++
168169
<?pdfpagebreak?>
@@ -177,9 +178,10 @@ These steps need to be repeated for every machine of the cluster.
177178
++++
178179
=== Upgrading {rancher}
179180

180-
IMPORTANT: We strongly recommend taking a backup before upgrading your {rancher} instance. Please refer to https://ranchermanager.docs.rancher.com/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/back-up-rancher for further information.
181+
IMPORTANT: We strongly recommend backing up your {rancher} instance before upgrading. For instructions, refer to the Rancher Backup and Restore Guide:
182+
https://ranchermanager.docs.rancher.com/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/back-up-rancher.
181183

182-
A detailed overview of the upgrade process can be found at:
184+
For a detailed overview of the upgrade process, see the official documentation:
183185
https://ranchermanager.docs.rancher.com/getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/upgrades
184186

185187
In this chapter we'll describe the most common upgrade path.
@@ -191,14 +193,14 @@ The first step is to update the helm repository:
191193
helm repo update
192194
----
193195

194-
Afterwards it's recommended to take a backup of the configuration parameters of the currently Helm deployment:
196+
Next, we recommend backing up the configuration parameters of the current Helm deployment:
195197

196198
[source, bash]
197199
----
198200
helm get values rancher -n cattle-system -o yaml > values.yaml
199201
----
200202

201-
The upgrade of {rancher} is then triggered by running the command below, where you'll specify the version to upgrade to:
203+
The upgrade of {rancher} is then triggered by running the command below, where you specify the version to upgrade to:
202204

203205
[source, bash]
204206
----
@@ -212,29 +214,36 @@ helm upgrade rancher rancher-prime/rancher \
212214

213215

214216
# tag::harvester[]
217+
215218
++++
216219
<?pdfpagebreak?>
217220
++++
221+
218222
=== Upgrading {harvester}
219223

220-
WARNING: Make sure to verify your {harvester} version is supported with your coupled {rancher} instance. You can check this at https://www.suse.com/suse-harvester/support-matrix/all-supported-versions/harvester-v1-5-x/ under *Harvester & Rancher Support Matrix*.
224+
WARNING: Ensure your {harvester} version is supported and compatible with your {rancher} instance.
225+
Verify this in the *Harvester & Rancher Support Matrix* at https://www.suse.com/suse-harvester/support-matrix/all-supported-versions/harvester-v1-5-x/.
221226

222-
Before upgrading {harvester}, it is highly recommended to use the pre-check script available at https://github.com/harvester/upgrade-helpers/tree/main/pre-check/v1.x.
223-
This will make sure that your cluster is in a healthy state and ready to be upgrade. If the check finds any issues, please make sure to fix the issue before running an upgrade.
224-
It is not necessary to run the script on all nodes - just one is enough.
227+
Before upgrading {harvester}, we highly recommend running the pre-check script available at
228+
https://github.com/harvester/upgrade-helpers/tree/main/pre-check/v1.x.
229+
This script ensures that your cluster is in a healthy state and ready to be upgraded.
230+
If any issues are found, resolve them before proceeding.
231+
It is not necessary to run the script on all nodes, you only need to run it on a single node.
225232

226-
Besides running the check script, we highly recommend to check the official upgrade documentation at https://docs.harvesterhci.io/v1.5/upgrade/index and in particular the sections that refer the upgrade from your current version to the target version.
233+
In addition to running the pre-check script, review the official upgrade documentation at
234+
https://docs.harvesterhci.io/v1.5/upgrade/index, specifically the sections covering the
235+
upgrade path from your current version to your target version.
227236

228-
The upgrade itself can be easily triggered from the {harvester} UI, once an upgrade is available.
229-
If there is an upgrade availabe, the UI will show an *Upgrade* button in the upper right corner of the Dashboard, as shown below:
237+
You can trigger the upgrade directly from the {harvester} UI. When an upgrade is available, an *Upgrade* button will appear
238+
in the upper right corner of the Dashboard, as shown below:
230239

231240
image::SAP-Edge-Upgrade-Harvester-Upgrade-Button.png[title=Harvester upgrade vailable,scaledwidth=99%,opts=inline,Embedded]
232241

233-
If you click on the *Upgrade* button, a window will open, showing all possible target versions.
242+
If you click the *Upgrade* button, a window will open, displaying all possible target versions.
234243

235244
image::SAP-Edge-Upgrade-Harvester-Version.png[title=Harvester upgrade vailable,scaledwidth=99%,opts=inline,Embedded]
236245

237-
After selecting the target version, click on *Upgrade* again, to start the upgrade process.
246+
After selecting the target version, click *Upgrade* again to start the upgrade process.
238247

239248

240249
# end::harvester[]
@@ -243,28 +252,29 @@ After selecting the target version, click on *Upgrade* again, to start the upgra
243252
++++
244253
<?pdfpagebreak?>
245254
++++
246-
=== Upgrading the OS
247-
248-
Depending on the operating system used, the commands and procedures for the upgrade differs.
249-
In this guide we'll describe how to upgrade {slem}, as it's the operating system that we already used to explain how to set up your landscapes.
255+
=== Upgrading the operating system
250256

251-
NOTE: If you want to familiarize with {slem} and the concept of transactional updates, we recommend to read https://documentation.suse.com/sle-micro/{slem_version}/html/Micro-transactional-updates/transactional-updates.html .
257+
Upgrade procedures and commands differ depending on the operating system used.
258+
In this guide, we focus on upgrading {slem}, as this is the operating system used in our landscape setup examples.
252259

260+
NOTE: To familiarize yourself with {slem} and the concept of transactional updates, we recommend reading
261+
https://documentation.suse.com/sle-micro/{slem_version}/html/Micro-transactional-updates/transactional-updates.html .
253262

254-
Before upgrading your {slem} instance, read https://documentation.suse.com/en-us/sle-micro/{slem_version}/html/Micro-upgrade/index.html .
263+
Before upgrading your {slem} instance, read the Upgrade Guide at
264+
https://documentation.suse.com/en-us/sle-micro/{slem_version}/html/Micro-upgrade/index.html .
255265

256-
As a {slem} upgrade is only supported from the most recent patch levels, make sure your system is up to date.
257-
Updating {slem} can be done by running:
266+
Since a {slem} upgrade is only supported from the most recent patch level, ensure your system is fully up to date before proceeding.
267+
You can update {slem} by running:
258268

259269
[source, bash]
260270
----
261271
sudo transactional-update patch
262272
----
263273

264-
WARNING: Keep in mind that transactional-updates requires a reboot to take effect!
274+
WARNING: Keep in mind that transactional updates require a reboot to take effect!
265275

266276

267-
Upgrading {slem} can be done in a similar manner:
277+
You can update {slem} n a similar way:
268278

269279
[source, bash]
270280
----

0 commit comments

Comments
 (0)