Skip to content

Commit fa95684

Browse files
committed
CNV-67472: Clean up docs structure before adding new content
1 parent 58dbc0f commit fa95684

6 files changed

+46
-49
lines changed

modules/virt-about-cluster-checkup-framework.adoc

Lines changed: 0 additions & 21 deletions
This file was deleted.

modules/virt-checking-storage-configuration.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,8 @@
99
Use a predefined checkup to verify that the {product-title} cluster storage is configured optimally to run {VirtProductName} workloads.
1010

1111
.Prerequisites
12-
* You have installed the OpenShift CLI (`oc`).
12+
13+
* You have installed the {oc-first}.
1314
* The cluster administrator has created the required `cluster-reader` permissions for the storage checkup service account and namespace, such as in the following example:
1415
+
1516
[source,yaml]
@@ -29,7 +30,6 @@ subjects:
2930
----
3031
<1> The namespace where the checkup is to be run.
3132
32-
3333
.Procedure
3434

3535
. Create a `ServiceAccount`, `Role`, and `RoleBinding` manifest file for the storage checkup:

modules/virt-latency-checkup-web-console.adoc

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,4 +25,6 @@ Run a latency checkup to verify network connectivity and measure the latency bet
2525
. Optional: Target specific nodes by enabling *Select nodes* and specifying the *Source node* and *Target node*.
2626
. Click *Run*.
2727

28-
You can view the status of the latency checkup in the *Checkups* list on the *Latency checkup* tab. Click on the name of the checkup for more details.
28+
.Verification
29+
30+
* To view the status of the latency checkup, go to the *Checkups* list on the *Latency checkup* tab. Click on the name of the checkup for more details.

modules/virt-measuring-latency-vm-secondary-network.adoc

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,7 @@
66
[id="virt-measuring-latency-vm-secondary-network_{context}"]
77
= Running a latency checkup by using the CLI
88

9-
You use a predefined checkup to verify network connectivity and measure latency between two virtual machines (VMs) that are attached to a secondary network interface. The latency checkup uses the ping utility.
10-
11-
You run a latency checkup by performing the following steps:
9+
You run a latency checkup using the CLI by performing the following steps:
1210

1311
. Create a service account, roles, and rolebindings to provide cluster access permissions to the latency checkup.
1412
. Create a config map to provide the input to run the checkup and to store the results.
@@ -19,7 +17,7 @@ You run a latency checkup by performing the following steps:
1917

2018
.Prerequisites
2119

22-
* You installed the OpenShift CLI (`oc`).
20+
* You installed the {oc-first}.
2321
* The cluster has at least two worker nodes.
2422
* You configured a network attachment definition for a namespace.
2523
Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
// Text snippet included in the following modules:
2+
//
3+
// *
4+
//
5+
// Text snippet included in the following assemblies:
6+
//
7+
// * /virt/monitoring/virt-running-cluster-checkups.adoc
8+
9+
:_mod-docs-content-type: SNIPPET
10+
11+
Running a predefined checkup in an existing namespace involves setting up a service account for the checkup, creating the `Role` and `RoleBinding` objects for the service account, enabling permissions for the checkup, and creating the input config map and the checkup job. You can run a checkup multiple times.
12+
13+
[IMPORTANT]
14+
====
15+
You must always:
16+
17+
* Verify that the checkup image is from a trustworthy source before applying it.
18+
* Review the checkup permissions before creating the `Role` and `RoleBinding` objects.
19+
====

virt/monitoring/virt-running-cluster-checkups.adoc

Lines changed: 20 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -6,46 +6,45 @@ include::_attributes/common-attributes.adoc[]
66

77
toc::[]
88

9-
{VirtProductName} includes the following predefined checkups that can be used for cluster maintenance and troubleshooting:
9+
A _checkup_ is an automated test workload that allows you to verify if a specific cluster functionality works as expected. The cluster checkup framework uses native Kubernetes resources to configure and execute the checkup.
10+
11+
:FeatureName: The {VirtProductName} cluster checkup framework
12+
include::snippets/technology-preview.adoc[]
13+
14+
As a developer or cluster administrator, you can use predefined checkups to improve cluster maintainability, troubleshoot unexpected behavior, minimize errors, and save time. You can review the results of the checkup and share them with experts for further analysis. Vendors can write and publish checkups for features or services that they provide and verify that their customer environments are configured correctly.
15+
16+
[id="virt-running-cluster-checkups-latency"]
17+
== Running predefined latency checkups
18+
19+
You can use a latency checkup to verify network connectivity and measure latency between two virtual machines (VMs) that are attached to a secondary network interface. The predefined latency checkup uses the ping utility.
1020

11-
* Latency checkup, which verifies network connectivity and measures latency between two virtual machines (VMs) that are attached to a secondary network interface.
12-
+
1321
[IMPORTANT]
1422
=====
1523
Before you run a latency checkup, you must first xref:../../virt/vm_networking/virt-connecting-vm-to-linux-bridge.adoc#virt-connecting-vm-to-linux-bridge[create a bridge interface] on the cluster nodes to connect the VM's secondary interface to any interface on the node. If you do not create a bridge interface, the VMs do not start and the job fails.
1624
=====
1725

18-
* Storage checkup, which verifies if the cluster storage is optimally configured for {VirtProductName}.
26+
include::snippets/virt-about-running-checkups.adoc[]
1927

20-
:FeatureName: The {VirtProductName} cluster checkup framework
21-
include::snippets/technology-preview.adoc[]
28+
include::modules/virt-latency-checkup-web-console.adoc[leveloffset=+2]
2229

23-
include::modules/virt-about-cluster-checkup-framework.adoc[leveloffset=+1]
30+
include::modules/virt-measuring-latency-vm-secondary-network.adoc[leveloffset=+2]
2431

25-
[id="virt-running-cluster-checkups-console_{context}"]
26-
== Running checkups by using the web console
32+
[id="virt-running-cluster-checkups-storage"]
33+
== Running predefined storage checkups
2734

28-
Use the following procedures the first time you run checkups by using the web console. For additional checkups, click *Run checkup* on either checkup tab, and select the appropriate checkup from the drop down menu.
35+
You can use a storage checkup to verify that the cluster storage is optimally configured for {VirtProductName}.
2936

30-
include::modules/virt-latency-checkup-web-console.adoc[leveloffset=+2]
37+
include::snippets/virt-about-running-checkups.adoc[]
3138

3239
include::modules/virt-storage-checkup-web-console.adoc[leveloffset=+2]
3340

34-
[id="virt-running-cluster-checkups-cli_{context}"]
35-
== Running checkups by using the CLI
36-
37-
Use the following procedures the first time you run checkups by using the command line.
38-
39-
include::modules/virt-measuring-latency-vm-secondary-network.adoc[leveloffset=+2]
40-
4141
include::modules/virt-checking-storage-configuration.adoc[leveloffset=+2]
4242

43-
4443
ifndef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
4544
[role="_additional-resources"]
4645
[id="additional-resources_running-cluster-checkups"]
4746
== Additional resources
4847
endif::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
4948
ifndef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
50-
* xref:../../virt/vm_networking/virt-connecting-vm-to-linux-bridge.adoc#virt-connecting-vm-to-linux-bridge[Attaching a virtual machine to multiple networks]
51-
endif::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
49+
* xref:../../virt/vm_networking/virt-connecting-vm-to-linux-bridge.adoc#virt-connecting-vm-to-linux-bridge[Connecting a virtual machine to a Linux bridge network]
50+
endif::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]

0 commit comments

Comments
 (0)