Reorganize app/ and add script for secret management #29
1 changed files with 12 additions and 2 deletions
|
@ -1,4 +1,14 @@
|
||||||
## How to install `secretmgr`
|
## Understand this folder hierarchy
|
||||||
|
|
||||||
|
This folder contains the following 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
|
||||||
|
- `<module>/secrets/`: folder containing secrets, which can be synchronized with Consul using `secretmgr.py`
|
||||||
|
- `<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
|
||||||
|
|
||||||
How to install its dependencies:
|
How to install its dependencies:
|
||||||
|
|
||||||
|
@ -12,7 +22,7 @@ apt-get install -y libldap2-dev
|
||||||
pip3 install --user --requirement requirements.txt
|
pip3 install --user --requirement requirements.txt
|
||||||
```
|
```
|
||||||
|
|
||||||
## How to use `secretmgr`
|
## How to use `secretmgr.py`
|
||||||
|
|
||||||
Check that all secrets are correctly deployed for app `dummy`:
|
Check that all secrets are correctly deployed for app `dummy`:
|
||||||
|
|
||||||
|
|
Reference in a new issue