diff --git a/README.rst b/README.rst index 8b3a2107..8a7b7b85 100644 --- a/README.rst +++ b/README.rst @@ -1,28 +1,5 @@ +=========================== OpenStack-Ansible LXC hosts -########################### +=========================== Ansible role that configures a host for running LXC containers. - -Default Variables -================= - -.. literalinclude:: ../../defaults/main.yml - :language: yaml - :start-after: under the License. - -Required Variables -================== - -None - -Example Playbook -================ - -.. code-block:: yaml - - - name: Basic lxc host setup - hosts: "hosts" - user: root - roles: - - { role: "lxc_hosts" } - diff --git a/doc/source/index.rst b/doc/source/index.rst index a6210d3d..efd68b8d 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -1 +1,23 @@ -.. include:: ../../README.rst +=========================== +OpenStack-Ansible LXC hosts +=========================== + +Ansible role that configures a host for running LXC containers. + +Default variables +~~~~~~~~~~~~~~~~~ + +.. literalinclude:: ../../defaults/main.yml + :language: yaml + :start-after: under the License. + +Required variables +~~~~~~~~~~~~~~~~~~ + +None + +Example playbook +~~~~~~~~~~~~~~~~ + +.. literalinclude:: ../../examples/playbook.yml + :language: yaml diff --git a/examples/playbook.yml b/examples/playbook.yml new file mode 100644 index 00000000..69dc3378 --- /dev/null +++ b/examples/playbook.yml @@ -0,0 +1,5 @@ +- name: Basic LXC host setup + hosts: "hosts" + user: root + roles: + - { role: "lxc_hosts" }