Skip to content

Commit

Permalink
Add docs for podman specific compose file extensions
Browse files Browse the repository at this point in the history
Signed-off-by: GnSight <[email protected]>
  • Loading branch information
ftyghome committed Mar 16, 2024
1 parent bb857aa commit f8be18c
Showing 1 changed file with 23 additions and 0 deletions.
23 changes: 23 additions & 0 deletions docs/Extensions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# Overview

Podman-compose extends the compose specification to support some unique features of Podman. These extensions can be specified in the compose file under the "x-podman" field.

Currently, podman-compose supports the following extensions:

* `uidmap` - Run the container in a new user namespace using the supplied UID mapping.

* `gidmap` - Run the container in a new user namespace using the supplied GID mapping.

* `rootfs` - Run the container without requiring any image management; the rootfs of the container is assumed to be managed externally.

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

0 comments on commit f8be18c

Please sign in to comment.