Bug 1549446 - replace '--clone' and '--master' with 'clone' and 'master' in 'pcs resource create' commands
Summary: replace '--clone' and '--master' with 'clone' and 'master' in 'pcs resource c...
Status: CLOSED CURRENTRELEASE
Alias: None
Product: Red Hat Enterprise Linux 7
Classification: Red Hat
Component: doc-High_Availability_Add-On_Reference
Version: 7.4
Hardware: Unspecified
OS: Unspecified
medium
medium
Target Milestone: rc
: ---
Assignee: Steven J. Levine
QA Contact: cluster-qe@redhat.com
URL:
Whiteboard:
Keywords: Documentation
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2018-02-27 06:04 UTC by Ondrej Faměra
Modified: 2019-03-06 01:59 UTC (History)
4 users (show)

(edit)
Clone Of:
(edit)
Last Closed: 2018-03-12 16:59:59 UTC


Attachments (Terms of Use)


External Trackers
Tracker ID Priority Status Summary Last Updated
Red Hat Knowledge Base (Solution) 3364631 None None None 2018-02-27 06:06 UTC

Description Ondrej Faměra 2018-02-27 06:04:54 UTC
=== Document URL:
High Availability Add-On Reference
https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/7/html-single/high_availability_add-on_reference/index#s1-resourcecreate-HAAR

=== Section Number and Name:
6.1. Resource Creation
9.2. MultiState Resources: Resources That Have Multiple Modes
8.3. Moving Resources Due to Connectivity Changes

=== Describe the issue:
`pcs resource create` command from RHEL 7.4 (pcs-0.9.158) uses new syntax for `--master` and `--clone` resources. from `pcs-0.9.158` these option are `clone` and `master` without double-dash ('--') and the `master` option has a slightly different syntax than before.

=== Suggestions for improvement:
Update the above mentioned sections to reflect the current state == use `clone` instead of `--clone` and `master` instead of `--master`.
In section 9.2 also make sure that option `meta` is removed after `master`.

-   --master [meta master_options]
+   master [master_options]

=== Additional information:
I have recently created article https://access.redhat.com/solutions/3364631 to document and explain change that occurs when `--master` changed to `master`. It might be worth checking if it makes sense to mention this in the documentation somewhere, for example in 'New and changed Features in ...' section for 7.4 where the 0.9.158 introducing the `master` option was added.

Comment 8 Steven J. Levine 2018-03-12 13:32:37 UTC
The updated manual is now on the Portal:

https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/7/html-single/high_availability_add-on_reference/#s1-multistateresource-HAAR

I will wait until we get this info into the 7.4 release notes before closing this BZ.

Comment 10 Steven J. Levine 2018-03-12 14:38:41 UTC
Adding Tomas Jelinek to the CC list to this BZ in case he can add any clarification to the issue of which release implemented this update.

Comment 12 Steven J. Levine 2018-03-12 16:58:51 UTC
Ondrej:

Since the updated manual is now on the Portal, I am closing this BZ.

However, I have written up a description for the 7.4 release notes (to be updated) on BZ#1549446 and put it in needinfo from Ivan. Could you look that over as well (and comment on that BZ)?

Thanks,

Steven

Comment 13 Steven J. Levine 2018-03-12 16:59:40 UTC
Oops -- the updated description is in this BZ:

https://bugzilla.redhat.com/show_bug.cgi?id=1378107


Note You need to log in before you can comment on or make changes to this bug.