diff --git a/doc/Makefile b/doc/Makefile new file mode 100644 index 0000000..d99fa4e --- /dev/null +++ b/doc/Makefile @@ -0,0 +1,20 @@ +# Minimal makefile for Sphinx documentation +# + +# You can set these variables from the command line. +SPHINXOPTS = +SPHINXBUILD = sphinx-build +SPHINXPROJ = lilik_playbook +SOURCEDIR = source +BUILDDIR = build + +# Put it first so that "make" without argument is like "make help". +help: + @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) + +.PHONY: help Makefile + +# Catch-all target: route all unknown targets to Sphinx using the new +# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). +%: Makefile + @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) \ No newline at end of file diff --git a/doc/source/index.rst b/doc/source/index.rst new file mode 100644 index 0000000..4aa241b --- /dev/null +++ b/doc/source/index.rst @@ -0,0 +1,23 @@ +.. lilik_playbook documentation master file, created by + sphinx-quickstart on Fri Apr 7 14:02:37 2017. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +Welcome to lilik_playbook's documentation! +========================================== + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + quickstart + prepare_host + lxc_guest + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` diff --git a/doc/source/lxc_guest.rst b/doc/source/lxc_guest.rst new file mode 100644 index 0000000..d8487b2 --- /dev/null +++ b/doc/source/lxc_guest.rst @@ -0,0 +1,31 @@ +.. highlight:: yaml + +lxc_guest +========= + +This role provides the building blocks to create a virtual machine using lxc containers on a phisical server:: + + - hosts: phisical_host + roles: + - role: lxc_guest + vm_name: virtual_machine_name + +Additional parameter can be specified, the defaults are documented into the `lxc_guest` default folder:: + + - hosts: phisical_host + roles: + - role: lxc_guest + vm_name: virtual_machine_name + auto_start: true + container_state: started + distro: jessie + vm_size: 5G + +During the role execution there are multiple phases + +- Create the container and assign the configuration +- Update the container dns configuration +- Creation of the host ssh certificate if needed +- Update the container network configuration +- Install python and openssh-server +- Update of the user ssh certification authority public key