OSDOCS-14552 greatly reducing Azure sample install config files #92943
Conversation
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
openshift-ci
bot
added
the
size/M
| @@ -0,0 +1,55 @@ | |||
| // Module included in the following assemblies: | |||
There was a problem hiding this comment.
🤖 [error] OpenShiftAsciiDoc.ModuleContainsContentType: Module is missing the '_mod-docs-content-type' variable.
|
@bscott-rh: all tests passed! Full PR test history. Your PR dashboard. 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. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Version(s):
4.19
Issue:
https://issues.redhat.com/browse/OSDOCS-14552
Link to docs preview:
Customizations
QE review:
Problem statement:
The sample install-config.yaml file (aws for example) is:
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.