Merge pull request #40136 from maxwelldb/shiftstack-affinity-osdocs3064

[OSDOCS-3064] Allow strict anti-affinity for servers at install time - ShiftStack

Author: maxwelldb

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

@@ -43,7 +43,7 @@ After you deploy your cluster, you can attach pods to additional networks. For m
 ====
 
 include::modules/installation-osp-config-yaml.adoc[leveloffset=+2]
-include::modules/installation-osp-setting-worker-affinity.adoc[leveloffset=+1]
+// include::modules/installation-osp-setting-worker-affinity.adoc[leveloffset=+1]
 include::modules/ssh-agent-using.adoc[leveloffset=+1]
 include::modules/installation-osp-accessing-api.adoc[leveloffset=+1]
 include::modules/installation-osp-accessing-api-floating.adoc[leveloffset=+2]

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

@@ -51,7 +51,7 @@ After you deploy your cluster, you can attach pods to additional networks. For m
 
 include::modules/installation-osp-kuryr-port-pools.adoc[leveloffset=+2]
 include::modules/installation-osp-kuryr-settings-installing.adoc[leveloffset=+2]
-include::modules/installation-osp-setting-worker-affinity.adoc[leveloffset=+1]
+// include::modules/installation-osp-setting-worker-affinity.adoc[leveloffset=+1]
 include::modules/ssh-agent-using.adoc[leveloffset=+1]
 include::modules/installation-osp-accessing-api.adoc[leveloffset=+1]
 include::modules/installation-osp-accessing-api-floating.adoc[leveloffset=+2]

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

@@ -35,7 +35,7 @@ include::modules/installation-initializing.adoc[leveloffset=+1]
 include::modules/installation-configure-proxy.adoc[leveloffset=+2]
 include::modules/installation-configuration-parameters.adoc[leveloffset=+2]
 include::modules/installation-osp-restricted-config-yaml.adoc[leveloffset=+2]
-include::modules/installation-osp-setting-worker-affinity.adoc[leveloffset=+1]
+// include::modules/installation-osp-setting-worker-affinity.adoc[leveloffset=+1]
 include::modules/ssh-agent-using.adoc[leveloffset=+1]
 include::modules/installation-osp-accessing-api.adoc[leveloffset=+1]
 include::modules/installation-osp-accessing-api-floating.adoc[leveloffset=+2]

modules/installation-configuration-parameters.adoc

@@ -796,6 +796,14 @@ On clusters that use Kuryr, {rh-openstack} Octavia does not support availability
 |For compute machines, the availability zone to install root volumes on. If you do not set a value for this parameter, the installer selects the default availability zone.
 |A list of strings, for example `["zone-1", "zone-2"]`.
 
+|`compute.platform.openstack.serverGroupPolicy`
+|Server group policy to apply to the group that will contain the compute machines in the pool. You cannot change server group policies or affiliations after creation. Supported options include `anti-affinity`, `soft-affinity`, and `soft-anti-affinity`. The default value is `soft-anti-affinity`. 
+
+An `affinity` policy prevents migrations and therefore affects {rh-openstack} upgrades. The `affinity` policy is not supported.
+
+If you use a strict `anti-affinity` policy, an additional {rh-openstack} host is required during instance migration. 
+|A server group policy to apply to the machine pool. For example, `soft-affinity`.
+
 |`controlPlane.platform.openstack.additionalNetworkIDs`
 |Additional networks that are associated with control plane machines. Allowed address pairs are not created for additional networks.
 |A list of one or more UUIDs as strings. For example, `fa806b2f-ac49-4bce-b9db-124bc64209bf`.
@@ -814,6 +822,14 @@ On clusters that use Kuryr, {rh-openstack} Octavia does not support availability
 |For control plane machines,  the availability zone to install root volumes on. If you do not set this value, the installer selects the default availability zone.
 |A list of strings, for example `["zone-1", "zone-2"]`.
 
+|`controlPlane.platform.openstack.serverGroupPolicy`
+|Server group policy to apply to the group that will contain the control plane machines in the pool. You cannot change server group policies or affiliations after creation. Supported options include `anti-affinity`, `soft-affinity`, and `soft-anti-affinity`. The default value is `soft-anti-affinity`. 
+
+An `affinity` policy prevents migrations, and therefore affects {rh-openstack} upgrades. The `affinity` policy is not supported.
+
+If you use a strict `anti-affinity` policy, an additional {rh-openstack} host is required during instance migration. 
+|A server group policy to apply to the machine pool. For example, `soft-affinity`.
+
 |`platform.openstack.clusterOSImage`
 |The location from which the installer downloads the {op-system} image.
 

modules/installation-osp-default-deployment.adoc

@@ -23,6 +23,7 @@ To support an {product-title} installation, your {rh-openstack-first} quota must
 |Instances             | 7
 |Security groups       | 3
 |Security group rules  | 60
+|Server groups         | 2 - plus 1 for each additional availability zone in each machine pool
 |======================================
 
 A cluster might function with fewer than recommended resources, but its performance is not guaranteed.

modules/installation-osp-default-kuryr-deployment.adoc

@@ -28,6 +28,7 @@ Use the following quota to satisfy a default cluster's minimum requirements:
 |Instances               | 7
 |Security groups         | 250 - 1 needed per Service and per NetworkPolicy
 |Security group rules    | 1000
+|Server groups           | 2 - plus 1 for each additional availability zone in each machine pool
 |Load balancers          | 100 - 1 needed per Service
 |Load balancer listeners | 500 - 1 needed per Service-exposed port
 |Load balancer pools     | 500 - 1 needed per Service-exposed port

modules/installation-osp-setting-worker-affinity.adoc

@@ -12,15 +12,10 @@
 [id="installation-osp-setting-worker-affinity_{context}"]
 = Setting compute machine affinity
 
-Optionally, you can set the affinity policy for compute machines during installation. The installer does not select an affinity policy for compute machines by default. 
+Optionally, you can set the affinity policy for compute machines during installation. By default, both compute and control plane machines are created with a `soft-anti-affinity` policy.
 
 You can also create machine sets that use particular {rh-openstack} server groups after installation. 
 
-[NOTE]
-====
-Control plane machines are created with a `soft-anti-affinity` policy. 
-====
-
 [TIP]
 ====
 You can learn more about link:https://access.redhat.com/documentation/en-us/red_hat_openstack_platform/16.1/html/configuring_the_compute_service_for_instance_creation/configuring-instance-scheduling-and-placement[{rh-openstack} instance scheduling and placement] in the {rh-openstack} documentation.