Description of problem: OpenShift installer's -h manual page is not specific about what the create and destroy commands do. "destroy" and "create" say that they destroy part of the cluster but don't specify which part. Meanwhile, "create cluster" creates an entire cluster. Customers may not know how to proceed with install/destroy. Version-Release number of the following components: ./openshift-install v4.1.0-201904211700-dirty built from commit f3b726cc151f5a3d66bc7e23e81b3013f1347a7e release image quay.io/openshift-release-dev/ocp-release@sha256:345ec9351ecc1d78c16cf0853fe0ef2d9f48dd493da5fdffc18fa18f45707867 Steps to Reproduce: 1. run openshift-installer -h Expected results: As a newcomer, I would expect to understand that the create and destroy command would manage the entire cluster, or be specific about which parts of the cluster they interact with.
Like most openshift commands you can drill down on help info by adding the --help flag to specific commands which is mentioned in the output of the base command. $ openshift-install -h Creates OpenShift clusters Usage: openshift-install [command] Available Commands: completion Outputs shell completions for the openshift-install command create Create part of an OpenShift cluster ... Use "openshift-install [command] --help" for more information about a command. $ openshift-install create -h Create part of an OpenShift cluster Usage: openshift-install create [flags] openshift-install create [command] Available Commands: cluster Create an OpenShift cluster ignition-configs Generates the Ignition Config asset install-config Generates the Install Config asset manifests Generates the Kubernetes manifests ...
We did find the -h subcommand flag and it does clarify the situation but we're asking specifically about ./openshift-installer -h help file to be clarified. At first glance, it suggests only part of the cluster will be created or destroyed and this is wrong. This may seem nitpick-y but we can imagine a customer asking for clarification on this through a support case when it is simple fix: Change from: Create part of an OpenShift cluster To something like: Create an OpenShift cluster or configs