From edc59a421d1bc3d25237fbfd3eaa43994ca60c11 Mon Sep 17 00:00:00 2001 From: Ben Scott Date: Thu, 22 May 2025 14:38:17 -0400 Subject: [PATCH] OSDOCS-14757 simplified install config yaml file, replaced shared vpc config yaml --- .../installation-gcp-config-yaml.adoc | 0 .../installing-gcp-customizations.adoc | 3 +- ...installing-gcp-network-customizations.adoc | 3 +- .../installing-gcp-private.adoc | 3 +- .../installing-gcp-shared-vpc.adoc | 7 ++ .../installing_gcp/installing-gcp-vpc.adoc | 3 +- ...ed-networks-gcp-installer-provisioned.adoc | 7 +- .../installation-gcp-config-yaml-simple.adoc | 51 +++++++++++++ .../installation-gcp-shared-vpc-config.adoc | 73 ++++--------------- 9 files changed, 86 insertions(+), 64 deletions(-) rename {modules => _unused_topics}/installation-gcp-config-yaml.adoc (100%) create mode 100644 modules/installation-gcp-config-yaml-simple.adoc diff --git a/modules/installation-gcp-config-yaml.adoc b/_unused_topics/installation-gcp-config-yaml.adoc similarity index 100% rename from modules/installation-gcp-config-yaml.adoc rename to _unused_topics/installation-gcp-config-yaml.adoc diff --git a/installing/installing_gcp/installing-gcp-customizations.adoc b/installing/installing_gcp/installing-gcp-customizations.adoc index 9edd601f559a..25c65a899bdb 100644 --- a/installing/installing_gcp/installing-gcp-customizations.adoc +++ b/installing/installing_gcp/installing-gcp-customizations.adoc @@ -48,11 +48,12 @@ include::modules/installation-gcp-enabling-shielded-vms.adoc[leveloffset=+2] include::modules/installation-gcp-enabling-confidential-vms.adoc[leveloffset=+2] -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] diff --git a/installing/installing_gcp/installing-gcp-network-customizations.adoc b/installing/installing_gcp/installing-gcp-network-customizations.adoc index 6ba82d58901e..3beadc0a69bc 100644 --- a/installing/installing_gcp/installing-gcp-network-customizations.adoc +++ b/installing/installing_gcp/installing-gcp-network-customizations.adoc @@ -54,11 +54,12 @@ include::modules/installation-gcp-enabling-shielded-vms.adoc[leveloffset=+2] include::modules/installation-gcp-enabling-confidential-vms.adoc[leveloffset=+2] -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] diff --git a/installing/installing_gcp/installing-gcp-private.adoc b/installing/installing_gcp/installing-gcp-private.adoc index 591c96a45096..ab8186c342b5 100644 --- a/installing/installing_gcp/installing-gcp-private.adoc +++ b/installing/installing_gcp/installing-gcp-private.adoc @@ -51,11 +51,12 @@ include::modules/installation-gcp-enabling-shielded-vms.adoc[leveloffset=+2] include::modules/installation-gcp-enabling-confidential-vms.adoc[leveloffset=+2] -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] diff --git a/installing/installing_gcp/installing-gcp-shared-vpc.adoc b/installing/installing_gcp/installing-gcp-shared-vpc.adoc index 6c5cd68e7b82..6f19e9942d22 100644 --- a/installing/installing_gcp/installing-gcp-shared-vpc.adoc +++ b/installing/installing_gcp/installing-gcp-shared-vpc.adoc @@ -42,6 +42,13 @@ include::modules/installation-gcp-enabling-confidential-vms.adoc[leveloffset=+2] 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 the OpenShift CLI by downloading the binary: Moved up to precede `ccoctl` steps, which require the use of `oc` diff --git a/installing/installing_gcp/installing-gcp-vpc.adoc b/installing/installing_gcp/installing-gcp-vpc.adoc index f582ad3ae921..e35d96c606f6 100644 --- a/installing/installing_gcp/installing-gcp-vpc.adoc +++ b/installing/installing_gcp/installing-gcp-vpc.adoc @@ -47,11 +47,12 @@ include::modules/installation-gcp-enabling-shielded-vms.adoc[leveloffset=+2] include::modules/installation-gcp-enabling-confidential-vms.adoc[leveloffset=+2] -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] diff --git a/installing/installing_gcp/installing-restricted-networks-gcp-installer-provisioned.adoc b/installing/installing_gcp/installing-restricted-networks-gcp-installer-provisioned.adoc index 6db2f93cfa43..c2045c76cfcd 100644 --- a/installing/installing_gcp/installing-restricted-networks-gcp-installer-provisioned.adoc +++ b/installing/installing_gcp/installing-restricted-networks-gcp-installer-provisioned.adoc @@ -59,7 +59,12 @@ include::modules/installation-gcp-enabling-shielded-vms.adoc[leveloffset=+2] include::modules/installation-gcp-enabling-confidential-vms.adoc[leveloffset=+2] -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] diff --git a/modules/installation-gcp-config-yaml-simple.adoc b/modules/installation-gcp-config-yaml-simple.adoc new file mode 100644 index 000000000000..0e2b0272adc2 --- /dev/null +++ b/modules/installation-gcp-config-yaml-simple.adoc @@ -0,0 +1,51 @@ +// 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 + +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 <1> +baseDomain: example.com +pullSecret: '{"auths": ...}' +controlPlane: <2> + name: master + replicas: 3 + platform: + gcp: + type: n2-standard-4 +compute: <3> +- name: worker + replicas: 3 + platform: + gcp: + type: n2-standard-4 +metadata: + name: test-cluster +networking: <4> + clusterNetwork: + - cidr: 10.128.0.0/14 + hostPrefix: 23 +platform: <5> + gcp: + projectID: sample-project +---- +<1> Parameters at the first level of indentation apply to the cluster globally. +<2> The `controlPlane` stanza applies to control plane machines. +<3> The `compute` stanza applies to compute machines. +<4> The `networking` stanza applies to the cluster networking configuration. If you do not provide networking values, the installation program provides default values. +<5> The `platform` stanza applies to the infrastructure platform that hosts the cluster. \ No newline at end of file diff --git a/modules/installation-gcp-shared-vpc-config.adoc b/modules/installation-gcp-shared-vpc-config.adoc index a851db312f77..593c2d29c6d7 100644 --- a/modules/installation-gcp-shared-vpc-config.adoc +++ b/modules/installation-gcp-shared-vpc-config.adoc @@ -3,68 +3,23 @@ :_mod-docs-content-type: PROCEDURE [id="installation-gcp-shared-vpc-config_{context}"] -= Sample customized install-config.yaml file for shared VPC installation -There are several configuration parameters which are required to install {product-title} on GCP using a shared VPC. The following is a sample `install-config.yaml` file which demonstrates these fields. - -[IMPORTANT] -==== -This sample YAML file is provided for reference only. You must modify this file with the correct values for your environment and cluster. -==== += Enabling installation into a shared VPC +There are several configuration parameters which are required to install {product-title} on GCP using a shared VPC. +The following parameters must be added to the `install-config.yaml` file prior to installation. +.Shared VPC parameters in `install-config.yaml` [source,yaml] ---- -apiVersion: v1 -baseDomain: example.com -credentialsMode: Passthrough <1> -metadata: - name: cluster_name platform: gcp: - computeSubnet: shared-vpc-subnet-1 <2> - controlPlaneSubnet: shared-vpc-subnet-2 <3> - network: shared-vpc <4> - networkProjectID: host-project-name <5> - projectID: service-project-name <6> - region: us-east1 - defaultMachinePlatform: - tags: <7> - - global-tag1 -controlPlane: - name: master - platform: - gcp: - tags: <7> - - control-plane-tag1 - type: n2-standard-4 - zones: - - us-central1-a - - us-central1-c - replicas: 3 -compute: -- name: worker - platform: - gcp: - tags: <7> - - compute-tag1 - type: n2-standard-4 - zones: - - us-central1-a - - us-central1-c - replicas: 3 -networking: - clusterNetwork: - - cidr: 10.128.0.0/14 - hostPrefix: 23 - machineNetwork: - - cidr: 10.0.0.0/16 -pullSecret: '{"auths": ...}' -sshKey: ssh-ed25519 AAAA... <8> + computeSubnet: shared-vpc-subnet-1 <1> + controlPlaneSubnet: shared-vpc-subnet-2 <2> + network: shared-vpc <3> + networkProjectID: host-project-name <4> + projectID: service-project-name <5> ---- -<1> `credentialsMode` must be set to `Passthrough` or `Manual`. See the "Prerequisites" section for the required GCP permissions that your service account must have. -<2> The name of the subnet in the shared VPC for compute machines to use. -<3> The name of the subnet in the shared VPC for control plane machines to use. -<4> The name of the shared VPC. -<5> The name of the host project where the shared VPC exists. -<6> The name of the GCP project where you want to install the cluster. -<7> Optional. One or more network tags to apply to compute machines, control plane machines, or all machines. -<8> You can optionally provide the `sshKey` value that you use to access the machines in your cluster. \ No newline at end of file +<1> The name of the subnet in the shared VPC for compute machines to use. +<2> The name of the subnet in the shared VPC for control plane machines to use. +<3> The name of the shared VPC. +<4> The name of the host project where the shared VPC exists. +<5> The name of the GCP project where you want to install the cluster. \ No newline at end of file