Skip to content

Commit eade2e8

Browse files
committed
TELCODOCS-791-Upgrade: Adding KATA notes to Upgrade section
1 parent 87848b7 commit eade2e8

File tree

5 files changed

+114
-30
lines changed

5 files changed

+114
-30
lines changed

_topic_maps/_topic_map.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2137,8 +2137,8 @@ Topics:
21372137
File: monitoring-sandboxed-containers
21382138
- Name: Uninstalling OpenShift sandboxed containers
21392139
File: uninstalling-sandboxed-containers
2140-
- Name: Upgrade OpenShift sandboxed containers
2141-
File: upgrade-sandboxed-containers
2140+
- Name: Upgrading OpenShift sandboxed containers
2141+
File: upgrading-sandboxed-containers
21422142
- Name: Collecting OpenShift sandboxed containers data
21432143
File: troubleshooting-sandboxed-containers
21442144
---
@@ -2307,7 +2307,7 @@ Topics:
23072307
- Name: Deploying distributed units manually on single-node OpenShift
23082308
File: ztp-configuring-single-node-cluster-deployment-during-installation
23092309
Distros: openshift-origin,openshift-enterprise
2310-
- Name: Validating cluster tuning for vDU application workloads
2310+
- Name: Validating cluster tuning for vDU application workloads
23112311
File: ztp-vdu-validating-cluster-tuning
23122312
Distros: openshift-origin,openshift-enterprise
23132313
- Name: Provisioning and deploying a distributed unit (DU)
Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
//Module included in the following assemblies:
2+
//
3+
// *upgrading-sandboxed-containers.adoc
4+
5+
:_content-type: PROCEDURE
6+
[id="sandboxed-containers-upgrading-monitor-pods-cli_{context}"]
7+
= Upgrading the monitor pods using the CLI
8+
9+
You can manually patch the monitor image in the `KataConfig` CR to update the monitor pods.
10+
11+
.Prerequisites
12+
13+
* You have {product-title} {product-version} installed on your cluster.
14+
* You have installed the OpenShift CLI (`oc`).
15+
* You have access to the cluster as a user with the `cluster-admin` role.
16+
17+
.Procedure
18+
19+
* In the {product-title} CLI, run the following command:
20+
+
21+
[source,terminal]
22+
----
23+
$ oc patch kataconfig <kataconfig_name> --type merge --patch
24+
'{"spec":{"kataMonitorImage":"registry.redhat.io/openshift-sandboxed-containers/osc-monitor-rhel8:1.3.0"}}'
25+
----
26+
+
27+
where:
28+
`<kataconfig_name>`:: specifies the name of your Kata configuration file, such as `example-kataconfig`.
Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
//Module included in the following assemblies:
2+
//
3+
// *upgrading-sandboxed-containers.adoc
4+
5+
:_content-type: PROCEDURE
6+
[id="sandboxed-containers-upgrading-monitor-pods-web_{context}"]
7+
= Upgrading the monitor pods using the web console
8+
9+
The `KataConfig` YAML file in the {product-title} contains the version number for the monitor image. Update the version number with the correct version.
10+
11+
.Prerequisites
12+
13+
* You have {product-title} {product-version} installed on your cluster.
14+
* You have access to the cluster as a user with the `cluster-admin` role.
15+
16+
.Procedure
17+
18+
. From the *Administrator* perspective of {product-title}, navigate to *Operators**Installed Operators*.
19+
. Select the *{sandboxed-containers-operator}* and go to the *KataConfig* tab.
20+
. Search for the `KataConfig` resource using the *Search by name* field. The default name for the `KataConfig` resource is *example-kataconfig*.
21+
. Select the `KataConfig` resource and go to the *KataConfig* tab.
22+
. Modify the version number for `kataMonitorImage`:
23+
24+
+
25+
[source,yaml]
26+
----
27+
checkNodeEligibility: false
28+
kataConfigPoolSelector: null
29+
kataMonitorImage: 'registry.redhat.io/openshift-sandboxed-containers/osc-monitor-rhel8:1.3.0'
30+
----
31+
32+
. Click *Save*.

sandboxed_containers/upgrade-sandboxed-containers.adoc

Lines changed: 0 additions & 27 deletions
This file was deleted.
Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
:_content-type: ASSEMBLY
2+
[id="upgrading-sandboxed-containers"]
3+
= Upgrading {sandboxed-containers-first}
4+
include::_attributes/common-attributes.adoc[]
5+
:context: upgrading-sandboxed-containers
6+
7+
toc::[]
8+
9+
The upgrade of the {sandboxed-containers-first} components consists of the following three steps:
10+
11+
* Upgrading {product-title} to update the `Kata` runtime and its dependencies.
12+
13+
* Upgrading the {sandboxed-containers-operator} to update the Operator subscription.
14+
15+
* Manually patching the `KataConfig` custom resource (CR) to update the monitor pods.
16+
17+
You can upgrade {product-title} before or after the {sandboxed-containers-operator} upgrade, with the one exception noted below. Always apply the `KataConfig` patch immediately after upgrading {sandboxed-containers-operator}.
18+
19+
[IMPORTANT]
20+
====
21+
22+
If you are upgrading to {product-title} 4.11 with {sandboxed-containers-first} 1.3, the recommended order is to first upgrade {sandboxed-containers-first} from 1.2 to 1.3, and then upgrade {product-title} from 4.10 to 4.11.
23+
====
24+
25+
[id="sandboxed-containers-upgrade-resources"]
26+
== Upgrading the {sandboxed-containers-first} resources
27+
28+
The {sandboxed-containers-first} resources are deployed onto the cluster using {op-system-first} extensions.
29+
30+
//Update the Red Hat CoreOS extension with the updated link once PR is approved for the Understanding section.
31+
32+
The {op-system} extension `sandboxed containers` contains the required components to run Kata Containers such as the Kata containers runtime, the hypervisor QEMU, and other dependencies. You upgrade the extension by upgrading the cluster to a new release of {product-title}.
33+
34+
For more information about upgrading {product-title}, see xref:../updating/index.adoc#index[Updating Clusters].
35+
36+
[id="sandboxed-containers-upgrading-operator"]
37+
== Upgrading the {sandboxed-containers-operator}
38+
39+
Use Operator Lifecycle Manager (OLM) to upgrade the {sandboxed-containers-operator} either manually or automatically. Selecting between manual or automatic upgrade during the initial deployment determines the future upgrade mode. For manual upgrades, the web console shows the available updates that can be installed by the cluster administrator.
40+
41+
For more information about upgrading the {sandboxed-containers-operator} in Operator Lifecycle Manager (OLM), see xref:../operators/admin/olm-upgrading-operators.adoc#olm-upgrading-operators[Upgrading installed Operators].
42+
43+
[id="sandboxed-containers-upgrading-monitor-pods"]
44+
== Upgrading the {sandboxed-containers-first} monitor pods
45+
46+
After upgrading {sandboxed-containers-first}, you need to update the monitor image in the `KataConfig` CR to upgrade the monitor pods. Otherwise, the monitor pods will continue running images from the previous version.
47+
48+
You can perform the update using the web console or the CLI.
49+
50+
include::modules/sandboxed-containers-upgrading-monitor-pods-web.adoc[leveloffset=+2]
51+
include::modules/sandboxed-containers-upgrading-monitor-pods-cli.adoc[leveloffset=+2]

0 commit comments

Comments
 (0)