summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorThomas Wiest <twiest@gmail.com>2014-10-30 15:56:09 -0400
committerThomas Wiest <twiest@gmail.com>2014-10-30 15:56:09 -0400
commitd57f8d6968f0b580d3201df197eda98ed5f8fe19 (patch)
treebaf13768c8c0c24c32b166758b1b38f3a3207a3e
parent492b629d1c497158fe0d9fec97b2605f1c1ba1e7 (diff)
parent6c16b293560196ec98cc5422ee6c7b126a29912c (diff)
downloadopenshift-d57f8d6968f0b580d3201df197eda98ed5f8fe19.tar.gz
openshift-d57f8d6968f0b580d3201df197eda98ed5f8fe19.tar.bz2
openshift-d57f8d6968f0b580d3201df197eda98ed5f8fe19.tar.xz
openshift-d57f8d6968f0b580d3201df197eda98ed5f8fe19.zip
Merge pull request #21 from twiest/doc_updates
Documentation updates
-rw-r--r--README.md11
1 files changed, 10 insertions, 1 deletions
diff --git a/README.md b/README.md
index ce842e2b0..e872aae63 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,7 @@
openshift-online-ansible
========================
-This repo houses ansible code used in OpenShift Online.
+This repo houses Ansible code used in OpenShift Online.
Setup
-----
@@ -14,3 +14,12 @@ Setup
- Setup for a specific cloud:
- [AWS](README_AWS.md)
- [GCE](README_GCE.md)
+
+- Directory Structure:
+ - [cloud.rb](cloud.rb) - light wrapper around Ansible
+ - [cluster.sh](cluster.sh) - easily create OpenShift 3 clusters
+ - [filter_plugins/](filter_plugins) - custom filters used to manipulate data in Ansible
+ - [inventory/](inventory) - houses Ansible dynamic inventory scripts
+ - [lib/](lib) - library components of cloud.rb
+ - [playbooks/](playbooks) - houses host-type Ansible playbooks (launch, config, destroy, vars)
+ - [roles/](roles) - shareable Ansible tasks