Merge pull request #56165 from sabrinajess/CNV13359

CNV-13359: VMI to VM

Author: sjhala-ccs

_topic_maps/_topic_map.yml

@@ -3710,7 +3710,7 @@ Topics:
     File: virt-monitor-vmi-migration
   - Name: Diagnosing data volumes using events and conditions
     File: virt-diagnosing-datavolumes-using-events-and-conditions
-  - Name: Monitoring virtual machine health
+  - Name: Monitoring virtual machine health with health probes
     File: virt-monitoring-vm-health
   - Name: Viewing cluster information
     File: virt-using-dashboard-to-get-cluster-info

modules/virt-about-readiness-liveness-probes.adoc

@@ -7,16 +7,16 @@
 
 = About readiness and liveness probes
 
-Use readiness and liveness probes to detect and handle unhealthy virtual machine instances (VMIs). You can include one or more probes in the specification of the VMI to ensure that traffic does not reach a VMI that is not ready for it and that a new instance is created when a VMI becomes unresponsive.
+Use readiness and liveness probes to detect and handle unhealthy virtual machines (VMs). You can include one or more probes in the specification of the VM to ensure that traffic does not reach a VM that is not ready for it and that a new VM is created when a VM becomes unresponsive.
 
-A _readiness probe_ determines whether a VMI is ready to accept service requests. If the probe fails, the VMI is removed from the list of available endpoints until the VMI is ready.
+A _readiness probe_ determines whether a VM is ready to accept service requests. If the probe fails, the VM is removed from the list of available endpoints until the VM is ready.
 
-A _liveness probe_ determines whether a VMI is responsive. If the probe fails, the VMI is deleted and a new instance is created to restore responsiveness.
+A _liveness probe_ determines whether a VM is responsive. If the probe fails, the VM is deleted and a new VM is created to restore responsiveness.
 
-You can configure readiness and liveness probes by setting the `spec.readinessProbe` and the `spec.livenessProbe` fields of the `VirtualMachineInstance` object. These fields support the following tests:
+You can configure readiness and liveness probes by setting the `spec.readinessProbe` and the `spec.livenessProbe` fields of the `VirtualMachine` object. These fields support the following tests:
 
-HTTP GET:: The probe determines the health of the VMI by using a web hook. The test is successful if the HTTP response code is between 200 and 399. You can use an HTTP GET test with applications that return HTTP status codes when they are completely initialized.
+HTTP GET:: The probe determines the health of the VM by using a web hook. The test is successful if the HTTP response code is between 200 and 399. You can use an HTTP GET test with applications that return HTTP status codes when they are completely initialized.
 
-TCP socket:: The probe attempts to open a socket to the VMI. The VMI is only considered healthy if the probe can establish a connection. You can use a TCP socket test with applications that do not start listening until initialization is complete.
+TCP socket:: The probe attempts to open a socket to the VM. The VM is only considered healthy if the probe can establish a connection. You can use a TCP socket test with applications that do not start listening until initialization is complete.
 
 Guest agent ping:: The probe uses the `guest-ping` command to determine if the QEMU guest agent is running on the virtual machine.

modules/virt-define-guest-agent-ping-probe.adoc

@@ -7,7 +7,7 @@
 
 = Defining a guest agent ping probe
 
-Define a guest agent ping probe by setting the `spec.readinessProbe.guestAgentPing` field of the virtual machine instance (VMI) configuration.
+Define a guest agent ping probe by setting the `spec.readinessProbe.guestAgentPing` field of the virtual machine (VM) configuration.
 
 :FeatureName: The guest agent ping probe
 include::snippets/technology-preview.adoc[]
@@ -18,7 +18,7 @@ include::snippets/technology-preview.adoc[]
 
 .Procedure
 
-. Include details of the guest agent ping probe in the VMI configuration file. For example:
+. Include details of the guest agent ping probe in the VM configuration file. For example:
 +
 
 .Sample guest agent ping probe
@@ -35,14 +35,14 @@ spec:
     successThreshold: 3 <6>
 # ...
 ----
-<1> The guest agent ping probe to connect to the VMI.
-<2> Optional: The time, in seconds, after the VMI starts before the guest agent probe is initiated.
+<1> The guest agent ping probe to connect to the VM.
+<2> Optional: The time, in seconds, after the VM starts before the guest agent probe is initiated.
 <3> Optional: The delay, in seconds, between performing probes. The default delay is 10 seconds. This value must be greater than `timeoutSeconds`.
-<4> Optional: The number of seconds of inactivity after which the probe times out and the VMI is assumed to have failed. The default value is 1. This value must be lower than `periodSeconds`.
+<4> Optional: The number of seconds of inactivity after which the probe times out and the VM is assumed to have failed. The default value is 1. This value must be lower than `periodSeconds`.
 <5> Optional: The number of times that the probe is allowed to fail. The default is 3. After the specified number of attempts, the pod is marked `Unready`.
 <6> Optional: The number of times that the probe must report success, after a failure, to be considered successful. The default is 1.
 
-. Create the VMI by running the following command:
+. Create the VM by running the following command:
 +
 [source,terminal]
 ----

modules/virt-define-http-liveness-probe.adoc

@@ -7,12 +7,12 @@
 
 = Defining an HTTP liveness probe
 
-Define an HTTP liveness probe by setting the `spec.livenessProbe.httpGet` field of the virtual machine instance (VMI) configuration. You can define both HTTP and TCP tests for liveness probes in the same way as readiness probes. This procedure configures a sample liveness probe with an HTTP GET test.
+Define an HTTP liveness probe by setting the `spec.livenessProbe.httpGet` field of the virtual machine (VM) configuration. You can define both HTTP and TCP tests for liveness probes in the same way as readiness probes. This procedure configures a sample liveness probe with an HTTP GET test.
 
 
 .Procedure
 
-. Include details of the HTTP liveness probe in the VMI configuration file.
+. Include details of the HTTP liveness probe in the VM configuration file.
 +
 
 .Sample liveness probe with an HTTP GET test
@@ -32,14 +32,14 @@ spec:
     timeoutSeconds: 10 <6>
 # ...
 ----
-<1> The time, in seconds, after the VMI starts before the liveness probe is initiated.
+<1> The time, in seconds, after the VM starts before the liveness probe is initiated.
 <2> The delay, in seconds, between performing probes. The default delay is 10 seconds. This value must be greater than `timeoutSeconds`.
-<3> The HTTP GET request to perform to connect to the VMI.
-<4> The port of the VMI that the probe queries. In the above example, the probe queries port 1500. The VMI installs and runs a minimal HTTP server on port 1500 via cloud-init.
-<5> The path to access on the HTTP server. In the above example, if the handler for the server's `/healthz` path returns a success code, the VMI is considered to be healthy. If the handler returns a failure code, the VMI is deleted and a new instance is created.
-<6> The number of seconds of inactivity after which the probe times out and the VMI is assumed to have failed. The default value is 1. This value must be lower than `periodSeconds`.
+<3> The HTTP GET request to perform to connect to the VM.
+<4> The port of the VM that the probe queries. In the above example, the probe queries port 1500. The VM installs and runs a minimal HTTP server on port 1500 via cloud-init.
+<5> The path to access on the HTTP server. In the above example, if the handler for the server's `/healthz` path returns a success code, the VM is considered to be healthy. If the handler returns a failure code, the VM is deleted and a new VM is created.
+<6> The number of seconds of inactivity after which the probe times out and the VM is assumed to have failed. The default value is 1. This value must be lower than `periodSeconds`.
 
-. Create the VMI by running the following command:
+. Create the VM by running the following command:
 +
 [source,terminal]
 ----

modules/virt-define-http-readiness-probe.adoc

@@ -7,11 +7,11 @@
 
 = Defining an HTTP readiness probe
 
-Define an HTTP readiness probe by setting the `spec.readinessProbe.httpGet` field of the virtual machine instance (VMI) configuration.
+Define an HTTP readiness probe by setting the `spec.readinessProbe.httpGet` field of the virtual machine (VM) configuration.
 
 
 .Procedure
-. Include details of the readiness probe in the VMI configuration file.
+. Include details of the readiness probe in the VM configuration file.
 +
 
 .Sample readiness probe with an HTTP GET test
@@ -33,16 +33,16 @@ spec:
     successThreshold: 3 <8>
 # ...
 ----
-<1> The HTTP GET request to perform to connect to the VMI.
-<2> The port of the VMI that the probe queries. In the above example, the probe queries port 1500.
-<3> The path to access on the HTTP server. In the above example, if the handler for the server’s /healthz path returns a success code, the VMI is considered to be healthy. If the handler returns a failure code, the VMI is removed from the list of available endpoints.
-<4> The time, in seconds, after the VMI starts before the readiness probe is initiated.
+<1> The HTTP GET request to perform to connect to the VM.
+<2> The port of the VM that the probe queries. In the above example, the probe queries port 1500.
+<3> The path to access on the HTTP server. In the above example, if the handler for the server’s /healthz path returns a success code, the VM is considered to be healthy. If the handler returns a failure code, the VM is removed from the list of available endpoints.
+<4> The time, in seconds, after the VM starts before the readiness probe is initiated.
 <5> The delay, in seconds, between performing probes. The default delay is 10 seconds. This value must be greater than `timeoutSeconds`.
-<6> The number of seconds of inactivity after which the probe times out and the VMI is assumed to have failed. The default value is 1. This value must be lower than `periodSeconds`.
+<6> The number of seconds of inactivity after which the probe times out and the VM is assumed to have failed. The default value is 1. This value must be lower than `periodSeconds`.
 <7> The number of times that the probe is allowed to fail. The default is 3. After the specified number of attempts, the pod is marked `Unready`.
 <8> The number of times that the probe must report success, after a failure, to be considered successful. The default is 1.
 
-. Create the VMI by running the following command:
+. Create the VM by running the following command:
 +
 [source,terminal]
 ----

modules/virt-define-tcp-readiness-probe.adoc

@@ -7,12 +7,12 @@
 
 = Defining a TCP readiness probe
 
-Define a TCP readiness probe by setting the `spec.readinessProbe.tcpSocket` field of the virtual machine instance (VMI) configuration.
+Define a TCP readiness probe by setting the `spec.readinessProbe.tcpSocket` field of the virtual machine (VM) configuration.
 
 
 .Procedure
 
-. Include details of the TCP readiness probe in the VMI configuration file.
+. Include details of the TCP readiness probe in the VM configuration file.
 +
 
 .Sample readiness probe with a TCP socket test
@@ -28,13 +28,13 @@ spec:
     timeoutSeconds: 10 <5>
 ...
 ----
-<1> The time, in seconds, after the VMI starts before the readiness probe is initiated.
+<1> The time, in seconds, after the VM starts before the readiness probe is initiated.
 <2> The delay, in seconds, between performing probes. The default delay is 10 seconds. This value must be greater than `timeoutSeconds`.
 <3> The TCP action to perform.
-<4> The port of the VMI that the probe queries.
-<5> The number of seconds of inactivity after which the probe times out and the VMI is assumed to have failed. The default value is 1. This value must be lower than `periodSeconds`.
+<4> The port of the VM that the probe queries.
+<5> The number of seconds of inactivity after which the probe times out and the VM is assumed to have failed. The default value is 1. This value must be lower than `periodSeconds`.
 
-. Create the VMI by running the following command:
+. Create the VM by running the following command:
 +
 [source,terminal]
 ----

virt/support/virt-monitoring-vm-health.adoc

@@ -1,12 +1,12 @@
 :_content-type: ASSEMBLY
 [id="virt-monitoring-vm-health"]
-= Monitoring virtual machine health
+= Monitoring virtual machine health with health probes
 include::_attributes/common-attributes.adoc[]
 :context: virt-monitoring-vm-health
 
 toc::[]
 
-A virtual machine instance (VMI) can become unhealthy due to transient issues such as connectivity loss, deadlocks, or problems with external dependencies. A health check periodically performs diagnostics on a VMI by using any combination of the readiness and liveness probes.
+A virtual machine (VM) can become unhealthy due to transient issues such as connectivity loss, deadlocks, or problems with external dependencies. A health check periodically performs diagnostics on a VM by using any combination of the readiness and liveness probes.
 
 include::modules/virt-about-readiness-liveness-probes.adoc[leveloffset=+1]
 
@@ -18,8 +18,6 @@ include::modules/virt-define-http-liveness-probe.adoc[leveloffset=+1]
 
 include::modules/virt-define-guest-agent-ping-probe.adoc[leveloffset=+1]
 
-include::modules/virt-template-vm-probe-config.adoc[leveloffset=+1]
-
 
 [id="additional-resources_monitoring-vm-health"]
 [role="_additional-resources"]