Update docs, including description of current ansible role guidelines for tendrl components #23
Conversation
This commit provides explanation of structure we use for tendrl-* ansible roles which install/configure individual tendrl components.
This is being moved into usmqe documentation, see: usmqe/usmqe-tests#23
| @@ -24,23 +24,24 @@ qe machines. | |||
| Quick Example of QE Server deployment | |||
| ===================================== | |||
|
|
|||
| You need a CentOS 7 machine for the QE Server. We are going to quickly create | |||
| one via `virt-builder`_ tool. | |||
| You need a RHEL or CentOS 7 machine for the QE Server. For to purpose of this | |||
There was a problem hiding this comment.
I would specify the version also for RHEL (like RHEL 7 or CentOS 7 machine).
And For to purpose of... should probably be For the purpose of...
| You need a CentOS 7 machine for the QE Server. We are going to quickly create | ||
| one via `virt-builder`_ tool. | ||
| You need a RHEL or CentOS 7 machine for the QE Server. For to purpose of this | ||
| example, we are going to quickly create virtual machine one via `virt-builder`_ |
There was a problem hiding this comment.
The one should probably be before the virtual machine.
| value="{{ groups['usm_server'][0] }}" | ||
|
|
||
| As you can see, there are 2 additional yaml files, one for installation from | ||
| rpm packages and other for installation from source code. The default value of |
There was a problem hiding this comment.
Do we expect to have also deb packages for Debian/Ubuntu? I know it will require lot's of changes, but still if it is expected to support also Debian like distributions I would remove the rpm reference here (so it will stay as ...installation from packages...).
The same apply also for the next paragraph.
There was a problem hiding this comment.
That is a good point, but so far we don't deal with deb packages at all. Since this text describes the current state, I would leave it as it is.
We are going to do that in the future, but it would require changes in playbooks and I would wait with work required for this until we actually have deb packages.
|
When we are reviewing these files I would like to correct typo in docs/test_configuration.rst on line 118: "(eg. api tests doesn't care..." to "(e.g. api tests don't care...". Otherwise it looks good to me. |
This updates rst files in
docs/directory only.Changes include linking of related documents and description of ansible role guidelines for tendrl components.