Bug 1833425

Summary: openshift-install explain installconfig subcommand examples references kubectl not openshift-install
Product: OpenShift Container Platform Reporter: Mike Gahagan <mgahagan>
Component: InstallerAssignee: Abhinav Dahiya <adahiya>
Installer sub component: openshift-installer QA Contact: Mike Gahagan <mgahagan>
Status: CLOSED ERRATA Docs Contact:
Severity: medium    
Priority: unspecified    
Version: 4.5   
Target Milestone: ---   
Target Release: 4.5.0   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: Doc Type: If docs needed, set a value
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2020-07-13 17:36:23 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 Mike Gahagan 2020-05-08 16:16:45 UTC
Description of problem:

The newly added 'openshift-install explain installconfig' subcommand references the kubectl command 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")


The examples: section should use openshift-install not kubectl.

Version-Release number of the following components:
openshift-install-linux-4.5.0-0.nightly-2020-05-08-095803

How reproducible:
always

Steps to Reproduce:
1.run ./openshift-install explain -h
2.
3.


Expected results:

Examples provided should reference openshift-install not kubectl.

Additional info:
Please attach logs from ansible-playbook with the -vvv flag

Comment 3 Mike Gahagan 2020-05-11 19:56:14 UTC
[m@localhost 45-azure-install]$ ./openshift-install explain installconfig -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
openshift-install explain installconfig

# Get the documentation of a AWS platform
openshift-install 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")

confirmed kubectl references are removed in openshift-install-linux-4.5.0-0.nightly-2020-05-11-193026

Comment 4 errata-xmlrpc 2020-07-13 17:36:23 UTC
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