install-config.yaml is a self documented api object but there's no accessible way to review the documentation for the API without going to github, it'd be nice if the installer provided a way to explain the API object and it were kept in sync with the specific version of the Installer I have downloaded as things change over time.
Confirmed openshift-install explain is working for installconfig, although we might want to clean up the example documentation a little since it references kubectl rather than openshift-install:
[m@localhost 45-azure-install]$ ./openshift-install explain -h
This command describes the fields associated with each supported InstallConfig API. Fields are identified via a simple
openshift-install explain [flags]
# Get the documentation of the resource and its fields
kubectl explain installconfig
# Get the documentation of a AWS platform
kubectl explain installconfig.platform.aws
-h, --help help for explain
--dir string assets directory (default ".")
--log-level string log level (e.g. "debug | info | warn | error") (default "info")
[m@localhost 45-azure-install]$ ./openshift-install explain installconfig
InstallConfig is the configuration for an OpenShift install.
AdditionalTrustBundle is a PEM-encoded X.509 certificate bundle that will be added to the nodes' trusted certificate store.
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
[m@localhost 45-azure-install]$ ./openshift-install explain installconfig.platform.azure
Azure is the configuration used when installing on Azure.
BaseDomainResourceGroupName specifies the resource group where the Azure DNS zone for the base domain is found.
ComputeSubnet specifies an existing subnet for use by compute nodes
Verified with openshift-install-linux-4.5.0-0.nightly-2020-05-08-095803
Opened https://bugzilla.redhat.com/show_bug.cgi?id=1833425 for they help example referencing kubectl.
Since the problem described in this bug report should be
resolved in a recent advisory, it has been closed with a
resolution of ERRATA.
For information on the advisory, and where to find the updated
files, follow the link below.
If the solution does not work for you, open a new bug report.