From 93eda665c6f5a4514cf2852c8af8ba64215a5d63 Mon Sep 17 00:00:00 2001 From: Ashleigh Brennan Date: Tue, 20 Aug 2024 11:47:05 -0500 Subject: [PATCH] OSDOCS-11627: Consolidate vSphere docs under existing installation section --- _topic_maps/_topic_map.yml | 12 ++++++------ ...-vsphere-post-installation-configuration.adoc | 2 +- ...tall-vsphere-zones-regions-configuration.adoc | 16 ++++++---------- .../vsphere-post-installation-encryption.adoc | 6 +++--- .../cluster-api-config-options-vsphere.adoc | 4 ++-- .../cpmso-resiliency.adoc | 2 +- .../cpmso-config-options-vsphere.adoc | 4 ++-- ...ces-regions-zones-infrastructure-vsphere.adoc | 4 ++-- ...sphere-enabling-multiple-layer2-networks.adoc | 4 ++-- .../persistent-storage-csi-vsphere.adoc | 6 +++--- 10 files changed, 28 insertions(+), 32 deletions(-) rename {post_installation_configuration => installing/installing_vsphere}/installing-vsphere-post-installation-configuration.adoc (89%) rename {post_installation_configuration => installing/installing_vsphere}/post-install-vsphere-zones-regions-configuration.adoc (59%) rename {post_installation_configuration => installing/installing_vsphere}/vsphere-post-installation-encryption.adoc (59%) diff --git a/_topic_maps/_topic_map.yml b/_topic_maps/_topic_map.yml index 8f0ba82bdf..53932133f2 100644 --- a/_topic_maps/_topic_map.yml +++ b/_topic_maps/_topic_map.yml @@ -556,6 +556,12 @@ Topics: File: using-vsphere-problem-detector-operator - Name: Installation configuration parameters File: installation-config-parameters-vsphere + - Name: Regions and zones for a VMware vCenter + File: post-install-vsphere-zones-regions-configuration + - Name: Enabling encryption on a vSphere cluster + File: vsphere-post-installation-encryption + - Name: Configuring the vSphere connection settings after an installation + File: installing-vsphere-post-installation-configuration - Name: Installing on any platform Dir: installing_platform_agnostic Distros: openshift-origin,openshift-enterprise @@ -621,10 +627,6 @@ Topics: File: multi-architecture-compute-managing - Name: Managing workloads on multi-architecture clusters by using the Multiarch Tuning Operator File: multiarch-tuning-operator -- Name: Enabling encryption on a vSphere cluster - File: vsphere-post-installation-encryption -- Name: Configuring the vSphere connection settings after an installation - File: installing-vsphere-post-installation-configuration - Name: Cluster tasks File: cluster-tasks - Name: Node tasks @@ -648,8 +650,6 @@ Topics: Distros: openshift-origin,openshift-enterprise - Name: Configuring additional devices in an IBM Z or IBM LinuxONE environment File: ibmz-post-install -- Name: Regions and zones for a VMware vCenter - File: post-install-vsphere-zones-regions-configuration - Name: AWS Local Zone or Wavelength Zone tasks File: aws-compute-edge-zone-tasks Distros: openshift-enterprise diff --git a/post_installation_configuration/installing-vsphere-post-installation-configuration.adoc b/installing/installing_vsphere/installing-vsphere-post-installation-configuration.adoc similarity index 89% rename from post_installation_configuration/installing-vsphere-post-installation-configuration.adoc rename to installing/installing_vsphere/installing-vsphere-post-installation-configuration.adoc index a86bbfd771..e6bf385b8d 100644 --- a/post_installation_configuration/installing-vsphere-post-installation-configuration.adoc +++ b/installing/installing_vsphere/installing-vsphere-post-installation-configuration.adoc @@ -17,4 +17,4 @@ include::modules/configuring-vsphere-connection-settings.adoc[leveloffset=+1] include::modules/configuring-vsphere-verifying-configuration.adoc[leveloffset=+1] -For instructions on creating storage objects, see xref:../storage/dynamic-provisioning.adoc#dynamic-provisioning[Dynamic provisioning]. +For instructions on creating storage objects, see xref:../../storage/dynamic-provisioning.adoc#dynamic-provisioning[Dynamic provisioning]. diff --git a/post_installation_configuration/post-install-vsphere-zones-regions-configuration.adoc b/installing/installing_vsphere/post-install-vsphere-zones-regions-configuration.adoc similarity index 59% rename from post_installation_configuration/post-install-vsphere-zones-regions-configuration.adoc rename to installing/installing_vsphere/post-install-vsphere-zones-regions-configuration.adoc index 6b97cfce72..5ac6f67626 100644 --- a/post_installation_configuration/post-install-vsphere-zones-regions-configuration.adoc +++ b/installing/installing_vsphere/post-install-vsphere-zones-regions-configuration.adoc @@ -28,29 +28,25 @@ If you want to migrate pre-existing {product-title} cluster compute nodes to a f The cloud provider adds `topology.kubernetes.io/zone` and `topology.kubernetes.io/region` labels to any compute node provisioned by a machine set resource. -For more information, see xref:../machine_management/creating_machinesets/creating-machineset-vsphere.adoc[Creating a compute machine set]. +For more information, see xref:../../machine_management/creating_machinesets/creating-machineset-vsphere.adoc[Creating a compute machine set]. ==== include::modules/specifying-regions-zones-infrastructure-vsphere.adoc[leveloffset=+1] [role="_additional-resources"] .Additional resources -* xref:../post_installation_configuration/post-install-vsphere-zones-regions-configuration.adoc#references-regions-zones-infrastructure-vsphere_post-install-vsphere-zones-regions-configuration[Parameters for the cluster-wide infrastructure CRD] +* xref:../../installing/installing_vsphere/post-install-vsphere-zones-regions-configuration.adoc#references-regions-zones-infrastructure-vsphere_post-install-vsphere-zones-regions-configuration[Parameters for the cluster-wide infrastructure CRD] include::modules/vsphere-enabling-multiple-layer2-networks.adoc[leveloffset=+1] [role="_additional-resources"] .Additional resources - -* xref:../installing/installing_vsphere/upi/installing-vsphere-network-customizations.adoc#installation-network-connectivity-user-infra_installing-vsphere-network-customizations[Network connectivity requirements] - -* xref:../machine_management/creating-infrastructure-machinesets.adoc#creating-infrastructure-machinesets-production[Creating infrastructure machine sets for production environments] - -* xref:../machine_management/creating_machinesets/creating-machineset-vsphere.adoc#machineset-creating_creating-machineset-vsphere[Creating a compute machine set] +* xref:../../installing/installing_vsphere/upi/installing-vsphere-network-customizations.adoc#installing-vsphere-network-customizations[Installing a cluster on vSphere with network customizations] +* xref:../../machine_management/creating-infrastructure-machinesets.adoc#creating-infrastructure-machinesets-production[Creating infrastructure machine sets for production environments] +* xref:../../machine_management/creating_machinesets/creating-machineset-vsphere.adoc#machineset-creating_creating-machineset-vsphere[Creating a compute machine set] include::modules/references-regions-zones-infrastructure-vsphere.adoc[leveloffset=+1] [role="_additional-resources"] .Additional resources - -* xref:../post_installation_configuration/post-install-vsphere-zones-regions-configuration.adoc#specifying-regions-zones-infrastructure-vsphere_post-install-vsphere-zones-regions-configuration[Specifying multiple regions and zones for your cluster on vSphere] +* xref:../../installing/installing_vsphere/post-install-vsphere-zones-regions-configuration.adoc#specifying-regions-zones-infrastructure-vsphere_post-install-vsphere-zones-regions-configuration[Specifying multiple regions and zones for your cluster on vSphere] diff --git a/post_installation_configuration/vsphere-post-installation-encryption.adoc b/installing/installing_vsphere/vsphere-post-installation-encryption.adoc similarity index 59% rename from post_installation_configuration/vsphere-post-installation-encryption.adoc rename to installing/installing_vsphere/vsphere-post-installation-encryption.adoc index 703d1770f6..7838601b97 100644 --- a/post_installation_configuration/vsphere-post-installation-encryption.adoc +++ b/installing/installing_vsphere/vsphere-post-installation-encryption.adoc @@ -13,6 +13,6 @@ include::modules/vsphere-encrypting-vms.adoc[leveloffset=+1] [role="_additional-resources"] [id="additional-resources_enabling-encryption-installation"] == Additional resources -* xref:../nodes/nodes/nodes-nodes-working.adoc#nodes-nodes-working-evacuating_nodes-nodes-working[Working with nodes] -* xref:../storage/container_storage_interface/persistent-storage-csi-vsphere.adoc#vsphere-pv-encryption[vSphere encryption] -* xref:../installing/installing_vsphere/upi/upi-vsphere-installation-reqs.adoc#installation-vsphere-encrypted-vms_upi-vsphere-installation-reqs[Requirements for encrypting virtual machines] +* xref:../../nodes/nodes/nodes-nodes-working.adoc#nodes-nodes-working-evacuating_nodes-nodes-working[Working with nodes] +* xref:../../storage/container_storage_interface/persistent-storage-csi-vsphere.adoc#vsphere-pv-encryption[vSphere encryption] +* xref:../../installing/installing_vsphere/upi/upi-vsphere-installation-reqs.adoc#installation-vsphere-encrypted-vms_upi-vsphere-installation-reqs[Requirements for encrypting virtual machines] diff --git a/machine_management/cluster_api_machine_management/cluster_api_provider_configurations/cluster-api-config-options-vsphere.adoc b/machine_management/cluster_api_machine_management/cluster_api_provider_configurations/cluster-api-config-options-vsphere.adoc index d3eb50c59a..98fa4cfcb6 100644 --- a/machine_management/cluster_api_machine_management/cluster_api_provider_configurations/cluster-api-config-options-vsphere.adoc +++ b/machine_management/cluster_api_machine_management/cluster_api_provider_configurations/cluster-api-config-options-vsphere.adoc @@ -27,11 +27,11 @@ include::modules/capi-yaml-machine-set-vsphere.adoc[leveloffset=+2] // This additional resources section can be added if this configuration is validated. (see also: callout in capi-yaml-machine-set-vsphere.adoc) // [role="_additional-resources"] // .Additional resources -// * xref:../../../post_installation_configuration/post-install-vsphere-zones-regions-configuration.adoc#post-install-vsphere-zones-regions-configuration[Multiple regions and zones configuration for a cluster on {vmw-full}] +// * xref:../../../installing/installing_vsphere/post-install-vsphere-zones-regions-configuration.adoc#post-install-vsphere-zones-regions-configuration[Multiple regions and zones configuration for a cluster on {vmw-full}] // [id="cluster-api-supported-features-vsphere_{context}"] // == Enabling {vmw-full} features with the Cluster API // You can enable the following features by updating values in the Cluster API custom resource manifests. -//Not sure what, if anything, we can add here at this time. \ No newline at end of file +//Not sure what, if anything, we can add here at this time. diff --git a/machine_management/control_plane_machine_management/cpmso-resiliency.adoc b/machine_management/control_plane_machine_management/cpmso-resiliency.adoc index 197dd4526b..57a08b2b99 100644 --- a/machine_management/control_plane_machine_management/cpmso-resiliency.adoc +++ b/machine_management/control_plane_machine_management/cpmso-resiliency.adoc @@ -30,7 +30,7 @@ include::modules/cpmso-failure-domains-provider.adoc[leveloffset=+2] * xref:../../machine_management/control_plane_machine_management/cpmso_provider_configurations/cpmso-config-options-vsphere.adoc#cpmso-yaml-failure-domain-vsphere_cpmso-config-options-vsphere[Sample {vmw-full} failure domain configuration] -* xref:../../post_installation_configuration/post-install-vsphere-zones-regions-configuration.adoc#post-install-vsphere-zones-regions-configuration[Regions and zones for a VMware vCenter] +* xref:../../installing/installing_vsphere/post-install-vsphere-zones-regions-configuration.adoc#post-install-vsphere-zones-regions-configuration[Regions and zones for a VMware vCenter] //Balancing control plane machines include::modules/cpmso-failure-domains-balancing.adoc[leveloffset=+2] diff --git a/machine_management/control_plane_machine_management/cpmso_provider_configurations/cpmso-config-options-vsphere.adoc b/machine_management/control_plane_machine_management/cpmso_provider_configurations/cpmso-config-options-vsphere.adoc index eb08fe8323..18711ea6a0 100644 --- a/machine_management/control_plane_machine_management/cpmso_provider_configurations/cpmso-config-options-vsphere.adoc +++ b/machine_management/control_plane_machine_management/cpmso_provider_configurations/cpmso-config-options-vsphere.adoc @@ -22,7 +22,7 @@ include::modules/cpmso-yaml-failure-domain-vsphere.adoc[leveloffset=+2] [role="_additional-resources"] .Additional resources -* xref:../../../post_installation_configuration/post-install-vsphere-zones-regions-configuration.adoc#specifying-regions-zones-infrastructure-vsphere_post-install-vsphere-zones-regions-configuration[Specifying multiple regions and zones for your cluster on {vmw-short}] +* xref:../../../installing/installing_vsphere/post-install-vsphere-zones-regions-configuration.adoc#specifying-regions-zones-infrastructure-vsphere_post-install-vsphere-zones-regions-configuration[Specifying multiple regions and zones for your cluster on {vmw-short}] [id="cpmso-supported-features-vsphere_{context}"] == Enabling {vmw-full} features for control plane machines @@ -30,4 +30,4 @@ include::modules/cpmso-yaml-failure-domain-vsphere.adoc[leveloffset=+2] You can enable features by updating values in the control plane machine set. //Adding tags to machines by using machine sets -include::modules/machine-api-vmw-add-tags.adoc[leveloffset=+2,tag=!compute] \ No newline at end of file +include::modules/machine-api-vmw-add-tags.adoc[leveloffset=+2,tag=!compute] diff --git a/modules/references-regions-zones-infrastructure-vsphere.adoc b/modules/references-regions-zones-infrastructure-vsphere.adoc index d38aa5a1e0..55faa9e055 100644 --- a/modules/references-regions-zones-infrastructure-vsphere.adoc +++ b/modules/references-regions-zones-infrastructure-vsphere.adoc @@ -1,5 +1,5 @@ // Module included in the following assemblies: -// * post_installation_configuration/post-install-vsphere-zones-regions-configuration.adoc +// * installing/installing_vsphere/post-install-vsphere-zones-regions-configuration.adoc :_mod-docs-content-type: REFERENCE [id="references-regions-zones-infrastructure-vsphere_{context}"] @@ -27,4 +27,4 @@ The following table lists mandatory parameters for defining multiple regions and |`resourcePool` | The full path of the resource pool associated with the failure domain. |`datastore` | The full path of the datastore associated with the failure domain. |`networks` | A list of port groups associated with the failure domain. Only one portgroup may be defined. -|=== \ No newline at end of file +|=== diff --git a/modules/vsphere-enabling-multiple-layer2-networks.adoc b/modules/vsphere-enabling-multiple-layer2-networks.adoc index aa65e7aecc..fc6e537636 100644 --- a/modules/vsphere-enabling-multiple-layer2-networks.adoc +++ b/modules/vsphere-enabling-multiple-layer2-networks.adoc @@ -1,5 +1,5 @@ // Module included in the following assemblies: -// * post_installation_configuration/post-install-vsphere-zones-regions-configuration.adoc +// * installing/installing_vsphere/post-install-vsphere-zones-regions-configuration.adoc :_mod-docs-content-type: PROCEDURE [id="vsphere-enabling-multiple-layer2-network_{context}"] @@ -18,4 +18,4 @@ You can configure your cluster to use a multiple layer 2 network configuration s * If you installed your cluster on infrastructure that you provided, which is defined as a user-provisioned infrastructure, complete the following actions to meet your needs: ** Configure your API load balancer and network so that the load balancer can reach the API and Machine Config Server on the control plane nodes. -** Configure your Ingress load balancer and network so that the load balancer can reach the Ingress pods on the compute or infrastructure nodes. \ No newline at end of file +** Configure your Ingress load balancer and network so that the load balancer can reach the Ingress pods on the compute or infrastructure nodes. diff --git a/storage/container_storage_interface/persistent-storage-csi-vsphere.adoc b/storage/container_storage_interface/persistent-storage-csi-vsphere.adoc index 03abb6a0e6..938c2b6ad7 100644 --- a/storage/container_storage_interface/persistent-storage-csi-vsphere.adoc +++ b/storage/container_storage_interface/persistent-storage-csi-vsphere.adoc @@ -53,7 +53,7 @@ You can encrypt virtual machines (VMs) and dynamically provisioned persistent vo {product-title} does not support RWX-encrypted PVs. You cannot request RWX PVs out of a storage class that uses an encrypted storage policy. ==== -You must encrypt VMs before you can encrypt PVs, which you can do during installation or postinstallation. +You must encrypt VMs before you can encrypt PVs, which you can do during or after installation. For information about encrypting VMs, see: @@ -61,7 +61,7 @@ For information about encrypting VMs, see: * xref:../../installing/installing_vsphere/upi/installing-vsphere.adoc#installation-vsphere-machines_installing-vsphere[During installation: Step 7 of Installing RHCOS and starting the {product-title} bootstrap process] -* xref:../../post_installation_configuration/vsphere-post-installation-encryption.adoc[Postinstallation enabling encryption on a vSphere cluster] +* xref:../../installing/installing_vsphere/vsphere-post-installation-encryption.adoc#vsphere-post-installation-encryption[Enabling encryption on a vSphere cluster] After encrypting VMs, you can configure a storage class that supports dynamic encryption volume provisioning using the vSphere Container Storage Interface (CSI) driver. This can be accomplished in one of two ways using: @@ -83,7 +83,7 @@ include::modules/persistent-storage-csi-vsphere-top-aware-during-install.adoc[le include::modules/persistent-storage-csi-vsphere-top-aware-post-install.adoc[leveloffset=+2] [role="_additional-resources"] .Additional resources -* xref:../../post_installation_configuration/post-install-vsphere-zones-regions-configuration.adoc#specifying-regions-zones-infrastructure-vsphere_post-install-vsphere-zones-regions-configuration[Specifying multiple regions and zones for your cluster on vSphere] +* xref:../../installing/installing_vsphere/post-install-vsphere-zones-regions-configuration.adoc#specifying-regions-zones-infrastructure-vsphere_post-install-vsphere-zones-regions-configuration[Specifying multiple regions and zones for your cluster on vSphere] * https://docs.vmware.com/en/VMware-vSphere/8.0/vsphere-vcenter-esxi-management/GUID-16422FF7-235B-4A44-92E2-532F6AED0923.html?hWord=N4IghgNiBcIC5gOYgL5A[VMware vSphere tag documentation] include::modules/persistent-storage-csi-vsphere-top-aware-infra-top.adoc[leveloffset=+2]