[DOCS] Move example playbook to separate file

Change-Id: I5cd81128951ee5694a3c438c70e60253c4cb0795
This commit is contained in:
Robb Romans 2016-08-11 15:59:27 -05:00
parent e14f1f3920
commit 364048fec0
3 changed files with 52 additions and 47 deletions

View File

@ -1,50 +1,9 @@
=============================
OpenStack-Ansible openrc file OpenStack-Ansible openrc file
############################# =============================
:tags: openstack, openrc, cloud, ansible :tags: openstack, openrc, cloud, ansible
:category: \*nix :category: \*nix
This Ansible role creates the configuration files used by various OpenStack This Ansible role creates the configuration files used by various
CLI tools. For more information about these tools, see the `OpenStack CLI OpenStack CLI tools.
Reference`_.
.. _OpenStack CLI Reference: http://docs.openstack.org/cli-reference/overview.html
Required Variables
==================
To use this role, define the following variables:
.. code-block:: yaml
keystone_service_adminuri_insecure: false
keystone_service_internaluri_insecure: false
openrc_os_password: secrete
openrc_os_domain_name: Default
Example Playbook
================
.. code-block:: yaml
- name: Install openrc
hosts: all
user: root
roles:
- { role: "openstack-ansible-openstack_openrc",
tags: [ "openstack_openrc" ]
}
vars:
keystone_service_adminuri_insecure: false
keystone_service_internaluri_insecure: false
openrc_os_password: secrete
openrc_os_domain_name: Default
Tags
====
This role supports two tags: ``openrc-install`` and ``openrc-config``
The ``openrc-install`` tag can be used to install and upgrade.
The ``openrc-config`` tag can be used to manage configuration.

View File

@ -1 +1,35 @@
.. include:: ../../README.rst =============================
OpenStack-Ansible openrc file
=============================
This Ansible role creates the configuration files used by various
OpenStack CLI tools. For more information about these tools, see the
`OpenStack CLI Reference`_.
.. _OpenStack CLI Reference: http://docs.openstack.org/cli-reference/overview.html
Required variables
~~~~~~~~~~~~~~~~~~
To use this role, define the following variables:
.. code-block:: yaml
keystone_service_adminuri_insecure: false
keystone_service_internaluri_insecure: false
openrc_os_password: secrete
openrc_os_domain_name: Default
Tags
~~~~
This role supports two tags: ``openrc-install`` and ``openrc-config``.
The ``openrc-install`` tag can be used to install and upgrade. The
``openrc-config`` tag can be used to manage configuration.
Example playbook
~~~~~~~~~~~~~~~~
.. literalinclude:: ../../examples/playbook.yml
:language: yaml

12
examples/playbook.yml Normal file
View File

@ -0,0 +1,12 @@
- name: Install openrc
hosts: all
user: root
roles:
- { role: "openstack-ansible-openstack_openrc",
tags: [ "openstack_openrc" ]
}
vars:
keystone_service_adminuri_insecure: false
keystone_service_internaluri_insecure: false
openrc_os_password: secrete
openrc_os_domain_name: Default