Merge pull request #1279 from mokibit/add-volume-bind-create-host-path-option

Add volume bind `create_host_path` option

.codespellignore

@@ -0,0 +1 @@
+assertIn

.codespellrc

@@ -0,0 +1,4 @@
+[codespell]
+skip = .git,*.pdf,*.svg,requirements.txt,test-requirements.txt
+# poped - loved variable name
+ignore-words-list = poped

.coveragerc

@@ -0,0 +1,2 @@
+[run] 
+parallel=True

.editorconfig

@@ -0,0 +1,19 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = tab
+tab_width = 4
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+max_line_length = 100
+
+[*.{yml,yaml}]
+indent_style = space
+indent_size = 2
+
+[*.py]
+indent_style = space
+

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,52 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: bug
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+Please make sure it's not a bug in podman (in that case report it to podman)
+or your understanding of docker-compose or how rootless containers work (for example, it's normal for rootless container not to be able to listen for port less than 1024 like 80)
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. what is the content of the current working directory (ex. `docker-compose.yml`, `.env`, `Dockerfile`, ...etc.)
+2. what is the sequence of commands you typed
+
+please use [minimal reproducible example](https://stackoverflow.com/help/minimal-reproducible-example) for example give me a small busybox-based compose yaml
+
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Actual behavior**
+What is the behavior you actually got and that should not happen.
+
+
+**Output**
+
+```
+$ podman-compose version
+using podman version: 3.4.0
+podman-compose version  0.1.7dev
+podman --version 
+podman version 3.4.0
+
+$ podman-compose up
+...
+
+```
+
+**Environment:**
+ - OS: Linux / WSL / Mac
+ - podman version: 
+ - podman compose version: (git hex)
+
+**Additional context**
+
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: enhancement
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,10 @@
+
+## Contributor Checklist:
+
+If this PR adds a new feature that improves compatibility with docker-compose, please add a link
+to the exact part of compose spec that the PR touches.
+
+For any user-visible change please add a release note to newsfragments directory, e.g.
+newsfragments/my_feature.feature. See newsfragments/README.md for more details.
+
+All changes require additional unit tests.

.github/dependabot.yml

@@ -0,0 +1,6 @@
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"

.github/workflows/codespell.yml

@@ -0,0 +1,22 @@
+---
+name: Codespell
+
+on:
+  push:
+  pull_request:
+
+permissions:
+  contents: read
+
+jobs:
+  codespell:
+    name: Check for spelling errors
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Codespell
+        uses: codespell-project/actions-codespell@v2
+        with:
+            ignore_words_file: .codespellignore

.github/workflows/release.yml

@@ -0,0 +1,27 @@
+name: Build and Release
+
+on:
+  push:
+    tags:
+      - 'v*.*.*'
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Build binary
+        run: |
+          mkdir -p release/
+          docker build -t podman-compose-bin -v "$PWD/release:/result" .
+          mv "$PWD/release/podman-compose" "$PWD/release/podman-compose-linux-x86"
+
+      - name: Upload release asset
+        uses: softprops/action-gh-release@v2
+        with:
+          files: ./release/podman-compose-linux-x86
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/static-checks.yml

@@ -0,0 +1,32 @@
+name: Static checks
+
+on:
+- push
+- pull_request
+
+jobs:
+  static-checks:
+    runs-on: ubuntu-latest
+    container:
+      image: docker.io/library/python:3.11-bookworm
+      # cgroupns needed to address the following error:
+      # write /sys/fs/cgroup/cgroup.subtree_control: operation not supported
+      options: --privileged --cgroupns=host
+    steps:
+    - uses: actions/checkout@v4
+    - name: Install dependencies
+      run: |
+        set -e
+        pip install -r test-requirements.txt
+    - name: Analysing the code using ruff
+      run: |
+        set -e
+        ruff format --check
+        ruff check
+    - name: Analysing the code using mypy
+      run: |
+        set -e
+        mypy .
+    - name: Analysing the code with pylint
+      run: |
+        pylint podman_compose.py

.github/workflows/test.yml

@@ -0,0 +1,40 @@
+name: Tests
+
+on:
+  push:
+  pull_request:
+
+jobs:
+  test:
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: [ '3.9', '3.10', '3.11', '3.12', '3.13' ]
+
+    runs-on: ubuntu-latest
+    container:
+      image: "docker.io/library/python:${{ matrix.python-version }}-bookworm"
+      # cgroupns needed to address the following error:
+      # write /sys/fs/cgroup/cgroup.subtree_control: operation not supported
+      options: --privileged --cgroupns=host
+    steps:
+    - uses: actions/checkout@v4
+    - name: Install dependencies
+      run: |
+        set -e
+        apt-get update && DEBIAN_FRONTEND=noninteractive apt-get install -y podman
+        python -m pip install --upgrade pip
+        pip install -r requirements.txt
+        pip install -r test-requirements.txt
+    - name: Run integration tests
+      run: |
+        python -m unittest discover -v tests/integration
+      env:
+        TESTS_DEBUG: 1
+    - name: Run unit tests
+      run: |
+        coverage run --source podman_compose -m unittest discover tests/unit
+    - name: Report coverage
+      run: |
+        coverage combine
+        coverage report --format=markdown | tee -a $GITHUB_STEP_SUMMARY

.gitignore

@@ -47,6 +47,8 @@ coverage.xml
 *.cover
 .hypothesis/
 .pytest_cache/
+test-compose.yaml
+test-compose-?.yaml
 
 # Translations
 *.mo
@@ -103,3 +105,6 @@ venv.bak/
 
 # mypy
 .mypy_cache/
+
+
+.vscode

.pre-commit-config.yaml

@@ -0,0 +1,34 @@
+default_install_hook_types: [pre-commit, commit-msg]
+repos:
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.9.6
+    hooks:
+      - id: ruff
+        types: [python]
+  - repo: https://github.com/pycqa/flake8
+    rev: 6.0.0
+    hooks:
+      - id: flake8
+        types: [python]
+  - repo: local
+    hooks:
+      - id: pylint
+        name: pylint
+        entry: pylint
+        language: system
+        types: [python]
+        args:
+          [
+            "-rn", # Only display messages
+            "-sn", # Don't display the score
+            "--rcfile=.pylintrc", # Link to your config file
+          ]
+  - repo: https://github.com/codespell-project/codespell
+    rev: v2.2.5
+    hooks:
+    - id: codespell
+
+  - repo: https://github.com/gklein/check_signoff
+    rev: v1.0.5
+    hooks:
+      - id: check-signoff

.pylintrc

@@ -1,13 +1,18 @@
 [MESSAGES CONTROL]
-disable=W0614,C0410,C0321,C0111,I0011,C0103
+# C0111 missing-docstring: missing-class-docstring, missing-function-docstring, missing-method-docstring, missing-module-docstrin
+# consider-using-with: we need it for color formatter pipe
+disable=too-many-lines,too-many-branches,too-many-locals,too-many-statements,too-many-arguments,too-many-instance-attributes,fixme,multiple-statements,missing-docstring,line-too-long,consider-using-f-string,consider-using-with,unnecessary-lambda-assignment,broad-exception-caught
 # allow _ for ignored variables
 # allow generic names like a,b,c and i,j,k,l,m,n and x,y,z
 # allow k,v for key/value
-# allow e for exceptions, it for iterator
+# allow e for exceptions, it for iterator, ix for index
+# allow ip for ip address
 # allow w,h for width, height
 # allow op for operation/operator/opcode
 # allow t, t0, t1, t2, and t3 for time
 # allow dt for delta time
 # allow db for database
 # allow ls for list
-good-names=_,a,b,c,dt,db,e,f,fn,fd,i,j,k,v,kv,kw,l,m,n,ls,t,t0,t1,t2,t3,w,h,x,y,z,it,op
+# allow p for pipe
+# allow ex for examples, exists ..etc
+good-names=_,a,b,c,dt,db,e,f,fn,fd,i,j,k,v,kv,kw,l,m,n,ls,t,t0,t1,t2,t3,w,h,x,y,z,it,ix,ip,op,p,ex

CODE-OF-CONDUCT.md

@@ -0,0 +1,3 @@
+## The Podman Compose Project Community Code of Conduct
+
+The Podman Compose project follows the [Containers Community Code of Conduct](https://github.com/containers/common/blob/master/CODE-OF-CONDUCT.md).

CONTRIBUTING.md

@@ -1,74 +1,152 @@
 # Contributing to podman-compose
 
+## Who can contribute?
+
+- Users that found a bug,
+- Users that want to propose new functionalities or enhancements,
+- Users that want to help other users to troubleshoot their environments,
+- Developers that want to fix bugs,
+- Developers that want to implement new functionalities or enhancements.
+
+## Development environment setup
+
+Note: Some steps are OPTIONAL but all are RECOMMENDED.
+
+1. Fork the project repository and clone it:
+
+   ```shell
+   $ git clone https://github.com/USERNAME/podman-compose.git
+   $ cd podman-compose
+   ```
+
+2. (OPTIONAL) Create a Python virtual environment. Example using python builtin
+   `venv` module:
+
+    ```shell
+    $ python3 -m venv .venv
+    $ . .venv/bin/activate
+    ```
+
+3. Install the project runtime and development requirements:
+
+   ```shell
+   $ pip install '.[devel]'
+   ```
+
+4. (OPTIONAL) Install `pre-commit` git hook scripts
+   (https://pre-commit.com/#3-install-the-git-hook-scripts):
+
+   ```shell
+   $ pre-commit install
+   ```
+
+5. Create a new branch, develop and add tests when possible.
+6. Run linting and testing before committing code. Ensure all the hooks are passing.
+
+   ```shell
+   $ pre-commit run --all-files
+   ```
+
+7. Run code coverage:
+
+    ```shell
+    $ coverage run --source podman_compose -m unittest discover tests/unit
+    $ python3 -m unittest discover tests/integration
+    $ coverage combine
+    $ coverage report
+    $ coverage html
+    ```
+
+8. Commit your code to your fork's branch.
+   - Make sure you include a `Signed-off-by` message in your commits.
+     Read [this guide](https://github.com/containers/common/blob/main/CONTRIBUTING.md#sign-your-prs)
+     to learn how to sign your commits.
+   - In the commit message body, reference the Issue ID that your code fixes and a brief description of the changes.
+     Example:
+     ```
+     Allow empty network
+
+     <description, such as links to the compose spec and so on>
+
+     Fixes https://github.com/containers/podman-compose/issues/516
+     ```
+   - If your commit requires a refactoring, first do the refactoring and
+     commit it separately before starting feature work. This makes the
+     pull request easier to review. Additionally, pull request will be
+     less risky, because if it breaks something, it's way easier to
+     isolate the offending code, understand what's broken and fix it.
+     Due to the latter reason it's best to commit in as many independent
+     commits as reasonable.
+
+     This will result in pull requests being merged much faster.
+
+9. Open a pull request to `containers/podman-compose` and wait for a maintainer to review your work.
+
 ## Adding new commands
 
-To add a command you need to add a function that is decorated
-with `@cmd_run` passing the compose instance, command name and
-description. the wrapped function should accept two arguments
-the compose instance and the command-specific arguments (resulted
-from python's `argparse` package) inside that command you can
-run PodMan like this `compose.podman.run(['inspect', 'something'])`
-and inside that function you can access `compose.pods`
-and `compose.containers` ...etc.
-Here is an example
+To add a command, you need to add a function that is decorated with `@cmd_run`.
 
-```
+The decorated function must be declared `async` and should accept two arguments: The compose
+instance and the command-specific arguments (resulted from the Python's `argparse` package).
+
+In this function, you can run Podman (e.g. `await compose.podman.run(['inspect', 'something'])`),
+access `compose.pods`, `compose.containers` etc.
+
+Here is an example:
+
+```python
 @cmd_run(podman_compose, 'build', 'build images defined in the stack')
-def compose_build(compose, args):
-    compose.podman.run(['build', 'something'])
+async def compose_build(compose, args):
+    await compose.podman.run(['build', 'something'])
 ```
 
 ## Command arguments parsing
 
-Add a function that accept `parser` which is an instance from `argparse`.
-In side that function you can call `parser.add_argument()`.
-The function decorated with `@cmd_parse` accepting the compose instance,
-and command names (as a list or as a string).
-You can do this multiple times. 
+To add arguments to be parsed by a command, you need to add a function that is decorated with
+`@cmd_parse` which accepts the compose instance and the command's name (as a string list or as a
+single string).
 
-Here is an example
+The decorated function should accept a single argument: An instance of `argparse`.
 
-```
+In this function, you can call `parser.add_argument()` to add a new argument to the command.
+
+Note you can add such a function multiple times.
+
+Here is an example:
+
+```python
 @cmd_parse(podman_compose, 'build')
 def compose_build_parse(parser):
     parser.add_argument("--pull",
         help="attempt to pull a newer version of the image", action='store_true')
     parser.add_argument("--pull-always",
-        help="attempt to pull a newer version of the image, Raise an error even if the image is present locally.", action='store_true')
+        help="Attempt to pull a newer version of the image, "
+             "raise an error even if the image is present locally.",
+        action='store_true')
 ```
 
-NOTE: `@cmd_parse` should be after `@cmd_run`
+NOTE: `@cmd_parse` should be after `@cmd_run`.
 
-## Calling a command from inside another
+## Calling a command from another one
 
-If you need to call `podman-compose down` from inside `podman-compose up`
-do something like:
+If you need to call `podman-compose down` from `podman-compose up`, do something like:
 
-```
+```python
 @cmd_run(podman_compose, 'up', 'up desc')
-def compose_up(compose, args):
-    compose.commands['down'](compose, args)
+async def compose_up(compose, args):
+    await compose.commands['down'](compose, args)
     # or
-    compose.commands['down'](argparse.Namespace(foo=123))
+    await compose.commands['down'](argparse.Namespace(foo=123))
 ```
 
-
 ## Missing Commands (help needed)
 
+```
   bundle             Generate a Docker bundle from the Compose file
-  config             Validate and view the Compose file
   create             Create services
   events             Receive real time events from containers
-  exec               Execute a command in a running container
   images             List images
-  kill               Kill containers
-  logs               View output from containers
-  pause              Pause services
-  port               Print the public port for a port binding
-  ps                 List containers
   rm                 Remove stopped containers
-  run                Run a one-off command
   scale              Set number of containers for a service
   top                Display the running processes
-  unpause            Unpause services
-  version            Show the Docker-Compose version information
+```

Dockerfile

@@ -0,0 +1,30 @@
+# Use a base image with necessary build tools
+FROM python:3.11-slim AS builder
+
+# Install required packages for building
+RUN apt-get update && apt-get install -y \
+    gcc \
+    musl-dev \
+    build-essential \
+    python3-dev \
+    && apt-get clean \
+    && rm -rf /var/lib/apt/lists/*
+
+# Set the working directory
+WORKDIR /app
+
+# Copy the application code
+COPY . .
+
+# Install PyInstaller
+RUN pip install pyinstaller
+RUN pip install -r requirements.txt
+
+# Create a binary with PyInstaller
+RUN pyinstaller --onefile --clean podman_compose.py
+
+# Create /result dir in case it is not mounted
+RUN mkdir -p /result
+
+# Export binary
+RUN cp /app/dist/podman_compose /result/podman-compose

README.md

@@ -1,34 +1,62 @@
 # Podman Compose
+## [![Tests](https://github.com/containers/podman-compose/actions/workflows/test.yml/badge.svg)](https://github.com/containers/podman-compose/actions/workflows/test.yml)
 
-An implementation of `docker-compose` with [podman](https://podman.io/) 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:
+An implementation of [Compose Spec](https://compose-spec.io/) with [Podman](https://podman.io/) backend.
+This project focuses on:
 
-- can run rootless
-- only depend on `podman` and Python3 and [PyYAML](https://pyyaml.org/)
-- no daemon, no setup.
-- can be used by developers to run single-machine containerized stacks using single familiar YAML file
+* rootless
+* daemon-less process model, we directly execute podman, no running daemon.
+
+This project only depends on:
+
+* `podman`
+* [podman dnsname plugin](https://github.com/containers/dnsname): 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. This is not necessary when podman is using
+  netavark as a network backend.
+* Python3
+* [PyYAML](https://pyyaml.org/)
+* [python-dotenv](https://pypi.org/project/python-dotenv/)
+
+And it's formed as a single Python file script that you can drop into your PATH and run.
+
+## References:
+
+* [spec.md](https://github.com/compose-spec/compose-spec/blob/master/spec.md)
+* [docker-compose compose-file-v3](https://docs.docker.com/compose/compose-file/compose-file-v3/)
+* [docker-compose compose-file-v2](https://docs.docker.com/compose/compose-file/compose-file-v2/)
+
+## Alternatives
+
+As in [this article](https://fedoramagazine.org/use-docker-compose-with-podman-to-orchestrate-containers-on-fedora/) 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
 
 - [k3s](https://k3s.io) | [k3s github](https://github.com/rancher/k3s)
 - [MiniKube](https://minikube.sigs.k8s.io/)
-- [MiniShift](https://www.okd.io/minishift/)
-
 
 For the real thing (multi-node clusters) check any production
-OpenShift/Kubernetes distribution like [OKD](https://www.okd.io/minishift/).
+OpenShift/Kubernetes distribution like [OKD](https://www.okd.io/).
 
-## NOTE
+## 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.
 
-This project is still underdevelopment.
 
 ## Installation
 
-Install latest stable version from PyPI:
+### Pip
 
-```
+Install the latest stable version from PyPI:
+
+```bash
 pip3 install podman-compose
 ```
 
@@ -36,60 +64,68 @@ 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
+```bash
+pip3 install https://github.com/containers/podman-compose/archive/main.tar.gz
 ```
 
-or
+### Package repositories
 
+podman-compose is available from the following package repositories:
+
+Debian:
+
+```bash
+sudo apt install podman-compose
 ```
-curl -o /usr/local/bin/podman-compose https://raw.githubusercontent.com/containers/podman-compose/devel/podman_compose.py
+
+Fedora (starting from f31) repositories:
+
+```bash
+sudo dnf install podman-compose
+```
+
+Homebrew:
+
+```bash
+brew install podman-compose
+```
+
+### Generate binary using docker/podman locally
+This script will download the repo, generate the binary using [this Dockerfile](https://github.com/containers/podman-compose/blob/main/Dockerfile), and place the binary in the directory where you called this script.
+```bash
+sh -c "$(curl -sSL https://raw.githubusercontent.com/containers/podman-compose/main/scripts/download_and_build_podman-compose.sh)"
+```
+
+### Manual
+
+```bash
+curl -o /usr/local/bin/podman-compose https://raw.githubusercontent.com/containers/podman-compose/main/podman_compose.py
 chmod +x /usr/local/bin/podman-compose
 ```
 
-or 
+or inside your home
 
-```
-curl -o ~/.local/bin/podman-compose https://raw.githubusercontent.com/containers/podman-compose/devel/podman_compose.py
+```bash
+curl -o ~/.local/bin/podman-compose https://raw.githubusercontent.com/containers/podman-compose/main/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](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
+podman-compose is tested via unit and integration tests.
 
-## How it works
+Unit tests can be run via the following:
 
-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](docs/Mappings.md).
+```shell
+python3 -m unittest discover tests/unit
+```
 
-If you are running as root, you might use identity mapping.
+Integration tests can be run via the following:
 
+```shell
+python3 -m unittest discover tests/integration
+```
+
+# Contributing guide
+
+If you are a user or a developer and want to contribute please check the [CONTRIBUTING](CONTRIBUTING.md) section

RELEASING.md

@@ -0,0 +1,63 @@
+Creating a release
+==================
+
+This file contains instructions for maintainers on how to release new versions of podman-compose.
+
+Step 1: Initialize variables for subsequent steps
+-------------------------------------------------
+
+```
+export VERSION=1.2.3
+```
+
+Step 2: Release notes PR
+------------------------
+
+Open a new branch (e.g. `release`) and run the following:
+
+```
+./scripts/make_release_notes.sh $VERSION
+```
+
+This collects the release notes using the `towncrier` tool and then commits the result.
+This step is done as a PR so that CI can check for spelling errors and similar issues.
+
+Certain file names are not properly supported by the `towncrier` tool and it ignores them.
+Check `newsfragments` directory for any forgotten release notes
+
+Step 3: Merge the release notes PR
+----------------------------------
+
+Step 4: Perform actual release
+------------------------------
+
+Pull the merge commit created on the `main` branch during the step 2.
+Then run:
+
+```
+./scripts/make_release.sh $VERSION
+```
+
+This will create release commit, tag and push everything.
+
+Step 5: Create a release on Github
+----------------------------------
+
+The release notes must be added manually by drafting a release on the GitHub UI at
+https://github.com/containers/podman-compose/releases.
+
+Step 6: Upload to Pypi
+----------------------
+
+Run the following command to build artifacts:
+
+```
+rm -rf build dist
+python3 -m build
+```
+
+Upload to Pypi
+
+```
+python3 -m twine upload dist/*
+```

SECURITY.md

@@ -0,0 +1,3 @@
+## Security and Disclosure Information Policy for the Podman Compose Project
+
+The Podman Compose Project follows the [Security and Disclosure Information Policy](https://github.com/containers/common/blob/master/SECURITY.md) for the Containers Projects.

completion/bash/podman-compose

@@ -0,0 +1,411 @@
+# Naming convention:
+# * _camelCase for function names
+# * snake_case for variable names
+
+# all functions will return 0 if they successfully complete the argument
+# (or establish there is no need or no way to complete), and something
+# other than 0 if that's not the case
+
+# complete arguments to global options
+_completeGlobalOptArgs() {
+    # arguments to options that take paths as arguments: complete paths
+    for el in ${path_arg_global_opts}; do
+        if [[ ${prev} == ${el} ]]; then
+            COMPREPLY=( $(compgen -f -- ${cur}) )
+            return 0
+        fi
+    done
+
+    # arguments to options that take generic arguments: don't complete
+    for el in ${generic_arg_global_opts}; do
+        if [[ ${prev} == ${el} ]]; then
+            return 0
+        fi
+    done
+    return 1
+}
+
+# complete root subcommands and options
+_completeRoot() {
+    # if we're completing an option
+    if [[ ${cur} == -* ]]; then
+        COMPREPLY=( $(compgen -W "${global_opts}" -- ${cur}) )
+        return 0
+    fi
+    # complete root commands
+    COMPREPLY=( $(compgen -W "${root_commands}" -- ${cur}) )
+    return 0
+}
+
+# complete names of Compose services
+_completeServiceNames() {
+    # ideally we should complete service names,
+    # but parsing the compose spec file in the
+    # completion script is quite complex
+    return 0
+}
+
+# complete commands to run inside containers
+_completeCommand() {
+    # we would need to complete commands to run inside
+    # a container
+    return 0
+}
+
+
+# complete the arguments for `podman-compose up` and return 0
+_completeUpArgs() {
+    up_opts="${help_opts} -d --detach --no-color --quiet-pull --no-deps --force-recreate --always-recreate-deps --no-recreate --no-build --no-start --build --abort-on-container-exit -t --timeout -V --renew-anon-volumes --remove-orphans --scale --exit-code-from --pull --pull-always --build-arg --no-cache"
+    if [[ ${prev} == "--scale" || ${prev} == "-t" || ${prev} == "--timeout" ]]; then
+        return 0
+    elif [[ ${cur} == -* ]]; then
+        COMPREPLY=( $(compgen -W "${up_opts}" -- ${cur}) )
+        return 0
+    else
+        _completeServiceNames
+        if [[ $? -eq 0 ]]; then
+            return 0
+        fi
+        return 0
+    fi
+
+}
+
+# complete the arguments for `podman-compose exec` and return 0
+_completeExecArgs() {
+    exec_opts="${help_opts} -d --detach --privileged -u --user -T --index -e --env -w --workdir"
+    if [[ ${prev} == "-u" || ${prev} == "--user" || ${prev} == "--index" || ${prev} == "-e" || ${prev} == "--env" || ${prev} == "-w" || ${prev} == "--workdir" ]]; then
+        return 0
+    elif [[ ${cur} == -* ]]; then
+        COMPREPLY=( $(compgen -W "${exec_opts}" -- ${cur}) )
+        return 0
+    elif [[ ${comp_cword_adj} -eq 2 ]]; then
+        # complete service name
+        _completeServiceNames
+        if [[ $? -eq 0 ]]; then
+            return 0
+        fi
+    elif [[ ${comp_cword_adj} -eq 3 ]]; then
+        _completeCommand
+        if [[ $? -eq 0 ]]; then
+            return 0
+        fi
+        return 0
+    fi
+
+}
+
+
+# complete the arguments for `podman-compose down` and return 0
+_completeDownArgs() {
+    down_opts="${help_opts} -v --volumes -t --timeout --remove-orphans"
+    if [[ ${prev} == "-t" || ${prev} == "--timeout" ]]; then
+        return 0
+    elif [[ ${cur} == -* ]]; then
+        COMPREPLY=( $(compgen -W "${down_opts}" -- ${cur}) )
+        return 0
+    else
+        _completeServiceNames
+        if [[ $? -eq 0 ]]; then
+            return 0
+        fi
+        return 0
+    fi
+
+}
+
+
+# complete the arguments for `podman-compose build` and return 0
+_completeBuildArgs() {
+    build_opts="${help_opts} --pull --pull-always --build-arg --no-cache"
+    if [[ ${prev} == "--build-arg" ]]; then
+        return 0
+    elif [[ ${cur} == -* ]]; then
+        COMPREPLY=( $(compgen -W "${build_opts}" -- ${cur}) )
+        return 0
+    else
+        _completeServiceNames
+        if [[ $? -eq 0 ]]; then
+            return 0
+        fi
+        return 0
+    fi
+}
+
+# complete the arguments for `podman-compose logs` and return 0
+_completeLogsArgs() {
+    logs_opts="${help_opts} -f --follow -l --latest -n --names --since -t --timestamps --tail --until"
+    if [[ ${prev} == "--since" || ${prev} == "--tail" || ${prev} == "--until" ]]; then
+        return 0
+    elif [[ ${cur} == -* ]]; then
+        COMPREPLY=( $(compgen -W "${logs_opts}" -- ${cur}) )
+        return 0
+    else
+        _completeServiceNames
+        if [[ $? -eq 0 ]]; then
+            return 0
+        fi
+        return 0
+    fi
+}
+
+# complete the arguments for `podman-compose ps` and return 0
+_completePsArgs() {
+    ps_opts="${help_opts} -q --quiet"
+    if [[ ${cur} == -* ]]; then
+        COMPREPLY=( $(compgen -W "${ps_opts}" -- ${cur}) )
+        return 0
+    else
+        return 0
+    fi
+}
+
+# complete the arguments for `podman-compose pull` and return 0
+_completePullArgs() {
+    pull_opts="${help_opts} --force-local"
+    if [[ ${cur} == -* ]]; then
+        COMPREPLY=( $(compgen -W "${pull_opts}" -- ${cur}) )
+        return 0
+    else
+        return 0
+    fi
+}
+
+# complete the arguments for `podman-compose push` and return 0
+_completePushArgs() {
+    push_opts="${help_opts} --ignore-push-failures"
+    if [[ ${cur} == -* ]]; then
+        COMPREPLY=( $(compgen -W "${push_opts}" -- ${cur}) )
+        return 0
+    else
+        _completeServiceNames
+        if [[ $? -eq 0 ]]; then
+            return 0
+        fi
+        return 0
+    fi
+}
+
+# complete the arguments for `podman-compose restart` and return 0
+_completeRestartArgs() {
+    restart_opts="${help_opts} -t --timeout"
+    if [[ ${prev} == "-t" || ${prev} == "--timeout" ]]; then
+        return 0
+    elif [[ ${cur} == -* ]]; then
+        COMPREPLY=( $(compgen -W "${restart_opts}" -- ${cur}) )
+        return 0
+    else
+        _completeServiceNames
+        if [[ $? -eq 0 ]]; then
+            return 0
+        fi
+        return 0
+    fi
+}
+
+# complete the arguments for `podman-compose stop` and return 0
+_completeStopArgs() {
+    stop_opts="${help_opts} -t --timeout"
+    if [[ ${prev} == "-t" || ${prev} == "--timeout" ]]; then
+        return 0
+    elif [[ ${cur} == -* ]]; then
+        COMPREPLY=( $(compgen -W "${stop_opts}" -- ${cur}) )
+        return 0
+    else
+        _completeServiceNames
+        if [[ $? -eq 0 ]]; then
+            return 0
+        fi
+        return 0
+    fi
+}
+
+# complete the arguments for `podman-compose start` and return 0
+_completeStartArgs() {
+    start_opts="${help_opts}"
+    if [[ ${cur} == -* ]]; then
+        COMPREPLY=( $(compgen -W "${start_opts}" -- ${cur}) )
+        return 0
+    else
+        _completeServiceNames
+        if [[ $? -eq 0 ]]; then
+            return 0
+        fi
+        return 0
+    fi
+}
+
+# complete the arguments for `podman-compose run` and return 0
+_completeRunArgs() {
+    run_opts="${help_opts} -d --detach --privileged -u --user -T --index -e --env -w --workdir"
+    if [[ ${prev} == "-u" || ${prev} == "--user" || ${prev} == "--index" || ${prev} == "-e" || ${prev} == "--env" || ${prev} == "-w" || ${prev} == "--workdir" ]]; then
+        return 0
+    elif  [[ ${cur} == -* ]]; then
+        COMPREPLY=( $(compgen -W "${run_opts}" -- ${cur}) )
+        return 0
+    elif [[ ${comp_cword_adj} -eq 2 ]]; then
+        # complete service name
+        _completeServiceNames
+        if [[ $? -eq 0 ]]; then
+            return 0
+        fi
+    elif [[ ${comp_cword_adj} -eq 3 ]]; then
+        _completeCommand
+        if [[ $? -eq 0 ]]; then
+            return 0
+        fi
+    fi
+}
+
+
+_podmanCompose() {
+    cur="${COMP_WORDS[COMP_CWORD]}"
+	prev="${COMP_WORDS[COMP_CWORD-1]}"
+    root_commands="help version pull push build up down ps run exec start stop restart logs"
+
+    # options to output help text (used as global and subcommand options)
+    help_opts="-h --help"
+
+    # global options that don't take additional arguments
+    basic_global_opts="${help_opts} -v --no-ansi --no-cleanup --dry-run" 
+
+    # global options that take paths as arguments
+    path_arg_global_opts="-f --file --podman-path"
+    path_arg_global_opts_array=($arg_global_opts)
+
+    # global options that take arguments that are not files
+    generic_arg_global_opts="-p --project-name --podman-path --podman-args --podman-pull-args --podman-push-args --podman-build-args --podman-inspect-args --podman-run-args --podman-start-args --podman-stop-args --podman-rm-args --podman-volume-args"
+    generic_arg_global_opts_array=($generic_arg_global_opts)
+
+    # all global options that take arguments
+    arg_global_opts="${path_arg_global_opts} ${generic_arg_global_opts}"
+    arg_global_opts_array=($arg_global_opts)
+
+    # all global options
+    global_opts="${basic_global_opts} ${arg_global_opts}"
+
+    chosen_root_command=""
+
+
+    _completeGlobalOptArgs
+    if [[ $? -eq 0 ]]; then
+        return 0
+    fi
+   
+    # computing comp_cword_adj, which thruthfully tells us how deep in the subcommands tree we are
+    # additionally, set the chosen_root_command if possible
+    comp_cword_adj=${COMP_CWORD}
+    if [[ ${COMP_CWORD} -ge 2 ]]; then
+        skip_next="no"
+        for el in ${COMP_WORDS[@]}; do
+            # if the user has asked for help text there's no need to complete further
+            if [[ ${el} == "-h" || ${el} == "--help" ]]; then
+                return 0
+            fi
+            if [[ ${skip_next} == "yes" ]]; then
+                let "comp_cword_adj--"
+                skip_next="no"
+                continue
+            fi
+            if [[ ${el} == -* && ${el} != ${cur} ]]; then
+                let "comp_cword_adj--"
+                
+                for opt in ${arg_global_opts_array[@]}; do
+                    if [[ ${el} == ${opt} ]]; then
+                        skip_next="yes"
+                    fi
+                done
+            elif [[ ${el} != ${cur} && ${el} != ${COMP_WORDS[0]} && ${chosen_root_command} == "" ]]; then
+                chosen_root_command=${el}
+            fi
+        done
+    fi
+    
+    if [[ ${comp_cword_adj} -eq 1 ]]; then
+       _completeRoot
+
+       # Given that we check the value of comp_cword_adj outside
+       # of it, at the moment _completeRoot should always return
+       # 0, this is just here in case changes are made. The same
+       # will apply to similar functions below
+        if [[ $? -eq 0 ]]; then
+            return 0
+        fi
+    fi
+    case $chosen_root_command in
+        up)
+            _completeUpArgs
+            if [[ $? -eq 0 ]]; then
+                return 0
+            fi
+            ;;
+        down)
+            _completeDownArgs
+            if [[ $? -eq 0 ]]; then
+                return 0
+            fi
+            ;;
+        exec)
+            _completeExecArgs
+            if [[ $? -eq 0 ]]; then
+                return 0
+            fi
+            ;;
+        build)
+            _completeBuildArgs
+            if [[ $? -eq 0 ]]; then
+                return 0
+            fi
+            ;;
+        logs)
+            _completeLogsArgs
+            if [[ $? -eq 0 ]]; then
+                return 0
+            fi
+            ;;
+        ps)
+            _completePsArgs
+            if [[ $? -eq 0 ]]; then
+                return 0
+            fi
+            ;;
+        pull)
+            _completePullArgs
+            if [[ $? -eq 0 ]]; then
+                return 0
+            fi
+            ;;
+        push)
+            _completePushArgs
+            if [[ $? -eq 0 ]]; then
+                return 0
+            fi
+            ;;
+        restart)
+            _completeRestartArgs
+            if [[ $? -eq 0 ]]; then
+                return 0
+            fi
+            ;;
+        start)
+            _completeStartArgs
+            if [[ $? -eq 0 ]]; then
+                return 0
+            fi
+            ;;
+        stop)
+            _completeStopArgs
+            if [[ $? -eq 0 ]]; then
+                return 0
+            fi
+            ;;
+        run)
+            _completeRunArgs
+            if [[ $? -eq 0 ]]; then
+                return 0
+            fi
+            ;;
+    esac
+}
+
+complete -F _podmanCompose podman-compose

docs/Changelog-1.1.0.md

@@ -0,0 +1,33 @@
+Version v1.1.0 (2024-04-17)
+===========================
+
+Bug fixes
+---------
+
+- Fixed support for values with equals sign in `-e` argument of `run` and `exec` commands.
+- Fixed duplicate arguments being emitted in `stop` and `restart` commands.
+- Removed extraneous debug output. `--verbose` flag has been added to preserve verbose output.
+- Links aliases are now added to service aliases.
+- Fixed image build process to use defined environmental variables.
+- Empty list is now allowed to be `COMMAND` and `ENTRYPOINT`.
+- Environment files are now resolved relative to current working directory.
+- Exit code of container build is now preserved as return code of `build` command.
+
+New features
+------------
+
+- Added support for `uidmap`, `gidmap`, `http_proxy` and `runtime` service configuration keys.
+- Added support for `enable_ipv6` network configuration key.
+- Added `--parallel` option to support parallel pulling and building of images.
+- Implemented support for maps in `sysctls` container configuration key.
+- Implemented `stats` command.
+- Added `--no-normalize` flag to `config` command.
+- Added support for `include` global configuration key.
+- Added support for `build` command.
+- Added support to start containers with multiple networks.
+- Added support for `profile` argument.
+- Added support for starting podman in existing network namespace.
+- Added IPAM driver support. 
+- Added support for file secrets being passed to `podman build` via `--secret` argument.
+- Added support for multiple networks with separately specified IP and MAC address.
+- Added support for `service.build.ulimits` when building image.

docs/Changelog-1.2.0.md

@@ -0,0 +1,40 @@
+Version v1.2.0 (2024-06-26)
+===========================
+
+Bug fixes
+---------
+
+- Fixed handling of `--in-pod` argument. Previously it was hard to provide false value to it.
+- podman-compose no longer creates pods when registering systemd unit.
+- Fixed warning `RuntimeWarning: coroutine 'create_pods' was never awaited`
+- Fixed error when setting up IPAM network with default driver.
+- Fixed support for having list and dictionary `depends_on` sections in related compose files.
+- Fixed logging of failed build message.
+- Fixed support for multiple entries in `include` section.
+- Fixed environment variable precedence order.
+
+Changes
+-------
+
+- `x-podman` dictionary in container root has been migrated to `x-podman.*` fields in container root.
+
+New features
+------------
+
+- Added support for `--publish` in `podman-compose run`.
+- Added support for Podman external root filesystem management (`--rootfs` option).
+- Added support for `podman-compose images` command.
+- Added support for `env_file` being configured via dictionaries.
+- Added support for enabling GPU access.
+- Added support for selinux in verbose mount specification.
+- Added support for `additional_contexts` section.
+- Added support for multi-line environment files.
+- Added support for passing contents of `podman-compose.yml` via stdin.
+- Added support for specifying the value for `--in-pod` setting in `podman-compose.yml` file.
+- Added support for environmental secrets.
+
+Documentation
+-------------
+
+- Added instructions on how to install podman-compose on Homebrew.
+- Added explanation that netavark is an alternative to dnsname plugin

docs/Changelog-1.3.0.md

@@ -0,0 +1,38 @@
+Version 1.3.0 (2025-01-07)
+==========================
+
+Bug fixes
+---------
+
+- Fixed support for de-facto alternative `Dockerfile` names (e.g. `Containerfile`)
+- Fixed a bug that caused attempts to create already existing pods multiple times.
+- Fixed compatibility with docker-compose in how symlinks to docker-compose.yml are handled.
+- Fixed freeze caused by too long log lines without a newline.
+- Fixed support for `network_mode: none`.
+- Improved error detection by rejecting service definitions that contain both `network_mode` and
+  `networks` keys, which is not allowed.
+
+
+Features
+--------
+
+- Added support for build labels.
+- Added support for "platform" property in the build command.
+- Added support for "ssh" property in the build command.
+- Added support for cache_from and cache_to fields in build section.
+- Added support for honoring the condition in the depends_on section of the service, if stated.
+- Added `x-podman.no_hosts` setting to pass `--no-hosts` to podman run
+- Added support for compatibility with docker compose for default network behavior when no network
+  defined in service. This is controlled via `default_net_behavior_compat` feature flag.
+- Added a way to get compatibility of default network names with docker compose.
+  This is selected by setting `default_net_name_compat: true` on `x-podman` global dictionary.
+- Added support for the `device_cgroup_rules` property in services.
+- Added support for removing networks in `podman-compose down`.
+- Added support for network scoped service aliases.
+- Added support for network level `mac_address` attribute.
+- Added ability to substitute variables with the environment of the service.
+
+Misc
+----
+
+- Declared compatibility with Python 3.13.

docs/Changelog-1.4.0.md

@@ -0,0 +1,39 @@
+Version 1.4.0 (2025-05-10)
+==========================
+
+Bug fixes
+---------
+
+- Fixed handling of relative includes and extends in compose files
+- Fixed error when merging arguments in list and dictionary syntax
+- Fixed issue where short-lived containers could execute twice when using `up` in detached mode
+- Fixed `up` command hanging on Podman versions earlier than 4.6.0
+- Fixed issue where `service_healthy` conditions weren't enforced during `up` command
+- Fixed support for the `--scale` flag
+- Fixed bug causing dependent containers to start despite `--no-deps` flag
+- Fixed port command behavior for dynamic host ports
+- Fixed interpolation of `COMPOSE_PROJECT_NAME` when set from top-level `name` in compose file
+- Fixed project name evaluation order to match compose spec
+- Fixed build context when using git URLs
+- Fixed `KeyError` when `down` is called with non-existent service
+- Skip `down` during `up` when no active containers exist
+- Fixed non-zero exit code on failure when using `up -d`
+- Fixed SIGINT handling during `up` command for graceful shutdown
+- Fixed `NotImplementedError` when interrupted on Windows
+
+Features
+--------
+
+- Added `--quiet` flag to `config` command to suppress output
+- Added support for `pids_limit` and `deploy.resources.limits.pids`
+- Added `--abort-on-container-failure` option
+- Added `--rmi` argument to `down` command for image removal
+- Added support for `x-podman.disable-dns` to disable DNS plugin on defined networks
+- Added support for `x-podman.dns` to set DNS nameservers for defined networks
+- Improved file descriptor handling - no longer closes externally created descriptors.
+  This allows descriptors created e.g. via systemd socket activation to be passed to
+  containers.
+- Added support for `cpuset` configuration
+- Added support for `reset` and `override` tags when merging compose files
+- Added support for `x-podman.interface_name` to set network interface names
+- Added support for `x-podman.pod_args` to override default `--pod-args`

docs/Changelog-1.4.1.md

@@ -0,0 +1,7 @@
+Version 1.4.1 (2025-06-05)
+==========================
+
+Bug fixes
+---------
+
+- Fixed relative host path resolution for volume bind mount source

docs/Changelog-1.5.0.md

@@ -0,0 +1,30 @@
+Version 1.5.0 (2025-07-07)
+==========================
+
+Bug fixes
+---------
+
+- Fixed path to a local SSH key to be relative to the directory of compose file during build.
+- Fixed CMD healthchecks to run the given command directly and not use `/bin/sh -c`.
+- Fixed regression of dockerfile definition if current directory name ends with ".git".
+- Fixed exit code from `push` command.
+- Implemented short syntax for environment variables set in `.env` for compose.yml `environment:` section.
+- Fixed regression of log output including "text" in detached mode.
+- Implemented `up --no-recreate` to work as advertised.
+- Stack traces emitted due to YAML parse errors are now hidden.
+
+
+Features
+--------
+
+- Added unregister command to remove systemd service registration (`podman-compose systemd -a unregister`)
+- Added new `docker_compose_compat` `x-podman` meta setting to enable all Docker Compose compatibility settings
+- Added new `name_separator_compat` `x-podman` setting to change name separator to hyphen, same as Docker Compose.
+- Added support for environment variable interpolation for YAML keys.
+- Added `io.podman.compose.service` label to created containers. It contains the same value as
+  `com.docker.compose.service`.
+- Added relabel option to secret to make possible to read the secret file by the contained process.
+- Added support for setting x-podman values using PODMAN_COMPOSE_* environment variables.
+- Added support to set `--route` option to `podman network create` via
+  `x-podman.routes` key on network configuration.
+- Implemented support for custom pod names in `--in-pod`. 

docs/Extensions.md

@@ -0,0 +1,273 @@
+# Podman specific extensions to the docker-compose format
+
+Podman-compose supports the following extension to the docker-compose format. These extensions
+are generally specified under fields with "x-podman" prefix in the compose file.
+
+## Container management
+
+The following extension keys are available under container configuration:
+
+* `x-podman.uidmaps` - Run the container in a new user namespace using the supplied UID mapping.
+
+* `x-podman.gidmaps` - Run the container in a new user namespace using the supplied GID mapping.
+
+* `x-podman.rootfs` - Run the container without requiring any image management; the rootfs of the
+container is assumed to be managed externally.
+
+* `x-podman.no_hosts` - Run the container without creating /etc/hosts file
+
+For example, the following docker-compose.yml allows running a podman container with externally managed rootfs.
+```yml
+version: "3"
+services:
+    my_service:
+        command: ["/bin/busybox"]
+        x-podman.rootfs: "/path/to/rootfs"
+```
+
+For explanations of these extensions, please refer to the [Podman Documentation](https://docs.podman.io/).
+
+## Secrets
+The following extension keys are available under `secret` configuration:
+
+    x-podman.relabel - Configure SELinux relabeling
+
+For example, the following configures custom-secret to use mount with private and unshared content.
+Only the current container can use a private volume.
+
+```yml
+secrets:
+  custom-secret:
+    x-podman.relabel: Z
+```
+
+For explanations of these extensions, please refer to the [podman-run --volume documentation](https://docs.podman.io/en/latest/markdown/podman-run.1.html#volume-v-source-volume-host-dir-container-dir-options)).
+
+## Network management
+
+The following extension keys are available under network configuration:
+
+* `x-podman.disable_dns` - Disable the DNS plugin for the network when set to 'true'.
+* `x-podman.dns` - Specifies a list of nameservers for the network This cannot be used with x-podman.disable_dns`.
+
+For example, the following docker-compose.yml allows all containers on the same network to use the
+specified nameservers:
+```yml
+version: "3"
+network:
+  my_network:
+    x-podman.dns:
+      - "10.1.2.3"
+      - "10.1.2.4"
+```
+
+* `x-podman.routes` - Specifies a list of additional routes for the network. This corresponds to
+  `--route` option in `podman network create`.
+
+For example, the following docker-compose.yml blocks network connectivity to specified subnet from
+all containers on the network:
+```yml
+version: "3"
+network:
+  my_network:
+    x-podman.routes:
+      - "10.2.3.4,127.0.0.1"
+```
+
+For explanations of these extensions, please refer to the
+[Podman network create command Documentation](https://docs.podman.io/en/latest/markdown/podman-network-create.1.html).
+
+## Per-network MAC-addresses
+
+Generic docker-compose files support specification of the MAC address on the container level. If the
+container has multiple network interfaces, the specified MAC address is applied to the first
+specified network.
+
+Podman-compose in addition supports the specification of MAC addresses on a per-network basis. This
+is done by adding a `x-podman.mac_address` key to the network configuration in the container. The
+value of the `x-podman.mac_address` key is the MAC address to be used for the network interface.
+
+Note that the [compose spec](https://github.com/compose-spec/compose-spec/blob/main/05-services.md#mac_address)
+now supports `mac_address` on the network level, so we recommend using
+the standard `mac_address` key for setting the MAC address. The
+`x-podman.mac_address` is still supported for backwards compatibility.
+
+
+Specifying a MAC address for the container and for individual networks at the same time is not
+supported.
+
+Example:
+
+```yaml
+---
+version: "3"
+
+networks:
+  net0:
+    driver: "bridge"
+    ipam:
+      config:
+        - subnet: "192.168.0.0/24"
+  net1:
+    driver: "bridge"
+    ipam:
+      config:
+        - subnet: "192.168.1.0/24"
+
+services:
+  webserver:
+    image: "busybox"
+    command: ["/bin/busybox", "httpd", "-f", "-h", "/etc", "-p", "8001"]
+    networks:
+      net0:
+        ipv4_address: "192.168.0.10"
+        x-podman.mac_address: "02:aa:aa:aa:aa:aa"
+      net1:
+        ipv4_address: "192.168.1.10"
+        mac_address: "02:bb:bb:bb:bb:bb" # mac_address is supported
+```
+
+## Per-network interface name
+
+Using `x-podman.interface_name` within a containers network config you can specify the interface name inside the container.
+
+## Podman-specific network modes
+
+Generic docker-compose supports the following values for `network-mode` for a container:
+
+- `bridge`
+- `host`
+- `none`
+- `service`
+- `container`
+
+In addition, podman-compose supports the following podman-specific values for `network-mode`:
+
+- `slirp4netns[:<options>,...]`
+- `ns:<options>`
+- `pasta[:<options>,...]`
+- `private`
+
+The options to the network modes are passed to the `--network` option of the `podman create` command
+as-is.
+
+
+## Docker Compose Compatibility
+
+podman-compose aims to be compatible with docker-compose, but there are some differences in
+behavior and features. The following sections describe how to enable compatibility with docker-compose
+and how to handle some of the differences.
+
+Compatibility settings can either be set explicitly as described below, or by setting the `docker_compose_compat` meta
+settings to `true` under the global `x-podman` key:
+
+```yaml
+x-podman:
+    docker_compose_compat: true
+```
+
+This will enable all compatibility settings described below, and is equivalent to setting each of them to `true`.
+
+This setting can also be changed by setting the `PODMAN_COMPOSE_DOCKER_COMPOSE_COMPAT` environment variable.
+
+## Compatibility of name separators between docker-compose and podman-compose
+
+Currently, podman-compose is using underscores (`_` character) as a separator in names of
+containers, images, etc., while docker-compose has switched to hyphens (`-` character). This setting
+allows to switch podman-compose to use hyphens as well.
+
+To enable compatibility between docker-compose and podman-compose, specify
+`name_separator_compat: true` under global `x-podman` key:
+
+```
+x-podman:
+    name_separator_compat: true
+```
+
+By default `name_separator_compat` is `false`. This will change to `true` at some point and the
+setting will be removed.
+
+This setting can also be changed by setting `PODMAN_COMPOSE_NAME_SEPARATOR_COMPAT` environment
+variable.
+
+## Compatibility of default network names between docker-compose and podman-compose
+
+Current versions of podman-compose may produce different default external network names than
+docker-compose under certain conditions. Specifically, docker-compose removes dashes (`-` character)
+from project name.
+
+To enable compatibility between docker-compose and podman-compose, specify
+`default_net_name_compat: true` under global `x-podman` key:
+
+```
+x-podman:
+    default_net_name_compat: true
+```
+
+By default `default_net_name_compat` is `false`. This will change to `true` at some point and the
+setting will be removed.
+
+This setting can also be changed by setting `PODMAN_COMPOSE_DEFAULT_NET_NAME_COMPAT` environment
+variable.
+
+## Compatibility of default network behavior between docker-compose and podman-compose
+
+When there is no network defined (neither network-mode nor networks) in service,
+The behavior of default network in docker-compose and podman-compose are different.
+
+| Top-level networks             | podman-compose             | docker-compose |
+| ------------------------------ | -------------------------- | -------------- |
+| No networks                    | default                    | default        |
+| One network named net0         | net0                       | default        |
+| Two networks named net0, net1  | podman(`--network=bridge`) | default        |
+| Contains network named default | default                    | default        |
+
+To enable compatibility between docker-compose and podman-compose, specify
+`default_net_behavior_compat: true` under global `x-podman` key:
+
+```yaml
+x-podman:
+    default_net_behavior_compat: true
+```
+
+This setting can also be changed by setting `PODMAN_COMPOSE_DEFAULT_NET_BEHAVIOR_COMPAT` environment
+variable.
+
+## Custom pods management
+
+Podman-compose can have containers in pods. This can be controlled by extension key x-podman in_pod.
+It allows providing custom value for --in-pod and is especially relevant when --userns has to be set.
+
+For example, the following docker-compose.yml allows using userns_mode by overriding the default
+value of --in-pod (unless it was specifically provided by "--in-pod=True" in command line interface).
+```yml
+version: "3"
+services:
+    cont:
+        image: nopush/podman-compose-test
+        userns_mode: keep-id:uid=1000
+        command: ["dumb-init", "/bin/busybox", "httpd", "-f", "-p", "8080"]
+
+x-podman:
+    in_pod: false
+```
+
+This setting can also be changed by setting `PODMAN_COMPOSE_IN_POD` environment
+variable.
+
+It is also possible to override the default arguments for pod creation that are
+used when --pod-args is not passed on the command line:
+```yml
+version: "3"
+services:
+    cont:
+        image: nopush/podman-compose-test
+        command: ["dumb-init", "/bin/busybox", "httpd", "-f", "-p", "8080"]
+x-podman:
+    pod_args: ["--infra=false", "--share=", "--cpus=1"]
+```
+When not set in docker-compose.yml or on the command line, the pod args default
+to `["--infra=false", "--share="]`.
+
+This setting can also be changed by setting `PODMAN_COMPOSE_POD_ARGS` environment
+variable.

examples/awx17/README.md

@@ -0,0 +1,37 @@
+# AWX Compose
+
+the directory roles is taken from [here](https://github.com/ansible/awx/tree/17.1.0/installer/roles/local_docker)
+
+also look at https://github.com/ansible/awx/tree/17.1.0/tools/docker-compose
+
+```
+mkdir deploy awx17
+ansible localhost \
+    -e host_port=8080 \
+    -e awx_secret_key='awx,secret.123' \
+    -e secret_key='awx,secret.123' \
+    -e admin_user='admin' \
+    -e admin_password='admin' \
+    -e pg_password='awx,123.' \
+    -e pg_username='awx' \
+    -e pg_database='awx' \
+    -e pg_port='5432' \
+    -e redis_image="docker.io/library/redis:6-alpine" \
+    -e postgres_data_dir="./data/pg" \
+    -e compose_start_containers=false \
+    -e dockerhub_base='docker.io/ansible' \
+    -e awx_image='docker.io/ansible/awx' \
+    -e awx_version='17.1.0' \
+    -e dockerhub_version='17.1.0' \
+    -e docker_deploy_base_path=$PWD/deploy \
+    -e docker_compose_dir=$PWD/awx17 \
+    -e awx_task_hostname=awx \
+    -e awx_web_hostname=awxweb \
+    -m include_role -a name=local_docker
+cp awx17/docker-compose.yml awx17/docker-compose.yml.orig
+sed -i -re "s#- \"$PWD/awx17/(.*):/#- \"./\1:/#" awx17/docker-compose.yml
+cd awx17
+podman-compose run --rm --service-ports task awx-manage migrate --no-input
+podman-compose up -d
+```
+

examples/awx17/roles/local_docker/defaults/main.yml

@@ -0,0 +1,11 @@
+---
+dockerhub_version: "{{ lookup('file', playbook_dir + '/../VERSION') }}"
+
+awx_image: "awx"
+redis_image: "redis"
+
+postgresql_version: "12"
+postgresql_image: "postgres:{{postgresql_version}}"
+
+compose_start_containers: true
+upgrade_postgres: false

examples/awx17/roles/local_docker/tasks/compose.yml

@@ -0,0 +1,74 @@
+---
+- name: Create {{ docker_compose_dir }} directory
+  file:
+    path: "{{ docker_compose_dir }}"
+    state: directory
+
+- name: Create Redis socket directory
+  file:
+    path: "{{ docker_compose_dir }}/redis_socket"
+    state: directory
+    mode: 0777
+
+- name: Create Docker Compose Configuration
+  template:
+    src: "{{ item.file }}.j2"
+    dest: "{{ docker_compose_dir }}/{{ item.file }}"
+    mode: "{{ item.mode }}"
+  loop:
+    - file: environment.sh
+      mode: "0600"
+    - file: credentials.py
+      mode: "0600"
+    - file: docker-compose.yml
+      mode: "0600"
+    - file: nginx.conf
+      mode: "0600"
+    - file: redis.conf
+      mode: "0664"
+  register: awx_compose_config
+
+- name: Render SECRET_KEY file
+  copy:
+    content: "{{ secret_key }}"
+    dest: "{{ docker_compose_dir }}/SECRET_KEY"
+    mode: 0600
+  register: awx_secret_key
+
+- block:
+    - name: Remove AWX containers before migrating postgres so that the old postgres container does not get used
+      docker_compose:
+        project_src: "{{ docker_compose_dir }}"
+        state: absent
+      ignore_errors: true
+
+    - name: Run migrations in task container
+      shell: docker-compose run --rm --service-ports task awx-manage migrate --no-input
+      args:
+        chdir: "{{ docker_compose_dir }}"
+
+    - name: Start the containers
+      docker_compose:
+        project_src: "{{ docker_compose_dir }}"
+        restarted: "{{ awx_compose_config is changed or awx_secret_key is changed }}"
+      register: awx_compose_start
+
+    - name: Update CA trust in awx_web container
+      command: docker exec awx_web '/usr/bin/update-ca-trust'
+      when: awx_compose_config.changed or awx_compose_start.changed
+
+    - name: Update CA trust in awx_task container
+      command: docker exec awx_task '/usr/bin/update-ca-trust'
+      when: awx_compose_config.changed or awx_compose_start.changed
+
+    - name: Wait for launch script to create user
+      wait_for:
+        timeout: 10
+      delegate_to: localhost
+
+    - name: Create Preload data
+      command: docker exec awx_task bash -c "/usr/bin/awx-manage create_preload_data"
+      when: create_preload_data|bool
+      register: cdo
+      changed_when: "'added' in cdo.stdout"
+  when: compose_start_containers|bool

examples/awx17/roles/local_docker/tasks/main.yml

@@ -0,0 +1,15 @@
+---
+- name: Generate broadcast websocket secret
+  set_fact:
+    broadcast_websocket_secret: "{{ lookup('password', '/dev/null length=128') }}"
+  run_once: true
+  no_log: true
+  when: broadcast_websocket_secret is not defined
+
+- import_tasks: upgrade_postgres.yml
+  when:
+    - postgres_data_dir is defined
+    - pg_hostname is not defined
+
+- import_tasks: set_image.yml
+- import_tasks: compose.yml

examples/awx17/roles/local_docker/tasks/set_image.yml

@@ -0,0 +1,46 @@
+---
+- name: Manage AWX Container Images
+  block:
+    - name: Export Docker awx image if it isn't local and there isn't a registry defined
+      docker_image:
+        name: "{{ awx_image }}"
+        tag: "{{ awx_version }}"
+        archive_path: "{{ awx_local_base_config_path|default('/tmp') }}/{{ awx_image }}_{{ awx_version }}.tar"
+      when: inventory_hostname != "localhost" and docker_registry is not defined
+      delegate_to: localhost
+
+    - name: Set docker base path
+      set_fact:
+        docker_deploy_base_path: "{{ awx_base_path|default('/tmp') }}/docker_deploy"
+      when: ansible_connection != "local" and docker_registry is not defined
+
+    - name: Ensure directory exists
+      file:
+        path: "{{ docker_deploy_base_path }}"
+        state: directory
+      when: ansible_connection != "local" and docker_registry is not defined
+
+    - name: Copy awx image to docker execution
+      copy:
+        src: "{{ awx_local_base_config_path|default('/tmp') }}/{{ awx_image }}_{{ awx_version }}.tar"
+        dest: "{{ docker_deploy_base_path }}/{{ awx_image }}_{{ awx_version }}.tar"
+      when: ansible_connection != "local" and docker_registry is not defined
+
+    - name: Load awx image
+      docker_image:
+        name: "{{ awx_image }}"
+        tag: "{{ awx_version }}"
+        load_path: "{{ docker_deploy_base_path }}/{{ awx_image }}_{{ awx_version }}.tar"
+        timeout: 300
+      when: ansible_connection != "local" and docker_registry is not defined
+
+    - name: Set full image path for local install
+      set_fact:
+        awx_docker_actual_image: "{{ awx_image }}:{{ awx_version }}"
+      when: docker_registry is not defined
+  when: dockerhub_base is not defined
+
+- name: Set DockerHub Image Paths
+  set_fact:
+    awx_docker_actual_image: "{{ dockerhub_base }}/awx:{{ dockerhub_version }}"
+  when: dockerhub_base is defined

examples/awx17/roles/local_docker/tasks/upgrade_postgres.yml

@@ -0,0 +1,64 @@
+---
+
+- name: Create {{ postgres_data_dir }} directory
+  file:
+    path: "{{ postgres_data_dir }}"
+    state: directory
+
+- name: Get full path of postgres data dir
+  shell: "echo {{ postgres_data_dir }}"
+  register: fq_postgres_data_dir
+
+- name: Register temporary docker container
+  set_fact:
+    container_command: "docker run --rm -v '{{ fq_postgres_data_dir.stdout }}:/var/lib/postgresql' centos:8 bash -c "
+
+- name: Check for existing Postgres data (run from inside the container for access to file)
+  shell:
+    cmd: |
+      {{ container_command }} "[[ -f /var/lib/postgresql/10/data/PG_VERSION ]] && echo 'exists'"
+  register: pg_version_file
+  ignore_errors: true
+
+- name: Record Postgres version
+  shell: |
+    {{ container_command }} "cat /var/lib/postgresql/10/data/PG_VERSION"
+  register: old_pg_version
+  when: pg_version_file is defined and pg_version_file.stdout == 'exists'
+
+- name: Determine whether to upgrade postgres
+  set_fact:
+    upgrade_postgres: "{{ old_pg_version.stdout == '10' }}"
+  when: old_pg_version.changed
+
+- name: Set up new postgres paths pre-upgrade
+  shell: |
+    {{ container_command }} "mkdir -p /var/lib/postgresql/12/data/"
+  when: upgrade_postgres | bool
+
+- name: Stop AWX before upgrading postgres
+  docker_compose:
+    project_src: "{{ docker_compose_dir }}"
+    stopped: true
+  when: upgrade_postgres | bool
+
+- name: Upgrade Postgres
+  shell: |
+    docker run --rm \
+      -v {{ postgres_data_dir }}/10/data:/var/lib/postgresql/10/data \
+      -v {{ postgres_data_dir }}/12/data:/var/lib/postgresql/12/data \
+      -e PGUSER={{ pg_username }} -e POSTGRES_INITDB_ARGS="-U {{ pg_username }}" \
+      tianon/postgres-upgrade:10-to-12 --username={{ pg_username }}
+  when: upgrade_postgres | bool
+
+- name: Copy old pg_hba.conf
+  shell: |
+    {{ container_command }} "cp /var/lib/postgresql/10/data/pg_hba.conf /var/lib/postgresql/12/data/pg_hba.conf"
+  when: upgrade_postgres | bool
+
+- name: Remove old data directory
+  shell: |
+    {{ container_command }} "rm -rf /var/lib/postgresql/10/data"
+  when:
+    - upgrade_postgres | bool
+    - compose_start_containers|bool

examples/awx17/roles/local_docker/templates/credentials.py.j2

@@ -0,0 +1,13 @@
+DATABASES = {
+    'default': {
+        'ATOMIC_REQUESTS': True,
+        'ENGINE': 'django.db.backends.postgresql',
+        'NAME': "{{ pg_database }}",
+        'USER': "{{ pg_username }}",
+        'PASSWORD': "{{ pg_password }}",
+        'HOST': "{{ pg_hostname | default('postgres') }}",
+        'PORT': "{{ pg_port }}",
+    }
+}
+
+BROADCAST_WEBSOCKET_SECRET = "{{ broadcast_websocket_secret | b64encode }}"

examples/awx17/roles/local_docker/templates/docker-compose.yml.j2

@@ -0,0 +1,208 @@
+#jinja2: lstrip_blocks: True
+version: '2'
+services:
+
+  web:
+    image: {{ awx_docker_actual_image }}
+    container_name: awx_web
+    depends_on:
+      - redis
+      {% if pg_hostname is not defined %}
+      - postgres
+      {% endif %}
+    {% if (host_port is defined) or (host_port_ssl is defined) %}
+    ports:
+      {% if (host_port_ssl is defined) and (ssl_certificate is defined) %}
+      - "{{ host_port_ssl }}:8053"
+      {% endif %}
+      {% if host_port is defined %}
+      - "{{ host_port }}:8052"
+      {% endif %}
+    {% endif %}
+    hostname: {{ awx_web_hostname }}
+    user: root
+    restart: unless-stopped
+    {% if (awx_web_container_labels is defined) and (',' in awx_web_container_labels) %}
+    {% set awx_web_container_labels_list = awx_web_container_labels.split(',') %}
+    labels:
+      {% for awx_web_container_label in awx_web_container_labels_list %}
+      - {{ awx_web_container_label }}
+      {% endfor %}
+    {% elif awx_web_container_labels is defined %}
+    labels:
+      - {{ awx_web_container_labels }}
+    {% endif %}
+    volumes:
+      - supervisor-socket:/var/run/supervisor
+      - rsyslog-socket:/var/run/awx-rsyslog/
+      - rsyslog-config:/var/lib/awx/rsyslog/
+      - "{{ docker_compose_dir }}/SECRET_KEY:/etc/tower/SECRET_KEY"
+      - "{{ docker_compose_dir }}/environment.sh:/etc/tower/conf.d/environment.sh"
+      - "{{ docker_compose_dir }}/credentials.py:/etc/tower/conf.d/credentials.py"
+      - "{{ docker_compose_dir }}/nginx.conf:/etc/nginx/nginx.conf:ro"
+      - "{{ docker_compose_dir }}/redis_socket:/var/run/redis/:rw"
+    {% if project_data_dir is defined %}
+      - "{{ project_data_dir +':/var/lib/awx/projects:rw' }}"
+    {% endif %}
+    {% if custom_venv_dir is defined %}
+      - "{{ custom_venv_dir +':'+ custom_venv_dir +':rw' }}"
+    {% endif %}
+    {% if ca_trust_dir is defined %}
+      - "{{ ca_trust_dir +':/etc/pki/ca-trust/source/anchors:ro' }}"
+    {% endif %}
+    {% if (ssl_certificate is defined) and (ssl_certificate_key is defined) %}
+      - "{{ ssl_certificate +':/etc/nginx/awxweb.pem:ro' }}"
+      - "{{ ssl_certificate_key +':/etc/nginx/awxweb_key.pem:ro' }}"
+    {% elif (ssl_certificate is defined) and (ssl_certificate_key is not defined) %}
+      - "{{ ssl_certificate +':/etc/nginx/awxweb.pem:ro' }}"
+    {% endif %}
+    {% if (awx_container_search_domains is defined) and (',' in awx_container_search_domains) %}
+    {% set awx_container_search_domains_list = awx_container_search_domains.split(',') %}
+    dns_search:
+    {% for awx_container_search_domain in awx_container_search_domains_list %}
+      - {{ awx_container_search_domain }}
+    {% endfor %}
+    {% elif awx_container_search_domains is defined %}
+    dns_search: "{{ awx_container_search_domains }}"
+    {% endif %}
+    {% if (awx_alternate_dns_servers is defined) and (',' in awx_alternate_dns_servers) %}
+    {% set awx_alternate_dns_servers_list = awx_alternate_dns_servers.split(',') %}
+    dns:
+    {% for awx_alternate_dns_server in awx_alternate_dns_servers_list %}
+      - {{ awx_alternate_dns_server }}
+    {% endfor %}
+    {% elif awx_alternate_dns_servers is defined %}
+    dns: "{{ awx_alternate_dns_servers }}"
+    {% endif %}
+    {% if (docker_compose_extra_hosts is defined) and (':' in docker_compose_extra_hosts) %}
+    {% set docker_compose_extra_hosts_list = docker_compose_extra_hosts.split(',') %}
+    extra_hosts:
+    {% for docker_compose_extra_host in docker_compose_extra_hosts_list %}
+      - "{{ docker_compose_extra_host }}"
+    {% endfor %}
+    {% endif %}
+    environment:
+      http_proxy: {{ http_proxy | default('') }}
+      https_proxy: {{ https_proxy | default('') }}
+      no_proxy: {{ no_proxy | default('') }}
+    {% if docker_logger is defined %}
+    logging:
+      driver: {{ docker_logger }}
+    {% endif %}
+
+  task:
+    image: {{ awx_docker_actual_image }}
+    container_name: awx_task
+    depends_on:
+      - redis
+      - web
+      {% if pg_hostname is not defined %}
+      - postgres
+      {% endif %}
+    command: /usr/bin/launch_awx_task.sh
+    hostname: {{ awx_task_hostname }}
+    user: root
+    restart: unless-stopped
+    volumes:
+      - supervisor-socket:/var/run/supervisor
+      - rsyslog-socket:/var/run/awx-rsyslog/
+      - rsyslog-config:/var/lib/awx/rsyslog/
+      - "{{ docker_compose_dir }}/SECRET_KEY:/etc/tower/SECRET_KEY"
+      - "{{ docker_compose_dir }}/environment.sh:/etc/tower/conf.d/environment.sh"
+      - "{{ docker_compose_dir }}/credentials.py:/etc/tower/conf.d/credentials.py"
+      - "{{ docker_compose_dir }}/redis_socket:/var/run/redis/:rw"
+    {% if project_data_dir is defined %}
+      - "{{ project_data_dir +':/var/lib/awx/projects:rw' }}"
+    {% endif %}
+    {% if custom_venv_dir is defined %}
+      - "{{ custom_venv_dir +':'+ custom_venv_dir +':rw' }}"
+    {% endif %}
+    {% if ca_trust_dir is defined %}
+      - "{{ ca_trust_dir +':/etc/pki/ca-trust/source/anchors:ro' }}"
+    {% endif %}
+    {% if ssl_certificate is defined %}
+      - "{{ ssl_certificate +':/etc/nginx/awxweb.pem:ro' }}"
+    {% endif %}
+    {% if (awx_container_search_domains is defined) and (',' in awx_container_search_domains) %}
+    {% set awx_container_search_domains_list = awx_container_search_domains.split(',') %}
+    dns_search:
+    {% for awx_container_search_domain in awx_container_search_domains_list %}
+      - {{ awx_container_search_domain }}
+    {% endfor %}
+    {% elif awx_container_search_domains is defined %}
+    dns_search: "{{ awx_container_search_domains }}"
+    {% endif %}
+    {% if (awx_alternate_dns_servers is defined) and (',' in awx_alternate_dns_servers) %}
+    {% set awx_alternate_dns_servers_list = awx_alternate_dns_servers.split(',') %}
+    dns:
+    {% for awx_alternate_dns_server in awx_alternate_dns_servers_list %}
+      - {{ awx_alternate_dns_server }}
+    {% endfor %}
+    {% elif awx_alternate_dns_servers is defined %}
+    dns: "{{ awx_alternate_dns_servers }}"
+    {% endif %}
+    {% if (docker_compose_extra_hosts is defined) and (':' in docker_compose_extra_hosts) %}
+    {% set docker_compose_extra_hosts_list = docker_compose_extra_hosts.split(',') %}
+    extra_hosts:
+    {% for docker_compose_extra_host in docker_compose_extra_hosts_list %}
+      - "{{ docker_compose_extra_host }}"
+    {% endfor %}
+    {% endif %}
+    environment:
+      AWX_SKIP_MIGRATIONS: "1"
+      http_proxy: {{ http_proxy | default('') }}
+      https_proxy: {{ https_proxy | default('') }}
+      no_proxy: {{ no_proxy | default('') }}
+      SUPERVISOR_WEB_CONFIG_PATH: '/etc/supervisord.conf'
+
+  redis:
+    image: {{ redis_image }}
+    container_name: awx_redis
+    restart: unless-stopped
+    environment:
+      http_proxy: {{ http_proxy | default('') }}
+      https_proxy: {{ https_proxy | default('') }}
+      no_proxy: {{ no_proxy | default('') }}
+    command: ["/usr/local/etc/redis/redis.conf"]
+    volumes:
+      - "{{ docker_compose_dir }}/redis.conf:/usr/local/etc/redis/redis.conf:ro"
+      - "{{ docker_compose_dir }}/redis_socket:/var/run/redis/:rw"
+    {% if docker_logger is defined %}
+    logging:
+      driver: {{ docker_logger }}
+    {% endif %}
+
+  {% if pg_hostname is not defined %}
+  postgres:
+    image: {{ postgresql_image }}
+    container_name: awx_postgres
+    restart: unless-stopped
+    volumes:
+      - "{{ postgres_data_dir }}/12/data/:/var/lib/postgresql/data:Z"
+    environment:
+      POSTGRES_USER: {{ pg_username }}
+      POSTGRES_PASSWORD: {{ pg_password }}
+      POSTGRES_DB: {{ pg_database }}
+      http_proxy: {{ http_proxy | default('') }}
+      https_proxy: {{ https_proxy | default('') }}
+      no_proxy: {{ no_proxy | default('') }}
+    {% if docker_logger is defined %}
+    logging:
+      driver: {{ docker_logger }}
+    {% endif %}
+  {% endif %}
+
+{% if docker_compose_subnet is defined %}
+networks:
+  default:
+    driver: bridge
+    ipam:
+      driver: default
+      config:
+      - subnet:  {{ docker_compose_subnet }}
+{% endif %}
+
+volumes:
+  supervisor-socket:
+  rsyslog-socket:
+  rsyslog-config:

examples/awx17/roles/local_docker/templates/environment.sh.j2

@@ -0,0 +1,10 @@
+DATABASE_USER={{ pg_username|quote }}
+DATABASE_NAME={{ pg_database|quote }}
+DATABASE_HOST={{ pg_hostname|default('postgres')|quote }}
+DATABASE_PORT={{ pg_port|default('5432')|quote }}
+DATABASE_PASSWORD={{ pg_password|default('awxpass')|quote }}
+{% if pg_admin_password is defined %}
+DATABASE_ADMIN_PASSWORD={{ pg_admin_password|quote }}
+{% endif %}
+AWX_ADMIN_USER={{ admin_user|quote }}
+AWX_ADMIN_PASSWORD={{ admin_password|quote }}

examples/awx17/roles/local_docker/templates/nginx.conf.j2

@@ -0,0 +1,122 @@
+#user awx;
+
+worker_processes  1;
+
+pid        /tmp/nginx.pid;
+
+events {
+    worker_connections  1024;
+}
+
+http {
+    include       /etc/nginx/mime.types;
+    default_type  application/octet-stream;
+    server_tokens off;
+
+    log_format  main  '$remote_addr - $remote_user [$time_local] "$request" '
+                      '$status $body_bytes_sent "$http_referer" '
+                      '"$http_user_agent" "$http_x_forwarded_for"';
+
+    access_log /dev/stdout main;
+
+    map $http_upgrade $connection_upgrade {
+        default upgrade;
+        ''      close;
+    }
+
+    sendfile        on;
+    #tcp_nopush     on;
+    #gzip  on;
+
+    upstream uwsgi {
+        server 127.0.0.1:8050;
+        }
+
+    upstream daphne {
+        server 127.0.0.1:8051;
+    }
+
+    {% if ssl_certificate is defined %}
+    server {
+        listen 8052 default_server;
+        server_name _;
+
+        # Redirect all HTTP links to the matching HTTPS page
+        return 301 https://$host$request_uri;
+    }
+    {%endif %}
+
+    server {
+        {% if (ssl_certificate is defined) and (ssl_certificate_key is defined) %}
+        listen 8053 ssl;
+
+        ssl_certificate /etc/nginx/awxweb.pem;
+        ssl_certificate_key /etc/nginx/awxweb_key.pem;
+        {% elif (ssl_certificate is defined) and (ssl_certificate_key is not defined) %}
+        listen 8053 ssl;
+
+        ssl_certificate /etc/nginx/awxweb.pem;
+        ssl_certificate_key /etc/nginx/awxweb.pem;
+        {% else %}
+        listen 8052 default_server;
+        {% endif %}
+
+        # If you have a domain name, this is where to add it
+        server_name _;
+        keepalive_timeout 65;
+
+        # HSTS (ngx_http_headers_module is required) (15768000 seconds = 6 months)
+        add_header Strict-Transport-Security max-age=15768000;
+
+        # Protect against click-jacking https://www.owasp.org/index.php/Testing_for_Clickjacking_(OTG-CLIENT-009)
+        add_header X-Frame-Options "DENY";
+
+        location /nginx_status {
+          stub_status on;
+          access_log off;
+          allow 127.0.0.1;
+          deny all;
+        }
+
+        location /static/ {
+            alias /var/lib/awx/public/static/;
+        }
+
+        location /favicon.ico { alias /var/lib/awx/public/static/favicon.ico; }
+
+        location /websocket {
+            # Pass request to the upstream alias
+            proxy_pass http://daphne;
+            # Require http version 1.1 to allow for upgrade requests
+            proxy_http_version 1.1;
+            # We want proxy_buffering off for proxying to websockets.
+            proxy_buffering off;
+            # http://en.wikipedia.org/wiki/X-Forwarded-For
+            proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
+            # enable this if you use HTTPS:
+            proxy_set_header X-Forwarded-Proto https;
+            # pass the Host: header from the client for the sake of redirects
+            proxy_set_header Host $http_host;
+            # We've set the Host header, so we don't need Nginx to muddle
+            # about with redirects
+            proxy_redirect off;
+            # Depending on the request value, set the Upgrade and
+            # connection headers
+            proxy_set_header Upgrade $http_upgrade;
+            proxy_set_header Connection $connection_upgrade;
+        }
+
+        location / {
+            # Add trailing / if missing
+            rewrite ^(.*)$http_host(.*[^/])$ $1$http_host$2/ permanent;
+            uwsgi_read_timeout 120s;
+            uwsgi_pass uwsgi;
+            include /etc/nginx/uwsgi_params;
+            {%- if extra_nginx_include is defined %}
+            include {{ extra_nginx_include }};
+            {%- endif %}
+            proxy_set_header X-Forwarded-Port 443;
+            uwsgi_param HTTP_X_FORWARDED_PORT 443;
+        }
+    }
+}

examples/awx17/roles/local_docker/templates/redis.conf.j2

@@ -0,0 +1,4 @@
+unixsocket /var/run/redis/redis.sock
+unixsocketperm 660
+port 0
+bind 127.0.0.1

examples/azure-vote/README.md

@@ -0,0 +1,17 @@
+# Azure Vote Example
+
+This example have two containers:
+
+* backend: `redis` used as storage
+* frontend: having supervisord, nginx, uwsgi/python
+
+
+```
+echo "HOST_PORT=8080" > .env
+podman-compose up
+```
+
+after typing the commands above open your browser on the host port you picked above like
+[http://localhost:8080/](http://localhost:8080/)
+
+

examples/azure-vote/docker-compose.yaml

@@ -0,0 +1,16 @@
+---
+# from https://github.com/Azure-Samples/azure-voting-app-redis/blob/master/docker-compose.yaml
+version: '3'
+services:
+  azure-vote-back:
+    image: mcr.microsoft.com/oss/bitnami/redis:6.0.8
+    container_name: azure-vote-back
+    environment:
+      ALLOW_EMPTY_PASSWORD: "yes"
+  azure-vote-front:
+    image: mcr.microsoft.com/azuredocs/azure-vote-front:v1
+    environment:
+      REDIS: azure-vote-back
+    ports:
+        - "${HOST_PORT:-8080}:80"
+

examples/docker-inline/docker-compose.yml

@@ -0,0 +1,9 @@
+---
+version: '3'
+services:
+  dummy:
+    build:
+      context: .
+      dockerfile_inline: |
+        FROM alpine
+        RUN echo "hello world"

examples/echo/README.md

@@ -0,0 +1,31 @@
+# Echo Service example
+
+```
+podman-compose up
+```
+
+Test the service with `curl like this`
+
+```
+$ curl -X POST -d "foobar" http://localhost:8080/; echo
+
+CLIENT VALUES:
+client_address=10.89.31.2
+command=POST
+real path=/
+query=nil
+request_version=1.1
+request_uri=http://localhost:8080/
+
+SERVER VALUES:
+server_version=nginx: 1.10.0 - lua: 10001
+
+HEADERS RECEIVED:
+accept=*/*
+content-length=6
+content-type=application/x-www-form-urlencoded
+host=localhost:8080
+user-agent=curl/7.76.1
+BODY:
+foobar
+```

examples/echo/docker-compose.yaml

@@ -0,0 +1,8 @@
+---
+version: '3'
+services:
+  web:
+    image: k8s.gcr.io/echoserver:1.4
+    ports:
+        - "${HOST_PORT:-8080}:8080"
+

examples/hello-app-redis/README.md

@@ -0,0 +1,12 @@
+# GCR Hello App Redis
+
+A 6-node redis cluster using [Bitnami](https://github.com/bitnami/bitnami-docker-redis-cluster)
+with a [simple hit counter](https://github.com/GoogleCloudPlatform/kubernetes-engine-samples/tree/main/hello-app-redis) that persists on that redis cluster
+
+```
+podman-compose up
+```
+
+then open your browser on [http://localhost:8080/](http://localhost:8080/)
+
+

examples/hello-app-redis/docker-compose.yaml

@@ -0,0 +1,67 @@
+---
+version: '3'
+volumes:
+  redis-node1-data:
+  redis-node2-data:
+  redis-node3-data:
+  redis-node4-data:
+  redis-node5-data:
+  redis-data:
+services:
+  web:
+    image: gcr.io/google-samples/hello-app-redis:1.0
+    depends_on:
+      - redis-cluster
+    ports:
+        - "${HOST_PORT:-8080}:8080"
+  redis-node1:
+    image: docker.io/bitnami/redis-cluster:6.2
+    volumes:
+      - redis-node1-data:/bitnami/redis/data
+    environment:
+      - ALLOW_EMPTY_PASSWORD=yes
+      - REDIS_NODES=redis-node1 redis-node2 redis-node3 redis-node4 redis-node5 redis-cluster
+  redis-node2:
+    image: docker.io/bitnami/redis-cluster:6.2
+    volumes:
+      - redis-node2-data:/bitnami/redis/data
+    environment:
+      - ALLOW_EMPTY_PASSWORD=yes
+      - REDIS_NODES=redis-node1 redis-node2 redis-node3 redis-node4 redis-node5 redis-cluster
+  redis-node3:
+    image: docker.io/bitnami/redis-cluster:6.2
+    volumes:
+      - redis-node3-data:/bitnami/redis/data
+    environment:
+      - ALLOW_EMPTY_PASSWORD=yes
+      - REDIS_NODES=redis-node1 redis-node2 redis-node3 redis-node4 redis-node5 redis-cluster
+  redis-node4:
+    image: docker.io/bitnami/redis-cluster:6.2
+    volumes:
+      - redis-node4-data:/bitnami/redis/data
+    environment:
+      - ALLOW_EMPTY_PASSWORD=yes
+      - REDIS_NODES=redis-node1 redis-node2 redis-node3 redis-node4 redis-node5 redis-cluster
+  redis-node5:
+    image: docker.io/bitnami/redis-cluster:6.2
+    volumes:
+      - redis-node5-data:/bitnami/redis/data
+    environment:
+      - ALLOW_EMPTY_PASSWORD=yes
+      - REDIS_NODES=redis-node1 redis-node2 redis-node3 redis-node4 redis-node5 redis-cluster
+
+  redis-cluster:
+    image: docker.io/bitnami/redis-cluster:6.2
+    volumes:
+      - redis-data:/bitnami/redis/data
+    depends_on:
+      - redis-node1
+      - redis-node2
+      - redis-node3
+      - redis-node4
+      - redis-node5
+    environment:
+      - ALLOW_EMPTY_PASSWORD=yes
+      - REDIS_NODES=redis-node1 redis-node2 redis-node3 redis-node4 redis-node5 redis-cluster
+      - REDIS_CLUSTER_CREATOR=yes
+

examples/hello-app/README.md

@@ -0,0 +1,10 @@
+# GCR Hello App
+
+A small ~2MB image, type
+
+```
+podman-compose up
+```
+
+then open your browser on [http://localhost:8080/](http://localhost:8080/)
+

examples/hello-app/docker-compose.yaml

@@ -0,0 +1,8 @@
+---
+version: '3'
+services:
+  web:
+    image: gcr.io/google-samples/hello-app:1.0
+    ports:
+        - "${HOST_PORT:-8080}:8080"
+

examples/hello-python/Dockerfile

@@ -0,0 +1,12 @@
+FROM python:3.9-alpine
+
+WORKDIR /usr/src/app
+
+COPY requirements.txt ./
+RUN pip install --no-cache-dir -r requirements.txt
+
+COPY . .
+
+CMD [ "python", "-m", "app.web" ]
+EXPOSE 8080
+

examples/hello-python/README.md

@@ -0,0 +1,8 @@
+# Simple Python Demo
+## A Redis counter
+
+```
+podman-compose up -d
+curl localhost:8080/
+curl localhost:8080/hello.json
+```

examples/hello-python/app/web.py

@@ -0,0 +1,39 @@
+# pylint: disable=import-error
+# pylint: disable=unused-import
+import asyncio  # noqa: F401
+import os
+
+import aioredis  # type: ignore[import-not-found]
+from aiohttp import web  # type: ignore[import-not-found]
+
+REDIS_HOST = os.environ.get("REDIS_HOST", "localhost")
+REDIS_PORT = int(os.environ.get("REDIS_PORT", "6379"))
+REDIS_DB = int(os.environ.get("REDIS_DB", "0"))
+
+redis = aioredis.from_url(f"redis://{REDIS_HOST}:{REDIS_PORT}/{REDIS_DB}")
+app = web.Application()
+routes = web.RouteTableDef()
+
+
+@routes.get("/")
+async def hello(request: web.Request) -> web.Response:  # pylint: disable=unused-argument
+    counter = await redis.incr("mycounter")
+    return web.Response(text=f"counter={counter}")
+
+
+@routes.get("/hello.json")
+async def hello_json(request: web.Request) -> web.Response:  # pylint: disable=unused-argument
+    counter = await redis.incr("mycounter")
+    data = {"counter": counter}
+    return web.json_response(data)
+
+
+app.add_routes(routes)
+
+
+def main() -> None:
+    web.run_app(app, port=8080)
+
+
+if __name__ == "__main__":
+    main()

examples/hello-python/docker-compose.yaml

@@ -0,0 +1,21 @@
+---
+version: '3'
+volumes:
+  redis:
+services:
+  redis:
+    read_only: true
+    image: docker.io/redis:alpine
+    command: ["redis-server", "--appendonly", "yes", "--notify-keyspace-events", "Ex"]
+    volumes:
+    - redis:/data
+  web:
+    read_only: true
+    build:
+      context: .
+    image: hello-py-aioweb
+    ports:
+    - 8080:8080
+    environment:
+      REDIS_HOST: redis
+

examples/hello-python/requirements.txt

@@ -0,0 +1,3 @@
+aiohttp
+aioredis
+# aioredis[hiredis]

examples/nodeproj/.eslintrc.json

@@ -0,0 +1,71 @@
+{
+  "env": {
+    "node": true,
+    "es6": true
+  },
+  "settings": {
+    "import/resolver": {
+      "node": {
+        "extensions": [".js", ".mjs", ".ts", ".cjs"]
+      }
+    }
+  },
+  "parser": "@typescript-eslint/parser",
+  "parserOptions": {
+    "ecmaVersion": 2020,
+    "sourceType": "module",
+    "allowImportExportEverywhere": true
+  },
+  "extends": [
+    "eslint:recommended",
+    "plugin:import/errors",
+    "plugin:import/warnings",
+    "plugin:import/typescript",
+    "plugin:promise/recommended",
+    "google",
+    "plugin:security/recommended"
+  ],
+  "plugins": ["promise", "security", "import"],
+  "overrides": [
+    {
+      "files": "public/**/*.min.js",
+      "env": {
+        "browser": true,
+        "node": false,
+        "es6": false
+      },
+      "parserOptions": {
+        "sourceType": "script"
+      },
+      "extends": ["plugin:compat/recommended"],
+      "plugins": [],
+      "rules": {
+        "no-var": ["off"]
+      }
+    }
+  ],
+  "rules": {
+    "security/detect-non-literal-fs-filename":["off"],
+    "security/detect-object-injection":["off"],
+    "camelcase": ["off"],
+    "no-console": ["off"],
+    "require-jsdoc": ["off"],
+    "one-var": ["off"],
+    "guard-for-in": ["off"],
+    "max-len": [
+      "warn",
+      {
+        "ignoreComments": true,
+        "ignoreTrailingComments": true,
+        "ignoreUrls": true,
+        "code": 200
+      }
+    ],
+    "indent": ["warn", 4],
+    "no-unused-vars": ["warn"],
+    "no-extra-semi": ["warn"],
+    "linebreak-style": ["error", "unix"],
+    "quotes": ["warn", "double"],
+    "semi": ["error", "always"]
+  }
+}

examples/nodeproj/.gitignore

@@ -0,0 +1,5 @@
+local.env
+.env
+*.pid
+node_modules
+

examples/nodeproj/.home/.gitignore

@@ -0,0 +1 @@
+*

examples/nodeproj/README.md

@@ -0,0 +1,16 @@
+# How to run example
+
+
+
+```
+cp example.local.env local.env
+cp example.env .env
+cat local.env
+cat .env
+echo "UID=$UID" >> .env
+cat .env
+podman-compose build
+podman-compose run --rm --no-deps init
+podman-compose up
+```
+

examples/nodeproj/containers/node16-runtime/Dockerfile

@@ -0,0 +1,12 @@
+FROM registry.fedoraproject.org/fedora-minimal:35
+ARG NODE_VER=16
+# microdnf -y module enable nodejs:${NODE_VER}
+RUN \
+  echo -e "[nodejs]\nname=nodejs\nstream=${NODE_VER}\nprofiles=\nstate=enabled\n" > /etc/dnf/modules.d/nodejs.module && \
+  microdnf -y install shadow-utils nodejs zopfli findutils busybox && \
+  microdnf clean all
+RUN adduser -d /app app && mkdir -p /app/code/.home && chown app:app -R /app/code && chmod 711 /app /app/code/.home && usermod -d /app/code/.home app
+ENV XDG_CONFIG_HOME=/app/code/.home
+ENV HOME=/app/code/.home
+WORKDIR /app/code
+

examples/nodeproj/docker-compose.yml

@@ -0,0 +1,48 @@
+version: '3'
+volumes:
+  redis:
+services:
+  redis:
+    read_only: true
+    image: docker.io/redis:alpine
+    command: ["redis-server", "--appendonly", "yes", "--notify-keyspace-events", "Ex"]
+    volumes:
+    - redis:/data
+    tmpfs:
+    - /tmp
+    - /var/run
+    - /run
+  init:
+    read_only: true
+    #userns_mode: keep-id
+    user: ${UID:-1000}
+    build:
+      context: ./containers/${NODE_IMG:-node16-runtime}
+    image: ${NODE_IMG:-node16-runtime}
+    env_file:
+    - local.env
+    volumes:
+    - .:/app/code
+    command: ["/bin/sh", "-c", "mkdir -p ~/; [ -d ./node_modules ] && echo '** node_modules exists' || npm install"]
+    tmpfs:
+    - /tmp
+    - /run
+  task:
+    extends:
+        service: init
+    command: ["npm", "run", "cli", "--", "task"]
+    links:
+    - redis
+    depends_on:
+    - redis
+  web:
+    extends:
+        service: init
+    command: ["npm", "run", "cli", "--", "web"]
+    ports:
+    - ${WEB_LISTEN_PORT:-3000}:3000
+    depends_on:
+    - redis
+    links:
+    - mongo
+

examples/nodeproj/example.env

@@ -0,0 +1,3 @@
+WEB_LISTEN_PORT=3000
+# pass UID= your IDE user
+

examples/nodeproj/example.local.env

@@ -0,0 +1,2 @@
+REDIS_HOST=redis
+

examples/nodeproj/index.js

@@ -0,0 +1,6 @@
+#! /usr/bin/env node
+"use strict";
+import {start} from "./lib";
+
+start();
+

examples/nodeproj/jsconfig.json

@@ -0,0 +1,14 @@
+{
+    "compilerOptions": {
+        "target": "es2020",
+        "module": "es2020",
+        "moduleResolution": "node",
+        "allowSyntheticDefaultImports": true
+    },
+    "files": [
+        "index.js"
+    ],
+    "include": [
+        "lib/**/*.js"
+    ]
+}

examples/nodeproj/lib/commands/task.js

@@ -0,0 +1,31 @@
+"use strict";
+import {proj} from "../proj";
+
+async function loop() {
+    const poped = await proj.predis.blpop("queue", 5);
+    const task_desc_s = poped[1];
+    let task_desc;
+    try {
+        task_desc = JSON.parse(task_desc_s);
+    } catch (e) {
+        console.exception(e);
+    }
+    console.info("got task "+task_desc.func);
+    const func = task_desc.func;
+    const args = task_desc.args;
+    if (typeof(proj.tasks[func])!="function") {
+        console.log(`task ${func} not found`);
+        process.exit(-1)
+    }
+    try {
+        await ((this.tasks[func])(...args));
+    } catch (e) {
+        console.exception(e);
+    }
+}
+
+export async function start() {
+    while(true) {
+        loop();
+    }
+}

examples/nodeproj/lib/commands/web.js

@@ -0,0 +1,21 @@
+"use strict";
+import {proj} from "../proj";
+
+import http from "http";
+import express from "express";
+
+
+export async function start() {
+    const app = express();
+    const server = http.createServer(app);
+
+    // Routing
+    app.use(express.static(proj.config.basedir + "/public"));
+    app.get("/healthz", function(req, res) {
+        res.send("ok@"+Date.now());
+    });
+
+    server.listen(proj.config.LISTEN_PORT, proj.config.LISTEN_HOST, function() {
+        console.warn(`listening at port ${proj.config.LISTEN_PORT}`);
+    });
+}

examples/nodeproj/package.json

@@ -0,0 +1,24 @@
+{
+  "name": "nodeproj",
+  "version": "0.0.1",
+  "description": "nodejs example project",
+  "exports": {
+    ".": "./index.js",
+    "./lib": "./lib"
+  },
+  "main": "index.js",
+  "type": "module",
+  "scripts": {
+    "cli": "nodemon -w lib -w index.js --es-module-specifier-resolution=node ./index.js"
+  },
+  "dependencies": {
+    "express": "~4.16.4",
+    "redis": "^3.1.2"
+  },
+  "private": true,
+  "author": "",
+  "license": "proprietary",
+  "devDependencies": {
+    "nodemon": "^2.0.14"
+  }
+}

examples/nodeproj/public/index.html

@@ -0,0 +1,18 @@
+<!DOCTYPE html>
+<html>
+<head>
+<title>Vote</title>
+<link rel="stylesheet" href="https://unpkg.com/browse/normalize.css@8.0.1/normalize.css">
+<link rel="stylesheet" href="styles.css">
+</head>
+<body>
+<h1>This is a Heading</h1>
+<p>This is a paragraph.</p>
+</body>
+<script type="text/javascript" src="main.css"></script>
+<script type="text/javascript">
+//<![CDATA[
+console.log("loaded");
+//]]>
+</script>
+</html>

examples/nvidia-smi/docker-compose.yaml

@@ -0,0 +1,11 @@
+services:
+  test:
+    image: nvidia/cuda:12.3.1-base-ubuntu20.04
+    command: nvidia-smi
+    deploy:
+      resources:
+        reservations:
+          devices:
+            - driver: nvidia
+              count: 1
+              capabilities: [gpu]

examples/wordpress/docker-compose.yaml

@@ -0,0 +1,24 @@
+---
+volumes:
+  db_data:
+services:
+  wordpress:
+    image: docker.io/library/wordpress:latest
+    ports:
+      - 8080:80
+    environment:
+      - WORDPRESS_DB_HOST=db
+      - WORDPRESS_DB_USER=wordpress
+      - WORDPRESS_DB_PASSWORD=password
+      - WORDPRESS_DB_NAME=wordpress
+  db:
+    image: docker.io/library/mariadb:10.6.4-focal
+    command: '--default-authentication-plugin=mysql_native_password'
+    volumes:
+      - db_data:/var/lib/mysql
+    environment:
+      - MYSQL_ROOT_PASSWORD=somewordpress
+      - MYSQL_DATABASE=wordpress
+      - MYSQL_USER=wordpress
+      - MYSQL_PASSWORD=password
+

newsfragments/README.txt

@@ -0,0 +1,13 @@
+This is the directory for news fragments used by towncrier: https://github.com/hawkowl/towncrier
+
+You create a news fragment in this directory when you make a change, and the file gets removed from
+this directory when the news is published.
+
+towncrier has a few standard types of news fragments, signified by the file extension. These are:
+
+.feature: Signifying a new feature.
+.bugfix: Signifying a bug fix.
+.doc: Signifying a documentation improvement.
+.removal: Signifying a deprecation or removal of public API.
+.change: Signifying a change of behavior
+.misc: Miscellaneous change

newsfragments/add-volumes-bind-create-host-path-option.bugfix

@@ -0,0 +1 @@
+Implemented volumes bind `create_host_path` option.

newsfragments/compose_profiles_env.feature

@@ -0,0 +1 @@
+Support COMPOSE_PROFILES environment variable to enable profiles.

pyproject.toml

@@ -0,0 +1,129 @@
+[build-system]
+build-backend = "setuptools.build_meta"
+requires = ["setuptools"]
+
+[project]
+name = "podman-compose"
+authors = [
+    { email = "alsadi@gmail.com", name = "Muayyad Alsadi" },
+]
+description = "A script to run docker-compose.yml using podman"
+dependencies = [
+    "python-dotenv",
+    "pyyaml",
+]
+requires-python = ">=3.9"
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Topic :: Software Development :: Build Tools",
+]
+keywords = [
+    "podman",
+    "podman-compose",
+]
+license = "GPL-2.0-only"
+dynamic = ["version", "readme"]
+
+[project.urls]
+homepage = "https://github.com/containers/podman-compose"
+
+[project.optional-dependencies]
+devel = [
+    "coverage",
+    "parameterized",
+    "pre-commit",
+    "ruff",
+]
+
+[project.scripts]
+podman-compose = "podman_compose:main"
+
+[tool.setuptools]
+py-modules = ["podman_compose"]
+
+[tool.setuptools.dynamic]
+readme = {file = ["README.md"], content-type = "text/markdown"}
+version = {attr = "podman_compose.__version__"}
+
+[tool.ruff]
+line-length = 100
+target-version = "py38"
+
+[tool.ruff.lint]
+select = ["W", "E", "F", "I"]
+ignore = [
+]
+
+[tool.ruff.lint.isort]
+force-single-line = true
+
+[tool.ruff.format]
+preview = true # needed for quote-style
+quote-style = "preserve"
+
+[tool.towncrier]
+    package = "podman_compose"
+    package_dir = "master"
+    directory = "newsfragments"
+    filename = "docs/Changelog-new.md"
+    template = "scripts/Changelog-template.jinja"
+    title_format = "Version {version} ({project_date})"
+    [[tool.towncrier.section]]
+        path = ""
+
+    [[tool.towncrier.type]]
+        directory = "feature"
+        name = "Features"
+        showcontent = true
+
+    [[tool.towncrier.type]]
+        directory = "change"
+        name = "Changes"
+        showcontent = true
+
+    [[tool.towncrier.type]]
+        directory = "bugfix"
+        name = "Bug fixes"
+        showcontent = true
+
+    [[tool.towncrier.type]]
+        directory = "doc"
+        name = "Improved Documentation"
+        showcontent = true
+
+    [[tool.towncrier.type]]
+        directory = "removal"
+        name = "Deprecations and Removals"
+        showcontent = true
+
+    [[tool.towncrier.type]]
+        directory = "misc"
+        name = "Misc"
+        showcontent = true
+
+[tool.mypy]
+python_version = "3.9"
+namespace_packages = true
+explicit_package_bases = true
+pretty = true
+warn_redundant_casts = true
+disallow_untyped_calls = false
+disallow_untyped_defs = true
+no_implicit_optional = true
+mypy_path = "$MYPY_CONFIG_FILE_DIR"
+exclude = "build"
+
+[[tool.mypy.overrides]]
+module = [
+    "parameterized.*",
+]
+ignore_missing_imports = true

requirements.txt

@@ -0,0 +1,7 @@
+# The order of packages is significant, because pip processes them in the order
+# of appearance. Changing the order has an impact on the overall integration
+# process, which may cause wedges in the gate later.
+
+pyyaml
+python-dotenv
+

scripts/Changelog-template.jinja

@@ -0,0 +1,33 @@
+{% for section, _ in sections|dictsort(by='key') %}
+{% set underline = "-" %}
+{% if section %}
+{{section}}
+{{ underline * section|length }}{% set underline = "~" %}
+
+{% endif %}
+{% if sections[section] %}
+{% for category, val in definitions|dictsort if category in sections[section]%}
+
+{{ definitions[category]['name'] }}
+{{ underline * definitions[category]['name']|length }}
+
+{% for text, values in sections[section][category]|dictsort(by='value') %}
+- {{ text }}
+{% endfor %}
+
+{% if sections[section][category]|length == 0 %}
+
+No significant changes.
+
+
+{% else %}
+{% endif %}
+{% endfor %}
+{% else %}
+
+No significant changes.
+
+
+{% endif %}
+{% endfor %}
+(venv) p12@exec-desktop:~/cod

scripts/download_and_build_podman-compose.sh

@@ -0,0 +1,16 @@
+#!/bin/sh
+
+# Delete repository dir
+rm -rf podman-compose-src
+
+# Clone repository
+git clone https://github.com/containers/podman-compose podman-compose-src
+
+# Generate binary
+sh podman-compose-src/scripts/generate_binary_using_dockerfile.sh
+
+# Move binary outside repo's dir
+mv podman-compose-src/podman-compose .
+
+# Delete repository dir
+rm -rf podman-compose-src

scripts/generate_binary_using_dockerfile.sh

@@ -0,0 +1,57 @@
+#!/bin/sh
+
+# Find an available container tool (docker or podman)
+find_container_tool() {
+    if command -v docker > /dev/null 2>&1; then
+        echo "sudo docker"
+    elif command -v podman > /dev/null 2>&1; then
+        echo "podman"
+    else
+        echo "Error: Neither docker nor podman is available." >&2
+        exit 1
+    fi
+}
+
+# Determine which container tool to use
+CONTAINER_TOOL=$(find_container_tool)
+
+# Locate the directory containing dockerfile (root)
+PROJECT_ROOT_DIR="$(cd "$(dirname "$0")" && pwd)/.."
+
+# Check SELinux status and set appropriate mount option
+check_selinux() {
+    if command -v getenforce > /dev/null 2>&1; then
+        SELINUX_STATUS=$(getenforce)
+        if [ "$SELINUX_STATUS" = "Enforcing" ] || [ "$SELINUX_STATUS" = "Permissive" ]; then
+            echo ":z"
+        else
+            echo ""
+        fi
+    elif [ -f /sys/fs/selinux/enforce ]; then
+        if [ "$(cat /sys/fs/selinux/enforce)" = "1" ]; then
+            echo ":z"
+        else
+            echo ""
+        fi
+    else
+        echo ""
+    fi
+}
+
+# Get the SELinux option for volume mounts if SELinux is enforcing or permissive
+SELINUX=$(check_selinux)
+
+# Build binary
+$CONTAINER_TOOL image rm build-podman-compose
+
+if expr "$CONTAINER_TOOL" : '.*docker.*' >/dev/null; then
+    $CONTAINER_TOOL build -t build-podman-compose "$PROJECT_ROOT_DIR"
+    $CONTAINER_TOOL run --name build-podman-compose build-podman-compose
+    $CONTAINER_TOOL cp build-podman-compose:/result/podman-compose "$PROJECT_ROOT_DIR/podman-compose"
+    $CONTAINER_TOOL container stop build-podman-compose
+    $CONTAINER_TOOL container rm -f build-podman-compose
+else
+    $CONTAINER_TOOL build -v "$PROJECT_ROOT_DIR:/result$SELINUX" -t build-podman-compose "$PROJECT_ROOT_DIR"
+fi
+$CONTAINER_TOOL image rm python:3.11-slim
+$CONTAINER_TOOL image rm build-podman-compose

scripts/make_release.sh

@@ -1,6 +1,18 @@
-#!/usr/bin/env bash
-./scripts/uninstall.sh
-./scripts/clean_up.sh
-python3 setup.py register
-python3 setup.py sdist bdist_wheel
-twine upload dist/*
+#!/bin/bash
+
+set -e
+
+if [ $# -ne 1 ]; then
+    echo "Usage: make_release.sh VERSION"
+    exit 1
+fi
+
+VERSION=$1
+
+sed "s/__version__ = .*/__version__ = \"$VERSION\"/g" -i podman_compose.py
+git add podman_compose.py
+git commit -m "Release $VERSION"
+
+git tag "v$VERSION" -m "v$VERSION" -s
+
+git push ssh://github.com/containers/podman-compose main "v$VERSION"

scripts/make_release_notes.sh

@@ -0,0 +1,14 @@
+#!/bin/bash
+
+set -e
+
+if [ $# -ne 1 ]; then
+    echo "Usage: make_release_notes.sh VERSION"
+    exit 1
+fi
+
+VERSION=$1
+towncrier build --version "$VERSION" --yes
+git mv "docs/Changelog-new.md" "docs/Changelog-$VERSION.md"
+git add "newsfragments/"
+git commit -m "Release notes for $VERSION"

scripts/make_release_upload.sh

@@ -0,0 +1,5 @@
+#!/usr/bin/env bash
+./scripts/uninstall.sh
+./scripts/clean_up.sh
+pyproject-build
+twine upload dist/*

setup.cfg

@@ -1,2 +1,5 @@
-[bdist_wheel]
-universal = 1
+[flake8]
+# The GitHub editor is 127 chars wide
+max-line-length=127
+# These are not being followed yet
+ignore=E222,E231,E272,E713,W503

setup.py

@@ -1,53 +0,0 @@
-import os
-from setuptools import setup, find_packages
-
-try:
-    readme = open(os.path.join(os.path.dirname(__file__), 'README.md')).read()
-except:
-    readme = ''
-
-from podman_compose import __version__ as podman_compose_version
-
-setup(
-    name='podman-compose',
-    version=podman_compose_version,
-    description="A script to run docker-compose.yml using podman",
-    long_description=readme,
-    long_description_content_type='text/markdown',
-    classifiers=[
-        "Programming Language :: Python",
-        "Programming Language :: Python :: 2",
-        "Programming Language :: Python :: 2.7",
-        "Programming Language :: Python :: 3",
-        "Programming Language :: Python :: 3.5",
-        "Programming Language :: Python :: 3.6",
-        "Programming Language :: Python :: 3.7",
-        "Intended Audience :: Developers",
-        "Operating System :: OS Independent",
-        "Development Status :: 3 - Alpha",
-        "Topic :: Software Development :: Build Tools",
-        "License :: OSI Approved :: GNU General Public License v2 (GPLv2)",
-    ],
-    keywords='podman, podman-compose',
-    author='Muayyad Alsadi',
-    author_email='alsadi@gmail.com',
-    url='https://github.com/containers/podman-compose',
-    py_modules=['podman_compose'],
-    entry_points={
-        'console_scripts': [
-            'podman-compose = podman_compose:main'
-        ]
-    },
-    include_package_data=True,
-    license='GPL-2.0-only',
-    install_requires=[
-        'pyyaml'
-    ],
-    # test_suite='tests',
-    # tests_require=[
-    #     'coverage',
-    #     'pytest-cov',
-    #     'pytest',
-    #     'tox',
-    # ]
-)

test-requirements.txt

@@ -0,0 +1,41 @@
+-e .
+coverage==7.4.3
+cryptography==44.0.3
+parameterized==0.9.0
+pytest==8.0.2
+tox==4.13.0
+mypy==1.15.0
+ruff==0.11.11
+pylint==3.1.0
+types-PyYAML==6.0.12.20250402
+types-requests==2.32.0.20250328
+types-setuptools==80.7.0.20250516
+
+# The packages below are transitive dependencies of the packages above and are included here
+# to make testing reproducible.
+# To refresh, create a new virtualenv and do:
+#  pip install -r requirements.txt -r test-requirements.txt
+#  pip freeze > test-requirements.txt
+# and edit test-requirements.txt to add this comment
+
+astroid==3.1.0
+cachetools==5.3.3
+chardet==5.2.0
+colorama==0.4.6
+dill==0.3.8
+distlib==0.3.8
+filelock==3.13.1
+iniconfig==2.0.0
+isort==5.13.2
+mccabe==0.7.0
+mypy_extensions==1.1.0
+packaging==23.2
+platformdirs==4.2.0
+pluggy==1.4.0
+pyproject-api==1.6.1
+python-dotenv==1.0.1
+PyYAML==6.0.1
+requests
+tomlkit==0.12.4
+typing_extensions==4.13.2
+virtualenv==20.26.6

tests/build/README.md

@@ -1,25 +0,0 @@
-# Test podman-compose with build
-
-```
-podman-compose build
-podman-compose up -d
-curl http://localhost:8080/index.txt
-curl http://localhost:8000/index.txt
-podman inspect my-busybox-httpd2 
-podman-compose down
-```
-
-expected output would be something like
-
-```
-2019-09-03T15:16:38+0000
-ALT buildno=2 port 8000 2019-09-03T15:16:38+0000
-{
-...
-}
-```
-
-as you can see we were able to override buildno to be 2 instead of 1,
-and httpd_port to 8000.
-
-NOTE: build labels are not passed to `podman build`

tests/integration/__init__.py

@@ -0,0 +1,12 @@
+import os
+import subprocess
+
+
+def create_base_test_image() -> None:
+    subprocess.check_call(
+        ['podman', 'build', '-t', 'nopush/podman-compose-test', '.'],
+        cwd=os.path.join(os.path.dirname(__file__), "base_image"),
+    )
+
+
+create_base_test_image()

tests/integration/abort/docker-compose-fail-first.yaml

@@ -0,0 +1,11 @@
+version: "3"
+services:
+    sh1:
+      image: nopush/podman-compose-test
+      command: ["dumb-init", "/bin/busybox", "sh", "-c", "sleep 1; exit 1"]
+    sh2:
+      image: nopush/podman-compose-test
+      command: ["dumb-init", "/bin/busybox", "sh", "-c", "sleep 2; exit 0"]
+    sh3:
+      image: nopush/podman-compose-test
+      command: ["dumb-init", "/bin/busybox", "sh", "-c", "sleep 3; exit 0"]

tests/integration/abort/docker-compose-fail-none.yaml

@@ -0,0 +1,11 @@
+version: "3"
+services:
+    sh1:
+      image: nopush/podman-compose-test
+      command: ["dumb-init", "/bin/busybox", "sh", "-c", "sleep 1; exit 0"]
+    sh2:
+      image: nopush/podman-compose-test
+      command: ["dumb-init", "/bin/busybox", "sh", "-c", "sleep 2; exit 0"]
+    sh3:
+      image: nopush/podman-compose-test
+      command: ["dumb-init", "/bin/busybox", "sh", "-c", "sleep 3; exit 0"]

tests/integration/abort/docker-compose-fail-second.yaml

@@ -0,0 +1,11 @@
+version: "3"
+services:
+    sh1:
+      image: nopush/podman-compose-test
+      command: ["dumb-init", "/bin/busybox", "sh", "-c", "sleep 1; exit 0"]
+    sh2:
+      image: nopush/podman-compose-test
+      command: ["dumb-init", "/bin/busybox", "sh", "-c", "sleep 2; exit 1"]
+    sh3:
+      image: nopush/podman-compose-test
+      command: ["dumb-init", "/bin/busybox", "sh", "-c", "sleep 3; exit 0"]

tests/integration/abort/docker-compose-fail-simultaneous.yaml

@@ -0,0 +1,11 @@
+version: "3"
+services:
+    sh1:
+      image: nopush/podman-compose-test
+      command: ["dumb-init", "/bin/busybox", "sh", "-c", "sleep 1; exit 1"]
+    sh2:
+      image: nopush/podman-compose-test
+      command: ["dumb-init", "/bin/busybox", "sh", "-c", "sleep 1; exit 0"]
+    sh3:
+      image: nopush/podman-compose-test
+      command: ["dumb-init", "/bin/busybox", "sh", "-c", "sleep 2; exit 0"]

tests/integration/abort/test_podman_compose_abort.py

@@ -0,0 +1,46 @@
+# SPDX-License-Identifier: GPL-2.0
+
+import os
+import unittest
+
+from parameterized import parameterized
+
+from tests.integration.test_utils import RunSubprocessMixin
+from tests.integration.test_utils import podman_compose_path
+from tests.integration.test_utils import test_path
+
+
+def compose_yaml_path(failure_order: str) -> str:
+    return os.path.join(test_path(), "abort", f"docker-compose-fail-{failure_order}.yaml")
+
+
+class TestComposeAbort(unittest.TestCase, RunSubprocessMixin):
+    @parameterized.expand([
+        ("exit", "first", 0),
+        ("failure", "first", 1),
+        ("exit", "second", 0),
+        ("failure", "second", 1),
+        ("exit", "simultaneous", 0),
+        ("failure", "simultaneous", 1),
+        ("exit", "none", 0),
+        ("failure", "none", 0),
+    ])
+    def test_abort(self, abort_type: str, failure_order: str, expected_exit_code: int) -> None:
+        try:
+            self.run_subprocess_assert_returncode(
+                [
+                    podman_compose_path(),
+                    "-f",
+                    compose_yaml_path(failure_order),
+                    "up",
+                    f"--abort-on-container-{abort_type}",
+                ],
+                expected_exit_code,
+            )
+        finally:
+            self.run_subprocess_assert_returncode([
+                podman_compose_path(),
+                "-f",
+                compose_yaml_path(failure_order),
+                "down",
+            ])

tests/integration/additional_contexts/README.md

@@ -0,0 +1,14 @@
+# Test podman-compose with build.additional_contexts
+
+```
+podman-compose build
+podman-compose up
+podman-compose down
+```
+
+expected output would be
+
+```
+[dict] | Data for dict
+[list] | Data for list
+```

tests/integration/additional_contexts/__init__.py

@@ -0,0 +1 @@
+

tests/integration/additional_contexts/data_for_dict/data.txt

@@ -0,0 +1 @@
+Data for dict

tests/integration/additional_contexts/data_for_list/data.txt

@@ -0,0 +1 @@
+Data for list

tests/integration/additional_contexts/project/Dockerfile

@@ -0,0 +1,3 @@
+FROM busybox
+COPY --from=data data.txt /data/data.txt
+CMD ["busybox", "cat", "/data/data.txt"]

tests/integration/additional_contexts/project/docker-compose.yml

@@ -0,0 +1,12 @@
+version: "3.7"
+services:
+  dict:
+    build:
+      context: .
+      additional_contexts:
+        data: ../data_for_dict
+  list:
+    build:
+      context: .
+      additional_contexts:
+        - data=../data_for_list