Bug 1225946

Summary: [CLI] minor cleanups in built-in documentation
Product: Red Hat Enterprise Linux 7 Reporter: Jan Pokorný [poki] <jpokorny>
Component: pcsAssignee: Ivan Devat <idevat>
Status: CLOSED ERRATA QA Contact: cluster-qe <cluster-qe>
Severity: unspecified Docs Contact:
Priority: medium    
Version: 7.2CC: cluster-maint, rsteiger, tojeline
Target Milestone: rc   
Target Release: ---   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: pcs-0.9.152-2.el7 Doc Type: Bug Fix
Doc Text:
This bz does not need doc text.
 Story Points: ---
Clone Of: Environment:
Last Closed: 2016-11-03 20:54:26 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:
Attachments:
Description Flags
proposed fix
none
proposed fix
none
proposed fix 3
none
proposed fix 4
none
proposed fix 5 none

Description Jan Pokorný [poki] 2015-05-28 14:03:39 UTC 
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)
Comment 1 Jan Pokorný [poki] 2015-05-28 14:07:41 UTC 
3/ colocation add
- with <target resource>. (score defaults to "INFINITY") A role can
+ with <target resource> (score defaults to "INFINITY"). A role can
Comment 2 Jan Pokorný [poki] 2015-06-10 17:59:37 UTC 
4/ verify [-V] [filename]
- If no filename is specified the check is performmed
+ If no filename is specified the check is performed
Comment 3 Jan Pokorný [poki] 2015-08-07 17:07:44 UTC 
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
Comment 5 Tomas Jelinek 2015-10-19 08:27:23 UTC 
Created attachment 1084297 [details]
proposed fix
Comment 6 Tomas Jelinek 2015-11-06 13:08:45 UTC 
6/ Change "pcs status pcsd <node> ..." to "pcs status pcsd [<node>]...", when no nodes are specified, status of all nodes is displayed.
Comment 7 Jan Pokorný [poki] 2015-12-10 14:22:54 UTC 
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>] ...]
Comment 8 Jan Pokorný [poki] 2015-12-11 23:08:37 UTC 
9/ using both "name" and "id" to effectively mean real ID (or a base
   of derived IDs)
Comment 9 Ivan Devat 2016-02-03 15:07:02 UTC 
Created attachment 1120806 [details]
proposed fix
Comment 10 Tomas Jelinek 2016-02-04 13:23:35 UTC 
Created attachment 1121100 [details]
proposed fix 3
Comment 11 Tomas Jelinek 2016-02-25 10:07:59 UTC 
https://github.com/feist/pcs/issues/82
Comment 12 Tomas Jelinek 2016-05-11 14:40:18 UTC 
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.
Comment 13 Jan Pokorný [poki] 2016-05-27 12:37:05 UTC 
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)
Comment 14 Ivan Devat 2016-05-31 13:02:03 UTC 
Fixed bugs up to comment 8.
Comment 16 Ivan Devat 2016-05-31 13:36:15 UTC 
There is still parts to fix.
Comment 17 Jan Pokorný [poki] 2016-06-10 12:02:50 UTC 
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?)
Comment 18 Ivan Devat 2016-06-16 14:36:07 UTC 
Problem described in Comment 17 is tracked in standalone bug 1347335 .
Comment 19 Tomas Jelinek 2016-06-17 09:45:36 UTC 
Created attachment 1169010 [details]
proposed fix 4
Comment 20 Tomas Jelinek 2016-06-17 09:45:55 UTC 
Created attachment 1169012 [details]
proposed fix 5
Comment 21 Ivan Devat 2016-06-22 12:29:45 UTC 
Documentation fixed.
Comment 26 errata-xmlrpc 2016-11-03 20:54:26 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-2016-2596.html