extern
/
podman-compose
mirror of https://github.com/containers/podman-compose.git
1
0
Fork 1
Code Issues Packages Projects Releases Wiki Activity
a script to run docker-compose.yml using podman
486 Commits 3 Branches 9 Tags 12 MiB
Python 99.3%
Shell 0.5%
Dockerfile 0.2%
Go to file
Povilas Kanapickas e4e5b7d461 Make test requirements reproducible 
Signed-off-by: Povilas Kanapickas <povilas@radix.lt>
 		2024-03-07 18:28:04 +02:00
.github Fix package installation 2024-02-25 01:25:28 +03:00
completion/bash Add --remove-orphans on down command 2023-04-09 11:35:46 +03:00
docs add docs directory 2019-09-03 00:19:41 +03:00
examples Fix typos 2023-08-08 18:05:25 +03:00
pytests rm redundant tests 2023-08-02 14:19:15 +03:00
scripts update readme and no arguments print help 2019-09-03 00:19:07 +03:00
tests Add tests to make sure all async paths are covered 2024-02-04 10:11:57 +03:00
.coveragerc Fix a couple issues and update docs 2024-02-04 10:11:57 +03:00
.gitignore Python packaging 2019-08-21 22:45:53 +02:00
.pre-commit-config.yaml pre-commit black config: run in check only mode 2023-04-10 14:13:00 +03:00
.pylintrc reformat 2022-06-21 21:54:44 +03:00
CODE-OF-CONDUCT.md Add Code of Conduct 2020-02-09 01:23:49 +02:00
CONTRIBUTING.md Fix a couple issues and update docs 2024-02-04 10:11:57 +03:00
LICENSE Initial commit 2019-03-04 10:52:30 +02:00
README.md version 1.0.6 2023-04-09 14:02:10 +03:00
SECURITY.md Add Security Policy 2020-05-09 17:54:44 -04:00
podman_compose.py remove recursion 2024-02-06 00:23:14 +03:00
requirements.txt FIXES #370: bug-for-bug hanlding of .env 2021-12-10 01:01:45 +02:00
setup.cfg Fixes #661 - Fixes linting/flake8 errors 2023-04-10 11:53:47 +03:00
setup.py Fix a couple issues and update docs 2024-02-04 10:11:57 +03:00
test-requirements.txt Make test requirements reproducible 2024-03-07 18:28:04 +02:00

README.md

Podman Compose

Pylint Test: Unit tests PyTest

An implementation of Compose Spec with Podman backend. This project focuses on:

  • rootless
  • daemon-less process model, we directly execute podman, no running daemon.

This project only depends on:

  • podman
  • podman dnsname plugin: It is usually found in the podman-plugins or podman-dnsname distro packages, those packages are not pulled by default and you need to install them. This allows containers to be able to resolve each other if they are on the same CNI network.
  • Python3
  • PyYAML
  • python-dotenv

And it's formed as a single Python file script that you can drop into your PATH and run.

References:

Alternatives

As in this article you can setup a podman.socket and use unmodified docker-compose that talks to that socket but in this case you lose the process-model (ex. docker-compose build will send a possibly large context tarball to the daemon)

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.1.0) 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.

If you are upgrading from podman-compose version 0.1.x then we no longer have global option -t to set mapping type like hostnet. If you desire that behavior, pass it the standard way like network_mode: host in the YAML.

Installation

Install the 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 install from Fedora (starting from f31) repositories:

sudo dnf install podman-compose

Basic Usage

We have included fully functional sample stacks inside examples/ directory. You can get more examples from awesome-compose.

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. There is also AWX 17.1.0

Tests

Inside tests/ directory we have many useless docker-compose stacks that are meant to test as many cases as we can to make sure we are compatible

Unit tests with pytest

run a pytest with following command

python -m pytest pytests

Contributing guide

If you are a user or a developer and want to contribute please check the CONTRIBUTING section