From 2074d976535ea7c35aeba55fe57247b62d1876a4 Mon Sep 17 00:00:00 2001 From: Travis Truman <travis_truman@cable.comcast.com> Date: Wed, 17 Aug 2016 13:27:37 -0400 Subject: [PATCH] [DOCS] - Use new documentation tree structure Changes the designate role doc tree to the new structure we are adopting for each role. Change-Id: I45924e641401218440542ab1d95376dd42811428 --- README.rst | 66 ++++++------------------------------------- doc/source/index.rst | 46 +++++++++++++++++++++++++++++- examples/playbook.yml | 13 +++++++++ 3 files changed, 66 insertions(+), 59 deletions(-) create mode 100644 examples/playbook.yml diff --git a/README.rst b/README.rst index 0e62bf6..cf57b34 100644 --- a/README.rst +++ b/README.rst @@ -1,61 +1,11 @@ -OpenStack-Ansible Designate -########################### -:tags: openstack, designate, cloud, ansible -:category: \*nix +==================================== +Designate role for OpenStack-Ansible +==================================== -This Ansible role installs and configures OpenStack Designate. +Ansible role to install OpenStack designate. -This role will install the following services: - * designate-api - * designate-central - * designate-pool-manager - * designate-zone-manager - * designate-mdns - * designate-sink +Documentation for the project can be found at: + http://docs.openstack.org/developer/openstack-ansible-os_designate -Default Variables -================= - -.. literalinclude:: ../../defaults/main.yml - :language: yaml - :start-after: under the License. - -Required Variables -================== - -.. code-block:: yaml - - designate_galera_address - designate_container_mysql_password - designate_pool_manager_container_mysql_password - designate_service_password - designate_rabbitmq_password - -Example Playbook -================ - -.. code-block:: yaml - - - name: Install Designate Server - hosts: designate_all - user: root - roles: - - { role: "os_designate", tags: [ "os-designate" ] } - vars: - external_lb_vip_address: 172.16.24.1 - internal_lb_vip_address: 192.168.0.1 - designate_galera_address: "{{ internal_lb_vip_address }}" - designate_container_mysql_password: "SuperSecretePassword1" - designate_pool_manager_container_mysql_password: "SuperSecretePassword2" - designate_service_password: "SuperSecretePassword3" - designate_rabbitmq_password: "SuperSecretePassword4" - -Tags -==== - -This role supports two tags: ``designate-install`` and ``designate-config`` - -The ``designate-install`` tag can be used to install and upgrade. - -The ``designate-config`` tag can be used to maintain configuration of the -service. +The project home is at: + http://launchpad.net/openstack-ansible \ No newline at end of file diff --git a/doc/source/index.rst b/doc/source/index.rst index a6210d3..296ae82 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -1 +1,45 @@ -.. include:: ../../README.rst +==================================== +Designate role for OpenStack-Ansible +==================================== + +This Ansible role installs and configures OpenStack Designate. + +This role will install the following services: + * designate-api + * designate-central + * designate-pool-manager + * designate-zone-manager + * designate-mdns + * designate-sink + +Default variables +~~~~~~~~~~~~~~~~~ + +.. literalinclude:: ../../defaults/main.yml + :language: yaml + :start-after: under the License. + +Required variables +~~~~~~~~~~~~~~~~~~ + +.. code-block:: yaml + + designate_galera_address + designate_container_mysql_password + designate_pool_manager_container_mysql_password + designate_service_password + designate_rabbitmq_password + +Example playbook +~~~~~~~~~~~~~~~~ + +.. literalinclude:: ../../examples/playbook.yml + :language: yaml + +Tags +^^^^ + +This role supports two tags: ``designate-install`` and ``designate-config``. +The ``designate-install`` tag can be used to install and upgrade. The +``designate-config`` tag can be used to maintain configuration of the service. + diff --git a/examples/playbook.yml b/examples/playbook.yml new file mode 100644 index 0000000..c5296c0 --- /dev/null +++ b/examples/playbook.yml @@ -0,0 +1,13 @@ +- name: Install Designate Server + hosts: designate_all + user: root + roles: + - { role: "os_designate", tags: [ "os-designate" ] } + vars: + external_lb_vip_address: 172.16.24.1 + internal_lb_vip_address: 192.168.0.1 + designate_galera_address: "{{ internal_lb_vip_address }}" + designate_container_mysql_password: "SuperSecretePassword1" + designate_pool_manager_container_mysql_password: "SuperSecretePassword2" + designate_service_password: "SuperSecretePassword3" + designate_rabbitmq_password: "SuperSecretePassword4" \ No newline at end of file