Bug 1498418

Summary: [Doc-RHGSC QSG] Document Tendrl ansible installation instructions
Product: [Red Hat Storage] Red Hat Gluster Storage Reporter: Anjana Suparna Sriram <asriram>
Component: doc-RHGS_Web_AdministrationAssignee: Rakesh <rghatvis>
Status: CLOSED CURRENTRELEASE QA Contact: Daniel Horák <dahorak>
Severity: unspecified Docs Contact:
Priority: unspecified    
Version: rhgs-3.3CC: asriram, mbukatov, mkudlej, nthomas, rhs-bugs, sanandpa, sankarshan
Target Milestone: ---Keywords: ZStream
Target Release: RHGS 3.3.1   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: Doc Type: If docs needed, set a value
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2018-05-30 18:00:14 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:
Bug Depends On: 1520384, 1520389    
Bug Blocks: 1502832    

Comment 5 Daniel Horák 2017-11-30 15:46:48 UTC
Bobb, finally I had some time to check this BZ, sorry for the delay.

There seems to be some misunderstanding of some terms (at least in the 3.2. Web Administration Roles chapter).

The usage of "role/roles" seems to me to be used slightly incorrectly for both Ansible roles[1] and Ansible groups[2] there.

* Groups[1] (in Ansible) are some sort of classification of hosts in the inventory file. You will group hosts with the same/similar purpose together and then for example launch some task on particular group.

* Roles[2] are bunch of task combined together to perform some comprehensive functionality (this is quite simplified description, but hopefully it make sense).

And for example, in some playbook, you will say something like: on hosts from group A run tasks from Roles X and Y.

In tendrl-ansible, there are two roles[3]:

* tendrl-ansible.tendrl-server
* tendrl-ansible.tendrl-storage-node

The tendrl-ansible.tendrl-server role contains tasks required for installation and configuration of RHGS Web Administration server.

The tendrl-ansible.tendrl-storage-node contains tasks required for installation and configuration of RHGS Web Administration agents on Gluster Storage Nodes.

Now there might be some confusion, because the example playbook site.yml.sample[4] expects, that the inventory file will contain hosts divided into two groups: tendrl-server and gluster-servers.
The group tendrl-server is not the same as role tendrl-ansible.tendrl-server! Nonetheless the role tendrl-ansible.tendrl-servrer contains tasks meant for host from tendrl-server group.

It is expected, that group tendrl-server will contains only one host (the RHGS Web Administration Server), while the gluster-servers group will contain all Gluster Storage servers.

[1] http://docs.ansible.com/ansible/latest/playbooks_reuse_roles.html
[2] http://docs.ansible.com/ansible/latest/intro_inventory.html
[3] check /usr/share/ansible/roles on system with installed tendrl-ansible package
[4] /usr/share/doc/tendrl-ansible-1.5.4/site.yml.sample on system with installed tendrl-ansible package

Comment 6 Martin Bukatovic 2017-12-06 16:38:11 UTC
Note that there is a README file in tendrl-ansible rpm package:

/usr/share/doc/tendrl-ansible-1.5.4/README.md

Besides that, there are additional comments in the example playbook:

/usr/share/doc/tendrl-ansible-1.5.4/site.yml.sample

Comment 8 Rakesh 2017-12-10 21:51:47 UTC
Any changes required in the content can be added in this gdoc:
https://docs.google.com/document/d/1RgqdA-eRDJ32eCnJrbXm80RPuuEEKs_2sdo0eThOEFc/edit#heading=h.y7oc8td2stbv

Comment 12 Daniel Horák 2017-12-12 14:22:50 UTC
The installation steps are documented including the information from the main tendrl-ansible README[1] and references to other sources of information (other README files, Ansible documentation, etc.).

Also all the comments and issues raised in this bug are involved.

[1] /usr/share/doc/tendrl-ansible-1.5.4/README.md

>> VERIFIED