Skip to content

Commit bd11976

Browse files
committed
docs: adds failure domain docs
1 parent e5b5cb1 commit bd11976

File tree

2 files changed

+146
-0
lines changed

2 files changed

+146
-0
lines changed
Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
+++
2+
title = "AWS Failure Domain"
3+
+++
4+
5+
The AWS failure domain customization allows the user to specify the AWS availability zone (failure domain) for worker node deployments.
6+
This customization can be applied to individual MachineDeployments to distribute worker nodes across different availability zones for high availability.
7+
This customization will be available when the
8+
[provider-specific cluster configuration patch]({{< ref "..">}}) is included in the `ClusterClass`.
9+
10+
## Example
11+
12+
To specify a failure domain for worker nodes, use the following configuration:
13+
14+
```yaml
15+
apiVersion: cluster.x-k8s.io/v1beta1
16+
kind: Cluster
17+
metadata:
18+
name: <NAME>
19+
spec:
20+
topology:
21+
variables:
22+
- name: workerConfig
23+
value:
24+
aws:
25+
failureDomain: us-west-2a
26+
```
27+
28+
You can customize individual MachineDeployments by using the overrides field to deploy workers across multiple availability zones:
29+
30+
```yaml
31+
spec:
32+
topology:
33+
# ...
34+
workers:
35+
machineDeployments:
36+
- class: default-worker
37+
name: md-0
38+
variables:
39+
overrides:
40+
- name: workerConfig
41+
value:
42+
aws:
43+
failureDomain: us-west-2a
44+
- class: default-worker
45+
name: md-1
46+
variables:
47+
overrides:
48+
- name: workerConfig
49+
value:
50+
aws:
51+
failureDomain: us-west-2b
52+
- class: default-worker
53+
name: md-2
54+
variables:
55+
overrides:
56+
- name: workerConfig
57+
value:
58+
aws:
59+
failureDomain: us-west-2c
60+
```
61+
62+
## Resulting CAPA Configuration
63+
64+
Applying this configuration will result in the following value being set:
65+
66+
- worker `MachineDeployment`:
67+
68+
- ```yaml
69+
spec:
70+
template:
71+
spec:
72+
failureDomain: us-west-2a
73+
```
Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
+++
2+
title = "AWS Failure Domain"
3+
+++
4+
5+
The AWS failure domain customization allows the user to specify the AWS availability zone (failure domain) for worker node deployments.
6+
This customization can be applied to individual MachineDeployments to distribute worker nodes across different availability zones for high availability.
7+
This customization will be available when the
8+
[provider-specific cluster configuration patch]({{< ref "..">}}) is included in the `ClusterClass`.
9+
10+
## Example
11+
12+
To specify a failure domain for worker nodes, use the following configuration:
13+
14+
```yaml
15+
apiVersion: cluster.x-k8s.io/v1beta1
16+
kind: Cluster
17+
metadata:
18+
name: <NAME>
19+
spec:
20+
topology:
21+
variables:
22+
- name: workerConfig
23+
value:
24+
aws:
25+
failureDomain: us-west-2a
26+
```
27+
28+
You can customize individual MachineDeployments by using the overrides field to deploy workers across multiple availability zones:
29+
30+
```yaml
31+
spec:
32+
topology:
33+
# ...
34+
workers:
35+
machineDeployments:
36+
- class: default-worker
37+
name: md-0
38+
variables:
39+
overrides:
40+
- name: workerConfig
41+
value:
42+
aws:
43+
failureDomain: us-west-2a
44+
- class: default-worker
45+
name: md-1
46+
variables:
47+
overrides:
48+
- name: workerConfig
49+
value:
50+
aws:
51+
failureDomain: us-west-2b
52+
- class: default-worker
53+
name: md-2
54+
variables:
55+
overrides:
56+
- name: workerConfig
57+
value:
58+
aws:
59+
failureDomain: us-west-2c
60+
```
61+
62+
## Resulting CAPA Configuration
63+
64+
Applying this configuration will result in the following value being set:
65+
66+
- worker `MachineDeployment`:
67+
68+
- ```yaml
69+
spec:
70+
template:
71+
spec:
72+
failureDomain: us-west-2a
73+
```

0 commit comments

Comments
 (0)