Bug 1684258

Summary: toolbox should handle `--help` flag
Product: OpenShift Container Platform Reporter: Micah Abbott <miabbott>
Component: RHCOSAssignee: Steve Milner <smilner>
Status: CLOSED ERRATA QA Contact: Micah Abbott <miabbott>
Severity: unspecified Docs Contact:
Priority: unspecified    
Version: 4.1.0CC: bbreard, dustymabe, imcleod, jligon, nstielau
Target Milestone: ---   
Target Release: 4.2.0   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: Doc Type: Enhancement
Doc Text:
Feature: Addition of -h/--help flag Reason: Administrators commonly look at the output of -h/--help before executing a command. Result: -h/--help has been added to the toolbox command.
 Story Points: ---
Clone Of: Environment:
Last Closed: 2019-10-16 06:27:41 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:

Comment 8 Micah Abbott 2019-06-26 18:54:26 UTC 
Verified with 4.2.0-0.nightly-2019-06-26-081712

```
$ oc get clusterversion
NAME      VERSION                             AVAILABLE   PROGRESSING   SINCE   STATUS
version   4.2.0-0.nightly-2019-06-26-081712   True        False         3h36m   Cluster version is 4.2.0-0.nightly-2019-06-26-081712

$ oc debug node/ip-10-0-136-252.us-west-2.compute.internal
Starting pod/ip-10-0-136-252us-west-2computeinternal-debug ...
To use host binaries, run `chroot /host`
If you don't see a command prompt, try pressing enter.
sh-4.2# chroot /host
sh-4.4# rpm -q toolbox
toolbox-0.0.4-1.rhaos4.2.el8.x86_64
sh-4.4# toolbox --help
USAGE: toolbox [-h/--help] [command]
toolbox is a small script that launches a container to let you bring in your favorite debugging or admin tools.
The toolbox container is a pet container and will be restarted on following runs.
To remove the container and start fresh, do sudo podman rm toolbox-.

Options:
  -h/--help: Shows this help message

You may override the following variables by setting them in /root/.toolboxrc:
- REGISTRY: The registry to pull from. Default: registry.redhat.io
- IMAGE: The image and tag from the registry to pull. Default: rhel8/support-tools
- TOOLBOX_NAME: The name to use for the local container. Default: toolbox-

Example toolboxrc:
REGISTRY=my.special.registry.example.com
IMAGE=debug:latest
TOOLBOX_NAME=special-debug-container
```
Comment 10 errata-xmlrpc 2019-10-16 06:27:41 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-2019:2922