Bug 1830270
| Summary: | openshift-install lacks in binary install-config documentation | ||
|---|---|---|---|
| Product: | OpenShift Container Platform | Reporter: | Scott Dodson <sdodson> |
| Component: | Installer | Assignee: | Abhinav Dahiya <adahiya> |
| Installer sub component: | openshift-installer | QA Contact: | Yunfei Jiang <yunjiang> |
| Status: | CLOSED ERRATA | Docs Contact: | |
| Severity: | medium | ||
| Priority: | medium | CC: | yunjiang |
| Version: | 4.5 | ||
| Target Milestone: | --- | ||
| Target Release: | 4.5.0 | ||
| Hardware: | Unspecified | ||
| OS: | Unspecified | ||
| Whiteboard: | |||
| Fixed In Version: | Doc Type: | Release Note | |
| Doc Text: |
Adds a subcommand to the installer binary `explain installconfig` that allows the users to see the fields available for install-config.yaml
Users can use `explain installconfig[.subfield][.subfield]` to see documentation for subfields.
The usage is very similar to `oc explain`
|
Story Points: | --- |
| Clone Of: | Environment: | ||
| Last Closed: | 2020-07-13 17:34:13 UTC | Type: | Bug |
| Regression: | --- | Mount Type: | --- |
| Documentation: | --- | CRM: | |
| Verified Versions: | Category: | --- | |
| oVirt Team: | --- | RHEL 7.3 requirements from Atomic Host: | |
| Cloudforms Team: | --- | Target Upstream Version: | |
| Embargoed: | |||
|
Description
Scott Dodson
2020-05-01 12:14:49 UTC
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
JSONPath identifier:
installconfig.<fieldName>[.<fieldName>]
Usage:
openshift-install explain [flags]
Examples:
# Get the documentation of the resource and its fields
kubectl explain installconfig
# Get the documentation of a AWS platform
kubectl explain installconfig.platform.aws
Flags:
-h, --help help for explain
Global Flags:
--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
KIND: InstallConfig
VERSION: v1
RESOURCE: <object>
InstallConfig is the configuration for an OpenShift install.
FIELDS:
additionalTrustBundle <string>
AdditionalTrustBundle is a PEM-encoded X.509 certificate bundle that will be added to the nodes' trusted certificate store.
apiVersion <string>
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
<snip>
[m@localhost 45-azure-install]$ ./openshift-install explain installconfig.platform.azure
KIND: InstallConfig
VERSION: v1
RESOURCE: <object>
Azure is the configuration used when installing on Azure.
FIELDS:
baseDomainResourceGroupName <string>
BaseDomainResourceGroupName specifies the resource group where the Azure DNS zone for the base domain is found.
computeSubnet <string>
ComputeSubnet specifies an existing subnet for use by compute nodes
<snip>
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. https://access.redhat.com/errata/RHBA-2020:2409 |