OSDOCS-14552 greatly reducing Azure sample install config files

[bscott-rh]

Version(s):
4.19

Issue:
https://issues.redhat.com/browse/OSDOCS-14552

Link to docs preview:
Customizations
Government region
Network customizations
Private cluster
Existing vnet
Restricted network

QE review:

• QE has approved this change.

Problem statement:
The sample install-config.yaml file (aws for example) is:

1. heavily conditionalized due to mod-docs attempt to use one module to cover many assemblies
2. impossible for writers to maintain due to the complicated conditional structures and annotations
3. inconsistent with regards to which parameters have dedicated callouts to explain them
4. perpetually out of date with engineering's recommendations due to the complexity and effort required to update it
5. different from platform to platform, leading to confusing and inconsistent customer experience

Proposal:
Remove the existing sample file and replace it with a boilerplate minimum viable install-config.yaml file. Use the same file for all assemblies in a platform (or with the minimum possible variation between them, for example an extra parameter for the disconnected installation method) and ideally the same basic file for all platforms where possible. Remove all of the existing annotations/callouts and replace them with a short set of annotations that describe the structure and syntax of the file, rather than each individual parameter. Clearly indicate that this file is a minimum viable sample, and that all customizations should be made based on the Installation Configuration Parameters table, where all parameters are listed and described in great detail.

[ocpdocs-previewbot]

🤖 Thu Oct 30 17:07:14 - Prow CI generated the docs preview:

https://92943--ocpdocs-pr.netlify.app/
https://92943--ocpdocs-pr.netlify.app/openshift-enterprise/latest/installing/installing_azure/ipi/installing-azure-customizations.html
https://92943--ocpdocs-pr.netlify.app/openshift-enterprise/latest/installing/installing_azure/ipi/installing-azure-government-region.html
https://92943--ocpdocs-pr.netlify.app/openshift-enterprise/latest/installing/installing_azure/ipi/installing-azure-private.html
https://92943--ocpdocs-pr.netlify.app/openshift-enterprise/latest/installing/installing_azure/ipi/installing-azure-vnet.html
https://92943--ocpdocs-pr.netlify.app/openshift-enterprise/latest/installing/installing_azure/ipi/installing-restricted-networks-azure-installer-provisioned.html

[patrickdillon]

Just one suggestion, otherwise this looks good to me.

[jianlinliu]

Compared with 4.18 official doc, there is a dedicated section - Define the network and subnets for the VNet to install the cluster under the platform.azure field to guide user to modify the install-config.yaml properly, but from the new version of preview doc, there are no such section, personally I think it is not very friendly to ready for users.

[bscott-rh]

Do you think that the sample install-config.yaml should contain the following parameters?

networkResourceGroupName: <vnet_resource_group> 
virtualNetwork: <vnet> 
controlPlaneSubnet: <control_plane_subnet> 
computeSubnet: <compute_subnet> 

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.

[jianlinliu]

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.

[jianlinliu]

Similar to https://github.com/openshift/openshift-docs/pull/92943/files#r2131397209, if we can have a dedicated section to guide users to set publish: Internal in install-config.yaml for a private cluster install. That would be helpful.

[jinyunma]

For installation in government region, platform.azure.cloudName must be customized and set to AzureUSGovernmentCloud, because default value is AzurePublicCloud if it is not configured in install-config.yaml file.

[bergerhoffer]

The branch/enterprise-4.20 label has been added to this PR.

This is because your PR targets the main branch and is labeled for enterprise-4.19. And any PR going into main must also target the latest version branch (enterprise-4.20).

If the update in your PR does NOT apply to version 4.20 onward, please re-target this PR to go directly into the appropriate version branch or branches (enterprise-4.x) instead of main.

[openshift-bot]

Issues go stale after 90d of inactivity.

Mark the issue as fresh by commenting /remove-lifecycle stale.
Stale issues rot after an additional 30d of inactivity and eventually close.
Exclude this issue from closing by commenting /lifecycle frozen.

If this issue is safe to close now please do so with /close.

/lifecycle stale

[openshift-bot]

Stale issues rot after 30d of inactivity.

Mark the issue as fresh by commenting /remove-lifecycle rotten.
Rotten issues close after an additional 30d of inactivity.
Exclude this issue from closing by commenting /lifecycle frozen.

If this issue is safe to close now please do so with /close.

/lifecycle rotten
/remove-lifecycle stale

[bergerhoffer]

The branch/enterprise-4.21 label has been added to this PR.

This is because your PR targets the main branch and is labeled for enterprise-4.20. And any PR going into main must also target the latest version branch (enterprise-4.21).

If the update in your PR does NOT apply to version 4.21 onward, please re-target this PR to go directly into the appropriate version branch or branches (enterprise-4.x) instead of main.

[openshift-ci]

@bscott-rh: all tests passed!

Full PR test history. Your PR dashboard.

Details

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here.