osdocs636 default GCP install

_topic_map.yml

@@ -109,10 +109,10 @@ Topics:
   Topics:
 #  - Name: Configuring an GCP account
 #    File: installing-gcp-account
-#  - Name: Installing a cluster quickly on GCP
-#    File: installing-gcp-default
-#  - Name: Installing a cluster on GCP with customizations
-#    File: installing-gcp-customizations
+  - Name: Installing a cluster quickly on GCP
+    File: installing-gcp-default
+  - Name: Installing a cluster on GCP with customizations
+    File: installing-gcp-customizations
   - Name: Uninstalling a cluster on GCP
     File: uninstalling-cluster-gcp
 #- Name: Installing in a disconnected environment

installing/installing_gcp/installing-gcp-customizations.adoc

@@ -1,7 +1,7 @@
 [id="installing-gcp-customizations"]
 = Installing a cluster on GCP with customizations
 include::modules/common-attributes.adoc[]
-:context: install-customizations-cloud
+:context: installing-gcp-customizations
 
 toc::[]
 
@@ -15,8 +15,8 @@ some parameters in the `install-config.yaml` file before you install the cluster
 * Review details about the
 xref:../../architecture/architecture-installation.adoc#architecture-installation[{product-title} installation and update]
 processes.
-* xref:../../installing/installing_gcp/installing-gcp-account.adoc#installing-gcp-account[Configure a GCP account]
-to host the cluster.
+//* xref:../../installing/installing_gcp/installing-gcp-account.adoc#installing-gcp-account[Configure a GCP account]
+//to host the cluster.
 * If you use a firewall, you must
 xref:../../installing/install_config/configuring-firewall.adoc#configuring-firewall[configure it to access Red Hat Insights].
 
@@ -30,13 +30,13 @@ include::modules/installation-initializing.adoc[leveloffset=+1]
 
 include::modules/installation-configuration-parameters.adoc[leveloffset=+2]
 
-//include::modules/installation-aws-config-yaml.adoc[leveloffset=+2]
+include::modules/installation-gcp-config-yaml.adoc[leveloffset=+2]
 
 include::modules/installation-launching-installer.adoc[leveloffset=+1]
 
 //include::modules/installing-aws-customizations.adoc[leveloffset=+1]
 
-//include::modules/cli-install.adoc[leveloffset=+1]
+include::modules/cli-install.adoc[leveloffset=+1]
 
 include::modules/cli-logging-in-kubeadmin.adoc[leveloffset=+1]
 

installing/installing_gcp/installing-gcp-default.adoc

@@ -13,8 +13,8 @@ Google Cloud Platform (GCP) that uses the default configuration options.
 * Review details about the
 xref:../../architecture/architecture-installation.adoc#architecture-installation[{product-title} installation and update]
 processes.
-* xref:../../installing/installing_gcp/installing-gcp-account.adoc#installing-gcp-account[Configure a GCP account]
-to host the cluster.
+//* xref:../../installing/installing_gcp/installing-gcp-account.adoc#installing-gcp-account[Configure a GCP account]
+//to host the cluster.
 * If you use a firewall, you must
 xref:../../installing/install_config/configuring-firewall.adoc#configuring-firewall[configure it to access Red Hat Insights].
 
@@ -26,7 +26,7 @@ include::modules/installation-obtaining-installer.adoc[leveloffset=+1]
 
 include::modules/installation-launching-installer.adoc[leveloffset=+1]
 
-//include::modules/cli-install.adoc[leveloffset=+1]
+include::modules/cli-install.adoc[leveloffset=+1]
 
 include::modules/cli-logging-in-kubeadmin.adoc[leveloffset=+1]
 

modules/cli-install.adoc

@@ -6,6 +6,8 @@
 // * installing/installing_aws_user_infra/installing-aws-user-infra.adoc
 // * installing/installing_azure/installing-azure-customizations.adoc
 // * installing/installing_bare_metal/installing-bare-metal.adoc
+// * installing/installing_gcp/installing-gcp-default.adoc
+// * installing/installing_gcp/installing-gcp-customizations.adoc
 // * installing/installing_vsphere/installing-vsphere.adoc
 
 [id="cli-install_{context}"]

modules/cli-logging-in-kubeadmin.adoc

@@ -6,6 +6,8 @@
 // * installing/installing_aws_user_infra/installing-aws-user-infra.adoc
 // * installing/installing_azure/installing-azure-customizations.adoc
 // * installing/installing_bare_metal/installing-bare-metal.adoc
+// * installing/installing_gcp/installing-gcp-default.adoc
+// * installing/installing_gcp/installing-gcp-customizations.adoc
 // * installing/installing_vsphere/installing-vsphere.adoc
 
 [id="cli-logging-in-kubeadmin_{context}"]

modules/cluster-entitlements.adoc

@@ -7,6 +7,8 @@
 // * installing/installing_aws_user_infra/installing-aws-user-infra.adoc
 // * installing/installing_azure/installing-azure-customizations.adoc
 // * installing/installing_bare_metal/installing-bare-metal.adoc
+// * installing/installing_gcp/installing-gcp-default.adoc
+// * installing/installing_gcp/installing-gcp-customizations.adoc
 // * installing/installing_vsphere/installing-vsphere.adoc
 
 [id="cluster-entitlements_{context}"]

modules/installation-aws-config-yaml.adoc

@@ -91,7 +91,7 @@ installation. Only one control plane pool is used.
 <4> Whether to enable or disable simultaneous multithreading, or
 `hyperthreading`. By default, simultaneous multithreading is enabled
 to increase the performance of your machines' cores. You can disable it by
-setting the parameter value to `Disabled`. If you disable simultanous
+setting the parameter value to `Disabled`. If you disable simultaneous
 multithreading in some cluster machines, you must disable it in all cluster
 machines.
 +

modules/installation-bare-metal-config-yaml.adoc

@@ -47,7 +47,7 @@ installation. Only one control plane pool is used.
 <3> Whether to enable or disable simultaneous multithreading, or
 `hyperthreading`. By default, simultaneous multithreading is enabled
 to increase the performance of your machines' cores. You can disable it by
-setting the parameter value to `Disabled`. If you disable simultanous
+setting the parameter value to `Disabled`. If you disable simultaneous
 multithreading in some cluster machines, you must disable it in all cluster
 machines.
 +

modules/installation-configuration-parameters.adoc

@@ -3,6 +3,7 @@
 // * installing/installing_aws/installing-aws-customizations.adoc
 // * installing/installing_aws/installing-aws-network-customizations.adoc
 // * installing/installing_azure/installing-azure-customizations.adoc
+// * installing/installing_gcp/installing-gcp-customizations.adoc
 
 ifeval::["{context}" == "install-customizations-cloud"]
 :aws:
@@ -13,6 +14,10 @@ endif::[]
 ifeval::["{context}" == "installing-azure-customizations"]
 :azure:
 endif::[]
+ifeval::["{context}" == "installing-gcp-customizations"]
+:gcp:
+endif::[]
+
 
 [id="installation-configuration-parameters_{context}"]
 = Installation configuration parameters
@@ -103,7 +108,7 @@ process uses to the installation program.
 |A valid, local public SSH key that you added to the `ssh-agent` process.
 
 |`compute.hyperthreading`
-|Whether to enable or disable simultaneous multithreading, or `hyperthreading`
+|Whether to enable or disable simultaneous multithreading, or `hyperthreading`,
 on compute machines. By default, simultaneous multithreading is enabled
 to increase the performance of your machines' cores.
 [IMPORTANT]
@@ -199,7 +204,6 @@ ifdef::azure[]
 [cols=".^2,.^3a,.^3a",options="header"]
 |====
 |Parameter|Description|Values
-
 |`machines.platform.azure.type`
 |The Azure VM instance type.
 |VMs that use Windows or Linux as the operating system. See the
@@ -230,3 +234,7 @@ link:https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-grou
 with an Azure cluster.
 ====
 endif::azure[]
+////
+ifdef::gcp[]
+.Additional Google Cloud Platform (GCP) parameters
+////

modules/installation-gcp-config-yaml.adoc

@@ -0,0 +1,104 @@
+// Module included in the following assemblies:
+//
+// * installing/installing_gcp/installing-gcp-customizations.adoc
+
+ifeval::["{context}" == "installing-gcp-network-customizations"]
+:with-networking:
+endif::[]
+
+[id="installation-gcp-config-yaml_{context}"]
+= Sample customized `install-config.yaml` file for GCP
+
+You can customize the `install-config.yaml` file to specify more details about
+your {product-title} cluster's platform or modify the values of the required
+parameters.
+
+[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 <1>
+controlPlane: <2>
+  hyperthreading: Enabled <3> <4>
+  name: master
+  platform:
+    gcp:
+      rootVolume:
+        iops: 4000
+        size: 500
+        type: io1
+      type: n1-standard-4
+  replicas: 3
+compute: <2>
+- hyperthreading: Enabled <3>
+  name: worker
+  platform:
+    gcp:
+      rootVolume:
+        iops: 2000
+        size: 500
+        type: io1 <5>
+      type: n1-standard-4
+  replicas: 3
+metadata:
+  name: test-cluster <1>
+ifdef::without-networking[]
+networking:
+endif::[]
+ifdef::with-networking[]
+networking: <2>
+endif::[]
+  clusterNetwork:
+  - cidr: 10.128.0.0/14
+    hostPrefix: 23
+  machineCIDR: 10.0.0.0/16
+  networkType: OpenShiftSDN
+  serviceNetwork:
+  - 172.30.0.0/16
+platform:
+  gcp:
+    ProjectID: openshift-production <1>
+    region: us-central-1 <1>
+pullSecret: '{"auths": ...}' <1>
+sshKey: ssh-ed25519 AAAA... <6>
+----
+<1> Required. The installation program prompts you for this value.
+<2> If you do not provide these parameters and values, the installation program
+provides the default value.
+<3> The `controlPlane` section is a single mapping, but the compute section is a
+sequence of mappings. To meet the requirements of the different data structures,
+the first line of the `compute` section must begin with a hyphen, `-`, and the
+first line of the `controlPlane` section must not. Although both sections
+currently define a single machine pool, it is possible that future versions
+of {product-title} will support defining multiple compute pools during
+installation. Only one control plane pool is used.
+<4> Whether to enable or disable simultaneous multithreading, or
+`hyperthreading`. By default, simultaneous multithreading is enabled
+to increase the performance of your machines' cores. You can disable it by
+setting the parameter value to `Disabled`. If you disable simultaneous
+multithreading in some cluster machines, you must disable it in all cluster
+machines.
++
+[IMPORTANT]
+====
+If you disable simultaneous multithreading, ensure that your capacity planning
+accounts for the dramatically decreased machine performance. Use larger
+instance types, such as `m4.2xlarge` or `m5.2xlarge`, for your machines if you
+disable simultaneous multithreading.
+====
+<5> To configure faster storage for etcd, especially for larger clusters, set the
+storage type as `io1` and set `iops` to `2000`.
+<6> You can optionally provide the `sshKey` value that you use to access the
+machines in your cluster.
++
+[NOTE]
+====
+For production {product-title} clusters on which you want to perform installation
+debugging or disaster recovery, you must provide an SSH key that your `ssh-agent`
+process uses to the installation program.
+====

modules/installation-initializing.adoc

@@ -3,6 +3,7 @@
 // * installing/installing_aws/installing-aws-customizations.adoc
 // * installing/installing_aws/installing-aws-network-customizations.adoc
 // * installing/installing_azure/installing-azure-customizations.adoc
+// * installing/installing_gcp/installing-gcp-customizations.adoc
 // Consider also adding the installation-configuration-parameters.adoc module.
 
 ifeval::["{context}" == "install-customizations-cloud"]
@@ -14,6 +15,10 @@ endif::[]
 ifeval::["{context}" == "installing-azure-customizations"]
 :azure:
 endif::[]
+ifeval::["{context}" == "installing-gcp-customizations"]
+:gcp:
+endif::[]
+
 
 [id="installation-initializing_{context}"]
 = Creating the installation configuration file
@@ -78,7 +83,23 @@ generated.
 ... Select the base domain to deploy the cluster to. The base domain corresponds
 to the Azure DNS Zone that you created for your cluster.
 endif::azure[]
+ifdef::gcp[]
+... Select *gcp* as the platform to target.
+... If you have not configured the service account key for your GCP account on
+your computer, you must obtain it from GCP and paste the contents of the file
+or enter the absolute path to the file.
+... Select the project ID to provision the cluster in. The default value is
+specified by the service account that you configured.
+... Select the region to deploy the cluster in.
+... Select the base domain to deploy the cluster to. The base domain corresponds
+to the public DNS zone that you created for your cluster.
+endif::gcp[]
 ... Enter a descriptive name for your cluster.
+ifdef::gcp[]
+If you provide a name that is longer
+than 6 characters, only the first 6 characters will be used in the infrastructure
+ID that is generated from the cluster name.
+endif::gcp[]
 ... Paste the pull secret that you obtained from the
 link:https://cloud.redhat.com/openshift/install[OpenShift Infrastructure Providers] page.
 

modules/installation-launching-installer.adoc

@@ -4,6 +4,8 @@
 // * installing/installing_aws/installing-aws-customizations.adoc
 // * installing/installing_aws/installing-aws-network-customizations.adoc
 // * installing/installing_azure/installing-azure-customizations.adoc
+// * installing/installing_gcp/installing-gcp-default.adoc
+// * installing/installing_gcp/installing-gcp-customizations.adoc
 // If you use this module in any other assembly, you must update the ifeval
 // statements.
 
@@ -23,6 +25,14 @@ ifeval::["{context}" == "installing-azure-default"]
 :no-config:
 :azure:
 endif::[]
+ifeval::["{context}" == "installing-gcp-customizations"]
+:custom-config:
+:gcp:
+endif::[]
+ifeval::["{context}" == "installing-gcp-default"]
+:no-config:
+:gcp:
+endif::[]
 ifeval::["{context}" == "installing-azure-customizations"]
 :custom-config:
 :azure:
@@ -46,6 +56,16 @@ cluster.
 
 .Procedure
 
+ifdef::gcp[]
+. Remove any existing GCP credentials that do not use the service account key
+for the GCP account that you configured for your cluster and that are stored in the
+following locations:
+** The `GOOGLE_CREDENTIALS`, `GOOGLE_CLOUD_KEYFILE_JSON`, or `GCLOUD_KEYFILE_JSON`
+environment variables
+** The `~/.gcp/osServiceAccount.json` file
+** The `gcloud cli` default credentials
+endif::gcp[]
+
 . Run the installation program:
 +
 ----
@@ -111,6 +131,23 @@ generated.
 to the Azure DNS Zone that you created for your cluster.
 endif::azure[]
 .. Enter a descriptive name for your cluster.
+ifdef::gcp[]
+.. Select *gcp* as the platform to target.
+.. If you have not configured the service account key for your GCP account on
+your computer, you must obtain it from GCP and paste the contents of the file
+or enter the absolute path to the file.
+.. Select the project ID to provision the cluster in. The default value is
+specified by the service account that you configured.
+.. Select the region to deploy the cluster in.
+.. Select the base domain to deploy the cluster to. The base domain corresponds
+to the public DNS zone that you created for your cluster.
+endif::gcp[]
+.. Enter a descriptive name for your cluster.
+ifdef::gcp[]
+If you provide a name that is longer
+than 6 characters, only the first 6 characters will be used in the infrastructure
+ID that is generated from the cluster name.
+endif::gcp[]
 .. Paste the pull secret that you obtained from the
 link:https://cloud.redhat.com/openshift/install[OpenShift Infrastructure Providers] page.
 --
@@ -132,6 +169,7 @@ display in your terminal.
 You must not delete the installation program or the files that the installation
 program creates. Both are required to delete the cluster.
 ====
+
 ifdef::aws[]
 . Optional: Remove or disable the `AdministratorAccess` policy from the IAM
 account that you used to install the cluster.

modules/installation-obtaining-installer.adoc

@@ -6,6 +6,8 @@
 // * installing/installing_aws_user_infra/installing-aws-user-infra.adoc
 // * installing/installing_azure/installing-azure-customizations.adoc
 // * installing/installing_bare_metal/installing-bare-metal.adoc
+// * installing/installing_gcp/installing-gcp-default.adoc
+// * installing/installing_gcp/installing-gcp-customizations.adoc
 // * installing/installing_vsphere/installing-vsphere.adoc
 
 [id="installation-obtaining-installer_{context}"]

modules/installation-vsphere-config-yaml.adoc

@@ -46,7 +46,7 @@ installation. Only one control plane pool is used.
 <3> Whether to enable or disable simultaneous multithreading, or
 `hyperthreading`. By default, simultaneous multithreading is enabled
 to increase the performance of your machines' cores. You can disable it by
-setting the parameter value to `Disabled`. If you disable simultanous
+setting the parameter value to `Disabled`. If you disable simultaneous
 multithreading in some cluster machines, you must disable it in all cluster
 machines.
 +