cluster-api-provider-azure
cluster-api-provider-azure copied to clipboard
In the godoc of CapacityReservationGroupID of AzureMachineSpec include an explanation of what are the requirements for the ID
/kind cleanup
What needs cleanup:
- Add explanation of what are the requirements for the
CapacityReservationGroupIDfield.
Describe the solution you'd like
Change the current godoc of CapacityReservationGroupID field in AzureMachineSpec from
// CapacityReservationGroupID specifies the capacity reservation group resource id that should be
// used for allocating the virtual machine.
// +optional
CapacityReservationGroupID *string `json:"capacityReservationGroupID,omitempty"`
to
// 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"`
Files to change: 2
- [ ] api/v1beta1/azuremachine_types.go
- Specific lines to cleanup: 146-147
Anything else you would like to add:
/assign