mirror of
https://github.com/openshift/openshift-docs.git
synced 2026-02-05 12:46:18 +01:00
CNV-67472: Clean up docs structure before adding new content
This commit is contained in:
Ashleigh Brennan
committed by
openshift-cherrypick-robot
openshift-cherrypick-robot
parent
fae8fe43e8
commit
5d0116755b
@@ -1,21 +0,0 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * virt/monitoring/virt-running-cluster-checkups.adoc
|
||||
|
||||
:_mod-docs-content-type: CONCEPT
|
||||
[id="virt-about-cluster-checkup-framework_{context}"]
|
||||
= About the {VirtProductName} cluster checkup framework
|
||||
|
||||
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.
|
||||
|
||||
By using predefined checkups, cluster administrators and developers can improve cluster maintainability, troubleshoot unexpected behavior, minimize errors, and save time. They can also 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.
|
||||
|
||||
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.
|
||||
|
||||
[IMPORTANT]
|
||||
====
|
||||
You must always:
|
||||
|
||||
* Verify that the checkup image is from a trustworthy source before applying it.
|
||||
* Review the checkup permissions before creating the `Role` and `RoleBinding` objects.
|
||||
====
|
||||
@@ -9,7 +9,8 @@
|
||||
Use a predefined checkup to verify that the {product-title} cluster storage is configured optimally to run {VirtProductName} workloads.
|
||||
|
||||
.Prerequisites
|
||||
* You have installed the OpenShift CLI (`oc`).
|
||||
|
||||
* You have installed the {oc-first}.
|
||||
* The cluster administrator has created the required `cluster-reader` permissions for the storage checkup service account and namespace, such as in the following example:
|
||||
+
|
||||
[source,yaml]
|
||||
@@ -29,7 +30,6 @@ subjects:
|
||||
----
|
||||
<1> The namespace where the checkup is to be run.
|
||||
|
||||
|
||||
.Procedure
|
||||
|
||||
. Create a `ServiceAccount`, `Role`, and `RoleBinding` manifest file for the storage checkup:
|
||||
|
||||
@@ -25,4 +25,6 @@ Run a latency checkup to verify network connectivity and measure the latency bet
|
||||
. Optional: Target specific nodes by enabling *Select nodes* and specifying the *Source node* and *Target node*.
|
||||
. Click *Run*.
|
||||
|
||||
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.
|
||||
.Verification
|
||||
|
||||
* 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.
|
||||
|
||||
@@ -6,9 +6,7 @@
|
||||
[id="virt-measuring-latency-vm-secondary-network_{context}"]
|
||||
= Running a latency checkup by using the CLI
|
||||
|
||||
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.
|
||||
|
||||
You run a latency checkup by performing the following steps:
|
||||
You run a latency checkup using the CLI by performing the following steps:
|
||||
|
||||
. Create a service account, roles, and rolebindings to provide cluster access permissions to the latency checkup.
|
||||
. 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:
|
||||
|
||||
.Prerequisites
|
||||
|
||||
* You installed the OpenShift CLI (`oc`).
|
||||
* You installed the {oc-first}.
|
||||
* The cluster has at least two worker nodes.
|
||||
* You configured a network attachment definition for a namespace.
|
||||
|
||||
|
||||
19
snippets/virt-about-running-checkups.adoc
Normal file
19
snippets/virt-about-running-checkups.adoc
Normal file
@@ -0,0 +1,19 @@
|
||||
// Text snippet included in the following modules:
|
||||
//
|
||||
// *
|
||||
//
|
||||
// Text snippet included in the following assemblies:
|
||||
//
|
||||
// * /virt/monitoring/virt-running-cluster-checkups.adoc
|
||||
|
||||
:_mod-docs-content-type: SNIPPET
|
||||
|
||||
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.
|
||||
|
||||
[IMPORTANT]
|
||||
====
|
||||
You must always:
|
||||
|
||||
* Verify that the checkup image is from a trustworthy source before applying it.
|
||||
* Review the checkup permissions before creating the `Role` and `RoleBinding` objects.
|
||||
====
|
||||
@@ -6,40 +6,39 @@ include::_attributes/common-attributes.adoc[]
|
||||
|
||||
toc::[]
|
||||
|
||||
{VirtProductName} includes the following predefined checkups that can be used for cluster maintenance and troubleshooting:
|
||||
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.
|
||||
|
||||
:FeatureName: The {VirtProductName} cluster checkup framework
|
||||
include::snippets/technology-preview.adoc[]
|
||||
|
||||
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.
|
||||
|
||||
[id="virt-running-cluster-checkups-latency"]
|
||||
== Running predefined latency checkups
|
||||
|
||||
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.
|
||||
|
||||
* Latency checkup, which verifies network connectivity and measures latency between two virtual machines (VMs) that are attached to a secondary network interface.
|
||||
+
|
||||
[IMPORTANT]
|
||||
=====
|
||||
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.
|
||||
=====
|
||||
|
||||
* Storage checkup, which verifies if the cluster storage is optimally configured for {VirtProductName}.
|
||||
|
||||
:FeatureName: The {VirtProductName} cluster checkup framework
|
||||
include::snippets/technology-preview.adoc[]
|
||||
|
||||
include::modules/virt-about-cluster-checkup-framework.adoc[leveloffset=+1]
|
||||
|
||||
[id="virt-running-cluster-checkups-console_{context}"]
|
||||
== Running checkups by using the web console
|
||||
|
||||
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.
|
||||
include::snippets/virt-about-running-checkups.adoc[]
|
||||
|
||||
include::modules/virt-latency-checkup-web-console.adoc[leveloffset=+2]
|
||||
|
||||
include::modules/virt-storage-checkup-web-console.adoc[leveloffset=+2]
|
||||
|
||||
[id="virt-running-cluster-checkups-cli_{context}"]
|
||||
== Running checkups by using the CLI
|
||||
|
||||
Use the following procedures the first time you run checkups by using the command line.
|
||||
|
||||
include::modules/virt-measuring-latency-vm-secondary-network.adoc[leveloffset=+2]
|
||||
|
||||
include::modules/virt-checking-storage-configuration.adoc[leveloffset=+2]
|
||||
[id="virt-running-cluster-checkups-storage"]
|
||||
== Running predefined storage checkups
|
||||
|
||||
You can use a storage checkup to verify that the cluster storage is optimally configured for {VirtProductName}.
|
||||
|
||||
include::snippets/virt-about-running-checkups.adoc[]
|
||||
|
||||
include::modules/virt-storage-checkup-web-console.adoc[leveloffset=+2]
|
||||
|
||||
include::modules/virt-checking-storage-configuration.adoc[leveloffset=+2]
|
||||
|
||||
ifndef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
[role="_additional-resources"]
|
||||
@@ -47,5 +46,5 @@ ifndef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
== Additional resources
|
||||
endif::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
ifndef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
* xref:../../virt/vm_networking/virt-connecting-vm-to-linux-bridge.adoc#virt-connecting-vm-to-linux-bridge[Attaching a virtual machine to multiple networks]
|
||||
endif::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
* 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]
|
||||
endif::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
|
||||
|
||||
Reference in New Issue
Block a user