Added basic doc for provisioners

lxdock · Mar 28, 2017 · 8aef6ca · 8aef6ca
1 parent 214b485
commit 8aef6ca
Show file tree

Hide file tree

Showing 3 changed files with 65 additions and 0 deletions.
diff --git a/docs/index.rst b/docs/index.rst
@@ -12,6 +12,7 @@ Welcome to LXDock's documentation!
    usage/index
    cli/index
    conf
+   provisioners/index
    glossary
    contributing
    release_notes/index

diff --git a/docs/provisioners/ansible.rst b/docs/provisioners/ansible.rst
@@ -0,0 +1,42 @@
+#######
+Ansible
+#######
+
+LXDock provides built-in support for `Ansible`_ provisioning.
+
+.. _Ansible: https://www.ansible.com/
+
+Requirements
+------------
+
+`Ansible`_ v2.0+
+
+Usage
+-----
+
+Just append an ``ansible`` provisioning operation to your LXDock file as follows:
+
+.. code-block:: yaml
+
+  name: myproject
+  image: ubuntu/xenial
+
+  provisioning:
+    - type: ansible
+      playbook: deploy/site.yml
+
+Required options
+----------------
+
+playbook
+========
+
+The ``playbook`` option allows you to define the path to your Ansible playbook you want to run when
+your containers are provisioned.
+
+Optional options
+----------------
+
+*Not yet!*
+
+.. _Ansible: https://www.ansible.com/
diff --git a/docs/provisioners/index.rst b/docs/provisioners/index.rst
@@ -0,0 +1,22 @@
+############
+Provisioners
+############
+
+LXDock provides support for common provisioning operations. Provisioning operations can be easily
+defined in your LXDock file using the ``provisioning`` option:
+
+.. code-block:: yaml
+
+  name: myproject
+  image: ubuntu/xenial
+
+  provisioning:
+    - type: ansible
+      playbook: deploy/site.yml
+
+Documentation sections for the supported provisioning tools or methods are listed here.
+
+.. toctree::
+    :maxdepth: 1
+
+    ansible