[overcloud_service_status] Remove README.md file

This patch removes the README.md file and adds the documentation
directly in the sphinx role documentation index. All variables have been
commented with a proper description to be included automatically in the
sphinx build.

Signed-off-by: Gael Chamoulaud (Strider) <gchamoul@redhat.com>
Change-Id: I516473463dc073caf4d4c740dc57f642e042f197

doc/source/roles/role-overcloud_service_status.rst

@@ -2,6 +2,47 @@
 overcloud_service_status
 ========================
 
+--------------
+About The Role
+--------------
+
+An Ansible role to verify the ``Overcloud`` services states after a deployment
+or an update. It checks the ``API /os-services`` and looks for deprecated
+services (``nova-consoleauth``) or any down services.
+
+Requirements
+============
+
+This role needs to be run on an ``Undercloud`` with a deployed ``Overcloud``.
+
+Dependencies
+============
+
+No dependencies.
+
+Example Playbook
+================
+
+.. code-block:: yaml
+
+   - hosts: undercloud
+     roles:
+       - { role: overcloud_service_status }
+
+License
+=======
+
+Apache
+
+Author Information
+==================
+
+**Red Hat TripleO DFG:Compute Squad:Deployment**
+
+----------------
+Full Description
+----------------
+
 .. ansibleautoplugin::
    :role: roles/overcloud_service_status
 

roles/overcloud_service_status/README.md

@@ -1,47 +0,0 @@
-Overcloud-service-status
-=========================
-
-An Ansible role to verify the Overcloud services states after a deployment or an update.
-It checks the API /os-services and looks for deprecated services (nova-consoleauth) or
-any down services.
-
-Requirements
-------------
-
-This role needs to be run on an Undercloud with a deployed Overcloud.
-
-Role Variables
---------------
-
-- overcloud_service_status_debug: Wether or not to log the token request
-- overcloud_deprecated_services: A list of services that shouldn't be registered any more
-- overcloud_service_api: overcloud API to validate against
-
-These variables are normally set as host variables for the undercloud when generating
-the inventory with tripleo-ansible-inventory:
-- overcloud_keystone_url
-- overcloud_admin_password
-
-
-Dependencies
-------------
-
-No dependencies.
-
-Example Playbook
-----------------
-
-
-    - hosts: undercloud
-      roles:
-         - { role: overcloud_service_status }
-
-License
--------
-
-Apache
-
-Author Information
-------------------
-
-Red Hat Nova Deployment Squad Team.

roles/overcloud_service_status/defaults/main.yml

@@ -18,10 +18,21 @@
 # All variables intended for modification should place placed in this file.
 
 # All variables within this role should have a prefix of "overcloud_service_status"
+
+# Debugging mode, whether or no to log the token request
 overcloud_service_status_debug: false
+
+# Overcloud API to validate against
 overcloud_service_api:
   - nova
   - cinderv3
+
+# A list of services that shouldn't be registered any more
 overcloud_deprecated_services:
   nova:
     - nova-consoleauth
+
+# These variables are normally set as host variables for the undercloud when generating
+# the inventory with tripleo-ansible-inventory:
+# - overcloud_keystone_url
+# - overcloud_admin_password