package
3.4.7
Repository: https://github.com/containers/podman.git
Documentation: pkg.go.dev

# Packages

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Functions

BuildContainerGraph builds a dependency graph based on the container slice.
ConvertV1PodToYAMLPod takes k8s API core Pod and returns a pointer to YAMLPod.
DefaultSeccompPath returns the path to the default seccomp.json file if it exists, first it checks OverrideSeccomp and then default.
DownloadFromFile reads all of the content from the reader and temporarily saves in it $TMPDIR/importxyz, which is deleted after the image is imported.
FuncTimer helps measure the execution time of a function For debug purposes, do not leave in code used like defer FuncTimer("foo").
GenerateForKube takes a slice of libpod containers and generates one v1.Pod description that includes just a single container.
GenerateKubeServiceFromV1Pod creates a v1 service object from a v1 pod object.
Get expected slirp DNS ipv4 address based on subnet Reference: https://github.com/rootless-containers/slirp4netns/blob/master/slirp4netns.1.md#description.
Get expected slirp Gateway ipv4 address based on subnet Reference: https://github.com/rootless-containers/slirp4netns/blob/master/slirp4netns.1.md#description.
Get expected slirp ipv4 address based on subnet.
JSONDeepCopy performs a deep copy by performing a JSON encode/decode of the given structures.
LabelVolumePath takes a mount path for a volume and gives it an selinux label of either shared or not.
MountExists returns true if dest exists in the list of mounts.
NewBoltState creates a new bolt-backed state database.
NewRuntime creates a new container runtime Options can be passed to override the default configuration for the runtime.
NewRuntimeFromConfig creates a new container runtime using the given configuration file for its default configuration.
SetXdgDirs ensures the XDG_RUNTIME_DIR env and XDG_CONFIG_HOME variables are set.
Unmount umounts a target directory.
WaitForFile waits until a file has been created or the given timeout has occurred.
WithAddCurrentUserPasswdEntry indicates that container should add current user entry to /etc/passwd, since the UID will be mapped into the container, via user namespace.
WithCDI sets the devices to check for for CDI configuration.
WithCgroupManager specifies the manager implementation name which is used to handle cgroups for containers.
WithCgroupNSFrom indicates the the container should join the CGroup namespace of the given container.
WithCgroupParent sets the Cgroup Parent of the new container.
WithCgroupsMode disables the creation of CGroups for the conmon process.
WithCNIConfigDir sets the CNI configuration directory.
WithCNIPluginDir sets the CNI plugins directory.
WithCommand sets the command of the container.
WithConmonEnv specifies the environment variable list for the conmon process.
WithConmonPath specifies the path to the conmon binary which manages the runtime.
WithConmonPidFile specifies the path to the file that receives the pid of conmon.
WithCreateCommand adds the full command plus arguments of the current process to the container config.
WithCreateWorkingDir tells Podman to create the container's working directory if it does not exist.
WithCtrNamespace sets the namespace the container will be created in.
WithDefaultInfraCommand sets the command to run on pause container start up.
WithDefaultInfraImage sets the infra image for libpod.
WithDefaultInfraName sets the infra container name for a single pod.
WithDefaultMountsFile sets the file to look at for default mounts (mainly secrets).
WithDefaultTransport sets the default transport for retrieving images.
WithDependencyCtrs sets dependency containers of the given container.
WithDNS sets additional name servers for the container.
WithDNSOption sets addition dns options for the container.
WithDNSSearch sets the additional search domains of a container.
WithEnableSDNotify sets a runtime option so we know whether to disable socket/FD listening.
WithEntrypoint sets the entrypoint of the container.
WithSecrets adds environment variable secrets to the container.
WithEventsLogger sets the events backend to use.
WithExitCommand sets the ExitCommand for the container, appending on the ctr.ID() to the end.
WithGroups sets additional groups for the container, which are defined by the user.
WithHealthCheck adds the healthcheck to the container config.
WithHooksDir sets the directories to look for OCI runtime hook configuration.
WithHosts sets additional host:IP for the hosts file.
WithIDMappings sets the idmappings for the container.
WithImageVolumes adds the given image volumes to the container.
WithInfraConmonPidFile sets the path to a custom conmon PID file for the infra container.
WithInfraContainer tells the pod to create a pause container.
WithInfraContainerPorts tells the pod to add port bindings to the pause container.
WithInitCtrType indicates the container is a initcontainer.
WithIPCNSFrom indicates the the container should join the IPC namespace of the given container.
WithLabels adds labels to the container.
WithLogDriver sets the log driver for the container.
WithLogPath sets the path to the log file.
WithLogTag sets the tag to the log file.
WithMaxLogSize sets the maximum size of container logs.
WithMigrate instructs libpod to migrate container configurations to account for changes between Engine versions.
WithMigrateRuntime instructs Engine to change the default OCI runtime on all containers during a migration.
WithMountNSFrom indicates the the container should join the mount namespace of the given container.
WithName sets the container's name.
WithNamedVolumes adds the given named volumes to the container.
WithNamespace sets the namespace for libpod.
WithNetNS indicates that the container should be given a new network namespace with a minimal configuration.
WithNetNSFrom indicates the the container should join the network namespace of the given container.
WithNetworkAliases sets network aliases for the container.
WithNetworkCmdPath specifies the path to the slirp4netns binary which manages the runtime.
WithNetworkOptions sets additional options for the networks.
WithNoPivotRoot sets the runtime to use MS_MOVE instead of PIVOT_ROOT when starting containers.
WithNoStore sets a bool on the runtime that we do not need any containers storage.
WithOCIRuntime specifies an OCI runtime to use for running containers.
WithOverlayVolumes adds the given overlay volumes to the container.
WithPidFile adds pidFile to the container.
WithPIDNSFrom indicates the the container should join the PID namespace of the given container.
WithPodCgroup tells containers in this pod to use the cgroup namespace created for this pod.
WithPodCgroupParent sets the Cgroup Parent of the pod.
WithPodCgroups tells containers in this pod to use the cgroup created for this pod.
WithPodCreateCommand adds the full command plus arguments of the current process to the pod config.
WithPodHostname sets the hostname of the pod.
WithPodIPC tells containers in this pod to use the ipc namespace created for this pod.
WithPodLabels sets the labels of a pod.
WithPodMount tells containers in this pod to use the mount namespace created for this pod.
WithPodName sets the name of the pod.
WithPodNamespace sets the namespace for the created pod.
WithPodNet tells containers in this pod to use the network namespace created for this pod.
WithPodPID tells containers in this pod to use the pid namespace created for this pod.
WithPodUser tells containers in this pod to use the user namespace created for this pod.
WithPodUTS tells containers in this pod to use the uts namespace created for this pod.
WithPreserveFDs forwards from the process running Libpod into the container the given number of extra FDs (starting after the standard streams) to the created container.
WithPrivileged sets the privileged flag in the container runtime.
WithRegistriesConf configures the runtime to always use specified registries.conf for image processing.
WithRenumber instructs libpod to perform a lock renumbering while initializing.
WithRestartPolicy sets the container's restart policy.
WithRestartRetries sets the number of retries to use when restarting a container with the "on-failure" restart policy.
WithRootFS sets the rootfs for the container.
WithRootFSFromImage sets up a fresh root filesystem using the given image.
WithRuntimeFlags adds the global runtime flags to the container config.
WithSdNotifyMode sets the sd-notify method.
WithSecLabels sets the labels for SELinux.
WithSecrets adds secrets to the container.
WithShmDir sets the directory that should be mounted on /dev/shm.
WithShmSize sets the size of /dev/shm tmpfs mount.
WithSignaturePolicy specifies the path of a file which decides how trust is managed for images we've pulled.
WithStateType sets the backing state implementation for libpod.
WithStaticDir sets the directory that static runtime files which persist across reboots will be stored.
WithStaticIP indicates that the container should request a static IP from the CNI plugins.
WithStaticMAC indicates that the container should request a static MAC from the CNI plugins.
WithStdin keeps stdin on the container open to allow interaction.
WithStopSignal sets the signal that will be sent to stop the container.
WithStopTimeout sets the time to after initial stop signal is sent to the container, before sending the kill signal.
WithStorageConfig uses the given configuration to set up container storage.
WithSystemd turns on systemd mode in the container.
WithTimeout sets the maximum time a container is allowed to run".
WithTimezone sets the timezone in the container.
WithTmpDir sets the directory that temporary runtime files which are not expected to survive across reboots will be stored.
WithUmask sets the umask in the container.
WithUseImageHosts tells the container not to bind-mount /etc/hosts in.
WithUseImageResolvConf tells the container not to bind-mount resolv.conf in.
WithUser sets the user identity field in configuration.
WithUserNSFrom indicates the the container should join the user namespace of the given container.
WithUserVolumes sets the user-added volumes of the container.
WithUTSNSFrom indicates the the container should join the UTS namespace of the given container.
WithUTSNSFromPod indicates the the container should join the UTS namespace of its pod.
WithVolatile sets the volatile flag for the container storage.
WithVolumeDriver sets the volume's driver.
WithVolumeGID sets the GID that the volume will be created as.
WithVolumeInodes sets the maximum inodes of the volume.
WithVolumeLabels sets the labels of the volume.
WithVolumeName sets the name of the volume.
WithVolumeNoChown prevents the volume from being chowned to the process uid at first use.
WithVolumeOptions sets the options of the volume.
WithVolumePath sets the path under which all named volumes should be created.
WithVolumeSize sets the maximum size of the volume.
WithVolumeUID sets the UID that the volume will be created as.

# Constants

Sync with stdpipe_t in conmon.c */.
Sync with stdpipe_t in conmon.c */.
Sync with stdpipe_t in conmon.c */.
CgroupfsDefaultCgroupParent is the cgroup parent for CGroupFS in libpod.
CgroupNS is the CGroup namespace.
DefaultWaitInterval is the default interval between container status checks while waiting.
InvalidNS is an invalid namespace.
IPCNS is the IPC namespace.
MaxHealthCheckLogLength in characters.
MaxHealthCheckNumberLogs is the maximum number of attempts we keep in the healthcheck history file.
MountNS is the mount namespace.
MountPrivate represents the private mount option.
MountRPrivate represents the rprivate mount option.
MountRShared represents the rshared mount option.
MountRSlave represents the rslave mount option.
MountShared represents the shared mount option.
MountSlave represents the slave mount option.
NetNS is the network namespace.
PIDNS is the PID namespace.
SystemdDefaultCgroupParent is the cgroup parent for the systemd cgroup manager in libpod.
SystemdDefaultRootlessCgroupParent is the cgroup parent for the systemd cgroup manager in libpod when running as rootless.
UserNS is the user namespace.
UTSNS is the UTS namespace.

# Variables

SdNotifyModeValues describes the only values that SdNotifyMode can be.

# Structs

BoltState is a state implementation backed by a Bolt DB.
ConmonOCIRuntime is an OCI runtime managed by Conmon.
Container is a single OCI container.
ContainerCheckpointOptions is a struct used to pass the parameters for checkpointing (and restoring) to the corresponding functions.
ContainerCommitOptions is a struct used to commit a container to an image It uses buildah's CommitOptions as a base.
ContainerConfig contains all information that was used to create the container.
ContainerGraph is a dependency graph based on a set of containers.
ContainerImageConfig is an embedded sub-config providing image configuration to the container.
ContainerImageVolume is a volume based on a container image.
ContainerInfo wraps a subset of information about a container: the locations of its nonvolatile and volatile per-container directories, along with a copy of the configuration blob from the image that was used to create the container, if the image had a configuration.
ContainerMiscConfig is an embedded sub-config providing misc configuration to the container.
ContainerNamedVolume is a named volume that will be mounted into the container.
ContainerNameSpaceConfig is an embedded sub-config providing namespace configuration to the container.
ContainerNetworkConfig is an embedded sub-config providing network configuration to the container.
ContainerOverlayVolume is a overlay volume that will be mounted into the container.
ContainerRootFSConfig is an embedded sub-config providing config info about the container's root fs.
ContainerSecret is a secret that is mounted in a container.
ContainerSecurityConfig is an embedded sub-config providing security configuration to the container.
ContainerState contains the current state of the container It is stored on disk in a tmpfs and recreated on reboot.
DBConfig is a set of Libpod runtime configuration settings that are saved in a State when it is first created, and can subsequently be retrieved.
ExecConfig contains the configuration of an exec session.
ExecOptions are options passed into ExecContainer.
ExecSession contains information on a single exec session attached to a given container.
HTTPAttachStreams informs the HTTPAttach endpoint which of the container's standard streams should be streamed to the client.
MissingRuntime is used when the OCI runtime requested by the container is missing (not installed or not in the configuration file).
Pod represents a group of containers that are managed together.
PodConfig represents a pod's static configuration.
PodContainerStats is an organization struct for pods and their containers.
No description provided by the author
Runtime is the core libpod runtime.
RuntimeContainerMetadata is the structure that we encode as JSON and store in the metadata field of storage.Container objects.
StorageContainer represents a container present in c/storage but not in libpod.
Volume is a libpod named volume.
VolumeConfig holds the volume's immutable configuration.
VolumeState holds the volume's mutable state.
YAMLContainer represents the same k8s API core Container struct with a small change and that is having Resources as a pointer to k8s API core ResourceRequirements.
YAMLPod represents the same k8s API core Pod struct with a small change and that is having Spec as a pointer to YAMLPodSpec and Status as a pointer to k8s API core PodStatus.
YAMLPodSpec represents the same k8s API core PodSpec struct with a small change and that is having Containers as a pointer to YAMLContainer.
YAMLService represents the same k8s API core Service struct with a small change and that is having Status as a pointer to k8s API core ServiceStatus.

# Interfaces

OCIRuntime is an implementation of an OCI runtime.
State is a storage backend for libpod's current state.

# Type aliases

ContainerFilter is a function to determine whether a container is included in command output.
ContainerNetworkDescriptions describes the relationship between the CNI network and the ethN where N is an integer.
A CtrCreateOption is a functional option which alters the Container created by NewContainer.
LinuxNS represents a Linux namespace.
A PodCreateOption is a functional option which alters the Pod created by NewPod.
PodFilter is a function to determine whether a pod is included in command output.
A RuntimeOption is a functional option which alters the Runtime created by NewRuntime.
A VolumeCreateOption is a functional option which alters the Volume created by NewVolume.
VolumeFilter is a function to determine whether a volume is included in command output.