aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md15
1 files changed, 14 insertions, 1 deletions
diff --git a/README.md b/README.md
index 1c0375b..d080367 100644
--- a/README.md
+++ b/README.md
@@ -10,7 +10,7 @@ We try to build a generic abstraction stack between our different resources (CPU
* ansible (physical node conf)
* nomad (schedule containers)
* consul (distributed key value store / lock / service discovery)
- * glusterfs (file storage)
+ * garage/glusterfs (file storage)
* stolon + postgresql (distributed relational database)
* docker (container tool)
* bottin (LDAP server, auth)
@@ -23,6 +23,19 @@ Some services we provide:
As a generic abstraction is provided, deploying new services should be easy.
+## I am lost, how this repo works?
+
+To ease the development, we make the choice of a fully integrated environment
+
+ 1. `os_build`: where you will build our OS image based on Debian that you will install on your server
+ 2. `os_config`: our Ansible recipes to configure and update your freshly installed server
+ 3. `app_build`: our Docker files to build immutable images of our applications
+ 4. `app_integration`: Our Docker compose files to test locally how our built images interact together
+ 5. `app_config`: Files containing application configurations to be deployed on Consul Key Value Store
+ 6. `app_deployment`: Files containing application definitions to be deployed on Nomad Scheduler
+ 7. `op_guide`: Guides to explain you operations you can do cluster wide (like configuring postgres)
+
+
## Start hacking
### Clone the repository