Merge pull request #4830 from arkadeepsen/capacity-reservation

Update godoc of CapacityReservationGroupID of AzureMachineSpec
kubernetes-sigs · May 14, 2024 · d475986 · d475986
2 parents 4b1d9c1 + de135dc
commit d475986
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 0 deletions.
diff --git a/api/v1beta1/azuremachine_types.go b/api/v1beta1/azuremachine_types.go
@@ -145,6 +145,10 @@ type AzureMachineSpec struct {
 
 	// CapacityReservationGroupID specifies the capacity reservation group resource id that should be
 	// used for allocating the virtual machine.
+	// The field size should be greater than 0 and the field input must start with '/'.
+	// The input for capacityReservationGroupID must be similar to '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/capacityReservationGroups/{capacityReservationGroupName}'.
+	// The keys which are used should be among 'subscriptions', 'providers' and 'resourcegroups' followed by valid ID or names respectively.
+	// It is optional but may not be changed once set.
 	// +optional
 	CapacityReservationGroupID *string `json:"capacityReservationGroupID,omitempty"`
 }

diff --git a/config/crd/bases/infrastructure.cluster.x-k8s.io_azuremachines.yaml b/config/crd/bases/infrastructure.cluster.x-k8s.io_azuremachines.yaml
@@ -114,6 +114,10 @@ spec:
                 description: |-
                   CapacityReservationGroupID specifies the capacity reservation group resource id that should be
                   used for allocating the virtual machine.
+                  The field size should be greater than 0 and the field input must start with '/'.
+                  The input for capacityReservationGroupID must be similar to '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/capacityReservationGroups/{capacityReservationGroupName}'.
+                  The keys which are used should be among 'subscriptions', 'providers' and 'resourcegroups' followed by valid ID or names respectively.
+                  It is optional but may not be changed once set.
                 type: string
               dataDisks:
                 description: DataDisk specifies the parameters that are used to add

diff --git a/config/crd/bases/infrastructure.cluster.x-k8s.io_azuremachinetemplates.yaml b/config/crd/bases/infrastructure.cluster.x-k8s.io_azuremachinetemplates.yaml
@@ -128,6 +128,10 @@ spec:
                         description: |-
                           CapacityReservationGroupID specifies the capacity reservation group resource id that should be
                           used for allocating the virtual machine.
+                          The field size should be greater than 0 and the field input must start with '/'.
+                          The input for capacityReservationGroupID must be similar to '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/capacityReservationGroups/{capacityReservationGroupName}'.
+                          The keys which are used should be among 'subscriptions', 'providers' and 'resourcegroups' followed by valid ID or names respectively.
+                          It is optional but may not be changed once set.
                         type: string
                       dataDisks:
                         description: DataDisk specifies the parameters that are used