Red Hat Bugzilla – Bug 1225946
[CLI] minor cleanups in built-in documentation
Last modified: 2016-11-03 16:54:26 EDT
Consider this as a tracker of low-prio findings in CLI: 1/ colocation add - Specifying ’INFINITY’ (or ’-INFINITY’) for the score force + Specifying ’INFINITY’ (or ’-INFINITY’) for the score forces 2/ cib-upgrade - Upgrade the cib to the latest version + Upgrade the cib to conform to the latest version of the document schema (or something to that effect, otherwise it is confusing -- as a new-comer, I would expect that it will actually synchronize the configs per the latest one discovered, which I'd like to use for resync prior to starting the cluster stack)
3/ colocation add - with <target resource>. (score defaults to "INFINITY") A role can + with <target resource> (score defaults to "INFINITY"). A role can
4/ verify [-V] [filename] - If no filename is specified the check is performmed + If no filename is specified the check is performed
5/ please clarify that "pcs stonith create <stonith id> <stonith device type> [stonith device options]" is also suitable for passing meta attributes and operations, at least by referring to "pcs resource create" syntax
Created attachment 1084297 [details] proposed fix
6/ Change "pcs status pcsd <node> ..." to "pcs status pcsd [<node>]...", when no nodes are specified, status of all nodes is displayed.
7/ mutual exclusivity of --force and --node for pcs property set: - set [--force] [--node <nodename>] <property>=[<value>] + set [--force | --node <nodename>] <property>=[<value>] 8/ excessive underdocumentation of where multiple arguments expected 8.1/ pcs property set - set [...] <property>=[<value>] + set [...] <property>=[<value>] [<property>=[<value>] ...]
9/ using both "name" and "id" to effectively mean real ID (or a base of derived IDs)
Created attachment 1120806 [details] proposed fix
Created attachment 1121100 [details] proposed fix 3
https://github.com/feist/pcs/issues/82
Some options of "pcs cluster setup" command are not supported on RHEL 6 (auto tie breaker, last man standing, wait for all, ipv6 etc). The best solution is probably just to mention that these are not supported on RHEL 6.
There's an inconsistency at using the trailing dots. For instance at "pcs constraint": > [list|show] --full > List all current location, order and colocation constraints, if --full > is specified also list the constraint ids. > > location <resource id> prefers <node[=score]>... > Create a location constraint on a resource to prefer the specified > node and score (default score: INFINITY)
Fixed bugs up to comment 8.
There is still parts to fix.
Another point (for which I can file a separate bug if you want to) is that I can imagine if I were a novice user, I'd be pretty baffled by the gory details in the documentation, such as: > cleanup [<resource id>] [--node <node>] > Cleans up the resource in the lrmd (useful to reset > the resource status and failcount). [...] (ehm, what's lrmd and why should I care if I just need to know the external impact, not the Pacemaker runtime internals?)
Problem described in Comment 17 is tracked in standalone bug 1347335 .
Created attachment 1169010 [details] proposed fix 4
Created attachment 1169012 [details] proposed fix 5
Documentation fixed.
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-2016-2596.html