summaryrefslogtreecommitdiffstats
path: root/docs/repo_structure.md
diff options
context:
space:
mode:
authorTim Bielawa <timbielawa@gmail.com>2017-04-28 12:41:09 -0400
committerGitHub <noreply@github.com>2017-04-28 12:41:09 -0400
commitd8a70bbd179c59e121a652f2b590f65ed7889eab (patch)
tree9d8c16df98ac710f1624acb5afc6f0d8be44fc82 /docs/repo_structure.md
parent7de281c7a8ddfcde6b416e3c4b0b2abb6c6c67a7 (diff)
parentb23be0da38759744cebc8d4b454af1299d97a445 (diff)
downloadopenshift-d8a70bbd179c59e121a652f2b590f65ed7889eab.tar.gz
openshift-d8a70bbd179c59e121a652f2b590f65ed7889eab.tar.bz2
openshift-d8a70bbd179c59e121a652f2b590f65ed7889eab.tar.xz
openshift-d8a70bbd179c59e121a652f2b590f65ed7889eab.zip
Merge branch 'master' into contrib_pre-commit_hook
Diffstat (limited to 'docs/repo_structure.md')
-rw-r--r--docs/repo_structure.md54
1 files changed, 54 insertions, 0 deletions
diff --git a/docs/repo_structure.md b/docs/repo_structure.md
new file mode 100644
index 000000000..693837fba
--- /dev/null
+++ b/docs/repo_structure.md
@@ -0,0 +1,54 @@
+# Repository structure
+
+### Ansible
+
+```
+.
+├── inventory Contains dynamic inventory scripts, and examples of
+│ Ansible inventories.
+├── library Contains Python modules used by the playbooks.
+├── playbooks Contains Ansible playbooks targeting multiple use cases.
+└── roles Contains Ansible roles, units of shared behavior among
+ playbooks.
+```
+
+#### Ansible plugins
+
+These are plugins used in playbooks and roles:
+
+```
+.
+├── ansible-profile
+├── callback_plugins
+├── filter_plugins
+└── lookup_plugins
+```
+
+### Scripts
+
+```
+.
+├── bin [DEPRECATED] Contains the `bin/cluster` script, a
+│ wrapper around the Ansible playbooks that ensures proper
+│ configuration, and facilitates installing, updating,
+│ destroying and configuring OpenShift clusters.
+│ Note: this tool is kept in the repository for legacy
+│ reasons and will be removed at some point.
+└── utils Contains the `atomic-openshift-installer` command, an
+ interactive CLI utility to install OpenShift across a
+ set of hosts.
+```
+
+### Documentation
+
+```
+.
+└── docs Contains documentation for this repository.
+```
+
+### Tests
+
+```
+.
+└── test Contains tests.
+```