OSDOCS-14757 greatly reducing GCP sample install config files #93709
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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: | ||
|
Contributor
There was a problem hiding this comment. Not sure how minimal you want to go but this
Contributor
Author
There was a problem hiding this comment. yeah, I am open to suggestions. At a minimum I'd like to put 1 parameter in each section. is there another you would recommend? |
||
| 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 | ||
|
There was a problem hiding this comment.
There was a problem hiding this comment. @bscott-rh Besides, I'm trying to understand the updates, for example, in the 4.18 doc chapter "Chapter 6. Installing a cluster on GCP in a disconnected environment", the section "6.5. Creating the installation configuration file" explains how to edit "install-config.yaml" to give the additional information that is required for an installation in a restricted network. But in your changes, it seems no such info, how do you expect the end-users know generally what's required?
Contributor
Author
There was a problem hiding this comment. Hi @jianli-wei , I am resuming work on this ticket finally :) I will add the region parameter. Regarding the updates, if the correct information is in the "Creating the installation configuration file" procedure, then it is okay for it to be removed from the sample install-config.yaml file, because the sample file is only meant to be a reference for the syntax of the file, not a complete config file. Does that make sense? |
||
| 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. | ||
Uh oh!
There was an error while loading. Please reload this page.