summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorRodolfo Carvalho <rhcarvalho@gmail.com>2017-04-24 15:36:39 +0200
committerRodolfo Carvalho <rhcarvalho@gmail.com>2017-04-27 11:54:12 +0200
commit9fd022f65d1df98f50c8bcc445c63d026f8d87b8 (patch)
tree4dc17968667db2d2b6e490988ebccaf643e17b58 /docs
parent8734fb6a7e9ceba9f78a8d435bf06459582aed05 (diff)
downloadopenshift-9fd022f65d1df98f50c8bcc445c63d026f8d87b8.tar.gz
openshift-9fd022f65d1df98f50c8bcc445c63d026f8d87b8.tar.bz2
openshift-9fd022f65d1df98f50c8bcc445c63d026f8d87b8.tar.xz
openshift-9fd022f65d1df98f50c8bcc445c63d026f8d87b8.zip
Move repo structure to a separate document
Reduces the clutter in CONTRIBUTING.md.
Diffstat (limited to 'docs')
-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.
+```