A script to run docker-compose.yml using podman
Project description
Podman Compose
An implementation of docker-compose
with Podman backend.
The main objective of this project is to be able to run docker-compose.yml
unmodified and rootless.
This project is aimed to provide drop-in replacement for docker-compose
,
and it's very useful for certain cases because:
- can run rootless
- no daemon, no setup.
- can be used by developers to run single-machine containerized stacks using single familiar YAML file
This project only depend on:
podman
- Python3
- PyYAML
- python-dotenv
And it's formed as a single python file script that you can drop into your PATH and run.
For production-like single-machine containerized environment consider
For the real thing (multi-node clusters) check any production OpenShift/Kubernetes distribution like OKD.
Versions
If you have legacy version of podman
(before 3.x) you might need to stick with legacy podman-compose
0.1.x
branch.
The legacy branch 0.1.x uses mappings and workarounds to compensate for rootless limitations.
Modern podman versions (>=3.4) do not have those limitations and thus you can use latest and stable 1.x branch.
Installation
Install latest stable version from PyPI:
pip3 install podman-compose
pass --user
to install inside regular user home without being root.
Or latest development version from GitHub:
pip3 install https://github.com/containers/podman-compose/archive/devel.tar.gz
or
curl -o /usr/local/bin/podman-compose https://raw.githubusercontent.com/containers/podman-compose/devel/podman_compose.py
chmod +x /usr/local/bin/podman-compose
or
curl -o ~/.local/bin/podman-compose https://raw.githubusercontent.com/containers/podman-compose/devel/podman_compose.py
chmod +x ~/.local/bin/podman-compose
or install from Fedora (starting from f31) repositories:
sudo dnf install podman-compose
Basic Usage
We have included fully functional sample stacks inside examples/
directory.
A quick example would be
cd examples/busybox
podman-compose --help
podman-compose up --help
podman-compose up
A more rich example can be found in examples/awx3 which have
- A Postgres Database
- RabbitMQ server
- MemCached server
- a django web server
- a django tasks
When testing the AWX3
example, if you got errors just wait for db migrations to end.
Tests
Inside tests/
directory we have many useless docker-compose stacks
that are meant to test as much cases as we can to make sure we are compatible
How it works
The default mapping 1podfw
creates a single pod and attach all containers to
its network namespace so that all containers talk via localhost.
For more information see docs/Mappings.md.
If you are running as root, you might use identity mapping.
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
Built Distribution
Hashes for podman_compose-0.1.10-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b4c87fed557457a64d99959bd2204a2202cd39e76d0a8f6c4275727e12b7182e |
|
MD5 | 95828e9c9a79bd17fadb0c3d36ff75dc |
|
BLAKE2b-256 | 28c23d2ab28e307cefe62d1c512589dec9c000cb5c051b8295e6284b35b787db |