From 5ba32d4c5f99a56caf7591e16bf6d5b83302b266 Mon Sep 17 00:00:00 2001
From: Romain Dessort <rdessort@evolix.fr>
Date: Tue, 22 Aug 2017 12:58:13 -0400
Subject: [PATCH] Add README to lxc role

---
 lxc/README.md | 24 ++++++++++++++++++++++++
 1 file changed, 24 insertions(+)
 create mode 100644 lxc/README.md

diff --git a/lxc/README.md b/lxc/README.md
new file mode 100644
index 00000000..4da64f3c
--- /dev/null
+++ b/lxc/README.md
@@ -0,0 +1,24 @@
+# lxc
+
+Install and configure lxc and create containers.
+
+## Tasks
+
+Everything is in the `tasks/main.yml` file.
+
+## Available variables
+
+Here is the list of available variables:
+
+* `lxc_unprivilegied_containers`: should LXC containers run in unprivilegied (non root) mode? Default: `true`
+* `lxc_network_type`: network type to use. See lxc.container.conf(5). Default: `"none"`
+* `lxc_mount_part`: partition to bind mount into containers. Default: `"/home"`
+* `lxc_containers`: list of LXC containers to create. Default: `[]` (empty).
+  Eg.:
+  ```
+  lxc_containers:
+    - name: php56
+      release: jessie
+    - name: php70
+      release: stretch
+   ```