OSDOCS-14552 greatly reducing Azure sample install config files #92943
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -43,7 +43,13 @@ include::modules/installation-azure-arm-tested-machine-types.adoc[leveloffset=+2 | |
| include::modules/installation-azure-trusted-launch.adoc[leveloffset=+2] | ||
| include::modules/installation-azure-confidential-vms.adoc[leveloffset=+2] | ||
|
|
||
| include::modules/installation-azure-config-yaml-simple.adoc[leveloffset=+2] | ||
|
There was a problem hiding this comment. Similar to https://github.com/openshift/openshift-docs/pull/92943/files#r2131397209, if we can have a dedicated section to guide users to set |
||
|
|
||
| [role="_additional-resources"] | ||
| .Additional resources | ||
|
|
||
| * xref:../../../installing/installing_azure/installation-config-parameters-azure.adoc#installation-config-parameters-aws[Installation configuration parameters for Azure] | ||
|
|
||
|
|
||
| include::modules/installation-configure-proxy.adoc[leveloffset=+2] | ||
|
|
||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -37,7 +37,13 @@ include::modules/installation-azure-arm-tested-machine-types.adoc[leveloffset=+2 | |
| include::modules/installation-azure-trusted-launch.adoc[leveloffset=+2] | ||
| include::modules/installation-azure-confidential-vms.adoc[leveloffset=+2] | ||
|
|
||
| include::modules/installation-azure-config-yaml-simple.adoc[leveloffset=+2] | ||
|
There was a problem hiding this comment. Compared with 4.18 official doc, there is a dedicated section -
Contributor
Author
There was a problem hiding this comment. Do you think that the sample install-config.yaml should contain the following parameters? I can add them if you think they're important, but I will not be adding descriptions to the parameters. This file is changing away from being a full description of all the parameters, towards being a simple example of what the install-config.yaml syntax looks like. There was a problem hiding this comment. I do not think we need to include the parameters in the sample install-config.yaml. But it is important for Existing vnet , currently users can not find out how to customized install-config.yaml in the doc of installing clusters in an existing vnet. |
||
|
|
||
| [role="_additional-resources"] | ||
| .Additional resources | ||
|
|
||
| * xref:../../../installing/installing_azure/installation-config-parameters-azure.adoc#installation-config-parameters-aws[Installation configuration parameters for Azure] | ||
|
|
||
|
|
||
| include::modules/installation-configure-proxy.adoc[leveloffset=+2] | ||
|
|
||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,58 @@ | ||
| // Module included in the following assemblies: | ||
bscott-rh marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| // | ||
| // * installing/installing_azure/installing-azure-customizations.adoc | ||
| // * installing/installing_azure/installing-azure-government-region.adoc | ||
| // * installing/installing_azure/installing-azure-network-customizations.adoc | ||
| // * installing/installing_azure/installing-azure-private.adoc | ||
| // * installing/installing_azure/installing-azure-vnet.adoc | ||
| // * installing/installing-restricted-networks-azure-installer-provisioned.adoc | ||
|
|
||
| :_mod-docs-content-type: REFERENCE | ||
| [id="installation-azure-config-yaml-simple_{context}"] | ||
| = Sample customized install-config.yaml file for Azure | ||
|
|
||
| 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. | ||
| For a full list and description of all installation configuration parameters, see _Installation configuration parameters for Azure_. | ||
| ==== | ||
|
|
||
| .Sample `install-config.yaml` file for {azure-short} | ||
| [source,yaml] | ||
| ---- | ||
| apiVersion: v1 <1> | ||
| baseDomain: example.com | ||
| pullSecret: '{"auths": ...}' | ||
| sshKey: ssh-ed25519 AAAA... | ||
| metadata: | ||
| name: example-cluster | ||
| controlPlane: <2> | ||
| hyperthreading: Enabled | ||
| name: master | ||
| platform: | ||
| azure: | ||
| type: Standard_D8s_v3 | ||
| replicas: 3 | ||
| compute: <3> | ||
| - hyperthreading: Enabled | ||
| name: worker | ||
| platform: | ||
| azure: | ||
| type: Standard_D2s_v3 | ||
| replicas: 3 | ||
| networking: <4> | ||
| clusterNetwork: | ||
| - cidr: 10.128.0.0/14 | ||
| hostPrefix: 23 | ||
| platform: <5> | ||
| azure: | ||
bscott-rh marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| baseDomainResourceGroupName: example-basedomain-resource-group | ||
| region: centralus | ||
| ---- | ||
| <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. | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For installation in government region,
platform.azure.cloudNamemust be customized and set toAzureUSGovernmentCloud, because default value isAzurePublicCloudif it is not configured in install-config.yaml file.