1
0
mirror of https://github.com/openshift/openshift-docs.git synced 2026-02-05 12:46:18 +01:00
Files
openshift-docs/modules/cpmso-yaml-failure-domain-azure.adoc
2026-02-03 22:00:10 +00:00

63 lines
2.5 KiB
Plaintext

// Module included in the following assemblies:
//
// * machine_management/cpmso-configuration.adoc
:_mod-docs-content-type: REFERENCE
[id="cpmso-yaml-failure-domain-azure_{context}"]
= Sample {azure-short} failure domain configuration
[role="_abstract"]
To prevent downtime for your application due to the failure of a single {azure-first} region, you can configure failure domains in the control plane machine set.
To use failure domains, you configure appropriate values in the `failureDomains` section of the `ControlPlaneMachineSet` custom resource (CR).
The control plane machine set concept of a failure domain is analogous to the {azure-short} concept of an link:https://learn.microsoft.com/en-us/azure/azure-web-pubsub/concept-availability-zones[_Azure availability zone_].
The `ControlPlaneMachineSet` CR spreads control plane machines across more than one failure domain when possible.
When configuring {azure-short} failure domains in the control plane machine set, you must specify the availability zone name.
An {azure-short} cluster can use the following configurations:
* One subnet for each availability zone.
* One subnet that spans more than one availability zone.
* More than one subnet in more than one availability zone.
.Sample {azure-short} failure domain values
[source,yaml]
----
apiVersion: machine.openshift.io/v1
kind: ControlPlaneMachineSet
metadata:
name: cluster
namespace: openshift-machine-api
spec:
# ...
template:
# ...
machines_v1beta1_machine_openshift_io:
failureDomains:
azure:
- zone: "1"
subnet: <subnet_zone_1>
- zone: "2"
subnet: <subnet_zone_2>
- zone: "3"
subnet: <subnet_zone_3>
platform: Azure
# ...
----
where:
`spec.template.machines_v1beta1_machine_openshift_io.failureDomains.azure.zone`::
Each instance of `zone` specifies an {azure-short} availability zone for a failure domain.
+
[NOTE]
====
If the cluster uses a single zone for all failure domains, the `zone` parameter is in the provider specification instead of in the failure domain configuration.
====
`spec.template.machines_v1beta1_machine_openshift_io.failureDomains.azure.subnet`::
Optional: Specifies the network subnet in which to create the control plane VM.
When omitted, the control plane machine set uses the `subnet` value from the machine `providerSpec` template.
`spec.template.machines_v1beta1_machine_openshift_io.failureDomains.platform`::
Specifies the cloud provider platform name.
Do not change this value.