Wrap docker-compose to acheive dev-perfect CI
Project description
Install with pip install compoctl
A wrapper for the long docker-compose command that also adds a few features that should be considered experimental, in waiting for refutation or upstream contribution - which won’t break BC because compoctl decorates docker-compose commands.
compoctl apply: the one-liner pipeline for docker-compose
Chain pull/build/down/up/logs/ps, nice to have for hacking and even more in automated deploys:
compoctl -f ./foo.yml apply # will run: docker-compose -f ./foo.yml pull docker-compose -f ./foo.yml build docker-compose -f ./foo.yml down docker-compose -f ./foo.yml up -d docker-compose -f ./foo.yml logs docker-compose -f ./foo.yml ps
compoctl backup
Backup data into ./backup.
Example configuration that makes it work as-is:
volumes: - ./backup/postgres:/backup labels: io.compoctl.backup.cmd: pg_dumpall -U postgres -f /backup/data.dump
This will dump pg data into ./backup/postgres, and also export docker-compose running config into ./backup/docker-compose.restore.yml
It will also execute the docker-compose.backup.yml if it exists. This is were you can spawn a container that mounts ./backup and proceeds to the secure backup export over the network that you want for production.
To prevent permission issues, containers should at no time write the ./backup directory itself.
pre-POC state: waiting for an example chaining a docker-compose.backup.yml that would spawn restic and rclone to backup the backup on a remote collection (or implement retention policy feature into duplicity).
compoctl restore
Copy docker-compose.yml back from ./backup and run restore commands.
This is a destructive operation that will delete all volumes except the backup volume, up each service one by one and apply the restore command.
Example configuration that makes it work as-is:
volumes: - ./backup/postgres:/backup labels: compoctl.restore: psql -U postgres -f /backup/data.dump
Note that the ./backup directory must have been provisioned with the backup command priorly.
Also, the cluster will be unusable/down during the restore operation.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
File details
Details for the file compoctl-0.1.2.post3.tar.gz
.
File metadata
- Download URL: compoctl-0.1.2.post3.tar.gz
- Upload date:
- Size: 4.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.6.2 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.6.8
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | c0dac0e8923049b6b4d3db06b95626e665350b77a9936b164f345845701fa09c |
|
MD5 | f80dca36fd75e469d062bc6cd9ddd7e5 |
|
BLAKE2b-256 | c87f0a39641cd925ef076f922689c83458006981bb91ccd719a4506e9c7fde4a |