quadlet

Documentation

Index

• Constants
• func ConvertContainer(container *parser.UnitFile, isUser bool) (*parser.UnitFile, error)
• func ConvertKube(kube *parser.UnitFile, isUser bool) (*parser.UnitFile, error)
• func ConvertNetwork(network *parser.UnitFile, name string) (*parser.UnitFile, error)
• func ConvertVolume(volume *parser.UnitFile, name string) (*parser.UnitFile, error)
• type PodmanCmdline
  • func NewPodmanCmdline(args ...string) *PodmanCmdline

Constants

const (
	// Directory for global Quadlet files (sysadmin owned)
	UnitDirAdmin = "/etc/containers/systemd"
	// Directory for global Quadlet files (distro owned)
	UnitDirDistro = "/usr/share/containers/systemd"

	// Names of commonly used systemd/quadlet group names
	UnitGroup       = "Unit"
	InstallGroup    = "Install"
	ServiceGroup    = "Service"
	ContainerGroup  = "Container"
	XContainerGroup = "X-Container"
	VolumeGroup     = "Volume"
	XVolumeGroup    = "X-Volume"
	KubeGroup       = "Kube"
	XKubeGroup      = "X-Kube"
	NetworkGroup    = "Network"
	XNetworkGroup   = "X-Network"
)

const (
	KeyContainerName     = "ContainerName"
	KeyImage             = "Image"
	KeyEnvironment       = "Environment"
	KeyEnvironmentFile   = "EnvironmentFile"
	KeyEnvironmentHost   = "EnvironmentHost"
	KeyExec              = "Exec"
	KeyNoNewPrivileges   = "NoNewPrivileges"
	KeyDropCapability    = "DropCapability"
	KeyAddCapability     = "AddCapability"
	KeyReadOnly          = "ReadOnly"
	KeyRemapUsers        = "RemapUsers"
	KeyRemapUID          = "RemapUid"
	KeyRemapGID          = "RemapGid"
	KeyRemapUIDSize      = "RemapUidSize"
	KeyNotify            = "Notify"
	KeyExposeHostPort    = "ExposeHostPort"
	KeyPublishPort       = "PublishPort"
	KeyUser              = "User"
	KeyGroup             = "Group"
	KeyDevice            = "Device"
	KeyType              = "Type"
	KeyOptions           = "Options"
	KeyCopy              = "Copy"
	KeyVolume            = "Volume"
	KeyPodmanArgs        = "PodmanArgs"
	KeyLabel             = "Label"
	KeyAnnotation        = "Annotation"
	KeyRunInit           = "RunInit"
	KeyVolatileTmp       = "VolatileTmp"
	KeyTimezone          = "Timezone"
	KeySeccompProfile    = "SeccompProfile"
	KeyAddDevice         = "AddDevice"
	KeyNetwork           = "Network"
	KeyYaml              = "Yaml"
	KeyNetworkDisableDNS = "DisableDNS"
	KeyNetworkDriver     = "Driver"
	KeyNetworkGateway    = "Gateway"
	KeyNetworkInternal   = "Internal"
	KeyNetworkIPRange    = "IPRange"
	KeyNetworkIPAMDriver = "IPAMDriver"
	KeyNetworkIPv6       = "IPv6"
	KeyNetworkOptions    = "Options"
	KeyNetworkSubnet     = "Subnet"
	KeyConfigMap         = "ConfigMap"
)

All the supported quadlet keys

Functions

func ConvertContainer

func ConvertContainer(container *parser.UnitFile, isUser bool) (*parser.UnitFile, error)

Convert a quadlet container file (unit file with a Container group) to a systemd service file (unit file with Service group) based on the options in the Container group. The original Container group is kept around as X-Container.

func ConvertKube

func ConvertKube(kube *parser.UnitFile, isUser bool) (*parser.UnitFile, error)

func ConvertNetwork

func ConvertNetwork(network *parser.UnitFile, name string) (*parser.UnitFile, error)

Convert a quadlet network file (unit file with a Network group) to a systemd service file (unit file with Service group) based on the options in the Network group. The original Network group is kept around as X-Network.

func ConvertVolume

func ConvertVolume(volume *parser.UnitFile, name string) (*parser.UnitFile, error)

Convert a quadlet volume file (unit file with a Volume group) to a systemd service file (unit file with Service group) based on the options in the Volume group. The original Volume group is kept around as X-Volume.

Types

type PodmanCmdline

type PodmanCmdline struct {
	Args []string
}

This is a helper for constructing podman commandlines

func NewPodmanCmdline

func NewPodmanCmdline(args ...string) *PodmanCmdline