Bug 1853115 - the restriction of --cloud option should be shown in help text.
Summary: the restriction of --cloud option should be shown in help text.
Keywords:
Status: CLOSED ERRATA
Alias: None
Product: OpenShift Container Platform
Classification: Red Hat
Component: oc
Version: 4.6
Hardware: Unspecified
OS: Unspecified
low
low
Target Milestone: ---
: 4.7.0
Assignee: Maciej Szulik
QA Contact: RamaKasturi
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2020-07-02 02:47 UTC by Yunfei Jiang
Modified: 2021-02-24 15:13 UTC (History)
5 users (show)

Fixed In Version:
Doc Type: No Doc Update
Doc Text:
Clone Of:
Environment:
Last Closed: 2021-02-24 15:13:40 UTC
Target Upstream Version:
Embargoed:


Attachments (Terms of Use)


Links
System ID Private Priority Status Summary Last Updated
Github openshift oc pull 482 0 None closed Bug 1853116: write to files instead of stdout 2021-01-07 17:13:59 UTC
Red Hat Product Errata RHSA-2020:5633 0 None None None 2021-02-24 15:13:43 UTC

Description Yunfei Jiang 2020-07-02 02:47:22 UTC
Description of problem:

execute `oc adm release extract --help`
the help message shows:
```
... ...
Options:
      --cloud='': Specify the cloud for which credential request manifests should be extracted.
... ...
```
The help text should point out that this option is only supported with --credentials-requests flag.
This is very helpful for customer understanding how to use this option exactly.


Version-Release number of selected component (if applicable):
oc Client Version: 4.6.0-0.nightly-2020-06-30-020342

How reproducible:


Steps to Reproduce:
1. execute `oc adm release extract --help`
2.
3.

Actual results:
` --cloud='': Specify the cloud for which credential request manifests should be extracted.`

Expected results:
the text like `--cloud only work with --credentials-requests flag` should be in `--cloud` option help.

Comment 1 Maciej Szulik 2020-07-09 11:08:53 UTC
I’m adding UpcomingSprint, because I was occupied by fixing bugs with higher priority/severity, developing new features with higher priority, or developing new features to improve stability at a macro level. I will revisit this bug next sprint.

Comment 2 Maciej Szulik 2020-08-21 12:06:22 UTC
I’m adding UpcomingSprint, because I was occupied by fixing bugs with higher priority/severity, developing new features with higher priority, or developing new features to improve stability at a macro level. I will revisit this bug next sprint.

Comment 3 Maciej Szulik 2020-09-11 11:26:14 UTC
I’m adding UpcomingSprint, because I was occupied by fixing bugs with higher priority/severity, developing new features with higher priority, or developing new features to improve stability at a macro level. I will revisit this bug next sprint.

Comment 4 Maciej Szulik 2020-10-01 14:22:39 UTC
Moving to 4.7, the PR is in the queue.

Comment 5 Maciej Szulik 2020-10-23 10:39:01 UTC
I’m adding UpcomingSprint, because I was occupied by fixing bugs with higher priority/severity, developing new features with higher priority, or developing new features to improve stability at a macro level. I will revisit this bug next sprint.

Comment 6 Maciej Szulik 2020-10-29 09:26:34 UTC
The linked PR merged, moving to modified.

Comment 8 zhou ying 2020-11-03 07:46:02 UTC
Confirmed with latest oc client, the issue has fixed:

[root@dhcp-140-138 ~]# oc version 
Client Version: 4.7.0-0.nightly-2020-11-03-040426

[root@dhcp-140-138 ~]# oc adm release extract --help
Extract the contents of a release image to disk

 Extracts the contents of an OpenShift release image to disk for inspection or debugging. Update images contain
manifests and metadata about the operators that must be installed on the cluster for a given version.

 The --tools and --command flags allow you to extract the appropriate client binaries for your operating system to disk.
--tools will create archive files containing the current OS tools (or, if --command-os is set to ' *', all OS versions).
Specifying --command for either 'oc' or 'openshift-install' will extract the binaries directly. You may pass a PGP
private key file with --signing-key which will create an ASCII armored sha256sum.txt.asc file describing the content
that was extracted that is signed by the key. For more advanced signing use the generated sha256sum.txt and an external
tool like gpg.

 The --credentials-requests flag filters extracted manifests to only cloud credential requests. The --cloud flag further
filters credential requests to a specific cloud. Valid values for --cloud include aws, gcp, azure, openstack, ovirt, and
vsphere.

 Instead of extracting the manifests, you can specify --git=DIR to perform a Git checkout of the source code that
comprises the release. A warning will be printed if the component is not associated with source code. The command will
not perform any destructive actions on your behalf except for executing a 'git checkout' which may change the current
branch. Requires 'git' to be on your path.

Usage:
  oc adm release extract [flags]

Examples:
  # Use git to check out the source code for the current cluster release to DIR
  oc adm release extract --git=DIR
  
  # Extract cloud credential requests for AWS
  oc adm release extract --credentials-requests --cloud=aws

Options:
      --cloud='': Specify the cloud for which credential request manifests should be extracted. Works only in
combination with --credentials-requests.

......

Comment 11 errata-xmlrpc 2021-02-24 15:13:40 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 (Moderate: OpenShift Container Platform 4.7.0 security, bug fix, and enhancement update), 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/RHSA-2020:5633


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