Skip to content

Commit 6d21dde

Browse files
authored
Merge pull request #102767 from abrennan89/DOCPLAN-29
DOCPLAN-30: Fixes for CNV postinstall docs for migration
2 parents 537c3f8 + e6c9471 commit 6d21dde

File tree

4 files changed

+52
-36
lines changed

4 files changed

+52
-36
lines changed

modules/virt-configuring-certificate-rotation.adoc

Lines changed: 21 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
// Module included in the following assemblies:
22
//
3-
// * virt/advanced_vm_management/virt-configuring-certificate-rotation.adoc
3+
// * virt/post_installation_configuration/virt-configuring-certificate-rotation.adoc
44

55
:_mod-docs-content-type: PROCEDURE
66
[id="virt-configuring-certificate-rotation_{context}"]
@@ -23,7 +23,6 @@ $ oc edit hyperconverged kubevirt-hyperconverged -n {CNVNamespace}
2323
----
2424

2525
. Edit the `spec.certConfig` fields as shown in the following example. To avoid overloading the system, ensure that all values are greater than or equal to 10 minutes. Express all values as strings that comply with the link:https://golang.org/pkg/time/#ParseDuration[golang `ParseDuration` format].
26-
2726
+
2827
[source,yaml,subs="attributes+"]
2928
----
@@ -36,13 +35,26 @@ spec:
3635
certConfig:
3736
ca:
3837
duration: 48h0m0s
39-
renewBefore: 24h0m0s <1>
38+
renewBefore: 24h0m0s
4039
server:
41-
duration: 24h0m0s <2>
42-
renewBefore: 12h0m0s <3>
40+
duration: 24h0m0s
41+
renewBefore: 12h0m0s
4342
----
44-
<1> The value of `ca.renewBefore` must be less than or equal to the value of `ca.duration`.
45-
<2> The value of `server.duration` must be less than or equal to the value of `ca.duration`.
46-
<3> The value of `server.renewBefore` must be less than or equal to the value of `server.duration`.
43+
+
44+
** The value of `ca.renewBefore` must be less than or equal to the value of `ca.duration`.
45+
** The value of `server.duration` must be less than or equal to the value of `ca.duration`.
46+
** The value of `server.renewBefore` must be less than or equal to the value of `server.duration`.
4747

48-
. Apply the YAML file to your cluster.
48+
. Apply updates to the `HyperConverged` CR by running the following command:
49+
+
50+
[source,terminal]
51+
----
52+
$ oc apply -f <filename>.yaml
53+
----
54+
+
55+
For example:
56+
+
57+
[source,terminal]
58+
----
59+
$ oc apply -f kubevirt-hyperconverged.yaml
60+
----

modules/virt-removing-wasp-agent.adoc

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -11,12 +11,12 @@ If you no longer need memory overcommitment, you can remove the `wasp-agent` com
1111

1212
.Prerequisites
1313

14-
* You are logged in to the cluster with the `cluster-admin` role.
14+
* You have logged in to the cluster with the `cluster-admin` role.
1515
* You have installed the {oc-first}.
1616
1717
.Procedure
1818

19-
. Revert the memory overcommitment configuration:
19+
. Revert the memory overcommitment configuration by running the following command:
2020
+
2121
[source,terminal]
2222
----
@@ -25,21 +25,21 @@ $ oc -n openshift-cnv patch HyperConverged/kubevirt-hyperconverged \
2525
-p='[{"op": "remove", "path": "/spec/higherWorkloadDensity"}]'
2626
----
2727

28-
. Delete the `MachineConfig` that provisions swap memory:
28+
. Delete the `MachineConfig` that provisions swap memory by running the following command:
2929
+
3030
[source,terminal]
3131
----
3232
$ oc delete machineconfig 90-worker-swap
3333
----
3434

35-
. Delete the associated `KubeletConfig`:
35+
. Delete the associated `KubeletConfig` custom resource (CR) by running the following command:
3636
+
3737
[source,terminal]
3838
----
3939
$ oc delete kubeletconfig custom-config
4040
----
4141

42-
. Wait for the worker nodes to reconcile:
42+
. Wait for the worker nodes to reconcile, by running the following command and observing the output:
4343
+
4444
[source,terminal]
4545
----
@@ -49,7 +49,7 @@ $ oc wait mcp worker --for condition=Updated=True --timeout=-1s
4949

5050
.Verification
5151

52-
* Confirm that swap is no longer enabled on a node:
52+
* Confirm that swap is no longer enabled on a node, by running the following command and observing the output:
5353
+
5454
[source,terminal]
5555
----

modules/virt-troubleshooting-cert-rotation-parameters.adoc

Lines changed: 20 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -7,29 +7,33 @@
77
= Troubleshooting certificate rotation parameters
88

99
[role="_abstract"]
10-
Deleting one or more `certConfig` values causes them to revert to the default values, unless the default values conflict with one of the specific conditions. If the default values conflict with these conditions, you will receive an error.
10+
Deleting one or more `certConfig` values in the `HyperConverged` custom resource (CR) causes the `certConfig` values to revert to the default values.
1111

12-
The conditions are:
12+
If the default values conflict with one of the following conditions, you receive an error message instead:
1313

1414
* The value of `ca.renewBefore` must be less than or equal to the value of `ca.duration`.
15-
1615
* The value of `server.duration` must be less than or equal to the value of `ca.duration`.
17-
1816
* The value of `server.renewBefore` must be less than or equal to the value of `server.duration`.
1917
20-
If you remove the `server.duration` value in the following example, the default value of `24h0m0s` is greater than the value of `ca.duration`, conflicting with the specified conditions.
21-
22-
Example:
18+
For example, if you remove the `server.duration` value, the default value of `24h0m0s` is greater than the value of `ca.duration`, which conflicts with the specified conditions:
2319

24-
[source,yaml]
20+
[source,yaml,subs="attributes+"]
2521
----
26-
certConfig:
27-
ca:
28-
duration: 4h0m0s
29-
renewBefore: 1h0m0s
30-
server:
31-
duration: 4h0m0s
32-
renewBefore: 4h0m0s
22+
apiVersion: hco.kubevirt.io/v1beta1
23+
kind: HyperConverged
24+
metadata:
25+
name: kubevirt-hyperconverged
26+
namespace: {CNVNamespace}
27+
spec:
28+
# ...
29+
certConfig:
30+
ca:
31+
duration: 4h0m0s
32+
renewBefore: 1h0m0s
33+
server:
34+
duration: 4h0m0s
35+
renewBefore: 4h0m0s
36+
# ...
3337
----
3438

3539
This results in the following error message:
@@ -39,4 +43,4 @@ This results in the following error message:
3943
error: hyperconvergeds.hco.kubevirt.io "kubevirt-hyperconverged" could not be patched: admission webhook "validate-hco.kubevirt.io" denied the request: spec.certConfig: ca.duration is smaller than server.duration
4044
----
4145

42-
The error message only mentions the first conflict. Review all certConfig values before you proceed.
46+
The error message only mentions the first conflict. Review all `certConfig` values before you proceed.

modules/virt-wasp-agent-pod-eviction.adoc

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,26 +7,26 @@
77
= Pod eviction conditions used by wasp-agent
88

99
[role="_abstract"]
10-
The wasp agent manages pod eviction when the system is heavily loaded and nodes are at risk. Eviction is triggered if one of the following conditions is met:
10+
The wasp agent manages pod eviction when the system is heavily loaded and nodes are at risk. Eviction triggers if one of the following conditions occurs:
1111

1212
High swap I/O traffic::
1313

14-
This condition is met when swap-related I/O traffic is excessively high.
14+
This condition occurs when swap-related I/O traffic is excessively high.
1515
+
1616
Condition:
1717
+
1818
[source,text]
1919
----
20-
averageSwapInPerSecond > maxAverageSwapInPagesPerSecond
20+
averageSwapInPerSecond > maxAverageSwapInPagesPerSecond
2121
&&
2222
averageSwapOutPerSecond > maxAverageSwapOutPagesPerSecond
2323
----
2424
+
25-
By default, `maxAverageSwapInPagesPerSecond` and `maxAverageSwapOutPagesPerSecond` are set to 1000 pages. The default time interval for calculating the average is 30 seconds.
25+
By default, the `maxAverageSwapInPagesPerSecond` and `maxAverageSwapOutPagesPerSecond` values are 1000 pages. The default time interval for calculating the average is 30 seconds.
2626

2727
High swap utilization::
2828

29-
This condition is met when swap utilization is excessively high, causing the current virtual memory usage to exceed the factored threshold. The `NODE_SWAP_SPACE` setting in your `MachineConfig` object can impact this condition.
29+
This condition occurs when swap utilization is excessively high, causing the current virtual memory usage to exceed the factored threshold. The `NODE_SWAP_SPACE` setting in your `MachineConfig` object can impact this condition.
3030
+
3131
Condition:
3232
+

0 commit comments

Comments
 (0)