From abde3c77602e63315e744b3aa89230107544e9a6 Mon Sep 17 00:00:00 2001 From: Ashleigh Brennan Date: Thu, 1 Aug 2024 14:41:06 -0500 Subject: [PATCH] OSDOCS-11473: Clean up Nutanix cluster fault toleration docs --- _topic_maps/_topic_map.yml | 2 - .../nutanix-failure-domains.adoc | 43 +++++++++++++++++-- .../cpmso-resiliency.adoc | 4 +- .../cpmso-config-options-nutanix.adoc | 2 +- .../creating-machineset-nutanix.adoc | 2 +- .../adding-nutanix-failure-domains.adoc | 42 ------------------ 6 files changed, 44 insertions(+), 51 deletions(-) delete mode 100644 post_installation_configuration/adding-nutanix-failure-domains.adoc diff --git a/_topic_maps/_topic_map.yml b/_topic_maps/_topic_map.yml index 1c41e78ee9..7d0bfd33e6 100644 --- a/_topic_maps/_topic_map.yml +++ b/_topic_maps/_topic_map.yml @@ -650,8 +650,6 @@ Topics: File: ibmz-post-install - Name: Regions and zones for a VMware vCenter File: post-install-vsphere-zones-regions-configuration -- Name: Adding failure domains to an existing Nutanix cluster - File: adding-nutanix-failure-domains Distros: openshift-origin,openshift-enterprise - Name: AWS Local Zone or Wavelength Zone tasks File: aws-compute-edge-zone-tasks diff --git a/installing/installing_nutanix/nutanix-failure-domains.adoc b/installing/installing_nutanix/nutanix-failure-domains.adoc index b8efccd386..c3f533566b 100644 --- a/installing/installing_nutanix/nutanix-failure-domains.adoc +++ b/installing/installing_nutanix/nutanix-failure-domains.adoc @@ -10,14 +10,51 @@ By default, the installation program installs control plane and compute machines A failure domain represents an additional Prism Element instance that is available to {product-title} machine pools during and after installation. -include::modules/installation-nutanix-failure-domains-req.adoc[leveloffset=+1] - +[id="nutanix-failure-domains-install-method_{context}"] == Installation method and failure domain configuration The {product-title} installation method determines how and when you configure failure domains: * If you deploy using installer-provisioned infrastructure, you can configure failure domains in the installation configuration file before deploying the cluster. For more information, see xref:../../installing/installing_nutanix/installing-nutanix-installer-provisioned.adoc#installation-configuring-nutanix-failure-domains_installing-nutanix-installer-provisioned[Configuring failure domains]. + -You can also configure failure domains after the cluster is deployed. For more information about configuring failure domains post-installation, see xref:../../post_installation_configuration/adding-nutanix-failure-domains.adoc#adding-failure-domains-to-an-existing-nutanix-cluster[Adding failure domains to an existing Nutanix cluster]. +You can also configure failure domains after the cluster is deployed. For more information about configuring failure domains post-installation, see xref:../../installing/installing_nutanix/nutanix-failure-domains.adoc#nutanix-failure-domains-adding-to-existing-cluster_nutanix-failure-domains[Adding failure domains to an existing Nutanix cluster]. * If you deploy using infrastructure that you manage (user-provisioned infrastructure) no additional configuration is required. After the cluster is deployed, you can manually distribute control plane and compute machines across failure domains. + +[id="nutanix-failure-domains-adding-to-existing-cluster_{context}"] +== Adding failure domains to an existing Nutanix cluster + +By default, the installation program installs control plane and compute machines into a single Nutanix Prism Element (cluster). After an {product-title} cluster is deployed, you can improve its fault tolerance by adding additional Prism Element instances to the deployment using failure domains. + +A failure domain represents a single Prism Element instance where new control plane and compute machines can be deployed and existing control plane and compute machines can be distributed. + +include::modules/installation-nutanix-failure-domains-req.adoc[leveloffset=+2] + +include::modules/post-installation-configuring-nutanix-failure-domains.adoc[leveloffset=+2] + +include::modules/post-installation-adding-nutanix-failure-domains-control-planes.adoc[leveloffset=+2] + +[role="_additional-resources"] +.Additional resources +* xref:../../machine_management/control_plane_machine_management/cpmso-getting-started.adoc#cpmso-checking-status_cpmso-getting-started[Checking the control plane machine set custom resource state] +* xref:../../machine_management/control_plane_machine_management/cpmso-managing-machines.adoc#cpmso-feat-replace_cpmso-managing-machines[Replacing a control plane machine] + +[id="nutanix-failure-domains-compute-machines_{context}"] +=== Distributing compute machines across failure domains + +You can distribute compute machines across Nutanix failure domains one of the following ways: + +* xref:../../installing/installing_nutanix/nutanix-failure-domains.adoc#post-installation-adding-nutanix-failure-domains-compute-machines-edit_nutanix-failure-domains[Editing existing compute machine sets] allows you to distribute compute machines across Nutanix failure domains as a minimal configuration update. +* xref:../../installing/installing_nutanix/nutanix-failure-domains.adoc#post-installation-adding-nutanix-failure-domains-compute-machines-replace_nutanix-failure-domains[Replacing existing compute machine sets] ensures that the specification is immutable and all your machines are the same. + +include::modules/post-installation-adding-nutanix-failure-domains-compute-machines-edit.adoc[leveloffset=+3] + +[role="_additional-resources"] +.Additional resources +* xref:../../machine_management/modifying-machineset.adoc#modifying-machineset[Modifying a compute machine set] + +include::modules/post-installation-adding-nutanix-failure-domains-compute-machines-replace.adoc[leveloffset=+3] + +[role="_additional-resources"] +.Additional resources +* xref:../../machine_management/creating_machinesets/creating-machineset-nutanix.adoc#creating-machineset-nutanix[Creating a compute machine set on Nutanix] diff --git a/machine_management/control_plane_machine_management/cpmso-resiliency.adoc b/machine_management/control_plane_machine_management/cpmso-resiliency.adoc index b3a6684d14..197dd4526b 100644 --- a/machine_management/control_plane_machine_management/cpmso-resiliency.adoc +++ b/machine_management/control_plane_machine_management/cpmso-resiliency.adoc @@ -24,7 +24,7 @@ include::modules/cpmso-failure-domains-provider.adoc[leveloffset=+2] * xref:../../machine_management/control_plane_machine_management/cpmso_provider_configurations/cpmso-config-options-azure.adoc#cpmso-yaml-failure-domain-azure_cpmso-config-options-azure[Sample {azure-full} failure domain configuration] -* xref:../../post_installation_configuration/adding-nutanix-failure-domains.adoc#adding-failure-domains-to-an-existing-nutanix-cluster[Adding failure domains to an existing Nutanix cluster] +* xref:../../installing/installing_nutanix/nutanix-failure-domains.adoc#nutanix-failure-domains-adding-to-existing-cluster_nutanix-failure-domains[Adding failure domains to an existing Nutanix cluster] * xref:../../machine_management/control_plane_machine_management/cpmso_provider_configurations/cpmso-config-options-openstack.adoc#cpmso-yaml-failure-domain-openstack_cpmso-config-options-openstack[Sample {rh-openstack-first} failure domain configuration] @@ -45,4 +45,4 @@ include::modules/cpmso-control-plane-recovery.adoc[leveloffset=+1] include::modules/machine-lifecycle-hook-deletion-etcd.adoc[leveloffset=+1] [role="_additional-resources"] .Additional resources -* xref:../../machine_management/deleting-machine.adoc#machine-lifecycle-hook-deletion_deleting-machine[Lifecycle hooks for the machine deletion phase] \ No newline at end of file +* xref:../../machine_management/deleting-machine.adoc#machine-lifecycle-hook-deletion_deleting-machine[Lifecycle hooks for the machine deletion phase] diff --git a/machine_management/control_plane_machine_management/cpmso_provider_configurations/cpmso-config-options-nutanix.adoc b/machine_management/control_plane_machine_management/cpmso_provider_configurations/cpmso-config-options-nutanix.adoc index 25620bd074..15ef9bbbfc 100644 --- a/machine_management/control_plane_machine_management/cpmso_provider_configurations/cpmso-config-options-nutanix.adoc +++ b/machine_management/control_plane_machine_management/cpmso_provider_configurations/cpmso-config-options-nutanix.adoc @@ -21,4 +21,4 @@ include::modules/cpmso-yaml-provider-spec-nutanix.adoc[leveloffset=+2] include::modules/mapi-failure-domain-nutanix.adoc[leveloffset=+2] [role="_additional-resources"] .Additional resources -* xref:../../../post_installation_configuration/adding-nutanix-failure-domains.adoc#adding-failure-domains-to-an-existing-nutanix-cluster[Adding failure domains to an existing Nutanix cluster] \ No newline at end of file +* xref:../../../installing/installing_nutanix/nutanix-failure-domains.adoc#nutanix-failure-domains-adding-to-existing-cluster_nutanix-failure-domains[Adding failure domains to an existing Nutanix cluster] diff --git a/machine_management/creating_machinesets/creating-machineset-nutanix.adoc b/machine_management/creating_machinesets/creating-machineset-nutanix.adoc index 1b4189fd45..8e7a1bb6e0 100644 --- a/machine_management/creating_machinesets/creating-machineset-nutanix.adoc +++ b/machine_management/creating_machinesets/creating-machineset-nutanix.adoc @@ -21,4 +21,4 @@ include::modules/machineset-creating.adoc[leveloffset=+1] include::modules/mapi-failure-domain-nutanix.adoc[leveloffset=+1] [role="_additional-resources"] .Additional resources -* xref:../../post_installation_configuration/adding-nutanix-failure-domains.adoc#adding-failure-domains-to-an-existing-nutanix-cluster[Adding failure domains to an existing Nutanix cluster] \ No newline at end of file +* xref:../../installing/installing_nutanix/nutanix-failure-domains.adoc#nutanix-failure-domains-adding-to-existing-cluster_nutanix-failure-domains[Adding failure domains to an existing Nutanix cluster] diff --git a/post_installation_configuration/adding-nutanix-failure-domains.adoc b/post_installation_configuration/adding-nutanix-failure-domains.adoc deleted file mode 100644 index a75c3151b8..0000000000 --- a/post_installation_configuration/adding-nutanix-failure-domains.adoc +++ /dev/null @@ -1,42 +0,0 @@ -:_mod-docs-content-type: ASSEMBLY -[id="adding-failure-domains-to-an-existing-nutanix-cluster"] -= Adding failure domains to an existing Nutanix cluster -include::_attributes/common-attributes.adoc[] -:context: adding-failure-domains-to-an-existing-nutanix-cluster - -toc::[] - -By default, the installation program installs control plane and compute machines into a single Nutanix Prism Element (cluster). After an {product-title} cluster is deployed, you can improve its fault tolerance by adding additional Prism Element instances to the deployment using failure domains. - -A failure domain represents a single Prism Element instance to which: - -* New control plane and compute machines can be deployed. -* Existing control plane and compute machines can be distributed. - -include::modules/installation-nutanix-failure-domains-req.adoc[leveloffset=+1] - -include::modules/post-installation-configuring-nutanix-failure-domains.adoc[leveloffset=+1] - -include::modules/post-installation-adding-nutanix-failure-domains-control-planes.adoc[leveloffset=+1] -[role="_additional-resources"] -.Additional resources -* xref:../machine_management/control_plane_machine_management/cpmso-getting-started.adoc#cpmso-checking-status_cpmso-getting-started[Checking the control plane machine set custom resource state] -* xref:../machine_management/control_plane_machine_management/cpmso-managing-machines.adoc#cpmso-feat-replace_cpmso-managing-machines[Replacing a control plane machine] - -[id="post-installation-adding-nutanix-failure-domains-compute-machines_{context}"] -== Distributing compute machines across failure domains - -You can distribute compute machines across Nutanix failure domains one of the following ways: - -* xref:../post_installation_configuration/adding-nutanix-failure-domains.adoc#post-installation-adding-nutanix-failure-domains-compute-machines-edit_adding-failure-domains-to-an-existing-nutanix-cluster[Editing existing compute machine sets] allows you to distribute compute machines across Nutanix failure domains as a minimal configuration update. -* xref:../post_installation_configuration/adding-nutanix-failure-domains.adoc#post-installation-adding-nutanix-failure-domains-compute-machines-replace_adding-failure-domains-to-an-existing-nutanix-cluster[Replacing existing compute machine sets] ensures that the specification is immutable and all your machines are the same. - -include::modules/post-installation-adding-nutanix-failure-domains-compute-machines-edit.adoc[leveloffset=+2] -[role="_additional-resources"] -.Additional resources -* xref:../machine_management/modifying-machineset.adoc#modifying-machineset[Modifying a compute machine set] - -include::modules/post-installation-adding-nutanix-failure-domains-compute-machines-replace.adoc[leveloffset=+2] -[role="_additional-resources"] -.Additional resources -* xref:../machine_management/creating_machinesets/creating-machineset-nutanix.adoc#creating-machineset-nutanix[Creating a compute machine set on Nutanix] \ No newline at end of file