From 98280c8628bc1df6197a1a830808bcd8631101bf Mon Sep 17 00:00:00 2001
From: LUXEY Adrien <adrien.luxey@inria.fr>
Date: Tue, 19 Jan 2021 15:21:23 +0100
Subject: updated READMEs

---
 app/README.md | 38 ++++++++++++++++++++++++++------------
 1 file changed, 26 insertions(+), 12 deletions(-)

(limited to 'app/README.md')

diff --git a/app/README.md b/app/README.md
index 3049cac..a0dcf43 100644
--- a/app/README.md
+++ b/app/README.md
@@ -1,6 +1,4 @@
-## Understand this folder hierarchy
-
-This folder contains the following hierarchy:
+# Folder hierarchy
 
 - `<module>/build/<image_name>/`: folders with dockerfiles and other necessary resources for building container images
 - `<module>/config/`: folder containing configuration files, referenced by deployment file
@@ -8,18 +6,34 @@ This folder contains the following hierarchy:
 - `<module>/deploy/`: folder containing the HCL file(s) necessary for deploying the module
 - `<module>/integration/`: folder containing files for integration testing using docker-compose
 
-## How to install `secretmgr.py` dependencies
+# Secret Manager `secretmgr.py`
+
+The Secret Manager ensures that all secrets are present where they should in the cluster.
+
+**You need access to the cluster** (SSH port forwarding) for it to find any secret on the cluster. Refer to the previous directory's [README](../README.md), at the bottom of the file.
 
-How to install its dependencies:
+## How to install `secretmgr.py` dependencies
 
 ```bash
-# on fedora:
-dnf install -y openldap-devel
-# on ubuntu:
-apt-get install -y libldap2-dev
+### Install system dependencies first:
+## On fedora
+
+dnf install -y openldap-devel cyrus-sasl-devel
+## On ubuntu
+apt-get install -y libldap2-dev libsasl2-dev
+
+### Now install the Python dependencies from requirements.txt:
+
+## Either using a virtual environment
+# (requires virtualenv python module)
+python3 -m virtualenv env 
+# Must be done everytime you create a new terminal window in this folder:
+. env/bin/activate 
+# Install the deps
+pip install -r requirements.txt
 
-# for eveyrone:
-pip3 install --user --requirement requirements.txt
+## Either by installing the dependencies for your system user:
+pip3 install --user -r requirements.txt
 ```
 
 ## How to use `secretmgr.py`
@@ -42,7 +56,7 @@ Rotate secrets for app `dummy`, overwriting existing ones (be careful, this is d
 ./secretmgr.py regen dummy
 ```
 
-## How to upgrade our packaged apps to a new version?
+# Upgrading one of our packaged apps to a new version
 
  1. Edit `docker-compose.yml`
  2. Change the `VERSION` variable to the desired version
-- 
cgit v1.2.3