Bug 1330458 - Examples missing from Domain management tool
Summary: Examples missing from Domain management tool
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Product: Red Hat Gluster Storage
Classification: Red Hat
Component: doc-Console_Administration_Guide
Version: rhgs-3.1
Hardware: Unspecified
OS: Unspecified
unspecified
unspecified
Target Milestone: ---
: RHGS 3.1.3
Assignee: Laura Bailey
QA Contact: Sachin
URL:
Whiteboard:
Depends On:
Blocks: 1311847
TreeView+ depends on / blocked
 
Reported: 2016-04-26 09:41 UTC by Sahina Bose
Modified: 2016-11-18 04:08 UTC (History)
13 users (show)

Fixed In Version:
Doc Type: Bug Fix
Doc Text:
Clone Of:
Environment:
Last Closed: 2016-06-29 14:23:22 UTC
Target Upstream Version:


Attachments (Terms of Use)

Description Sahina Bose 2016-04-26 09:41:10 UTC
Document URL: 
https://access.redhat.com/documentation/en-US/Red_Hat_Storage/3.1/html/Console_Administration_Guide/appe-Utilities.html#sect-Domain_Management_Tool]


Section Number and Name: 
A.1.2. Examples

Describe the issue: 
Section ends abrupty with "
 The following examples demonstrate the use of rhsc-manage-domains to perform basic manipulation of the Red Hat Gluster Storage Console domain configuration. "

Suggestions for improvement: 
Add examples similar to https://access.redhat.com/documentation/en-US/Red_Hat_Enterprise_Virtualization/3.4/html-single/Administration_Guide/index.html 19.2.3. Using the Domain Management Tool

Additional information:

Comment 3 Sahina Bose 2016-06-02 05:57:18 UTC
Please change all references to "Red Hat Enterprise Virtualization Manager" to "Red Hat Gluster Storage Console" like in 
"In this example, the rhsc-manage-domains command is used to add the IdM domain directory.demo.redhat.com to the Red Hat Enterprise Virtualization Manager configuration"

Otherwise the examples are relevant

Comment 4 Laura Bailey 2016-06-02 07:44:47 UTC
Thanks for the catch Sahina, I caught the command change but forgot about this. :) I've corrected all instances of RHEV-M in these sections to RHGS-C instead.

Since that was the only issue, setting this to ON_QA. See the link in comment 2 for review.

Comment 5 Sachin 2016-06-14 07:16:55 UTC
A.1.1. Syntax
-------------
Syntax needs to be changed.
engine-manage-domains <action> [options]





A.1.1. Syntax
-------------
All the options need t ostart with "--" insted of "-"

Ex:
--domain=DOMAIN
--user=USER






A.1.1. Syntax
-------------
Remove following option as it not available

-interactive
    Specifies that the domain user's password is to be provided interactively. This option or the - passwordFile option must be used to provide the password for use with the add action. 






A.1.1. Syntax
--------------
Change 

 -passwordFile=FILE
    Specifies that the domain user's password is on the first line of the provided file. This option or the -interactive option must be used to provide the password for use with the add action. 

 to

--password-file=PASS_FILE
	A  file containing the password (if it's not set, the password will be read interactively).





Example A.3. rhsc-manage-domains Edit Action
--------------------------------------------
Command needs to be changed to
rhsc-manage-domains edit --domain=directory.demo.redhat.com --user=admin

Comment 7 Sachin 2016-06-14 09:07:49 UTC
Thanks for the quick update. One last change is required.

A.1.1. Syntax
-------------
In option section change the following parameters

The -domain parameter  -->  The --domain parameter
The -user parameter  --> The --user parameter
-passwordFile=FILE  --> --password-file=FILE
--configFile=FILE --> --config-file=FILE
The -configFile parameter --> The --config-file parameter


Rest looks good to me.

-Sachin

Comment 9 Sachin 2016-06-15 05:44:03 UTC
PLease change -password-file=FILE to --password-file=FILE

Rest is fine.

Thanks
Sachin

Comment 11 Rahul Hinduja 2016-06-15 12:10:21 UTC
Link in the comment 10 correctly reflects --password-file=FILE. Moving this bug to verified state.


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