Kompozit

GitHub - veerendra2/kompozit: Customizing Docker Compose Made Easy 🚀 (Kustomize for Docker Compose)GitHub

ℹ️ Mostly likely you may want to use Use multiple Compose files in Docker Compose itself.

Declarative Configuration Management Tool for Docker Compose.

Like kustomize.io, but for Docker Compose.

Features

Kompozit simplifies complex Docker Compose setups using declarative overlays, supporting:

• patchesJSON6902: Precise modifications with JSON Merge Patch.

• patchesStrategicMerge: Flexible hierarchical changes with Strategic Merge Patch.

Resources

• 📖 Documentation

• 🛠️ Examples

• 🗂️ Github Repo

But Why...? 🤔

There are scenarios where you might need different Docker Compose configurations for the same application on different machines.

• For example, I use slightly different configurations for the Traefik reverse proxy when managing my public WordPress site versus my home server. Instead of maintaining multiple, slightly different docker-compose.yml files for the same app, you can use kompozit to simplify and manage these variations efficiently.

Additionally, kompozit allows you to combine multiple docker-compose.yml files into a single stack.

• For instance, you can keep a generic docker-compose.yml for PostgreSQL in a central location and customize it for different stacks in other locations as needed.

Installation 💻

PyPi

https://pypi.org/project/kompozit/

python -m pip install kompozit

kompozit -h
usage: kompozit [-h] [-b BUILD_PATH] [-o OUTPUT_DIR] [-v]

Declarative Configuration Management Tool for Docker Compose.

options:
  -h, --help            show this help message and exit
  -b, --build BUILD_PATH
                        Path to a directory containing 'kompozition.yaml' or 'kompozition.yml'. (default: .)
  -o, --output-dir OUTPUT_DIR
                        Directory to save the generated Docker Compose files. (default: None)
  -v, --version         Show kompozit version

Docker

https://hub.docker.com/r/veerendra2/kompozit

docker pull veerendra2/kompozit

Usage Examples ⚙️

git clone [e-mail]:veerendra2/kompozit.git
cd kompozit
python -m pip install .

kompozit --build ./examples/overlay
...

# inside docker
docker pull kompozit:latest
docker run -it --rm -v ./examples:/examples kompozit:latest -b /examples/overlay

Local Development 🔧

git clone [e-mail]:veerendra2/kompozit.git
cd kompozit

python -m venv venv
source venv/bin/activate
pip install -e .