diff --git a/README.rst b/README.rst index f081345..6435bfa 100644 --- a/README.rst +++ b/README.rst @@ -1,50 +1,9 @@ +============================= OpenStack-Ansible openrc file -############################# +============================= + :tags: openstack, openrc, cloud, ansible :category: \*nix -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 - -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. - +This Ansible role creates the configuration files used by various +OpenStack CLI tools. diff --git a/doc/source/index.rst b/doc/source/index.rst index a6210d3..191dd66 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -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 diff --git a/examples/playbook.yml b/examples/playbook.yml new file mode 100644 index 0000000..573d38a --- /dev/null +++ b/examples/playbook.yml @@ -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