[DOCS] Move example playbook to separate file

Change-Id: I97a1e91103539d92420683beac3fd9cf416b6b9c
This commit is contained in:
Robb Romans 2016-08-12 13:14:34 -05:00
parent c68bce0943
commit 18352f793e
3 changed files with 56 additions and 39 deletions

View File

@ -1,40 +1,9 @@
OpenStack-Ansible Galera Client
###############################
:tags: openstack, galera, client, cloud, ansible
:category: \*nix
===============================
OpenStack-Ansible Galera client
===============================
This Ansible role installs the MariaDB operating system and Python packages
used to interact with and manage a Galera cluster.
Required Variables
------------------
To use this role, define the following variables:
.. code-block:: yaml
galera_root_password: secrete
Dependencies
------------
This role depends on the ``config_template`` Ansible module provided
by `OpenStack-Ansible Plugins`_
.. _OpenStack-Ansible Plugins: https://github.com/openstack/openstack-ansible-plugins
Example Playbook
----------------
.. code-block:: yaml
- name: Install Galera Client
hosts: all
user: root
roles:
- role: "openstack-ansible-galera_client"
galera_address: "10.0.0.1"
galera_root_password: secrete
galera_root_user: root
galera_client_drop_config_file: true
Documentation for the project can be found at:
http://docs.openstack.org/developer/openstack-ansible-galera_client
The project home is at:
http://launchpad.net/openstack-ansible

View File

@ -1 +1,40 @@
.. include:: ../../README.rst
===============================
OpenStack-Ansible Galera client
===============================
:tags: openstack, galera, client, cloud, ansible
:category: \*nix
This Ansible role installs the MariaDB operating system and Python
packages used to interact with and manage a Galera cluster.
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
Dependencies
~~~~~~~~~~~~
This role depends on the ``config_template`` Ansible module provided
by `OpenStack-Ansible Plugins`_.
.. _OpenStack-Ansible Plugins:
https://github.com/openstack/openstack-ansible-plugins
Example playbook
~~~~~~~~~~~~~~~~
.. literalinclude:: ../../examples/playbook.yml
:language: yaml

9
examples/playbook.yml Normal file
View File

@ -0,0 +1,9 @@
- name: Install Galera client
hosts: all
user: root
roles:
- role: "openstack-ansible-galera_client"
galera_address: "10.0.0.1"
galera_root_password: secrete
galera_root_user: root
galera_client_drop_config_file: true