Bug 1833425 - openshift-install explain installconfig subcommand examples references kubectl not openshift-install
Summary: openshift-install explain installconfig subcommand examples references kubect...
Keywords:
Status: CLOSED ERRATA
Alias: None
Product: OpenShift Container Platform
Classification: Red Hat
Component: Installer
Version: 4.5
Hardware: Unspecified
OS: Unspecified
unspecified
medium
Target Milestone: ---
: 4.5.0
Assignee: Abhinav Dahiya
QA Contact: Mike Gahagan
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2020-05-08 16:16 UTC by Mike Gahagan
Modified: 2020-07-13 17:36 UTC (History)
0 users

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2020-07-13 17:36:23 UTC
Target Upstream Version:
Embargoed:


Attachments (Terms of Use)


Links
System ID Private Priority Status Summary Last Updated
Github openshift installer pull 3570 0 None closed Bug 1833425: pkg/explain/cmd.go: fix help text 2020-06-24 02:10:56 UTC
Red Hat Product Errata RHBA-2020:2409 0 None None None 2020-07-13 17:36:34 UTC

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


Note You need to log in before you can comment on or make changes to this bug.