Skip to content

Commit edc59a4

Browse files
committed
OSDOCS-14757 simplified install config yaml file, replaced shared vpc config yaml
1 parent 6e5997e commit edc59a4

9 files changed

+86
-64
lines changed

installing/installing_gcp/installing-gcp-customizations.adoc

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,11 +48,12 @@ include::modules/installation-gcp-enabling-shielded-vms.adoc[leveloffset=+2]
4848

4949
include::modules/installation-gcp-enabling-confidential-vms.adoc[leveloffset=+2]
5050

51-
include::modules/installation-gcp-config-yaml.adoc[leveloffset=+2]
51+
include::modules/installation-gcp-config-yaml-simple.adoc[leveloffset=+2]
5252

5353
[role="_additional-resources"]
5454
.Additional resources
5555

56+
* xref:../../installing/installing_gcp/installation-config-parameters-gcp.adoc#installation-config-parameters-gcp[Installation configuration parameters for GCP]
5657
* 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]
5758

5859
include::modules/installation-configure-proxy.adoc[leveloffset=+2]

installing/installing_gcp/installing-gcp-network-customizations.adoc

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,11 +54,12 @@ include::modules/installation-gcp-enabling-shielded-vms.adoc[leveloffset=+2]
5454

5555
include::modules/installation-gcp-enabling-confidential-vms.adoc[leveloffset=+2]
5656

57-
include::modules/installation-gcp-config-yaml.adoc[leveloffset=+2]
57+
include::modules/installation-gcp-config-yaml-simple.adoc[leveloffset=+2]
5858

5959
[role="_additional-resources"]
6060
.Additional resources
6161

62+
* xref:../../installing/installing_gcp/installation-config-parameters-gcp.adoc#installation-config-parameters-gcp[Installation configuration parameters for GCP]
6263
* 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]
6364

6465
include::modules/installation-configure-proxy.adoc[leveloffset=+2]

installing/installing_gcp/installing-gcp-private.adoc

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,11 +51,12 @@ include::modules/installation-gcp-enabling-shielded-vms.adoc[leveloffset=+2]
5151

5252
include::modules/installation-gcp-enabling-confidential-vms.adoc[leveloffset=+2]
5353

54-
include::modules/installation-gcp-config-yaml.adoc[leveloffset=+2]
54+
include::modules/installation-gcp-config-yaml-simple.adoc[leveloffset=+2]
5555

5656
[role="_additional-resources"]
5757
.Additional resources
5858

59+
* xref:../../installing/installing_gcp/installation-config-parameters-gcp.adoc#installation-config-parameters-gcp[Installation configuration parameters for GCP]
5960
* 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]
6061

6162
include::modules/nw-gcp-installing-global-access-configuration.adoc[leveloffset=+2]

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

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,13 @@ include::modules/installation-gcp-enabling-confidential-vms.adoc[leveloffset=+2]
4242

4343
include::modules/installation-gcp-shared-vpc-config.adoc[leveloffset=+2]
4444

45+
include::modules/installation-gcp-config-yaml-simple.adoc[leveloffset=+2]
46+
47+
[role="_additional-resources"]
48+
.Additional resources
49+
50+
* xref:../../installing/installing_gcp/installation-config-parameters-gcp.adoc#installation-config-parameters-gcp[Installation configuration parameters for GCP]
51+
4552
include::modules/installation-configure-proxy.adoc[leveloffset=+2]
4653

4754
//Installing the OpenShift CLI by downloading the binary: Moved up to precede `ccoctl` steps, which require the use of `oc`

installing/installing_gcp/installing-gcp-vpc.adoc

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,11 +47,12 @@ include::modules/installation-gcp-enabling-shielded-vms.adoc[leveloffset=+2]
4747

4848
include::modules/installation-gcp-enabling-confidential-vms.adoc[leveloffset=+2]
4949

50-
include::modules/installation-gcp-config-yaml.adoc[leveloffset=+2]
50+
include::modules/installation-gcp-config-yaml-simple.adoc[leveloffset=+2]
5151

5252
[role="_additional-resources"]
5353
.Additional resources
5454

55+
* xref:../../installing/installing_gcp/installation-config-parameters-gcp.adoc#installation-config-parameters-gcp[Installation configuration parameters for GCP]
5556
* 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]
5657

5758
include::modules/nw-gcp-installing-global-access-configuration.adoc[leveloffset=+2]

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

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,12 @@ include::modules/installation-gcp-enabling-shielded-vms.adoc[leveloffset=+2]
5959

6060
include::modules/installation-gcp-enabling-confidential-vms.adoc[leveloffset=+2]
6161

62-
include::modules/installation-gcp-config-yaml.adoc[leveloffset=+2]
62+
include::modules/installation-gcp-config-yaml-simple.adoc[leveloffset=+2]
63+
64+
[role="_additional-resources"]
65+
.Additional resources
66+
67+
* xref:../../installing/installing_gcp/installation-config-parameters-gcp.adoc#installation-config-parameters-gcp[Installation configuration parameters for GCP]
6368

6469
include::modules/nw-gcp-installing-global-access-configuration.adoc[leveloffset=+2]
6570

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * installing/installing_gcp/installing-gcp-customizations.adoc
4+
// * installing/installing_gcp/installing-gcp-network-customizations.adoc
5+
// * installing/installing_gcp/installing-gcp-vpc.adoc
6+
// * installing/installing_gcp/installing-gcp-private.adoc
7+
// * installing/installing_gcp/installing-restricted-networks-gcp-installer-provisioned.adoc
8+
9+
:_mod-docs-content-type: REFERENCE
10+
[id="installation-gcp-config-yaml_{context}"]
11+
= Sample customized install-config.yaml file for GCP
12+
13+
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.
14+
15+
[IMPORTANT]
16+
====
17+
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.
18+
====
19+
20+
[source,yaml]
21+
----
22+
apiVersion: v1 <1>
23+
baseDomain: example.com
24+
pullSecret: '{"auths": ...}'
25+
controlPlane: <2>
26+
name: master
27+
replicas: 3
28+
platform:
29+
gcp:
30+
type: n2-standard-4
31+
compute: <3>
32+
- name: worker
33+
replicas: 3
34+
platform:
35+
gcp:
36+
type: n2-standard-4
37+
metadata:
38+
name: test-cluster
39+
networking: <4>
40+
clusterNetwork:
41+
- cidr: 10.128.0.0/14
42+
hostPrefix: 23
43+
platform: <5>
44+
gcp:
45+
projectID: sample-project
46+
----
47+
<1> Parameters at the first level of indentation apply to the cluster globally.
48+
<2> The `controlPlane` stanza applies to control plane machines.
49+
<3> The `compute` stanza applies to compute machines.
50+
<4> The `networking` stanza applies to the cluster networking configuration. If you do not provide networking values, the installation program provides default values.
51+
<5> The `platform` stanza applies to the infrastructure platform that hosts the cluster.

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

Lines changed: 14 additions & 59 deletions
Original file line numberDiff line numberDiff line change
@@ -3,68 +3,23 @@
33

44
:_mod-docs-content-type: PROCEDURE
55
[id="installation-gcp-shared-vpc-config_{context}"]
6-
= Sample customized install-config.yaml file for shared VPC installation
7-
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.
8-
9-
[IMPORTANT]
10-
====
11-
This sample YAML file is provided for reference only. You must modify this file with the correct values for your environment and cluster.
12-
====
6+
= Enabling installation into a shared VPC
7+
There are several configuration parameters which are required to install {product-title} on GCP using a shared VPC.
8+
The following parameters must be added to the `install-config.yaml` file prior to installation.
139

10+
.Shared VPC parameters in `install-config.yaml`
1411
[source,yaml]
1512
----
16-
apiVersion: v1
17-
baseDomain: example.com
18-
credentialsMode: Passthrough <1>
19-
metadata:
20-
name: cluster_name
2113
platform:
2214
gcp:
23-
computeSubnet: shared-vpc-subnet-1 <2>
24-
controlPlaneSubnet: shared-vpc-subnet-2 <3>
25-
network: shared-vpc <4>
26-
networkProjectID: host-project-name <5>
27-
projectID: service-project-name <6>
28-
region: us-east1
29-
defaultMachinePlatform:
30-
tags: <7>
31-
- global-tag1
32-
controlPlane:
33-
name: master
34-
platform:
35-
gcp:
36-
tags: <7>
37-
- control-plane-tag1
38-
type: n2-standard-4
39-
zones:
40-
- us-central1-a
41-
- us-central1-c
42-
replicas: 3
43-
compute:
44-
- name: worker
45-
platform:
46-
gcp:
47-
tags: <7>
48-
- compute-tag1
49-
type: n2-standard-4
50-
zones:
51-
- us-central1-a
52-
- us-central1-c
53-
replicas: 3
54-
networking:
55-
clusterNetwork:
56-
- cidr: 10.128.0.0/14
57-
hostPrefix: 23
58-
machineNetwork:
59-
- cidr: 10.0.0.0/16
60-
pullSecret: '{"auths": ...}'
61-
sshKey: ssh-ed25519 AAAA... <8>
15+
computeSubnet: shared-vpc-subnet-1 <1>
16+
controlPlaneSubnet: shared-vpc-subnet-2 <2>
17+
network: shared-vpc <3>
18+
networkProjectID: host-project-name <4>
19+
projectID: service-project-name <5>
6220
----
63-
<1> `credentialsMode` must be set to `Passthrough` or `Manual`. See the "Prerequisites" section for the required GCP permissions that your service account must have.
64-
<2> The name of the subnet in the shared VPC for compute machines to use.
65-
<3> The name of the subnet in the shared VPC for control plane machines to use.
66-
<4> The name of the shared VPC.
67-
<5> The name of the host project where the shared VPC exists.
68-
<6> The name of the GCP project where you want to install the cluster.
69-
<7> Optional. One or more network tags to apply to compute machines, control plane machines, or all machines.
70-
<8> You can optionally provide the `sshKey` value that you use to access the machines in your cluster.
21+
<1> The name of the subnet in the shared VPC for compute machines to use.
22+
<2> The name of the subnet in the shared VPC for control plane machines to use.
23+
<3> The name of the shared VPC.
24+
<4> The name of the host project where the shared VPC exists.
25+
<5> The name of the GCP project where you want to install the cluster.

0 commit comments

Comments
 (0)