Skip to content

Commit 7338ecc

Browse files
maxwelldbmaxwelldb
authored
[OSDOCS-5249] TP - Failure domains for ShiftStack (#57526)
1 parent 17f110c commit 7338ecc

7 files changed

+128
-0
lines changed

‎installing/installing_openstack/installing-openstack-installer-custom.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@ See xref:../installing_openstack/installing-openstack-installer-custom.adoc#inst
3737

3838
include::modules/installation-configure-proxy.adoc[leveloffset=+2]
3939
include::modules/installation-configuration-parameters.adoc[leveloffset=+1]
40+
include::modules/installation-osp-failure-domains-config.adoc[leveloffset=+3]
4041
include::modules/installation-osp-custom-subnet.adoc[leveloffset=+2]
4142
include::modules/installation-osp-deploying-bare-metal-machines.adoc[leveloffset=+2]
4243
include::modules/installation-osp-provider-networks.adoc[leveloffset=+2]

‎installing/installing_openstack/installing-openstack-installer-kuryr.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,7 @@ include::modules/installation-obtaining-installer.adoc[leveloffset=+1]
4040
include::modules/installation-initializing.adoc[leveloffset=+1]
4141
include::modules/installation-configure-proxy.adoc[leveloffset=+2]
4242
include::modules/installation-configuration-parameters.adoc[leveloffset=+1]
43+
include::modules/installation-osp-failure-domains-config.adoc[leveloffset=+3]
4344
include::modules/installation-osp-custom-subnet.adoc[leveloffset=+2]
4445
include::modules/installation-osp-kuryr-config-yaml.adoc[leveloffset=+2]
4546
include::modules/installation-osp-external-lb-config.adoc[leveloffset=+2]

‎installing/installing_openstack/installing-openstack-installer-restricted.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@ include::modules/installation-osp-bootstrap-machine.adoc[leveloffset=+2]
2929
include::modules/cluster-entitlements.adoc[leveloffset=+1]
3030
include::modules/installation-osp-enabling-swift.adoc[leveloffset=+1]
3131
include::modules/installation-osp-describing-cloud-parameters.adoc[leveloffset=+1]
32+
include::modules/installation-osp-failure-domains-config.adoc[leveloffset=+3]
3233
include::modules/installation-osp-setting-cloud-provider-options.adoc[leveloffset=+1]
3334
include::modules/installation-creating-image-restricted.adoc[leveloffset=+1]
3435
include::modules/installation-initializing.adoc[leveloffset=+1]

‎installing/installing_openstack/installing-openstack-user-kuryr.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,7 @@ include::modules/installation-osp-accessing-api-no-floating.adoc[leveloffset=+2]
4646
include::modules/installation-osp-describing-cloud-parameters.adoc[leveloffset=+1]
4747
include::modules/installation-initializing.adoc[leveloffset=+1]
4848
include::modules/installation-configuration-parameters.adoc[leveloffset=+1]
49+
include::modules/installation-osp-failure-domains-config.adoc[leveloffset=+3]
4950
include::modules/installation-osp-custom-subnet.adoc[leveloffset=+2]
5051
include::modules/installation-osp-kuryr-config-yaml.adoc[leveloffset=+2]
5152
include::modules/installation-osp-provider-networks.adoc[leveloffset=+2]

‎installing/installing_openstack/installing-openstack-user.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,7 @@ include::modules/installation-osp-accessing-api-no-floating.adoc[leveloffset=+2]
3838
include::modules/installation-osp-describing-cloud-parameters.adoc[leveloffset=+1]
3939
include::modules/installation-initializing.adoc[leveloffset=+1]
4040
include::modules/installation-configuration-parameters.adoc[leveloffset=+1]
41+
include::modules/installation-osp-failure-domains-config.adoc[leveloffset=+3]
4142
include::modules/installation-osp-custom-subnet.adoc[leveloffset=+2]
4243
include::modules/installation-osp-config-yaml.adoc[leveloffset=+2]
4344
include::modules/installation-osp-fixing-subnet.adoc[leveloffset=+2]

‎modules/installation-configuration-parameters.adoc

Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1068,6 +1068,86 @@ If you deploy to a custom subnet, you cannot specify an external DNS server to t
10681068

10691069
|A UUID as a string. For example, `fa806b2f-ac49-4bce-b9db-124bc64209bf`.
10701070
|====
1071+
1072+
[id="installation-configuration-parameters-failure-domains-osp_{context}"]
1073+
== {rh-openstack} parameters for failure domains
1074+
1075+
:FeatureName: {rh-openstack} failure domains
1076+
[IMPORTANT]
1077+
====
1078+
[subs="attributes+"]
1079+
{FeatureName} is a Technology Preview feature only. Technology Preview features
1080+
are not supported with Red Hat production service level agreements (SLAs) and
1081+
might not be functionally complete. Red Hat does not recommend using them
1082+
in production. These features provide early access to upcoming product
1083+
features, enabling customers to test functionality and provide feedback during
1084+
the development process.
1085+
1086+
For more information about the support scope of Red Hat Technology Preview features, see link:https://access.redhat.com/support/offerings/techpreview/[Technology Preview Features Support Scope].
1087+
====
1088+
// Undefine {FeatureName} attribute, so that any mistakes are easily spotted
1089+
:!FeatureName:
1090+
1091+
{rh-openstack-first} deployments do not have a single implementation of failure domains. Instead, availability zones are defined individually for each service, such as the compute service, Nova; the networking service, Neutron; and the storage service, Cinder.
1092+
1093+
Beginning with {product-title} 4.13, there is a unified definition of failure domains for {rh-openstack} deployments that covers all supported availability zone types. You can use failure domains to control related aspects of Nova, Neutron, and Cinder configurations from a single place.
1094+
1095+
In {rh-openstack}, a port describes a network connection and maps to an interface inside a compute machine. A port also:
1096+
* Is defined by a network or by one more or subnets
1097+
* Connects a machine to one or more subnets
1098+
1099+
Failure domains group the services of your deployment by using ports. If you use failure domains, each machine connects to:
1100+
* The `portTarget` object with the ID `control-plane` while that object exists.
1101+
* All non-control-plane `portTarget` objects within its own failure domain.
1102+
* All networks in the machine pool's `additionalNetworkIDs` list.
1103+
1104+
To configure failure domains for a machine pool, edit availability zone and port target parameters under `controlPlane.platform.openstack.failureDomains`.
1105+
1106+
.{rh-openstack} parameters for failure domains
1107+
[cols=".^2,.^3a,.^3a",options="header"]
1108+
|====
1109+
|Parameter|Description|Values
1110+
1111+
|`platform.openstack.failuredomains.computeAvailabilityZone`
1112+
|An availability zone for the server. If not specified, the cluster default is used.
1113+
|The name of the availability zone. For example, `nova-1`.
1114+
1115+
|`platform.openstack.failuredomains.storageAvailabilityZone`
1116+
|An availability zone for the root volume. If not specified, the cluster default is used.
1117+
|The name of the availability zone. For example, `cinder-1`.
1118+
1119+
|`platform.openstack.failuredomains.portTargets`
1120+
|A list of `portTarget` objects, each of which defines a network connection to attach to machines within a failure domain.
1121+
|A list of `portTarget` objects.
1122+
1123+
|`platform.openstack.failuredomains.portTargets.portTarget.id`
1124+
|The ID of an individual port target. To select that port target as the first network for machines, set the value of this parameter to `control-plane`. If this parameter has a different value, it is ignored.
1125+
|`control-plane` or an arbitrary string.
1126+
1127+
|`platform.openstack.failuredomains.portTargets.portTarget.network`
1128+
|Required. The name or ID of the network to attach to machines in the failure domain.
1129+
|A `network` object that contains either a name or UUID. For example:
1130+
+
1131+
[source,yaml]
1132+
----
1133+
network:
1134+
id: 8db6a48e-375b-4caa-b20b-5b9a7218bfe6
1135+
----
1136+
+
1137+
or:
1138+
+
1139+
[source,yaml]
1140+
----
1141+
network:
1142+
name: my-network-1
1143+
----
1144+
1145+
|`platform.openstack.failuredomains.portTargets.portTarget.fixedIPs`
1146+
|Subnets to allocate fixed IP addresses to. These subnets must exist within the same network as the port.
1147+
|A list of `subnet` objects.
1148+
|====
1149+
1150+
NOTE: You cannot combine zone fields and failure domains. If you want to use failure domains, the `controlPlane.zone` and `controlPlane.rootVolume.zone` fields must be left unset.
10711151
endif::osp[]
10721152

10731153
ifdef::azure[]

‎modules/installation-osp-failure-domains-config.adoc

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * installing/installing_openstack/installing-openstack-*.adoc
4+
5+
:_content-type: PROCEDURE
6+
[id="installation-osp-failure-domains-config_{context}"]
7+
= An example installation configuration section that uses failure domains
8+
9+
:FeatureName: {rh-openstack} failure domains
10+
include::snippets/technology-preview.adoc[]
11+
12+
The following section of an `install-config.yaml` file demonstrates the use of failure domains in a cluster to deploy on {rh-openstack-first}:
13+
14+
[source,yaml]
15+
----
16+
...
17+
controlPlane:
18+
name: master
19+
platform:
20+
openstack:
21+
type: m1.large
22+
failureDomains:
23+
- computeAvailabilityZone: 'nova-1'
24+
storageAvailabilityZone: 'cinder-1'
25+
portTargets:
26+
- id: control-plane
27+
network:
28+
id: 8db6a48e-375b-4caa-b20b-5b9a7218bfe6
29+
- computeAvailabilityZone: 'nova-2'
30+
storageAvailabilityZone: 'cinder-2'
31+
portTargets:
32+
- id: control-plane
33+
network:
34+
id: 39a7b82a-a8a4-45a4-ba5a-288569a6edd1
35+
- computeAvailabilityZone: 'nova-3'
36+
storageAvailabilityZone: 'cinder-3'
37+
portTargets:
38+
- id: control-plane
39+
network:
40+
id: 8e4b4e0d-3865-4a9b-a769-559270271242
41+
featureSet: TechPreviewNoUpgrade
42+
...
43+
----

0 commit comments

Comments
 (0)