8 releases
0.3.0 | May 21, 2024 |
---|---|
0.2.4 | Jan 30, 2024 |
0.2.3 | Dec 31, 2023 |
0.2.1 | Nov 28, 2023 |
0.1.1 | Apr 19, 2023 |
#318 in Command line utilities
104 downloads per month
510KB
11K
SLoC
Podlet
Podlet generates Podman Quadlet files from a Podman command, compose file, or existing object.
Demo created with autocast. You can also view the demo on asciinema.
Features
- Supports the following Podman commands:
podman run
podman pod create
podman kube play
podman network create
podman volume create
podman image pull
- Convert a (docker) compose file to:
- Multiple Quadlet
.container
files. - A Quadlet
.pod
file and.container
files. - A Quadlet
.kube
file and Kubernetes Pod YAML.
- Multiple Quadlet
- Generate from existing:
- Containers
- Pods
- Networks
- Volumes
- Images
- Write to stdout or to a file.
- Options for including common systemd unit options.
- Checks for existing systemd services to avoid conflict.
- Opt-out with
--skip-services-check
.
- Opt-out with
- Set Podman version compatibility with
--podman-version
. - Resolve relative host paths with
--absolute-host-paths
.
Install
Podlet can be acquired in several ways:
- Download a prebuilt binary from releases.
- As a container:
podman run ghcr.io/containers/podlet
. - Use cargo-binstall to get a prebuilt binary:
cargo binstall podlet
. - Build and install with
cargo install podlet
.
Usage
$ podlet -h
Generate Podman Quadlet files from a Podman command, compose file, or existing object
Usage: podlet [OPTIONS] <COMMAND>
Commands:
podman Generate a Podman Quadlet file from a Podman command
compose Generate Podman Quadlet files from a compose file
generate Generate a Podman Quadlet file from an existing object
help Print this message or the help of the given subcommand(s)
Options:
-f, --file [<FILE>] Generate a file instead of printing to stdout
-u, --unit-directory Generate a file in the Podman unit directory instead of printing to stdout [aliases: unit-dir]
-n, --name <NAME> Override the name of the generated file (without the extension)
--overwrite Overwrite existing files when generating a file
--skip-services-check Skip the check for existing services of the same name
-p, --podman-version <PODMAN_VERSION> Podman version generated Quadlet files should conform to [default: 5.0] [aliases: compatibility, compat] [possible values: 4.4, 4.5, 4.6, 4.7, 4.8, 5.0]
-a, --absolute-host-paths [<RESOLVE_DIR>] Convert relative host paths to absolute paths
-d, --description <DESCRIPTION> Add a description to the unit
--wants <WANTS> Add (weak) requirement dependencies to the unit
--requires <REQUIRES> Similar to --wants, but adds stronger requirement dependencies
--binds-to <BINDS_TO> Similar to --requires, but when the dependency stops, this unit also stops
--before <BEFORE> Configure ordering dependency between units
--after <AFTER> Configure ordering dependency between units
-i, --install Add an [Install] section to the unit
--wanted-by <WANTED_BY> Add (weak) parent dependencies to the unit
--required-by <REQUIRED_BY> Similar to --wanted-by, but adds stronger parent dependencies
-h, --help Print help (see more with '--help')
-V, --version Print version
See podlet --help
for more information.
Podman Command
$ podlet podman -h
Generate a Podman Quadlet file from a Podman command
Usage: podlet podman [OPTIONS] <COMMAND>
Commands:
run Generate a Podman Quadlet `.container` file
pod Generate a Podman Quadlet `.pod` file
kube Generate a Podman Quadlet `.kube` file
network Generate a Podman Quadlet `.network` file
volume Generate a Podman Quadlet `.volume` file
image Generate a Podman Quadlet `.image` file
help Print this message or the help of the given subcommand(s)
Options:
-h, --help Print help (see more with '--help')
Podman Global Options:
--cgroup-manager <MANAGER> Cgroup manager to use [possible values: cgroupfs, systemd]
--config <PATH> Location of the authentication config file
--conmon <PATH> Path of the conmon binary
--connection <CONNECTION_URI> Connection to use for remote Podman service
--events-backend <TYPE> Backend to use for storing events [possible values: file, journald, none]
--hooks-dir <PATH> Set the OCI hooks directory path
--identity <PATH> Path to ssh identity file
--imagestore <PATH> Path to the 'image store'
--log-level <LEVEL> Log messages at and above specified level [default: warn] [possible values: debug, info, warn, error, fatal, panic]
--module <PATH> Load the specified `containers.conf(5)` module
--network-cmd-path <PATH> Path to the `slirp4netns(1)` command binary
--network-config-dir <DIRECTORY> Path of the configuration directory for networks
--out <PATH> Redirect the output of Podman to a file without affecting the container output or its logs
-r, --remote[=<REMOTE>] Access remote Podman service [possible values: true, false]
--root <VALUE> Path to the graph root directory where images, containers, etc. are stored
--runroot <VALUE> Storage state directory where all state information is stored
--runtime <VALUE> Path to the OCI-compatible binary used to run containers
--runtime-flag <FLAG> Add global flags for the container runtime
--ssh <VALUE> Define the ssh mode [possible values: golang, native]
--storage-driver <VALUE> Select which storage driver is used to manage storage of images and containers
--storage-opt <VALUE> Specify a storage driver option
--syslog Output logging information to syslog as well as the console
--tmpdir <PATH> Path to the tmp directory for libpod state content
--transient-store[=<TRANSIENT_STORE>] Enable transient container storage [possible values: true, false]
--url <VALUE> URL to access Podman service
--volumepath <VALUE> Volume directory where builtin volume information is stored
To generate a Quadlet file, just put podlet
in front of your Podman command!
$ podlet podman run quay.io/podman/hello
# hello.container
[Container]
Image=quay.io/podman/hello
This is useful for more complicated commands you are copying. For example, let's create a Quadlet file for running Caddy. We'll also use a few options for additional sections in the file.
$ podlet --file . --install --description Caddy \
podman run \
--restart always \
-p 8000:80 \
-p 8443:443 \
-v ./Caddyfile:/etc/caddy/Caddyfile:Z \
-v caddy_data:/data \
docker.io/library/caddy:latest
Wrote to file: ./caddy.container
$ cat caddy.container
[Unit]
Description=Caddy
[Container]
Image=docker.io/library/caddy:latest
PublishPort=8000:80
PublishPort=8443:443
Volume=./Caddyfile:/etc/caddy/Caddyfile:Z
Volume=caddy_data:/data
[Service]
Restart=always
[Install]
WantedBy=default.target
The name for the file was automatically pulled from the image name, but can be overridden with the --name
option.
Podlet also supports creating .pod
, .kube
, .network
, .volume
, and .image
Quadlet files.
$ podlet podman kube play --network pasta --userns auto caddy.yaml
# caddy.kube
[Kube]
Yaml=caddy.yaml
Network=pasta
UserNS=auto
Global Podman options are added to the GlobalArgs=
Quadlet option.
Compose
$ podlet compose -h
Generate Podman Quadlet files from a compose file
Usage: podlet compose [OPTIONS] [COMPOSE_FILE]
Arguments:
[COMPOSE_FILE] The compose file to convert
Options:
--pod Create a `.pod` file and link it with each `.container` file
--kube Create a Kubernetes YAML file for a pod instead of separate containers
-h, --help Print help (see more with '--help')
Let's return to the Caddy example, say you have a compose file at compose-example.yaml
:
name: caddy
services:
caddy:
image: docker.io/library/caddy:latest
ports:
- 8000:80
- 8443:443
volumes:
- ./Caddyfile:/etc/caddy/Caddyfile:Z
- caddy-data:/data
volumes:
caddy-data:
podlet compose compose-example.yaml
will create a caddy.container
file like so:
# caddy.container
[Container]
Image=docker.io/library/caddy:latest
PublishPort=8000:80
PublishPort=8443:443
Volume=./Caddyfile:/etc/caddy/Caddyfile:Z
Volume=caddy-data:/data
If a compose file is not given, Podlet will search for the following files in the current working directory, in order:
compose.yaml
compose.yml
docker-compose.yaml
docker-compose.yml
Pod
The --pod
option will create a .pod
Quadlet file and link each .container
file to it.
$ podlet compose --pod compose-example.yaml
# caddy-caddy.container
[Container]
Image=docker.io/library/caddy:latest
Pod=caddy.pod
Volume=./Caddyfile:/etc/caddy/Caddyfile:Z
Volume=caddy-data:/data
---
# caddy.pod
[Pod]
PublishPort=8000:80
PublishPort=8443:443
Kubernetes YAML
The --kube
option will generate Kubernetes YAML which groups all compose services in a pod.
$ podlet compose --kube compose-example.yaml
# caddy.kube
[Kube]
Yaml=caddy-kube.yaml
---
# caddy-kube.yaml
apiVersion: v1
kind: Pod
metadata:
name: caddy
spec:
containers:
- image: docker.io/library/caddy:latest
name: caddy
ports:
- containerPort: 80
hostPort: 8000
- containerPort: 443
hostPort: 8443
volumeMounts:
- mountPath: /etc/caddy/Caddyfile:Z
name: caddy-etc-caddy-Caddyfile
- mountPath: /data
name: caddy-data
volumes:
- hostPath:
path: ./Caddyfile
name: caddy-etc-caddy-Caddyfile
- name: caddy-data
persistentVolumeClaim:
claimName: caddy-data
Notes
When converting compose files, not all options are supported by Podman/Quadlet. This is especially true when converting to Kubernetes YAML as some options must be applied to the pod as a whole. If Podlet encounters an unsupported option an error will be returned. You will have to remove or comment out unsupported options to proceed.
Podlet does not yet support compose interpolation.
See podlet compose --help
for more information.
Generate from Existing
$ podlet generate -h
Generate a Podman Quadlet file from an existing object
Usage: podlet generate <COMMAND>
Commands:
container Generate a Quadlet file from an existing container
pod Generate Quadlet files from an existing pod and its containers
network Generate a Quadlet file from an existing network
volume Generate a Quadlet file from an existing volume
image Generate a Quadlet file from an image in local storage
help Print this message or the help of the given subcommand(s)
Options:
-h, --help Print help (see more with '--help')
If you have an existing container, pod, network, volume, or image, you can use podlet generate
to create a Quadlet file from it.
$ podman container create --name hello quay.io/podman/hello:latest
$ podlet generate container hello
# hello.container
[Container]
ContainerName=hello
Image=quay.io/podman/hello:latest
These commands require that podman
is installed and searchable from the PATH
environment variable.
See podlet generate --help
for more information.
In a Container
While Podlet can be used as-is in a container, passing the command to it; if you want to utilize some of the write-to-file functionality, or create Quadlet files from compose files, additional volumes may need to be attached.
An example of a generic Podman command that runs the most up-to-date version of Podlet with the current directory and user's Quadlet directory attached to the container would be:
podman run --rm --userns keep-id -e HOME -e XDG_CONFIG_HOME --user $(id -u) -v "$PWD":"$PWD" -v "$HOME/.config/containers/systemd/":"$HOME/.config/containers/systemd/" -w "$PWD" --security-opt label=disable --pull=newer ghcr.io/containers/podlet
Please note that --security-opt label=disable
may be required for systems with SELinux. If your system does not use SELinux, the option is not needed. Podman recommends disabling SELinux separation when mounting system files and directories to containers. See the note at the end of the "Labeling Volume Mounts" section in the podman run --volume
documentation.
Alternatively, if you just want Podlet to read a specific compose file you can use:
podman run --rm -v ./compose.yaml:/compose.yaml:Z ghcr.io/containers/podlet compose /compose.yaml
Cautions
Podlet is primarily a tool for helping to get started with Podman systemd units, aka Quadlet files. It is not meant to be an end-all solution for creating and maintaining Quadlet files. Files created with Podlet should always be reviewed before starting the unit.
Podlet is not (yet) a validator for Podman commands. Some Podman options are incompatible with each other and most options require specific formatting and/or only accept certain values. However, a few options are fully parsed and validated in order to facilitate creating the Quadlet file.
Contribution
Contributions, suggestions, and/or comments are appreciated! See the contribution guide for more information.
License
All source code for Podlet is licensed under the Mozilla Public License v2.0. View the LICENSE file for more information.
Dependencies
~66MB
~1M SLoC