extern/podman-compose
1
0
Fork 1
mirror of https://github.com/containers/podman-compose.git synced 2025-04-02 20:26:16 +02:00
Code Issues Packages Projects Releases Wiki Activity

Add docs for podman specific compose file extensions

Browse Source 
Signed-off-by: GnSight <ftyg@live.com>
This commit is contained in:
GnSight 2024-03-16 16:08:13 +08:00 committed by Povilas Kanapickas
parent 77f2e8e5b0
commit 2b4ecee082
1 changed files with 24 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
docs/Extensions.md
View File

@ -65,3 +65,27 @@ In addition, podman-compose supports the following podman-specific values for `n
The options to the network modes are passed to the `--network` option of the `podman create` command
as-is.
# Service management
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/).