• Stars
    star
    460
  • Rank 95,146 (Top 2 %)
  • Language
    Rust
  • License
    Mozilla Public Li...
  • Created over 1 year ago
  • Updated 8 days ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Generate Podman Quadlet files from a Podman command, compose file, or existing object

Podlet

Crates.io GitHub Workflow Status (with event) Crates.io License

Podlet generates podman quadlet files from a podman command, compose file, or existing object.

demo.gif Demo created with autocast. You can also view the demo on asciinema.

Features

  • Supports the following podman commands:
    • podman run
    • podman kube play
    • podman network create
    • podman volume create
    • podman image pull
  • Convert a (docker) compose file to:
    • Multiple quadlet files.
    • A pod with a quadlet kube file and Kubernetes YAML.
  • Generate from existing:
    • Containers
    • 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.
  • 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 quay.io/k9withabone/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 or a compose file

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 container, network, or volume
  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: 4.8] [aliases: compatibility, compat] [possible values: 4.4, 4.5, 4.6, 4.7, 4.8]
  -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
      --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
  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]
      --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 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 <POD>  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:

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

In addition, the --pod option will generate Kubernetes YAML which groups all compose services in a pod.

$ podlet compose --pod caddy 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

When converting compose files, not all options are supported by podman/quadlet. This is especially true when converting to a pod 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.

Also note that 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 container, network, or volume

Usage: podlet generate <COMMAND>

Commands:
  container  Generate a quadlet file from an existing container
  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, 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 quay.io/k9withabone/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 quay.io/k9withabone/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! Feel free to create an issue, discussion, or pull request.

Building

Podlet is a normal Rust project, so once Rust is installed, the source code can be cloned and built with:

git clone [email protected]:k9withabone/podlet.git
cd podlet
cargo build

Release builds are created with the dist profile:

cargo build --profile dist

Local CI

If you are submitting code changes in a pull request and would like to run the CI jobs locally, you can run the following commands:

  • format: cargo fmt --check
  • clippy: cargo clippy
  • test: cargo test
  • build-container:
    • Ensure the container builds for both x86 and ARM platforms.
    • podman build --platform linux/amd64 -t podlet .
    • podman build --platform linux/arm64/v8 -t podlet .

License

All source code for podlet is licensed under the Mozilla Public License v2.0. View the LICENSE file for more information.

More Repositories

1

podman

Podman: A tool for managing OCI containers and pods.
Go
23,573
star
2

skopeo

Work with remote images registries - retrieving information, images, signing content
Go
8,189
star
3

buildah

A tool that facilitates building OCI images.
Go
7,364
star
4

youki

A container runtime written in Rust
Rust
6,267
star
5

podman-compose

a script to run docker-compose.yml using podman
Python
5,047
star
6

podman-desktop

Podman Desktop is the best free and open source tool to work with Containers and Kubernetes for developers. Get an intuitive and user-friendly interface to effortlessly build, manage, and deploy containers and Kubernetes — all from your desktop.
TypeScript
4,794
star
7

bubblewrap

Low-level unprivileged sandboxing tool used by Flatpak and similar projects
C
3,920
star
8

crun

A fast and lightweight fully featured OCI runtime and C library for running containers
C
3,021
star
9

toolbox

Tool for interactive command line environments on Linux
Shell
2,537
star
10

krunvm

Create microVMs from OCI images
Rust
1,422
star
11

libkrun

A dynamic library providing Virtualization-based process isolation capabilities
Rust
871
star
12

image

Work with containers' images
Go
866
star
13

bootc

Boot and upgrade via container images
Rust
649
star
14

podman-tui

Podman Terminal UI
Go
639
star
15

storage

Container Storage Library
Go
560
star
16

fuse-overlayfs

FUSE implementation for overlayfs
C
528
star
17

netavark

Container network stack
Rust
528
star
18

udica

This repository contains a tool for generating SELinux security profiles for containers
Python
487
star
19

composefs

a file system for mounting container images
C
441
star
20

conmon

An OCI container runtime monitor.
C
420
star
21

podman-desktop-extension-bootc

Support for bootable OS containers (bootc) and generating disk images
TypeScript
411
star
22

build

another build tool for container images (archived, see https://github.com/rkt/rkt/issues/4024)
Go
342
star
23

quadlet

C
342
star
24

oci-seccomp-bpf-hook

OCI hook to trace syscalls and generate a seccomp profile
Go
301
star
25

ansible-podman-collections

Repository for Ansible content that can include playbooks, roles, modules, and plugins for use with the Podman tool
Python
266
star
26

gvisor-tap-vsock

A new network stack based on gVisor
Go
258
star
27

podman.io_old

Repository for podman.io website using GitHub Pages.
CSS
258
star
28

container-selinux

SELinux policy files for Container Runtimes
Roff
254
star
29

podman-py

Python bindings for Podman's RESTful API
Python
253
star
30

ramalama

The goal of RamaLama is to make working with AI boring.
Shell
231
star
31

oci-spec-rs

OCI Runtime, Image and Distribution Spec in Rust
Rust
208
star
32

common

Location for shared common files in github.com/containers repos.
Go
188
star
33

conmon-rs

An OCI container runtime monitor written in Rust
Rust
186
star
34

aardvark-dns

Authoritative dns server for A/AAAA container records. Forwards other request to host's /etc/resolv.conf
Rust
184
star
35

dnsname

name resolution for containers
Go
177
star
36

podman-desktop-extension-ai-lab

Work with LLMs on a local environment using containers
TypeScript
175
star
37

docker-lvm-plugin

Docker volume plugin for LVM volumes
Go
155
star
38

crun-vm

Run VM disk images using Podman / Docker / Kubernetes.
Rust
146
star
39

ocicrypt

Encryption libraries for Encrypted OCI Container images
Go
144
star
40

virtcontainers

A Go package for building hardware virtualized container runtimes
Go
139
star
41

prometheus-podman-exporter

Prometheus exporter for podman environments exposing containers, pods, images, volumes and networks information.
Go
134
star
42

fetchit

FetchIt is used to manage the life cycle and configuration of Podman containers
Go
124
star
43

containrs

General purpose container library
Rust
120
star
44

bluechi

Bluechi is a systemd service controller intended for multi-node environments with a predefined number of nodes and with a focus on highly regulated ecosystems such as those requiring functional safety.
C
96
star
45

Demos

Repository is a location of user demos for technologies listed on github.com/containers
Shell
80
star
46

libkrunfw

A dynamic library bundling the guest payload consumed by libkrun
C
77
star
47

omlmd

OCI Artifact for ML model & metadata
Python
69
star
48

shortnames

Shortnames project is collecting registry alias names for shortnames to fully specified container image names.
Python
68
star
49

psgo

A ps(1) AIX-format compatible golang library
Go
58
star
50

nri-plugins

A collection of community maintained NRI plugins
Go
57
star
51

podman.io

The new podman.io design project
TypeScript
53
star
52

libocispec

a C library for accessing OCI runtime and image spec files
Python
52
star
53

tar-diff

Go
51
star
54

python-podman

Python bindings and code examples for using Varlink access to Podman Service
Python
49
star
55

podman-security-bench

Shell
40
star
56

initoverlayfs

C
39
star
57

selinuxd

A daemon that manages SELinux policies on a filesystem
Go
36
star
58

krunkit

Launch configurable virtual machines with libkrun
Rust
36
star
59

nydus-storage-plugin

A storage plugin that provided CRI-O/Podman with the ability to lazy mount nydus images.
Go
34
star
60

podman-desktop-swift

Swift
34
star
61

appstore

Example directory of Kubernetes YAML and Quadlets tested with Podman
Python
30
star
62

BuildSourceImage

Tool to build a source image based on an existing OCI image
Shell
29
star
63

buildah.io

Repository for the buildah.io web site using GitHub Pages.
HTML
26
star
64

ansible-podman

Ansible podman is a package to allow ansible playbooks to manage podman containers
Python
26
star
65

oci-fetch

Simple command line tool for fetching the Open Container Initiative image format over various transports.
Go
24
star
66

containertoolbx.org

Website for the Toolbx project
CSS
24
star
67

qm

QM is a containerized environment for running Functional Safety qm (Quality Management) software
Shell
22
star
68

libhvee

Special purposed library for Windows HyperV control
Go
21
star
69

automation_images

Shell
21
star
70

containers-image-proxy-rs

containers-image-proxy-rs
Rust
20
star
71

podman-wsl-fedora

Root FS image of Fedora for Podman Machine on Windows
20
star
72

podman-machine-qemu

Qemu build for macOS used by the self-contained `podman machine` installer
Shell
19
star
73

podman-bootc

Go
18
star
74

automation

Automation scripts and configurations common across the containers org. repositories
Shell
15
star
75

podman-machine-wsl-os

WSL OS Images for Podman Machine 5.x - based on Fedora
15
star
76

oci-umount

C
13
star
77

docs

Repository for all documentation written about tools hosted at github.com/containers
Shell
12
star
78

bootable

Ruby
11
star
79

netavark-dhcp-proxy-deprecated

DHCP proxy for Netavark
Rust
11
star
80

image_build

Monorepo menagerie of container images and associated build automation
Shell
11
star
81

podhawk

Python
9
star
82

podman-desktop-catalog

Catalog of extensions of Podman Desktop
7
star
83

validator

C
7
star
84

podman-machine-cni

Go
6
star
85

arty

Arty is a tool for managing OCI Artifacts on OCI Registries.
6
star
86

ocidir-rs

Low level Rust library for working with OCI (opencontainers) directories
Rust
5
star
87

PodmanHello

Podman Hello Image Repository
Dockerfile
4
star
88

.github

The README for the containers organization
4
star
89

automation_sandbox

Test-repository for experimenting with in-repo automation tools/settings.
4
star
90

fetchit-desktop-extension

TypeScript
4
star
91

winquit

golang module that supports graceful shutdown of Windows applications
Go
4
star
92

kubensmnt

Shell
4
star
93

podman-desktop-extension-layers-explorer

An extension for Podman Desktop to explore files in Images layers
TypeScript
4
star
94

podman-desktop-e2e

Podman desktop e2e tests
Go
3
star
95

podman-desktop-extension-minikube

TypeScript
3
star
96

nri-plugins-operator

Makefile
3
star
97

luksy

offline encryption/decryption using LUKS formats
Go
3
star
98

release-keys

2
star
99

ContainerPlumbing

Container Plumbing Conference information.
2
star
100

podman-machine-os

machine image files
Go
2
star