From 63e1d9f7f904f58e445a7c406fae3da47c7ce322 Mon Sep 17 00:00:00 2001 From: Travis Truman Date: Tue, 7 Jun 2016 10:08:46 -0400 Subject: [PATCH] DOC - Adopting the common role documentation pattern As discussed during the Newton design summit, we agreed to adopt the role documentation pattern laid out in the os_keystone role Change-Id: I6a01800a1734872495a60a19de64d3c835574db6 --- README.rst | 27 ++++++++++++++++++++++----- 1 file changed, 22 insertions(+), 5 deletions(-) diff --git a/README.rst b/README.rst index 0b9fe9b0..b12945ba 100644 --- a/README.rst +++ b/README.rst @@ -1,18 +1,35 @@ OpenStack-Ansible Galera Server ############################### -:tags: openstack, galera, server, cloud, ansible -:category: \*nix Ansible role to install and configure a Galera cluster powered by MariaDB +Default Variables +================= + +.. literalinclude:: ../../defaults/main.yml + :language: yaml + :start-after: under the License. + +Required Variables +================== + +To use this role, define the following variables: + +.. code-block:: yaml + + galera_root_password: secrete + + +Example Playbook +================ + .. code-block:: yaml - name: Install galera server hosts: galera_all user: root roles: - - { role: "galera_server", tags: [ "galera-server" ] } + - { role: "galera_server" } vars: - container_address: "{{ ansible_ssh_host }}" galera_root_password: secrete - galera_root_user: root +