Merge pull request #78800 from jeana-redhat/OSDOCS-10292-azure-reserved-capacity

OSDOCS-10292: Azure Capacity Reservation with MAPI

Author: jeana-redhat

machine_management/control_plane_machine_management/cpmso_provider_configurations/cpmso-config-options-azure.adoc

@@ -61,6 +61,9 @@ include::modules/machineset-azure-confidential-vms.adoc[leveloffset=+2]
 // Accelerated Networking for Microsoft Azure VMs
 include::modules/machineset-azure-accelerated-networking.adoc[leveloffset=+2]
 
+//Configuring Capacity Reservation by using machine sets
+include::modules/machineset-azure-capacity-reservation.adoc[leveloffset=+2]
+
 //Not applicable for 4.12, possibly 4.13?
 //[role="_additional-resources"]
 //.Additional resources

machine_management/creating_machinesets/creating-machineset-azure.adoc

@@ -62,6 +62,9 @@ include::modules/machineset-azure-confidential-vms.adoc[leveloffset=+1]
 // Accelerated Networking for Microsoft Azure VMs
 include::modules/machineset-azure-accelerated-networking.adoc[leveloffset=+1]
 
+//Configuring Capacity Reservation by using machine sets
+include::modules/machineset-azure-capacity-reservation.adoc[leveloffset=+1]
+
 //Adding a GPU node to a machine set (stesmith)
 include::modules/nvidia-gpu-azure-adding-a-gpu-node.adoc[leveloffset=+1]
 

modules/machineset-azure-capacity-reservation.adoc

@@ -0,0 +1,94 @@
+// Module included in the following assemblies:
+//
+// * machine_management/creating_machinesets/creating-machineset-azure.adoc
+// * machine_management/control_plane_machine_management/cpmso_provider_configurations/cpmso-config-options-azure.adoc
+
+ifeval::["{context}" == "cpmso-config-options-azure"]
+:cpmso:
+endif::[]
+
+:_mod-docs-content-type: PROCEDURE
+[id="machineset-azure-capacity-reservation_{context}"]
+= Configuring Capacity Reservation by using machine sets
+
+//Note: This is in 4.16.3, and might be backported through 4.14.z at a later date.
+//Earlier versions of OCP should get an update .z version here. OCP 4.17 docs should use {product-version}.
+{product-title} version 4.16.3 and later supports on-demand Capacity Reservation with Capacity Reservation groups on {azure-full} clusters.
+
+You can configure a machine set to deploy machines on any available resources that match the parameters of a capacity request that you define.
+These parameters specify the VM size, region, and number of instances that you want to reserve.
+If your {azure-short} subscription quota can accommodate the capacity request, the deployment succeeds.
+
+For more information, including limitations and suggested use cases for this {azure-short} instance type, see the {azure-full} documentation about link:https://learn.microsoft.com/en-us/azure/virtual-machines/capacity-reservation-overview[On-demand Capacity Reservation].
+
+[NOTE]
+====
+You cannot change an existing Capacity Reservation configuration for a machine set.
+To use a different Capacity Reservation group, you must replace the machine set and the machines that the previous machine set deployed.
+====
+
+.Prerequisites
+
+* You have access to the cluster with `cluster-admin` privileges.
+* You installed the {oc-first}.
+* You created a Capacity Reservation group.
++
+For more information, see the {azure-full} documentation link:https://learn.microsoft.com/en-us/azure/virtual-machines/capacity-reservation-create[Create a Capacity Reservation].
+
+.Procedure
+
+. In a text editor, open the YAML file for an existing machine set or create a new one.
+
+. Edit the following section under the `providerSpec` field:
++
+--
+.Sample configuration
+[source,yaml]
+----
+ifndef::cpmso[]
+apiVersion: machine.openshift.io/v1beta1
+kind: MachineSet
+endif::cpmso[]
+ifdef::cpmso[]
+apiVersion: machine.openshift.io/v1
+kind: ControlPlaneMachineSet
+endif::cpmso[]
+# ...
+spec:
+  template:
+    spec:
+      providerSpec:
+        value:
+          capacityReservationGroupID: <capacity-reservation-group> # <1>
+# ...
+----
+<1> Specify the ID of the Capacity Reservation group that you want the machine set to deploy machines on.
+--
+
+.Verification
+
+* To verify machine deployment, list the machines that the machine set created by running the following command:
++
+[source,terminal]
+----
+ifndef::cpmso[]
+$ oc oc get machines.machine.openshift.io \
+  -n openshift-machine-api \
+  -l machine.openshift.io/cluster-api-machineset=<machine_set_name>
+endif::cpmso[]
+ifdef::cpmso[]
+$ oc get machine \
+  -n openshift-machine-api \
+  -l machine.openshift.io/cluster-api-machine-role=master
+endif::cpmso[]
+----
+ifndef::cpmso[]
++
+where `<machine_set_name>` is the name of the compute machine set.
+endif::cpmso[]
++
+In the output, verify that the characteristics of the listed machines match the parameters of your Capacity Reservation.
+
+ifeval::["{context}" == "cpmso-config-options-azure"]
+:!cpmso:
+endif::[]