Merge pull request #93709 from bscott-rh/OSDOCS-14757

OSDOCS-14757 greatly reducing GCP sample install config files

Author: bscott-rh

installing/installing_gcp/installing-gcp-customizations.adoc

@@ -59,11 +59,12 @@ include::modules/installation-gcp-managing-dns-solution.adoc[leveloffset=+2]
 .Additional resources
 * xref:../../installing/installing_gcp/installation-config-parameters-gcp.adoc#installation-configuration-parameters-additional-gcp_installation-config-parameters-gcp[Additional {gcp-first} configuration parameters]
 
-include::modules/installation-gcp-config-yaml.adoc[leveloffset=+2]
+include::modules/installation-gcp-config-yaml-simple.adoc[leveloffset=+2]
 
 [role="_additional-resources"]
 .Additional resources
 
+* xref:../../installing/installing_gcp/installation-config-parameters-gcp.adoc#installation-config-parameters-gcp[Installation configuration parameters for GCP]
 * xref:../../machine_management/creating_machinesets/creating-machineset-gcp.adoc#machineset-enabling-customer-managed-encryption_creating-machineset-gcp[Enabling customer-managed encryption keys for a compute machine set]
 
 include::modules/installation-configure-proxy.adoc[leveloffset=+2]

installing/installing_gcp/installing-gcp-private.adoc

@@ -61,11 +61,12 @@ include::modules/installation-gcp-managing-dns-solution.adoc[leveloffset=+2]
 .Additional resources
 * xref:../../installing/installing_gcp/installation-config-parameters-gcp.adoc#installation-config-parameters-gcp[Installation configuration parameters for {gcp-first}]
 
-include::modules/installation-gcp-config-yaml.adoc[leveloffset=+2]
+include::modules/installation-gcp-config-yaml-simple.adoc[leveloffset=+2]
 
 [role="_additional-resources"]
 .Additional resources
 
+* xref:../../installing/installing_gcp/installation-config-parameters-gcp.adoc#installation-config-parameters-gcp[Installation configuration parameters for GCP]
 * xref:../../machine_management/creating_machinesets/creating-machineset-gcp.adoc#machineset-enabling-customer-managed-encryption_creating-machineset-gcp[Enabling customer-managed encryption keys for a compute machine set]
 
 include::modules/nw-gcp-installing-global-access-configuration.adoc[leveloffset=+2]

installing/installing_gcp/installing-gcp-shared-vpc.adoc

@@ -52,7 +52,12 @@ include::modules/installation-gcp-managing-dns-solution.adoc[leveloffset=+2]
 .Additional resources
 * xref:../../installing/installing_gcp/installation-config-parameters-gcp.adoc#installation-config-parameters-gcp[Installation configuration parameters for {gcp-first}]
 
-include::modules/installation-gcp-shared-vpc-config.adoc[leveloffset=+2]
+include::modules/installation-gcp-config-yaml-simple.adoc[leveloffset=+2]
+
+[role="_additional-resources"]
+.Additional resources
+
+* xref:../../installing/installing_gcp/installation-config-parameters-gcp.adoc#installation-config-parameters-gcp[Installation configuration parameters for GCP]
 
 include::modules/installation-configure-proxy.adoc[leveloffset=+2]
 

installing/installing_gcp/installing-gcp-vpc.adoc

@@ -58,11 +58,12 @@ include::modules/installation-gcp-managing-dns-solution.adoc[leveloffset=+2]
 .Additional resources
 * xref:../../installing/installing_gcp/installation-config-parameters-gcp.adoc#installation-config-parameters-gcp[Installation configuration parameters for {gcp-first}]
 
-include::modules/installation-gcp-config-yaml.adoc[leveloffset=+2]
+include::modules/installation-gcp-config-yaml-simple.adoc[leveloffset=+2]
 
 [role="_additional-resources"]
 .Additional resources
 
+* xref:../../installing/installing_gcp/installation-config-parameters-gcp.adoc#installation-config-parameters-gcp[Installation configuration parameters for GCP]
 * xref:../../machine_management/creating_machinesets/creating-machineset-gcp.adoc#machineset-enabling-customer-managed-encryption_creating-machineset-gcp[Enabling customer-managed encryption keys for a compute machine set]
 
 include::modules/nw-gcp-installing-global-access-configuration.adoc[leveloffset=+2]

installing/installing_gcp/installing-restricted-networks-gcp-installer-provisioned.adoc

@@ -71,7 +71,12 @@ include::modules/installation-gcp-managing-dns-solution.adoc[leveloffset=+2]
 .Additional resources
 * xref:../../installing/installing_gcp/installation-config-parameters-gcp.adoc#installation-config-parameters-gcp[Installation configuration parameters for {gcp-first}]
 
-include::modules/installation-gcp-config-yaml.adoc[leveloffset=+2]
+include::modules/installation-gcp-config-yaml-simple.adoc[leveloffset=+2]
+
+[role="_additional-resources"]
+.Additional resources
+
+* xref:../../installing/installing_gcp/installation-config-parameters-gcp.adoc#installation-config-parameters-gcp[Installation configuration parameters for GCP]
 
 include::modules/nw-gcp-installing-global-access-configuration.adoc[leveloffset=+2]
 

modules/installation-gcp-config-yaml-simple.adoc

@@ -0,0 +1,54 @@
+// Module included in the following assemblies:
+//
+// * installing/installing_gcp/installing-gcp-customizations.adoc
+// * installing/installing_gcp/installing-gcp-network-customizations.adoc
+// * installing/installing_gcp/installing-gcp-vpc.adoc
+// * installing/installing_gcp/installing-gcp-private.adoc
+// * installing/installing_gcp/installing-restricted-networks-gcp-installer-provisioned.adoc
+
+:_mod-docs-content-type: REFERENCE
+[id="installation-gcp-config-yaml_{context}"]
+= Sample customized install-config.yaml file for {gcp-full}
+
+[role="_abstract"]
+To specify more details about your {product-title} cluster's platform or modify the values of the required parameters, you can customize the `install-config.yaml` file.
+
+[IMPORTANT]
+====
+This sample YAML file is provided for reference only. You must obtain your `install-config.yaml` file by using the installation program and modify it.
+====
+
+[source,yaml]
+----
+apiVersion: v1
+baseDomain: example.com
+pullSecret: '{"auths": ...}'
+controlPlane:
+  name: master
+  replicas: 3
+  platform:
+    gcp:
+      type: n2-standard-4
+compute:
+- name: worker
+  replicas: 3
+  platform:
+    gcp:
+      type: n2-standard-4
+metadata:
+  name: test-cluster
+networking:
+  clusterNetwork:
+  - cidr: 10.128.0.0/14
+    hostPrefix: 23
+platform:
+  gcp:
+    projectID: sample-project
+    region: us-east1
+----
+where:
+
+`controlPlane`:: Specifies parameters that apply to control plane machines.
+`compute`:: Specifies parameters that apply to compute machines.
+`networking`:: Specifies parameters that apply to the cluster networking configuration. If you do not provide networking values, the installation program provides default values.
+`platform`:: Specifies parameters that apply to the infrastructure platform that hosts the cluster.

modules/installation-gcp-shared-vpc-config.adoc

@@ -127,6 +127,46 @@ $ mkdir <installation_directory>
 You must create a directory. Some installation assets, such as bootstrap X.509 certificates have short expiration intervals, so you must not reuse an installation directory. If you want to reuse individual files from another cluster installation, you can copy them into your directory. However, the file names for the installation assets might change between releases. Use caution when copying installation files from an earlier {product-title} version.
 ====
 
+ifdef::gcp-private[]
+. Edit the `install-config.yaml` file to set the `publish: Internal` parameter.
+. Edit the `install-config.yaml` file to set the parameters necessary for installation into an existing VPC.
+.. Define the network and subnets for the VPC to install the cluster in under the parent `platform.gcp` field:
++
+[source,yaml]
+----
+platform:
+  gcp:
+    network: <existing_vpc>
+    controlPlaneSubnet: <control_plane_subnet>
+    computeSubnet: <compute_subnet>
+----
++
+For the `platform.gcp.network` parameter, specify the name for the existing Google VPC. For the `platform.gcp.controlPlaneSubnet` and `platform.gcp.computeSubnet` parameters, specify the existing subnets to deploy the control plane machines and compute machines, respectively.
+endif::gcp-private[]
+ifdef::gcp-shared[]
+. Edit the `install-config.yaml` file to set the parameters necessary for installation into a shared VPC.
+.. Define the network, subnets, and project names for the shared VPC:
++
+[source,yaml]
+----
+# ...
+platform:
+  gcp:
+    computeSubnet: <shared_vpc_compute_subnet>
+    controlPlaneSubnet: <shared_vpc_control_plane_subnet>
+    network: <shared_vpc_name>
+    networkProjectID: <host_project_name>
+    projectID: <service_project_name>
+----
+where:
+
+`<shared_vpc_compute_subnet>`:: Specifies the name of the subnet in the shared VPC for compute machines to use.
+`<shared_vpc_control_plane_subnet>`:: Specifies the name of the subnet in the shared VPC for control plane machines to use.
+`<shared_vpc_name>`:: Specifies the name of the shared VPC.
+`<host_project_name>`:: Specifies the name of the host project where the shared VPC exists.
+`<service_project_name>`:: Specifies the name of the project where you want to install the cluster.
+endif::gcp-shared[]
+
 . Customize the provided sample `install-config.yaml` file template and save the file in the `<installation_directory>`.
 ifdef::ibm-cloud-restricted[]
 +

modules/installation-initializing-manual.adoc

@@ -69,6 +69,7 @@ ifeval::["{context}" == "installing-gcp-customizations"]
 endif::[]
 ifeval::["{context}" == "installing-gcp-vpc"]
 :gcp:
+:gcp-vpc:
 endif::[]
 ifeval::["{context}" == "installing-gcp-shared-vpc"]
 :gcp:
@@ -89,6 +90,7 @@ ifeval::["{context}" == "installing-restricted-networks-gcp"]
 endif::[]
 ifeval::["{context}" == "installing-restricted-networks-gcp-installer-provisioned"]
 :gcp:
+:gcp-restricted:
 :restricted:
 endif::[]
 ifeval::["{context}" == "installing-ibm-cloud-customizations"]
@@ -459,6 +461,20 @@ endif::aws-outposts[]
 ifndef::restricted,nutanix,aws-outposts[]
 . Modify the `install-config.yaml` file. You can find more information about the available parameters in the "Installation configuration parameters" section.
 endif::restricted,nutanix,aws-outposts[]
+ifdef::gcp-vpc[]
+.. Define the network and subnets for the VPC to install the cluster in under the parent `platform.gcp` field:
++
+[source,yaml]
+----
+platform:
+  gcp:
+    network: <existing_vpc>
+    controlPlaneSubnet: <control_plane_subnet>
+    computeSubnet: <compute_subnet>
+----
++
+For `platform.gcp.network`, specify the name for the existing Google VPC. For `platform.gcp.controlPlaneSubnet` and `platform.gcp.computeSubnet`, specify the existing subnets to deploy the control plane machines and compute machines, respectively.
+endif::gcp-vpc[]
 ifdef::three-node-cluster[]
 +
 [NOTE]
@@ -581,19 +597,21 @@ where:
 `<control_plane_subnet>`:: Replace `<control_plane_subnet>` with the existing subnet name to deploy the control plane machines.
 `<compute_subnet>:: Replace `<compute_subnet>` with the existing subnet name to deploy compute machines.
 endif::azure+restricted[]
-ifdef::gcp+restricted[]
+ifdef::gcp-restricted[]
 +
 .. Define the network and subnets for the VPC to install the cluster in under the parent `platform.gcp` field:
 +
 [source,yaml]
 ----
-network: <existing_vpc>
-controlPlaneSubnet: <control_plane_subnet>
-computeSubnet: <compute_subnet>
+platform:
+  gcp:
+    network: <existing_vpc>
+    controlPlaneSubnet: <control_plane_subnet>
+    computeSubnet: <compute_subnet>
 ----
 +
 For `platform.gcp.network`, specify the name for the existing Google VPC. For `platform.gcp.controlPlaneSubnet` and `platform.gcp.computeSubnet`, specify the existing subnets to deploy the control plane machines and compute machines, respectively.
-endif::gcp+restricted[]
+endif::gcp-restricted[]
 ifdef::ibm-power-vs+restricted[]
 +
 .. Define the network for the VPC to install the cluster in under the parent `platform.powervs` field:
@@ -672,7 +690,7 @@ Only one VPE can be specified per service.
 endif::ibm-cloud[]
 ifdef::restricted[]
 +
-.. Set the publishing strategy to `Internal`:
+.. Optionally, set the publishing strategy to `Internal`:
 +
 [source,yaml]
 ----
@@ -764,6 +782,7 @@ ifeval::["{context}" == "installing-gcp-network-customizations"]
 endif::[]
 ifeval::["{context}" == "installing-gcp-vpc"]
 :!gcp:
+:!gcp-vpc:
 endif::[]
 ifeval::["{context}" == "installing-gcp-shared-vpc"]
 :!gcp:
@@ -781,6 +800,7 @@ ifeval::["{context}" == "installing-restricted-networks-gcp"]
 endif::[]
 ifeval::["{context}" == "installing-restricted-networks-gcp-installer-provisioned"]
 :!gcp:
+:!gcp-restricted:
 :!restricted:
 endif::[]
 ifeval::["{context}" == "installing-ibm-cloud-customizations"]

modules/installation-initializing.adoc

@@ -6,7 +6,8 @@
 [id="private-clusters-about-gcp_{context}"]
 = Private clusters in {gcp-short}
 
-To create a private cluster on {gcp-first}, you must provide an existing private VPC and subnets to host the cluster. The installation program must also be able to resolve the DNS records that the cluster requires. The installation program configures the Ingress Operator and API server for only internal traffic.
+[role="_abstract"]
+To create a private cluster on {gcp-first}, you must provide an existing VPC network and subnets to host the cluster, and you must specify `publish: Internal` in your `install-config.yaml` file. The installation program must also be able to resolve the DNS records that the cluster requires. The installation program configures the Ingress Operator and API server for only internal traffic.
 
 The cluster still requires access to internet to access the {gcp-short} APIs.