OSDOCS-12546 unconditionalize AWS sample install config doc

[bscott-rh]

Version(s):
4.18

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

Link to docs preview:
Customizations
Network customizations
Disconnected
Existing VPC
Private cluster
Government region
Secret region
China

QE review:

• QE has approved this change.

1. The current "sample install-config.yaml" files are too long and complicated
2. users find it hard to understand the file and sometimes think they need to copy/paste it and use all of the parameters specified in the sample file
3. writers find it hard to maintain because it has a large amount of conditional statements to account for the different installation methods
4. OCP docs will be transitioning to DITA/XML in the future, which currently does not support callouts/annotations in the way we use them now.

Therefore I'm beginning the process of reducing the sample file to a "minimum viable config" state for the purpose of showing users the basic syntax/layout of the file, and then referring them to the full parameters table for more information.

[ocpdocs-previewbot]

🤖 Thu May 15 17:38:11 - Prow CI generated the docs preview:

https://84385--ocpdocs-pr.netlify.app/
https://84385--ocpdocs-pr.netlify.app/openshift-enterprise/latest/installing/installing_aws/ipi/installing-aws-china.html
https://84385--ocpdocs-pr.netlify.app/openshift-enterprise/latest/installing/installing_aws/ipi/installing-aws-customizations.html
https://84385--ocpdocs-pr.netlify.app/openshift-enterprise/latest/installing/installing_aws/ipi/installing-aws-government-region.html
https://84385--ocpdocs-pr.netlify.app/openshift-enterprise/latest/installing/installing_aws/ipi/installing-aws-network-customizations.html
https://84385--ocpdocs-pr.netlify.app/openshift-enterprise/latest/installing/installing_aws/ipi/installing-aws-private.html
https://84385--ocpdocs-pr.netlify.app/openshift-enterprise/latest/installing/installing_aws/ipi/installing-aws-secret-region.html
https://84385--ocpdocs-pr.netlify.app/openshift-enterprise/latest/installing/installing_aws/ipi/installing-aws-vpc.html
https://84385--ocpdocs-pr.netlify.app/openshift-enterprise/latest/installing/installing_aws/ipi/installing-restricted-networks-aws-installer-provisioned.html

[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

[bergerhoffer]

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

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

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

[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

[openshift-bot]

Rotten issues close after 30d of inactivity.

Reopen the issue by commenting /reopen.
Mark the issue as fresh by commenting /remove-lifecycle rotten.
Exclude this issue from closing again by commenting /lifecycle frozen.

/close

[openshift-ci]

@openshift-bot: Closed this PR.

Details

In response to this:

Rotten issues close after 30d of inactivity.

Reopen the issue by commenting /reopen.
Mark the issue as fresh by commenting /remove-lifecycle rotten.
Exclude this issue from closing again by commenting /lifecycle frozen.

/close

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.

[bscott-rh]

@yunjiang29 @patrickdillon Hey Yunfei and Patrick, PTAL at this docs PR. Here is the context:

1. The current "sample install-config.yaml" files are too long and complicated
2. users find it hard to understand the file and sometimes think they need to copy/paste it and use all of the parameters specified in the sample file
3. writers find it hard to maintain because it has a large amount of conditional statements to account for the different installation methods
4. OCP docs will be transitioning to DITA/XML in the future, which currently does not support callouts/annotations in the way we use them now.

Therefore I'm beginning the process of reducing the sample file to a "minimum viable config" state for the purpose of showing users the basic syntax/layout of the file, and then referring them to the full parameters table for more information. If you have suggestions for ways to reduce the sample config file further, please let me know. Also if there are critical values that need to be present in this sample, add them as well. after AWS, I will perform the same task for the other platforms. Thank you very much!

[yunjiang29]

@brendan-daly-red-hat , the new sample install-config replaces this sample -> https://docs.redhat.com/en/documentation/openshift_container_platform/4.18/html/installing_on_aws/installer-provisioned-infrastructure#installation-aws-config-yaml_installing-aws-government-region

is that right?

[yunjiang29]

the change looks good to me.

[bscott-rh]

@brendan-daly-red-hat , the new sample install-config replaces this sample -> https://docs.redhat.com/en/documentation/openshift_container_platform/4.18/html/installing_on_aws/installer-provisioned-infrastructure#installation-aws-config-yaml_installing-aws-government-region

is that right?

Yes, this sample will replace the existing sample install config yaml in all of our AWS IPI assemblies.

[jeana-redhat]

Truly inspiring!

/remove-label peer-review-in-progress
/remove-label peer-review-needed
/label peer-review-done

[yunjiang29]

@brendan-daly-red-hat , the new sample install-config replaces this sample -> https://docs.redhat.com/en/documentation/openshift_container_platform/4.18/html/installing_on_aws/installer-provisioned-infrastructure#installation-aws-config-yaml_installing-aws-government-region
is that right?

Yes, this sample will replace the existing sample install config yaml in all of our AWS IPI assemblies.

@brendan-daly-red-hat the change looks good to me, thanks.

[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.

[bscott-rh]

/cherrypick enterprise-4.18

[openshift-cherrypick-robot]

@bscott-rh: new pull request created: #93460

Details

In response to this:

/cherrypick enterprise-4.18

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.

[bscott-rh]

/cherrypick enterprise-4.19

[openshift-cherrypick-robot]

@bscott-rh: new pull request created: #93461

Details

In response to this:

/cherrypick enterprise-4.19

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.