|
3 | 3 |
|
4 | 4 | :_mod-docs-content-type: PROCEDURE |
5 | 5 | [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-short} 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. |
13 | 9 |
|
| 10 | +.Shared VPC parameters in `install-config.yaml` |
14 | 11 | [source,yaml] |
15 | 12 | ---- |
16 | | -apiVersion: v1 |
17 | | -baseDomain: example.com |
18 | | -credentialsMode: Passthrough <1> |
19 | | -metadata: |
20 | | - name: cluster_name |
21 | 13 | platform: |
22 | 14 | 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> |
62 | 20 | ---- |
63 | | -<1> `credentialsMode` must be set to `Passthrough` or `Manual`. See the "Prerequisites" section for the required {gcp-short} 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-short} 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