ExitCode reads the error message when failing to executing container process and then returns 0 if no error, ExecErrorCodeNotFound if command does not exist, or ExecErrorCodeCannotInvoke for all other errors.

GetVersion returns a VersionOutput struct for API and podman.

IsReservedAnnotation returns true if the specified value corresponds to an already reserved annotation that Podman sets during container creation.

ParseHealthCheckOnFailureAction parses the specified string into a HealthCheckOnFailureAction.

Parse the specified kube exit-code propagation.

StringToContainerStatus converts a string representation of a container's status into an actual container status type.

TranslateExecErrorToExitCode takes an error and checks whether it has a predefined exit code associated.

ValidateSdNotifyMode validates the specified mode.

AlwaysInitContainer is an init container that runs on each pod start (including restart).

AutoUpdateAuthfileLabel denotes the container label key to specify authfile in container labels.

AutoUpdateLabel denotes the container/pod label key to specify auto-update policies in container labels.

BindMountPrefix distinguishes its annotations from others.

BoltDBStateStore is a state backed by a BoltDB database.

CheckpointAnnotationCgroupVersion is used by Container Checkpoint when creating a checkpoint image to specify the cgroup version used by the host where the checkpoint was created.

CheckpointAnnotationConmonVersion is used by Container Checkpoint when creating a checkpoint image to specify the version of conmon used on the host where the checkpoint was created.

CheckpointAnnotationCriuVersion is used by Container Checkpoint when creating a checkpoint image to specify the version of CRIU used on the host where the checkpoint was created.

CheckpointAnnotationDistributionName is used by Container Checkpoint when creating a checkpoint image to specify the name of host distribution on which the checkpoint was created.

CheckpointAnnotationDistributionVersion is used by Container Checkpoint when creating a checkpoint image to specify the version of host distribution on which the checkpoint was created.

CheckpointAnnotationHostArch is used by Container Checkpoint when creating a checkpoint image to specify the CPU architecture of the host on which the checkpoint was created.

CheckpointAnnotationHostKernel is used by Container Checkpoint when creating a checkpoint image to specify the kernel version used by the host where the checkpoint was created.

CheckpointAnnotationName is used by Container Checkpoint when creating a checkpoint image to specify the original human-readable name for the container.

CheckpointAnnotationPodmanVersion is used by Container Checkpoint when creating a checkpoint image to specify the version of Podman used on the host where the checkpoint was created.

CheckpointAnnotationRawImageName is used by Container Checkpoint when creating a checkpoint image to specify the original unprocessed name of the image used to create the container (as specified by the user).

CheckpointAnnotationRootfsImageID is used by Container Checkpoint when creating a checkpoint image to specify the original ID of the image used to create the container.

CheckpointAnnotationRootfsImageName is used by Container Checkpoint when creating a checkpoint image to specify the original image name used to create the container.

CheckpointAnnotationRuntimeName is used by Container Checkpoint when creating a checkpoint image to specify the runtime used on the host where the checkpoint was created.

CheckpointAnnotationRuntimeVersion is used by Container Checkpoint when creating a checkpoint image to specify the version of runtime used on the host where the checkpoint was created.

ContainerCreateTimeout is the timeout before we decide we've failed to create a container.

ContainerInitPath is the default path of the mounted container init.

ContainerStateConfigured indicates that the container has had its storage configured but it has not been created in the OCI runtime.

ContainerStateCreated indicates the container has been created in the OCI runtime but not started.

ContainerStateExited indicates the container has stopped and been cleaned up.

ContainerStatePaused indicates that the container has been paused.

ContainerStateRemoving indicates the container is in the process of being removed.

ContainerStateRunning indicates the container is currently executing.

ContainerStateStopped indicates that the container was running but has exited.

ContainerStateStopping indicates the container is in the process of being stopped.

ContainerStateUnknown indicates that the container is in an error state where information about it cannot be retrieved.

DefaultHealthCheckInterval default value.

DefaultHealthCheckRetries default value.

DefaultHealthCheckStartPeriod default value.

DefaultHealthCheckTimeout default value.

DefaultTransport is a prefix that we apply to an image name to check docker hub first for the image.

diff both containers and images.

only diff containers.

only diff images.

ExecErrorCodeCannotInvoke is the error code to return when the runtime fails to invoke a command.

ExecErrorCodeGeneric is the default error code to return from an exec session if libpod failed prior to calling the runtime.

ExecErrorCodeNotFound is the error code to return when a command cannot be found.

ExecStateCreated indicates that the exec session has been created but not yet started.

ExecStateRunning indicates that the exec session has been started but has not yet exited.

ExecStateStopped indicates that the exec session has stopped and is no longer running.

ExecStateUnknown indicates that the state of the exec session is not known.

HealthCheckContainerNotFound means the container could not be found in local store.

HealthCheckContainerStopped means the health check cannot be run because the container is stopped.

HealthCheckDefined means the healthcheck was found on the container.

HealthCheckFailure means the health ran and failed.

HealthCheckHealthy describes a healthy container.

HealthCheckInternalError means some something failed obtaining or running a given health check.

HealthCheckNotDefined means the container has no health check defined in it.

HealthCheckOnFailureActionInvalid denotes an invalid on-failure policy.

HealthCheckOnFailureActionNonce instructs Podman to kill the container on an unhealthy status.

Must be first iota for backwards compatibility.

HealthCheckOnFailureActionNonce instructs Podman to restart the container on an unhealthy status.

HealthCheckOnFailureActionNonce instructs Podman to stop the container on an unhealthy status.

HealthCheckStarting describes the time between when the container starts and the start-period (time allowed for the container to start and application to be running) expires.

HealthCheckStartup means the healthcheck was unhealthy, but is still either within the startup HC or the startup period of the healthcheck.

HealthCheckSuccess means the health worked.

HealthCheckUnhealthy describes an unhealthy container.

HealthConfigTestCmd execs arguments directly.

HealthConfigTestCmdShell runs commands with the system's default shell.

HealthConfigTestNone disables healthcheck.

InfraNameAnnotation is used by generate and play kube when the infra container is set by the user during pod creation.

InitContainerType is used by play kube when playing a kube yaml to specify the type of the init container.

InMemoryStateStore is an in-memory state that will not persist data on containers and pods between libpod instances or after system reboot.

InspectAnnotationApparmor is used by Inspect to identify containers with special Apparmor-related settings.

InspectAnnotationAutoremove is used by Inspect to determine if a container will be automatically removed on exit.

InspectAnnotationCIDFile is used by Inspect to determine if a container ID file was created for the container.

InspectAnnotationInit is used by Inspect to identify containers that mount an init binary in.

InspectAnnotationLabel is used by Inspect to identify containers with special SELinux-related settings.

InspectAnnotationPrivileged is used by Inspect to identify containers which are privileged (IE, running with elevated privileges).

InspectAnnotationPublishAll is used by Inspect to identify containers which have all the ports from their image published.

InspectAnnotationSeccomp is used by Inspect to identify containers with special Seccomp-related settings.

InspectAnnotationVolumesFrom is used by Inspect to identify containers whose volumes are being used by this container.

InspectResponseFalse is a boolean False response for an inspect annotation.

InspectResponseTrue is a boolean True response for an inspect annotation.

InvalidStateStore is an invalid state store.

JournaldLogging is the string conmon expects to specify journald logging.

JSONLogging is the string conmon expects when specifying to use the json logging format.

A DaemonSet kube yaml spec.

A Deployment kube yaml spec.

A Pod kube yaml spec.

Exit non-zero if all containers failed.

Exit non-zero if any container failed.

Invalid exit policy for a proper type system.

Exit 0 regardless of any failed containers.

KubeHealthCheckAnnotation is used by kube play to tell podman that any health checks should follow the k8s behavior of waiting for the intialDelaySeconds to be over before updating the status.

KubernetesLogging is the string conmon expects when specifying to use the kubernetes logging format.

MaxKubeAnnotation is the max length of annotations allowed by Kubernetes.

NoLogging is the string conmon expects when specifying to use no log driver whatsoever.

OneShotInitContainer is a container that only runs as init once and is then deleted.

PassthroughLogging is the string conmon expects when specifying to use the passthrough driver.

PodStateCreated indicates the pod is created but has not been started.

PodStateDegraded indicates that at least one, but not all, of the containers in the pod are running.

PodStateErrored indicates the pod is in an errored state where information about it can no longer be retrieved.

PodStateExited indicates the pod ran but has been stopped.

PodStatePaused indicates the pod has been paused.

PodStateRunning indicates that all of the containers in the pod are running.

PodStateStopped indicates all of the containers belonging to the pod are stopped.

RestartPolicyAlways unconditionally restarts the container.

RestartPolicyNo is identical in function to RestartPolicyNone.

RestartPolicyNone indicates that no restart policy has been requested by a container.

RestartPolicyOnFailure restarts the container on non-0 exit code, with an optional maximum number of retries.

RestartPolicyUnlessStopped unconditionally restarts unless stopped by the user.

DefaultRlimitValue is the value set by default for nofile and nproc.

RunOCIKeepOriginalGroups tells the OCI runtime to leak the users current groups into the container.

RunOCIMountContextType tells the OCI runtime which context mount type to use.

Strings used for --sdnotify option to podman.

Strings used for --sdnotify option to podman.

Strings used for --sdnotify option to podman.

Strings used for --sdnotify option to podman.

SQLiteStateStore is a state backed by a SQLite database It is presently disabled.

TypeBind is the type for mounting host dir.

TypeDevpts is the type for creating a devpts.

TypeRamfs is the type for mounting ramfs.

TypeTmpfs is the type for mounting tmpfs.

TypeVolume is the type for named volumes.

UlimitAnnotation is used by kube play when playing a kube yaml to specify the ulimits of the container.

VolumeDriverImage is the "image" volume driver.

VolumeDriverLocal is the "local" volume driver.

Mount potions for bind.

DefaultRootlessSHMLockPath is the default path for rootless SHM locks.

DefaultSHMLockPath is the default path for SHM locks.

ErrCanceled indicates that an operation has been cancelled by a user.

ErrConmonDead indicates that the container's conmon process has been killed, preventing normal operation.

ErrConmonOutdated indicates the version of conmon found (whether via the configuration or $PATH) is out of date for the current podman version.

ErrConmonVersionFormat is used when the expected version format of conmon has changed.

ErrCtrExists indicates a container with the same name or ID already exists.

ErrCtrFinalized indicates that the container has already been created and cannot be modified.

ErrCtrRemoved indicates that the container has already been removed and no further operations can be performed on it.

ErrCtrStateInvalid indicates a container is in an improper state for the requested operation.

ErrCtrStopped indicates that the requested container is not running and the requested operation cannot be performed until it is started.

ErrDBBadConfig indicates that the database has a different schema or was created by a libpod with a different config.

ErrDBClosed indicates that the connection to the state database has already been closed.

ErrDepExists indicates that the current object has dependencies and cannot be removed before them.

ErrDetach indicates that an attach session was manually detached by the user.

ErrEmptyID indicates that an empty ID was passed.

ErrExecSessionExists indicates an exec session with the same ID already exists.

ErrExecSessionRemoved indicates that the exec session has already been removed and no further operations can be performed on it.

ErrExecSessionStateInvalid indicates that an exec session is in an improper state for the requested operation.

ErrGetSecurityAttribute indicates that a request to get a container's security attribute was not possible.

ErrImageExists indicates an image with the same ID already exists.

ErrInternal indicates an internal library error.

ErrInvalidArg indicates that an invalid argument was passed.

ErrMissingPlugin indicates that the requested operation requires a plugin that is not present on the system or in the configuration.

ErrNetworkConnected indicates that the required operation failed because the container is already a network endpoint.

ErrNetworkExists indicates that a network with the given name already exists.

ErrNetworkInUse indicates the requested operation failed because the network was in use.

ErrNetworkModeInvalid indicates that a container has the wrong network mode for an operation.

ErrNetworkOnPodContainer indicates the user wishes to alter network attributes on a container in a pod.

ErrNoAliases indicates that the container does not have any network aliases.

ErrNoCgroups indicates that the container does not have its own Cgroup.

ErrNoLogs indicates that this container is not creating a log so log operations cannot be performed on it.

ErrNoNetwork indicates that a container has no net namespace, like network=none.

ErrNoSuchCtr indicates the requested container does not exist.

ErrNoSuchExecSession indicates that the requested exec session does not exist.

ErrNoSuchExitCode indicates that the requested container exit code does not exist.

ErrNoSuchNetwork indicates the requested network does not exist.

ErrNoSuchPod indicates the requested pod does not exist.

ErrNoSuchVolume indicates the requested volume does not exist.

ErrNotImplemented indicates that the requested functionality is not yet present.

ErrNSMismatch indicates that the requested pod or container is in a different namespace and cannot be accessed or modified.

ErrOCIRuntime indicates a generic error from the OCI runtime.

ErrOCIRuntimeNotFound indicates the OCI runtime attempted to invoke a command that was not found.

ErrOCIRuntimePermissionDenied indicates the OCI runtime attempted to invoke a command that returned a permission denied error.

ErrOCIRuntimeUnavailable indicates that the OCI runtime associated to a container could not be found in the configuration.

ErrOSNotSupported indicates the function is not available on the particular OS.

ErrPodExists indicates a pod with the same name or ID already exists.

ErrPodFinalized indicates that the pod has already been created and cannot be modified.

ErrPodPartialFail indicates that a pod operation was only partially successful, and some containers within the pod failed.

ErrPodRemoved indicates that the pod has already been removed and no further operations can be performed on it.

ErrRemovingCtrs indicates that there was an error removing all containers from a pod.

ErrRootless indicates that the given command cannot but run without root.

ErrRuntimeFinalized indicates that the runtime has already been created and cannot be modified.

ErrRuntimeStopped indicates that the runtime has already been shut down and no further operations can be performed on it.

ErrSecurityAttribute indicates that an error processing security attributes for the container.

ErrSetSecurityAttribute indicates that a request to set a container's security attribute was not possible.

ErrStoreNotInitialized indicates that the container storage was never initialized.

ErrVolumeBeingUsed indicates that a volume is being used by at least one container.

ErrVolumeExists indicates a volume with the same name already exists.

ErrVolumeFinalized indicates that the volume has already been created and cannot be modified.

ErrVolumeRemoved indicates that the volume has already been removed and no further operations can be performed on it.

ErrWillDeadlock indicates that the requested operation will cause a deadlock.

NameRegex is a regular expression to validate container/pod names.

RegexError is thrown in presence of an invalid container/pod name.

RestartPolicyMap maps between restart-policy valid values to restart policy types.

SupportedHealthCheckOnFailureActions lists all supported healthcheck restart policies.

Address represents an IP address.

AttachStreams contains streams that will be attached to the container.

ConmonInfo describes the conmon executable being used.

ContainerStats contains the statistics information for a running container.

ContainerStore describes the quantity of containers in the store by status.

This contains values reported by CRIU during checkpointing or restoring.

DistributionInfo describes the host distribution for libpod.

DriverData handles the data for a storage driver.

FileInfo describes the attributes of a file or directory.

HealthCheckLog describes the results of a single healthcheck.

HealthCheckResults describes the results/logs from a healthcheck.

HostInfo describes the libpod host.

IDMappings describe the GID and UID mappings.

ImageStore describes the image store.

Info is the overall struct that describes the host system running libpod/podman swagger:model LibpodInfo.

InfoData holds the info type, i.e store, host etc and the data for each type.

InspectAdditionalNetwork holds information about non-default networks the container has been connected to.

InspectBasicNetworkConfig holds basic configuration information (e.g.

InspectBlkioThrottleDevice holds information about a speed cap for a device node.

InspectBlkioWeightDevice holds information about the relative weight of an individual device node.

InspectContainerConfig holds further data about how a container was initially configured.

InspectContainerData provides a detailed record of a container's configuration and state as viewed by Libpod.

InspectContainerHostConfig holds information used when the container was created.

InspectContainerState provides a detailed record of a container's current state.

InspectDevice is a single device that will be mounted into the container.

InspectExecProcess contains information about the process in a given exec session.

InspectExecSession contains information about a given exec session.

InspectHostPort provides information on a port on the host that a container's port is bound to.

InspectLogConfig holds information about a container's configured log driver.

InspectMount provides a record of a single mount in a container.

InspectNetworkSettings holds information about the network settings of the container.

InspectPodContainerInfo contains information on a container in a pod.

InspectPodData contains detailed information on a pod's configuration and state.

InspectPodInfraConfig contains the configuration of the pod's infra container.

InspectRestartPolicy holds information about the container's restart policy.

InspectSecret contains information on secrets mounted inside the container.

InspectUlimit is a ulimit that will be applied to the container.

InspectVolumeData is the output of Inspect() on a volume.

OCIRuntimeInfo describes the runtime (crun or runc) being used with podman.

PastaInfo describes the pasta executable that is being used.

RemoteSocket describes information about the API socket.

SecurityInfo describes the libpod host.

SlirpInfo describes the slirp executable that is being used.

StartupHealthCheck is the configuration of a startup healthcheck.

StoreInfo describes the container storage and its attributes.

Version is an output struct for API.

ContainerExecStatus is the status of an exec session within a container.

ContainerStatus represents the current state of a container.

extra type to use as enum.

HealthCheckOnFailureAction defines how Podman reacts when a container's health status turns unhealthy.

HealthCheckStatus represents the current state of a container.

KubeExitCodePropagation defines an exit policy of kube workloads.

RuntimeStateStore is a constant indicating which state store implementation should be used by libpod.