summaryrefslogtreecommitdiffstats
path: root/roles/flannel/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'roles/flannel/README.md')
-rw-r--r--roles/flannel/README.md37
1 files changed, 37 insertions, 0 deletions
diff --git a/roles/flannel/README.md b/roles/flannel/README.md
new file mode 100644
index 000000000..94cf15254
--- /dev/null
+++ b/roles/flannel/README.md
@@ -0,0 +1,37 @@
+Role Name
+=========
+
+Configure flannel on openshift nodes
+
+Requirements
+------------
+
+This role assumes it's being deployed on a RHEL/Fedora based host with package
+named 'flannel' available via yum, in version superior to 0.3.
+
+Role Variables
+--------------
+
+TODO
+
+Dependencies
+------------
+
+openshift_facts
+
+Example Playbook
+----------------
+
+ - hosts: openshift_node
+ roles:
+ - { flannel }
+
+License
+-------
+
+Apache License, Version 2.0
+
+Author Information
+------------------
+
+Sylvain Baubeau <sbaubeau@redhat.com>