Skip to content

Commit 1244f19

Browse files
pneedle-rhpneedle-rh
authored
Merge pull request #49526 from slovern/TELCODOCS-508-4.12
TELCODOCS-508 Enhance SRO cluster upgrade support
2 parents 18e1885 + a422be0 commit 1244f19

File tree

5 files changed

+123
-0
lines changed

5 files changed

+123
-0
lines changed

‎_topic_maps/_topic_map.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -539,6 +539,8 @@ Topics:
539539
Distros: openshift-enterprise
540540
- Name: Updating hardware on nodes running on vSphere
541541
File: updating-hardware-on-nodes-running-on-vsphere
542+
- Name: Updating a cluster that includes the Special Resource Operator
543+
File: updating-clusters-sro
542544
# - Name: Troubleshooting an update
543545
# File: updating-troubleshooting
544546
---

‎modules/update-updating-clusters-sro-concept.adoc

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * updating/updating-clusters-sro.adoc
4+
5+
:_content-type: CONCEPT
6+
[id="custom-resource-and-verification-status-information_{context}"]
7+
= Custom resource and verification status information
8+
9+
The preflight check provides information on the status of the custom resource (CR) and the status of the verification.
10+
11+
.Possible CR statuses
12+
13+
The possible CR statuses are as follows:
14+
--
15+
`True`:: The Special Resource Operator (SRO) CR will upgrade without kernel compatibility issues.
16+
`False`:: There is an issue with kernel compatibility for the CR. The `Status Reason` field provides additional information on this.
17+
`Error`:: The status check was not completed due to an internal error. The `Status Reason` field provides additional information on debugging this.
18+
`Unknown`:: The check has not yet verified the status of the CR. This might be because the process has not yet reached the specific CR or not enough time has elapsed for the check to complete.
19+
--
20+
21+
.Possible verification statuses
22+
23+
The possible verification statuses are as follows:
24+
25+
--
26+
`True`:: The image exists and is compatible, or the image does not exist but there is a `BuildConfig` resource in place.
27+
`False`:: The image does not exist and there is no `BuildConfig` resource in place, or an image exists but it is not compatible with the new kernel version.
28+
+
29+
If the verification status is `False`, you can take one of the following steps:
30+
+
31+
* Create a prebuilt image with the correct name and check the status field again.
32+
* Change the CR to include a `BuildConfig` reosurce.
33+
--

‎modules/update-upgrading-sro.adoc

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * updating/updating-clusters-sro.adoc
4+
5+
:_content-type: PROCEDURE
6+
[id="updating-running-a-preflight-check-for-sro_{context}"]
7+
= Running a preflight check for the Special Resource Operator
8+
9+
You can use the following example procedure to check the compatibility of a kernel module version before updating a cluster that includes the Special Resource Operator (SRO).
10+
11+
.Prerequisites
12+
13+
* You have a running {product-title} cluster.
14+
* You installed the OpenShift CLI (`oc`).
15+
* You are logged in to the OpenShift CLI as a user with `cluster-admin` privileges.
16+
* You installed the SRO.
17+
18+
.Procedure
19+
20+
. Create the following preflight validation custom resource definition (CRD) and save the YAML as `prevalidation.yaml`.
21+
+
22+
[source,yaml]
23+
----
24+
apiVersion: sro.openshift.io/v1beta1
25+
kind: PreflightValidation
26+
metadata:
27+
name: preflight
28+
namespace: preflight
29+
spec:
30+
updateImage: quay.io/openshift-release-dev/ocp-release@sha256:f7f252c39b64601c8ac3de737a584ba4f6016b1f4b17801d726ca2fd15492878 <1>
31+
----
32+
<1> Specify the name of the update image here.
33+
+
34+
. Start the validation check by running the following command:
35+
+
36+
[source,terminal]
37+
----
38+
$ oc apply -f prevalidation.yaml
39+
----
40+
41+
.Verification
42+
* Check the status of the custom resource (CR) by running the following command:
43+
+
44+
[source,terminal]
45+
----
46+
$ oc describe preflightvalidations.sro.openshift.io/v1beta1 preflight
47+
----
48+
+
49+
.Example output
50+
The following is an example output in which `simple-oot` is a `SpecialResource` CR that is deployed on the cluster.
51+
+
52+
[source,terminal]
53+
----
54+
Status:
55+
Cr Statuses:
56+
Last Transition Time: 2022-08-02T08:48:45Z
57+
Name: simple-oot
58+
Status Reason: Verification successful, all driver-containers for the next kernel version are present
59+
Verification Stage: Image
60+
Verification Status: True
61+
Events: <none>
62+
----
63+
+
64+
The preflight check continues to run until all CRs are verified. You can repeat the preceding command to check the status. After all CRs are verified, you should delete the preflight CR.

‎updating/index.adoc

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -88,6 +88,11 @@ xref:../updating/updating-hardware-on-nodes-running-on-vsphere.adoc#updating-har
8888
* xref:../updating/updating-hardware-on-nodes-running-on-vsphere.adoc#updating-virtual-hardware-on-vsphere_updating-hardware-on-nodes-running-in-vsphere[Updating virtual hardware on vSphere]
8989
* xref:../updating/updating-hardware-on-nodes-running-on-vsphere.adoc#scheduling-virtual-hardware-update-on-vsphere_updating-hardware-on-nodes-running-in-vsphere[Scheduling an update for virtual hardware on vSphere]
9090

91+
[id="updating-clusters-overview-sro"]
92+
== Updating a cluster that includes the Special Resource Operator
93+
94+
xref:../updating/updating-clusters-sro.adoc#updating-clusters-sro[Updating a cluster that includes the Special Resource Operator]: When updating a cluster that includes the Special Resource Operator (SRO), it is important to consider whether the new kernel module version is compatible with the kernel modules currently loaded by the SRO. You can run a preflight check to confirm if the SRO will be able to upgrade the kernel modules.
95+
9196
[IMPORTANT]
9297
====
9398
Using hardware version 13 for your cluster nodes running on vSphere is now deprecated. This version is still fully supported, but support will be removed in a future version of {product-title}. Hardware version 15 is now the default for vSphere virtual machines in {product-title}.

‎updating/updating-clusters-sro.adoc

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
:_content-type: ASSEMBLY
2+
[id="updating-clusters-sro"]
3+
= Updating a cluster that includes the Special Resource Operator
4+
include::_attributes/common-attributes.adoc[]
5+
:context: updating-clusters-sro
6+
7+
toc::[]
8+
9+
When updating a cluster that includes the Special Resource Operator (SRO), it is important to consider whether the new kernel module version is compatible with the kernel modules currently loaded by the SRO. You can run a preflight check to confirm if the SRO will be able to upgrade the kernel modules.
10+
11+
include::modules/update-updating-clusters-sro-concept.adoc[leveloffset=+1]
12+
13+
include::modules/update-upgrading-sro.adoc[leveloffset=+1]
14+
15+
[role="_additional-resources"]
16+
[id="additional-resources_updating-clusters-sro"]
17+
== Additional resources
18+
19+
* xref:../hardware_enablement/psap-special-resource-operator.adoc#special-resource-operator[Special Resource Operator]

0 commit comments

Comments
 (0)