dc-ops/README.md
Sebastian Mark 203626f7e2 doc: update usage instructions
- replace vague instructions with specific command examples
- clarify the use of `stacklist` file

🤖
2023-12-15 22:55:21 +01:00

19 lines
1.1 KiB
Markdown

# Docker Compose Ops (dc-ops)
`dc-ops` is a shell script designed to operations automate the local building and updating of several Docker services.
It aims to simplify continuous delivery (CD) processes and infrastructure management in a Docker environment.
## How does it work?
* The script iterates through each line of the `stacklist` file (skipping comments) or through all cli parameters
* It fetches the latest changes from the remote git repository and checks if there are new commits
* If there is a change it pulls the updates from the remote git repository, otherwise the entry is skipped
* Following this, it runs `docker compose up` which builds, (re)creates and starts the containers
The `stacklist` file can list either a directory containing a `docker-compose.yml` file or a precise `docker-compose` file (see `stacklist.example`).
Alternatively, the stacklist can also be passed as a list of parameters.
## Usage
* `./dc-ops /path/to/repo /path/to/another-repo /path/with/docker-compose-dev.yml` or
* Update `stacklist` file and run `./dc-ops` (or create a crontab entry)