From 2b4ecee082221c871792bb9ae3da88cc7cd26615 Mon Sep 17 00:00:00 2001 From: GnSight Date: Sat, 16 Mar 2024 16:08:13 +0800 Subject: [PATCH] Add docs for podman specific compose file extensions Signed-off-by: GnSight --- docs/Extensions.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/docs/Extensions.md b/docs/Extensions.md index 24b6bd9..9e66ace 100644 --- a/docs/Extensions.md +++ b/docs/Extensions.md @@ -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/).