summaryrefslogtreecommitdiffstats
path: root/playbooks/README.md
diff options
context:
space:
mode:
authorRodolfo Carvalho <rhcarvalho@gmail.com>2017-01-12 16:34:56 +0100
committerRodolfo Carvalho <rhcarvalho@gmail.com>2017-01-13 10:55:21 +0100
commita0732616fca9fb42db7479ce0b3a339292f42a97 (patch)
tree9007795b9268202fc79c894467c7092c675ad020 /playbooks/README.md
parentfbcbeba1f29543332f295cd1fdc32bd584b3f5a3 (diff)
downloadopenshift-a0732616fca9fb42db7479ce0b3a339292f42a97.tar.gz
openshift-a0732616fca9fb42db7479ce0b3a339292f42a97.tar.bz2
openshift-a0732616fca9fb42db7479ce0b3a339292f42a97.tar.xz
openshift-a0732616fca9fb42db7479ce0b3a339292f42a97.zip
Document playbook directories
Diffstat (limited to 'playbooks/README.md')
-rw-r--r--playbooks/README.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/playbooks/README.md b/playbooks/README.md
new file mode 100644
index 000000000..5857a9f59
--- /dev/null
+++ b/playbooks/README.md
@@ -0,0 +1,19 @@
+# openshift-ansible playbooks
+
+In summary:
+
+- [`byo`](byo) (_Bring Your Own_ hosts) has the most actively maintained
+ playbooks for installing, upgrading and performing others tasks on OpenShift
+ clusters.
+- [`common`](common) has a set of playbooks that are included by playbooks in
+ `byo` and others.
+
+And:
+
+- [`adhoc`](adhoc) is a generic home for playbooks and tasks that are community
+ supported and not officially maintained.
+- [`aws`](aws), [`gce`](gce), [`libvirt`](libvirt) and [`openstack`](openstack)
+ are related to the [`bin/cluster`](../bin) tool and its usage is deprecated.
+
+Refer to the `README.md` file in each playbook directory for more information
+about them.