Skip to content

Commit fe32ee1

Browse files
authored
Merge pull request #56128 from apinnick/4.13-CNV-runbooks
Update CNV runbook module anchor IDs for 4.13
2 parents 55d338c + 79c3cc5 commit fe32ee1

File tree

52 files changed

+406
-306
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

52 files changed

+406
-306
lines changed

modules/virt-runbook-cdidataimportcronoutdated.adoc

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,15 @@
1-
// Automatically generated by 'runbook-conversion.sh'. Do not edit.
1+
// Do not edit this module. It is generated with a script.
2+
// Do not reuse this module. The anchor IDs do not contain a context statement.
23
// Module included in the following assemblies:
34
//
45
// * virt/logging_events_monitoring/virt-runbooks.adoc
56

67
:_content-type: REFERENCE
7-
[id="virt-runbook-cdidataimportcronoutdated_{context}"]
8+
[id="virt-runbook-CDIDataImportCronOutdated"]
89
= CDIDataImportCronOutdated
910

1011
[discrete]
11-
[id="meaning-cdidataimportcronoutdated_{context}"]
12+
[id="meaning-cdidataimportcronoutdated"]
1213
== Meaning
1314

1415
This alert fires when `DataImportCron` cannot poll or import the latest disk
@@ -24,15 +25,15 @@ distribution. For other disk images, _latest_ refers to the latest hash of the
2425
image that is available.
2526

2627
[discrete]
27-
[id="impact-cdidataimportcronoutdated_{context}"]
28+
[id="impact-cdidataimportcronoutdated"]
2829
== Impact
2930

3031
VMs might be created from outdated disk images.
3132

3233
VMs might fail to start because no source PVC is available for cloning.
3334

3435
[discrete]
35-
[id="diagnosis-cdidataimportcronoutdated_{context}"]
36+
[id="diagnosis-cdidataimportcronoutdated"]
3637
== Diagnosis
3738

3839
. Check the cluster for a default storage class:
@@ -112,7 +113,7 @@ $ oc logs -n $CDI_NAMESPACE deployment/cdi-deployment
112113
----
113114

114115
[discrete]
115-
[id="mitigation-cdidataimportcronoutdated_{context}"]
116+
[id="mitigation-cdidataimportcronoutdated"]
116117
== Mitigation
117118

118119
. Set a default storage class, either on the cluster or in the `DataImportCron`

modules/virt-runbook-cdidatavolumeunusualrestartcount.adoc

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,22 @@
1-
// Automatically generated by 'runbook-conversion.sh'. Do not edit.
1+
// Do not edit this module. It is generated with a script.
2+
// Do not reuse this module. The anchor IDs do not contain a context statement.
23
// Module included in the following assemblies:
34
//
45
// * virt/logging_events_monitoring/virt-runbooks.adoc
56

67
:_content-type: REFERENCE
7-
[id="virt-runbook-cdidatavolumeunusualrestartcount_{context}"]
8+
[id="virt-runbook-CDIDataVolumeUnusualRestartCount"]
89
= CDIDataVolumeUnusualRestartCount
910

1011
[discrete]
11-
[id="meaning-cdidatavolumeunusualrestartcount_{context}"]
12+
[id="meaning-cdidatavolumeunusualrestartcount"]
1213
== Meaning
1314

1415
This alert fires when a `DataVolume` object restarts more than three
1516
times.
1617

1718
[discrete]
18-
[id="impact-cdidatavolumeunusualrestartcount_{context}"]
19+
[id="impact-cdidatavolumeunusualrestartcount"]
1920
== Impact
2021

2122
Data volumes are responsible for importing and creating a virtual
@@ -24,7 +25,7 @@ more than three times, these operations are unlikely to succeed. You
2425
must diagnose and resolve the issue.
2526

2627
[discrete]
27-
[id="diagnosis-cdidatavolumeunusualrestartcount_{context}"]
28+
[id="diagnosis-cdidatavolumeunusualrestartcount"]
2829
== Diagnosis
2930

3031
. Obtain the name and namespace of the data volume:
@@ -59,7 +60,7 @@ $ oc -n <namespace> describe logs <pod>
5960
----
6061

6162
[discrete]
62-
[id="mitigation-cdidatavolumeunusualrestartcount_{context}"]
63+
[id="mitigation-cdidatavolumeunusualrestartcount"]
6364
== Mitigation
6465

6566
Delete the data volume, resolve the issue, and create a new data volume.

modules/virt-runbook-cdinotready.adoc

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,15 @@
1-
// Automatically generated by 'runbook-conversion.sh'. Do not edit.
1+
// Do not edit this module. It is generated with a script.
2+
// Do not reuse this module. The anchor IDs do not contain a context statement.
23
// Module included in the following assemblies:
34
//
45
// * virt/logging_events_monitoring/virt-runbooks.adoc
56

67
:_content-type: REFERENCE
7-
[id="virt-runbook-cdinotready_{context}"]
8+
[id="virt-runbook-CDINotReady"]
89
= CDINotReady
910

1011
[discrete]
11-
[id="meaning-cdinotready_{context}"]
12+
[id="meaning-cdinotready"]
1213
== Meaning
1314

1415
This alert fires when the Containerized Data Importer (CDI) is in
@@ -18,7 +19,7 @@ a degraded state:
1819
* Not available to use
1920

2021
[discrete]
21-
[id="impact-cdinotready_{context}"]
22+
[id="impact-cdinotready"]
2223
== Impact
2324

2425
CDI is not usable, so users cannot build virtual machine disks on
@@ -27,7 +28,7 @@ CDI components are not ready and they stopped progressing towards
2728
a ready state.
2829

2930
[discrete]
30-
[id="diagnosis-cdinotready_{context}"]
31+
[id="diagnosis-cdinotready"]
3132
== Diagnosis
3233

3334
. Set the `CDI_NAMESPACE` environment variable:
@@ -60,7 +61,7 @@ $ oc -n $CDI_NAMESPACE logs <pod>
6061
----
6162

6263
[discrete]
63-
[id="mitigation-cdinotready_{context}"]
64+
[id="mitigation-cdinotready"]
6465
== Mitigation
6566

6667
Try to identify the root cause and resolve the issue.

modules/virt-runbook-cdioperatordown.adoc

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,15 @@
1-
// Automatically generated by 'runbook-conversion.sh'. Do not edit.
1+
// Do not edit this module. It is generated with a script.
2+
// Do not reuse this module. The anchor IDs do not contain a context statement.
23
// Module included in the following assemblies:
34
//
45
// * virt/logging_events_monitoring/virt-runbooks.adoc
56

67
:_content-type: REFERENCE
7-
[id="virt-runbook-cdioperatordown_{context}"]
8+
[id="virt-runbook-CDIOperatorDown"]
89
= CDIOperatorDown
910

1011
[discrete]
11-
[id="meaning-cdioperatordown_{context}"]
12+
[id="meaning-cdioperatordown"]
1213
== Meaning
1314

1415
This alert fires when the Containerized Data Importer (CDI) Operator is down.
@@ -17,14 +18,14 @@ as data volume and persistent volume claim (PVC) controllers. These controllers
1718
help users build virtual machine disks on PVCs.
1819

1920
[discrete]
20-
[id="impact-cdioperatordown_{context}"]
21+
[id="impact-cdioperatordown"]
2122
== Impact
2223

2324
The CDI components might fail to deploy or to stay in a required state. The
2425
CDI installation might not function correctly.
2526

2627
[discrete]
27-
[id="diagnosis-cdioperatordown_{context}"]
28+
[id="diagnosis-cdioperatordown"]
2829
== Diagnosis
2930

3031
. Set the `CDI_NAMESPACE` environment variable:
@@ -57,7 +58,7 @@ $ oc -n $CDI_NAMESPACE logs -l name=cdi-operator
5758
----
5859

5960
[discrete]
60-
[id="mitigation-cdioperatordown_{context}"]
61+
[id="mitigation-cdioperatordown"]
6162
== Mitigation
6263

6364
If you cannot resolve the issue, log in to the

modules/virt-runbook-cdistorageprofilesincomplete.adoc

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,15 @@
1-
// Automatically generated by 'runbook-conversion.sh'. Do not edit.
1+
// Do not edit this module. It is generated with a script.
2+
// Do not reuse this module. The anchor IDs do not contain a context statement.
23
// Module included in the following assemblies:
34
//
45
// * virt/logging_events_monitoring/virt-runbooks.adoc
56

67
:_content-type: REFERENCE
7-
[id="virt-runbook-cdistorageprofilesincomplete_{context}"]
8+
[id="virt-runbook-CDIStorageProfilesIncomplete"]
89
= CDIStorageProfilesIncomplete
910

1011
[discrete]
11-
[id="meaning-cdistorageprofilesincomplete_{context}"]
12+
[id="meaning-cdistorageprofilesincomplete"]
1213
== Meaning
1314

1415
This alert fires when a Containerized Data Importer (CDI) storage profile is
@@ -19,13 +20,13 @@ If a storage profile is incomplete, the CDI cannot infer persistent volume claim
1920
create a virtual machine (VM) disk.
2021

2122
[discrete]
22-
[id="impact-cdistorageprofilesincomplete_{context}"]
23+
[id="impact-cdistorageprofilesincomplete"]
2324
== Impact
2425

2526
The CDI cannot create a VM disk on the PVC.
2627

2728
[discrete]
28-
[id="diagnosis-cdistorageprofilesincomplete_{context}"]
29+
[id="diagnosis-cdistorageprofilesincomplete"]
2930
== Diagnosis
3031

3132
* Identify the incomplete storage profile:
@@ -36,7 +37,7 @@ $ oc get storageprofile <storage_class>
3637
----
3738

3839
[discrete]
39-
[id="mitigation-cdistorageprofilesincomplete_{context}"]
40+
[id="mitigation-cdistorageprofilesincomplete"]
4041
== Mitigation
4142

4243
* Add the missing storage profile information as in the following

modules/virt-runbook-cnaodown.adoc

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,29 @@
1-
// Automatically generated by 'runbook-conversion.sh'. Do not edit.
1+
// Do not edit this module. It is generated with a script.
2+
// Do not reuse this module. The anchor IDs do not contain a context statement.
23
// Module included in the following assemblies:
34
//
45
// * virt/logging_events_monitoring/virt-runbooks.adoc
56

67
:_content-type: REFERENCE
7-
[id="virt-runbook-cnaodown_{context}"]
8+
[id="virt-runbook-CnaoDown"]
89
= CnaoDown
910

1011
[discrete]
11-
[id="meaning-cnaodown_{context}"]
12+
[id="meaning-cnaodown"]
1213
== Meaning
1314

1415
This alert fires when the Cluster Network Addons Operator (CNAO) is down.
1516
The CNAO deploys additional networking components on top of the cluster.
1617

1718
[discrete]
18-
[id="impact-cnaodown_{context}"]
19+
[id="impact-cnaodown"]
1920
== Impact
2021

2122
If the CNAO is not running, the cluster cannot reconcile changes to virtual
2223
machine components. As a result, the changes might fail to take effect.
2324

2425
[discrete]
25-
[id="diagnosis-cnaodown_{context}"]
26+
[id="diagnosis-cnaodown"]
2627
== Diagnosis
2728

2829
. Set the `NAMESPACE` environment variable:
@@ -55,7 +56,7 @@ $ oc -n $NAMESPACE describe pods -l name=cluster-network-addons-operator
5556
----
5657

5758
[discrete]
58-
[id="mitigation-cnaodown_{context}"]
59+
[id="mitigation-cnaodown"]
5960
== Mitigation
6061

6162
If you cannot resolve the issue, log in to the

modules/virt-runbook-hppnotready.adoc

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,15 @@
1-
// Automatically generated by 'runbook-conversion.sh'. Do not edit.
1+
// Do not edit this module. It is generated with a script.
2+
// Do not reuse this module. The anchor IDs do not contain a context statement.
23
// Module included in the following assemblies:
34
//
45
// * virt/logging_events_monitoring/virt-runbooks.adoc
56

67
:_content-type: REFERENCE
7-
[id="virt-runbook-hppnotready_{context}"]
8+
[id="virt-runbook-HPPNotReady"]
89
= HPPNotReady
910

1011
[discrete]
11-
[id="meaning-hppnotready_{context}"]
12+
[id="meaning-hppnotready"]
1213
== Meaning
1314

1415
This alert fires when a hostpath provisioner (HPP) installation is in a
@@ -18,14 +19,14 @@ The HPP dynamically provisions hostpath volumes to provide storage for
1819
persistent volume claims (PVCs).
1920

2021
[discrete]
21-
[id="impact-hppnotready_{context}"]
22+
[id="impact-hppnotready"]
2223
== Impact
2324

2425
HPP is not usable. Its components are not ready and they are not progressing
2526
towards a ready state.
2627

2728
[discrete]
28-
[id="diagnosis-hppnotready_{context}"]
29+
[id="diagnosis-hppnotready"]
2930
== Diagnosis
3031

3132
. Set the `HPP_NAMESPACE` environment variable:
@@ -58,7 +59,7 @@ $ oc -n $HPP_NAMESPACE logs <pod>
5859
----
5960

6061
[discrete]
61-
[id="mitigation-hppnotready_{context}"]
62+
[id="mitigation-hppnotready"]
6263
== Mitigation
6364

6465
Based on the information obtained during the diagnosis procedure, try to

modules/virt-runbook-hppoperatordown.adoc

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,15 @@
1-
// Automatically generated by 'runbook-conversion.sh'. Do not edit.
1+
// Do not edit this module. It is generated with a script.
2+
// Do not reuse this module. The anchor IDs do not contain a context statement.
23
// Module included in the following assemblies:
34
//
45
// * virt/logging_events_monitoring/virt-runbooks.adoc
56

67
:_content-type: REFERENCE
7-
[id="virt-runbook-hppoperatordown_{context}"]
8+
[id="virt-runbook-HPPOperatorDown"]
89
= HPPOperatorDown
910

1011
[discrete]
11-
[id="meaning-hppoperatordown_{context}"]
12+
[id="meaning-hppoperatordown"]
1213
== Meaning
1314

1415
This alert fires when the hostpath provisioner (HPP) Operator is down.
@@ -17,14 +18,14 @@ The HPP Operator deploys and manages the HPP infrastructure components, such
1718
as the daemon set that provisions hostpath volumes.
1819

1920
[discrete]
20-
[id="impact-hppoperatordown_{context}"]
21+
[id="impact-hppoperatordown"]
2122
== Impact
2223

2324
The HPP components might fail to deploy or to remain in the required state.
2425
As a result, the HPP installation might not work correctly in the cluster.
2526

2627
[discrete]
27-
[id="diagnosis-hppoperatordown_{context}"]
28+
[id="diagnosis-hppoperatordown"]
2829
== Diagnosis
2930

3031
. Configure the `HPP_NAMESPACE` environment variable:
@@ -57,7 +58,7 @@ $ oc -n $HPP_NAMESPACE logs -l name=hostpath-provisioner-operator
5758
----
5859

5960
[discrete]
60-
[id="mitigation-hppoperatordown_{context}"]
61+
[id="mitigation-hppoperatordown"]
6162
== Mitigation
6263

6364
Based on the information obtained during the diagnosis procedure, try to

0 commit comments

Comments
 (0)