infrastructure/dc-ops
2
0
Fork 0
Code Issues 1 Pull requests Activity

doc: update README with configuration options

Browse source 
- add section for configuration options
- explain each configuration option in detail
- provide examples for each configuration option

🤖
This commit is contained in:
Sebastian Mark 2023-12-19 22:24:51 +01:00
parent 4ee278dd86
commit 55d00d1b08
1 changed files with 9 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
README.md
View file

@ -18,6 +18,15 @@ See `requirements.txt`
2. Adapt `config.yml.example` to your needs and save it as `config.yml` 2. Adapt `config.yml.example` to your needs and save it as `config.yml`
3. Run `dc-ops` from the shell or from a cron job 3. Run `dc-ops` from the shell or from a cron job
## Configuration Options
- `loglevel`: (optional) define loglevel. Defaults to "INFO" if not set.
- `stacks`: an array containing details for each repository. Each element is a dictionary containing the following keys:
- `dir`: the directory of the repository on your local machine.
- `compose-files`: (optional) array of paths (relative to `dir`) to docker-compose files. Uses `["docker-compose.yml"]` by default if not set.
- `enabled`: (optional) `false` if this repository should be skipped. Defaults to `true` if not set.
- `pre`: (optional) a command to be run before `docker-compose up`, executed in `dir`.
- `post`: (optional) a command to be run after `docker-compose up`, executed in `dir`.
## Detailed process ## Detailed process
For each enabled stack in the config file, the following process will be executed: For each enabled stack in the config file, the following process will be executed: