Skip to main content

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
  • only depend on podman and Python3 and PyYAML
  • no daemon, no setup.
  • can be used by developers to run single-machine containerized stacks using single familiar YAML file

For production-like single-machine containerized environment consider

For the real thing (multi-node clusters) check any production OpenShift/Kubernetes distribution like OKD.

NOTE

This project is still underdevelopment.

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

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


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

podman-compose-0.1.4.tar.gz (13.8 kB view details)

Uploaded Source

Built Distribution

podman_compose-0.1.4-py2.py3-none-any.whl (20.7 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file podman-compose-0.1.4.tar.gz.

File metadata

  • Download URL: podman-compose-0.1.4.tar.gz
  • Upload date:
  • Size: 13.8 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.8.0 requests-toolbelt/0.9.1 tqdm/4.35.0 CPython/3.7.4

File hashes

Hashes for podman-compose-0.1.4.tar.gz
Algorithm Hash digest
SHA256 87302b9edc9cf2fba763833790f0d10b1dc7624c421663beb117e01d1bf80f88
MD5 ba33476dbc8ed0000000a108a0e67651
BLAKE2b-256 52c525767ee87a2288fb66fa3b1cdbda8d4a48be0d70230e52ed2f77da6b81d1

See more details on using hashes here.

File details

Details for the file podman_compose-0.1.4-py2.py3-none-any.whl.

File metadata

  • Download URL: podman_compose-0.1.4-py2.py3-none-any.whl
  • Upload date:
  • Size: 20.7 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.35.0 CPython/3.7.4

File hashes

Hashes for podman_compose-0.1.4-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 2c8dcd25d3202381c8f0ddcdf02b2bc8a67560027d9b13cebcbb12f86a71a24b
MD5 2f43157bcd1dcf88b395c8e9f9acbcd2
BLAKE2b-256 fcd95944a09f751cf7543480e89d7de64704f58ce6e5c25cdcbd785acefcf2ac

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page