Bug 1140766

Summary: oo-admin-ctl-district doesn't suggest FQDN for -i in -h output
Product: OpenShift Container Platform Reporter: Erik M Jacobs <ejacobs>
Component: ocAssignee: Miciah Dashiel Butler Masters <mmasters>
Status: CLOSED ERRATA QA Contact: libra bugs <libra-bugs>
Severity: low Docs Contact:
Priority: low    
Version: 2.2.0CC: adellape, jokerman, libra-onpremise-devel, lmeyer, mmccomas, tiwillia, xtian, yanpzhan
Target Milestone: ---Keywords: EasyFix
Target Release: ---   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: openshift-origin-broker-util-1.37.4.1-1.el6op Doc Type: Bug Fix
Doc Text:
The usage information for the `-i` flag to the `oo-admin-ctl-district` command did not explain the phrase "node identity". This bug fix updates the usage information to tell the reader that a node's server identity is its host name. In addition, the usage information was changed to mention that a comma-separated list or a regex enclosed in slashes may be specified with the `-i` flag.
Story Points: ---
Clone Of: Environment:
Last Closed: 2015-12-17 17:09:36 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 Erik M Jacobs 2014-09-11 16:07:47 UTC
Description of problem:
When running oo-admin-ctl-district -h, the info for -i doesn't suggest what to use (eg: FQDN)

Version-Release number of selected component (if applicable):
openshift-origin-broker-util-1.23.8.11-1.el6op.noarch

Steps to Reproduce:
[root@broker openshift]# oo-admin-ctl-district -h
== Synopsis

oo-admin-ctl-district: Control districts

== Usage

oo-admin-ctl-district OPTIONS

Options:
-c|--command <command>
    (list-available|create|add-node|set-region|unset-region|deactivate-node|activate-node|remove-node|add-capacity|remove-capacity|destroy|publish-uids)
-u|--uuid <district uuid>
    District uuid  (alphanumeric)
-n|--name <district name>
    District name (Used on create or in place of uuid on other commands)
    Allowed chars: alphanumeric, underscore, hyphen, dot
-p|--node_profile <gear_size>
    Only required for create
-i|--server_identity
    Node server identity (required) (may be a comma-separated list)
-a|--available
    On add-node, add all available nodes with the right profile
-r|--region <region_name>
    Region name of the server identitiy.
    Only valid for add-node (optional) and set-region
-z|--zone <zone_name>
    Zone within the region. Only valid when region is specified
-s|--size
    Amount of capacity to add or remove (positive number) (required)
-o|--platform
    Specify the platform of the district, default value is Linux
-b|--bypass
    Ignore warnings
-h|--help
    Show usage info

Expected results:
-i|--server_identity
    Node server identity (FQDN, required) (may be a comma-separated list)

Or just use what's in the man page:
Node server_identity (FQDN, required when operating on a node).

Comment 2 Luke Meyer 2014-09-18 15:01:12 UTC
server_identity doesn't have to be a FQDN, but we would do well to explain what they are since the admin may not be intimately familiar with mcollective.

Comment 3 Miciah Dashiel Butler Masters 2015-10-11 05:30:23 UTC
The server identity is whatever Socket.gethostname returns, which should be the same as the output of the `hostname` command, and it may not be fully qualified.  I figure we do not need to go into that much detail in the usage text though.

It is also interesting to note that MCollective gives us regex matching, so one can do things like `-i /^node-[ab]-/` or whatever. 

PR: https://github.com/openshift/origin-server/pull/6265

Comment 4 openshift-github-bot 2015-10-11 06:15:41 UTC
Commit pushed to master at https://github.com/openshift/origin-server

https://github.com/openshift/origin-server/commit/94c92486d4993a9fed72e3e62fd79ef031e14c69
oo-admin-ctl-district-elaborate-on-node-identity

Fix usage information to tell the reader that a node's server identity is
its hostname.  Also, mention that regex matching is supported, and fix
a typo in the -r/--region flag description.

This commit fixes bug 1140766.

Comment 9 Yanping Zhang 2015-11-12 10:38:32 UTC
Verified on latest puddle: OpenShiftEnterpriseErrata/2.2/2015-11-11.1
openshift-origin-broker-util-1.37.4.1-1.el6op.noarch

Steps to verify:
1.Check the help info of oo-admin-ctl-district:
There is new explaination for option -i now:
# oo-admin-ctl-district -h

-i|--server_identity
    Node server identity (i.e., its hostname; also may be
    a comma-separated list or a regex enclosed in slashes) (required)

The bug is fixed, so move it to Verified.

Comment 11 errata-xmlrpc 2015-12-17 17:09:36 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://rhn.redhat.com/errata/RHSA-2015-2666.html