[DOCS] - Use new documentation tree structure

Changes the barbican role doc tree to the new structure
we are adopting for each role.

Change-Id: Idb932a77f8528f015c05b12668933907406fe88f
This commit is contained in:
Travis Truman 2016-08-17 13:38:30 -04:00
parent 34d861b888
commit db0e745b63
4 changed files with 61 additions and 53 deletions

View File

@ -1,55 +1,11 @@
OpenStack-Ansible Barbican
##########################
:tags: openstack, barbican, cloud, ansible
:category: \*nix
===================================
Barbican role for OpenStack-Ansible
===================================
This Ansible role installs and configures OpenStack Barbican.
Default Variables
=================
Documentation for the project can be found at:
http://docs.openstack.org/developer/openstack-ansible-os_barbican/
.. literalinclude:: ../../defaults/main.yml
:language: yaml
:start-after: under the License.
Required Variables
==================
barbican_galera_address
barbican_galera_password
barbican_rabbitmq_password
barbican_service_password
keystone_admin_user_name
keystone_auth_admin_password
keystone_admin_tenant_name
Example Playbook
================
.. code-block:: yaml
- name: Install barbican server
hosts: barbican_all
user: root
roles:
- role: "os_barbican"
vars:
external_lb_vip_address: 172.16.24.1
internal_lb_vip_address: 192.168.0.1
barbican_galera_address: "{{ internal_lb_vip_address }}"
barbican_service_password: SuperSecretePassword1
barbican_galera_password: SuperSecretePassword2
barbican_rabbitmq_password: SuperSecretePassword3
keystone_admin_user_name: admin
keystone_auth_admin_password: SuperSecretePassword4
keystone_admin_tenant_name: admin
Tags
====
This role supports two tags: ``barbican-install`` and ``barbican-config``
The ``barbican-install`` tag can be used to install and upgrade.
The ``barbican-config`` tag can be used to maintain configuration of the
service.
The project home is at:
http://launchpad.net/openstack-ansible

View File

@ -1 +1,38 @@
.. include:: ../../README.rst
===================================
Barbican role for OpenStack-Ansible
===================================
This Ansible role installs and configures OpenStack barbican.
Default variables
~~~~~~~~~~~~~~~~~
.. literalinclude:: ../../defaults/main.yml
:language: yaml
:start-after: under the License.
Required variables
~~~~~~~~~~~~~~~~~~
.. code-block:: yaml
barbican_galera_address
barbican_galera_password
barbican_rabbitmq_password
barbican_service_password
keystone_admin_user_name
keystone_auth_admin_password
keystone_admin_tenant_name
Example playbook
~~~~~~~~~~~~~~~~
.. literalinclude:: ../../examples/playbook.yml
:language: yaml
Tags
~~~~
This role supports two tags: ``barbican-install`` and ``barbican-config``. The
``barbican-install`` tag can be used to install and upgrade. The ``barbican-
config`` tag can be used to maintain configuration of the service.

15
examples/playbook.yml Normal file
View File

@ -0,0 +1,15 @@
- name: Install barbican server
hosts: barbican_all
user: root
roles:
- role: "os_barbican"
vars:
external_lb_vip_address: 172.16.24.1
internal_lb_vip_address: 192.168.0.1
barbican_galera_address: "{{ internal_lb_vip_address }}"
barbican_service_password: SuperSecretePassword1
barbican_galera_password: SuperSecretePassword2
barbican_rabbitmq_password: SuperSecretePassword3
keystone_admin_user_name: admin
keystone_auth_admin_password: SuperSecretePassword4
keystone_admin_tenant_name: admin

View File

@ -5,7 +5,7 @@ description-file =
README.rst
author = OpenStack
author-email = openstack-dev@lists.openstack.org
home-page = http://www.openstack.org/
home-page = http://docs.openstack.org/developer/openstack-ansible-os_barbican/
classifier =
Intended Audience :: Developers
Intended Audience :: System Administrators