diff options
| author | Quentin <quentin@deuxfleurs.fr> | 2021-01-18 08:06:19 +0100 |
|---|---|---|
| committer | Quentin <quentin@deuxfleurs.fr> | 2021-01-18 08:06:19 +0100 |
| commit | cffd902815662aa298186e78c1a7b307f7022200 (patch) | |
| tree | 5011022effadfb6d75ff829f0cd1a597494626d3 | |
| parent | 850ccbf1c7c4ebba28b1971bafae0a6ba922b7c7 (diff) | |
| download | infrastructure-cffd902815662aa298186e78c1a7b307f7022200.tar.gz infrastructure-cffd902815662aa298186e78c1a7b307f7022200.zip | |
Add some documentation + add a requirements file
| -rw-r--r-- | README.md | 1 | ||||
| -rw-r--r-- | app/README.md | 34 | ||||
| -rw-r--r-- | app/requirements.txt | 3 |
3 files changed, 38 insertions, 0 deletions
@@ -82,6 +82,7 @@ alias bind_df="ssh \ -L 8500:127.0.0.1:8500 \ -L 8082:traefik-admin.service.2.cluster.deuxfleurs.fr:8082 \ -L 5432:psql-proxy.service.2.cluster.deuxfleurs.fr:5432 \ + -L 1389:bottin2.service.2.cluster.deuxfleurs.fr:389 \ <a server from the cluster>" ``` diff --git a/app/README.md b/app/README.md index a877cfa..21eb936 100644 --- a/app/README.md +++ b/app/README.md @@ -1,3 +1,37 @@ +## How to install `secretmgr` + +How to install its dependencies: + +```bash +# on fedora: +dnf install -y openldap-devel +# on ubuntu: +apt-get install -y libldap2-dev + +# for eveyrone: +pip3 install --user --requirement requirements.txt +``` + +## How to use `secretmgr` + +Check that all secrets are correctly deployed for app `dummy`: + +```bash +./secretmgr.py check dummy +``` + +Generate secrets for app `dummy` if they don't already exist: + +```bash +./secretmgr.py gen dummy +``` + +Rotate secrets for app `dummy`, overwriting existing ones (be careful, this is dangerous!): + +```bash +./secretmgr.py regen dummy +``` + ## How to upgrade our packaged apps to a new version? 1. Edit `docker-compose.yml` diff --git a/app/requirements.txt b/app/requirements.txt new file mode 100644 index 0000000..7874d93 --- /dev/null +++ b/app/requirements.txt @@ -0,0 +1,3 @@ +python-consul==1.1.0 +python-ldap==3.3.1 +passlib==1.7.4 |