Versions in this module Expand all Collapse all v4 v4.1.2 Jun 10, 2022 v4.1.1 Jun 10, 2022 Changes in this version + const AlwaysInitContainer + const BindMountPrefix + const CheckpointAnnotationCgroupVersion + const CheckpointAnnotationConmonVersion + const CheckpointAnnotationCriuVersion + const CheckpointAnnotationDistributionName + const CheckpointAnnotationDistributionVersion + const CheckpointAnnotationHostArch + const CheckpointAnnotationHostKernel + const CheckpointAnnotationName + const CheckpointAnnotationPodmanVersion + const CheckpointAnnotationRawImageName + const CheckpointAnnotationRootfsImageID + const CheckpointAnnotationRootfsImageName + const CheckpointAnnotationRuntimeName + const CheckpointAnnotationRuntimeVersion + const ContainerInitPath + const DefaultHealthCheckInterval + const DefaultHealthCheckRetries + const DefaultHealthCheckStartPeriod + const DefaultHealthCheckTimeout + const DefaultTransport + const ExecErrorCodeCannotInvoke + const ExecErrorCodeGeneric + const ExecErrorCodeNotFound + const HealthCheckHealthy + const HealthCheckStarting + const HealthCheckUnhealthy + const InspectAnnotationApparmor + const InspectAnnotationAutoremove + const InspectAnnotationCIDFile + const InspectAnnotationInit + const InspectAnnotationLabel + const InspectAnnotationPrivileged + const InspectAnnotationPublishAll + const InspectAnnotationSeccomp + const InspectAnnotationVolumesFrom + const InspectResponseFalse + const InspectResponseTrue + const JSONLogging + const JournaldLogging + const KubernetesLogging + const MaxKubeAnnotation + const NoLogging + const OCIArchive + const OCIManifestDir + const OneShotInitContainer + const PassthroughLogging + const PodStateCreated + const PodStateDegraded + const PodStateErrored + const PodStateExited + const PodStatePaused + const PodStateRunning + const PodStateStopped + const RLimitDefaultValue + const RestartPolicyAlways + const RestartPolicyNo + const RestartPolicyNone + const RestartPolicyOnFailure + const RestartPolicyUnlessStopped + const SdNotifyModeConmon + const SdNotifyModeContainer + const SdNotifyModeIgnore + const TypeBind + const TypeDevpts + const TypeTmpfs + const TypeVolume + const V2s2Archive + const V2s2ManifestDir + const VolumeDriverLocal + var DefaultRootlessSHMLockPath = "/libpod_rootless_lock" + var DefaultSHMLockPath = "/libpod_lock" + var ErrCanceled = errors.New("cancelled by user") + var ErrConmonDead = errors.New("conmon process killed") + var ErrConmonOutdated = errors.New("outdated conmon version") + var ErrConmonVersionFormat = "conmon version changed format" + var ErrCtrExists = errors.New("container already exists") + var ErrCtrFinalized = errors.New("container has been finalized") + var ErrCtrRemoved = errors.New("container has already been removed") + var ErrCtrStateInvalid = errors.New("container state improper") + var ErrCtrStopped = errors.New("container is stopped") + var ErrDBBadConfig = errors.New("database configuration mismatch") + var ErrDBClosed = errors.New("database connection already closed") + var ErrDepExists = errors.New("dependency exists") + var ErrDetach = errors.New("detached from container") + var ErrEmptyID = errors.New("name or ID cannot be empty") + var ErrExecSessionExists = errors.New("exec session already exists") + var ErrExecSessionRemoved = errors.New("exec session has already been removed") + var ErrExecSessionStateInvalid = errors.New("exec session state improper") + var ErrGetSecurityAttribute = fmt.Errorf("%w: unable to get security attribute", ErrOCIRuntime) + var ErrImageExists = errors.New("image already exists") + var ErrInternal = errors.New("internal libpod error") + var ErrInvalidArg = types.ErrInvalidArg + var ErrMissingPlugin = errors.New("required plugin missing") + var ErrNSMismatch = errors.New("target is in a different namespace") + var ErrNetworkExists = types.ErrNetworkExists + var ErrNetworkInUse = errors.New("network is being used") + var ErrNetworkModeInvalid = errors.New("invalid network mode") + var ErrNetworkOnPodContainer = errors.New("network cannot be configured when it is shared with a pod") + var ErrNoAliases = errors.New("no aliases for container") + var ErrNoCgroups = errors.New("this container does not have a cgroup") + var ErrNoLogs = errors.New("this container is not logging output") + var ErrNoNetwork = errors.New("container has no network namespace") + var ErrNoSuchCtr = errors.New("no such container") + var ErrNoSuchExecSession = errors.New("no such exec session") + var ErrNoSuchNetwork = types.ErrNoSuchNetwork + var ErrNoSuchPod = errors.New("no such pod") + var ErrNoSuchVolume = errors.New("no such volume") + var ErrNotImplemented = errors.New("not yet implemented") + var ErrOCIRuntime = errors.New("OCI runtime error") + var ErrOCIRuntimeNotFound = errors.New("OCI runtime attempted to invoke a command that was not found") + var ErrOCIRuntimePermissionDenied = errors.New("OCI permission denied") + var ErrOCIRuntimeUnavailable = errors.New("OCI unavailable") + var ErrOSNotSupported = errors.New("no support for this OS yet") + var ErrPodExists = errors.New("pod already exists") + var ErrPodFinalized = errors.New("pod has been finalized") + var ErrPodPartialFail = errors.New("some containers failed") + var ErrPodRemoved = errors.New("pod has already been removed") + var ErrRootless = errors.New("operation requires root privileges") + var ErrRuntimeFinalized = errors.New("runtime has been finalized") + var ErrRuntimeStopped = errors.New("runtime has already been stopped") + var ErrSecurityAttribute = fmt.Errorf("%w: unable to process security attribute", ErrOCIRuntime) + var ErrSetSecurityAttribute = fmt.Errorf("%w: unable to assign security attribute", ErrOCIRuntime) + var ErrStoreNotInitialized = errors.New("the container storage was never initialized") + var ErrVolumeBeingUsed = errors.New("volume is being used") + var ErrVolumeExists = errors.New("volume already exists") + var ErrVolumeFinalized = errors.New("volume has been finalized") + var ErrVolumeRemoved = errors.New("volume has already been removed") + var ErrWillDeadlock = errors.New("deadlock due to lock mismatch") + var NameRegex = types.NameRegex + var RegexError = types.RegexError + var RestartPolicyMap = map[string]string + var UmaskRegex = regexp.MustCompile(`^[0-7]{1,4}$`) + func ExitCode(err error) int + func IsReservedAnnotation(value string) bool + func TranslateExecErrorToExitCode(originalEC int, err error) int + type Address struct + Addr string + PrefixLength int + type AttachStreams struct + AttachError bool + AttachInput bool + AttachOutput bool + ErrorStream io.WriteCloser + InputStream *bufio.Reader + OutputStream io.WriteCloser + type CPUUsage struct + IdlePercent float64 + SystemPercent float64 + UserPercent float64 + type CRIUCheckpointRestoreStatistics struct + ForkingTime uint32 + FreezingTime uint32 + FrozenTime uint32 + MemdumpTime uint32 + MemwriteTime uint32 + PagesCompared uint64 + PagesRestored uint64 + PagesScanned uint64 + PagesSkippedCow uint64 + PagesWritten uint64 + RestoreTime uint32 + type ConmonInfo struct + Package string + Path string + Version string + type ContainerExecStatus int + const ExecStateCreated + const ExecStateRunning + const ExecStateStopped + const ExecStateUnknown + func (s ContainerExecStatus) String() string + type ContainerStats struct + AvgCPU float64 + BlockInput uint64 + BlockOutput uint64 + CPU float64 + CPUNano uint64 + CPUSystemNano uint64 + ContainerID string + Duration uint64 + MemLimit uint64 + MemPerc float64 + MemUsage uint64 + Name string + NetInput uint64 + NetOutput uint64 + PIDs uint64 + PerCPU []uint64 + SystemNano uint64 + UpTime time.Duration + type ContainerStatus int + const ContainerStateConfigured + const ContainerStateCreated + const ContainerStateExited + const ContainerStatePaused + const ContainerStateRemoving + const ContainerStateRunning + const ContainerStateStopped + const ContainerStateStopping + const ContainerStateUnknown + func StringToContainerStatus(status string) (ContainerStatus, error) + func (t ContainerStatus) String() string + type ContainerStore struct + Number int + Paused int + Running int + Stopped int + type DiffType uint8 + const DiffAll + const DiffContainer + const DiffImage + func (d DiffType) String() string + type DistributionInfo struct + Codename string + Distribution string + Variant string + Version string + type DriverData struct + Data map[string]string + Name string + type FileInfo struct + IsDir bool + LinkTarget string + ModTime time.Time + Mode os.FileMode + Name string + Size int64 + type HealthCheckLog struct + End string + ExitCode int + Output string + Start string + type HealthCheckResults struct + FailingStreak int + Log []HealthCheckLog + Status string + type HealthCheckStatus int + const HealthCheckContainerNotFound + const HealthCheckContainerStopped + const HealthCheckDefined + const HealthCheckFailure + const HealthCheckInternalError + const HealthCheckNotDefined + const HealthCheckSuccess + type HostInfo struct + Arch string + BuildahVersion string + CPUUtilization *CPUUsage + CPUs int + CgroupControllers []string + CgroupManager string + CgroupsVersion string + Conmon *ConmonInfo + Distribution DistributionInfo + EventLogger string + Hostname string + IDMappings IDMappings + Kernel string + Linkmode string + LogDriver string + MemFree int64 + MemTotal int64 + NetworkBackend string + OCIRuntime *OCIRuntimeInfo + OS string + RemoteSocket *RemoteSocket + RuntimeInfo map[string]interface{} + Security SecurityInfo + ServiceIsRemote bool + Slirp4NetNS SlirpInfo + SwapFree int64 + SwapTotal int64 + Uptime string + type IDMappings struct + GIDMap []idtools.IDMap + UIDMap []idtools.IDMap + type ImageStore struct + Number int + type Info struct + Host *HostInfo + Plugins Plugins + Registries map[string]interface{} + Store *StoreInfo + Version Version + type InfoData struct + Data map[string]interface{} + Type string + type InspectAdditionalNetwork struct + Aliases []string + DriverOpts map[string]string + IPAMConfig map[string]string + Links []string + NetworkID string + type InspectBasicNetworkConfig struct + AdditionalMacAddresses []string + EndpointID string + Gateway string + GlobalIPv6Address string + GlobalIPv6PrefixLen int + IPAddress string + IPPrefixLen int + IPv6Gateway string + MacAddress string + SecondaryIPAddresses []Address + SecondaryIPv6Addresses []Address + type InspectBlkioThrottleDevice struct + Path string + Rate uint64 + type InspectBlkioWeightDevice struct + Path string + Weight uint16 + type InspectContainerConfig struct + Annotations map[string]string + AttachStderr bool + AttachStdin bool + AttachStdout bool + ChrootDirs []string + Cmd []string + CreateCommand []string + DomainName string + Entrypoint string + Env []string + Healthcheck *manifest.Schema2HealthConfig + Hostname string + Image string + Labels map[string]string + OnBuild *string + OpenStdin bool + Passwd *bool + Secrets []*InspectSecret + StdinOnce bool + StopSignal uint + StopTimeout uint + SystemdMode bool + Timeout uint + Timezone string + Tty bool + Umask string + User string + Volumes map[string]struct{} + WorkingDir string + type InspectContainerData struct + AppArmorProfile string + Args []string + BoundingCaps []string + Config *InspectContainerConfig + ConmonPidFile string + Created time.Time + Dependencies []string + Driver string + EffectiveCaps []string + ExecIDs []string + GraphDriver *DriverData + HostConfig *InspectContainerHostConfig + HostnamePath string + HostsPath string + ID string + Image string + ImageName string + IsInfra bool + IsService bool + MountLabel string + Mounts []InspectMount + Name string + Namespace string + NetworkSettings *InspectNetworkSettings + OCIConfigPath string + OCIRuntime string + Path string + PidFile string + Pod string + ProcessLabel string + ResolvConfPath string + RestartCount int32 + Rootfs string + SizeRootFs int64 + SizeRw *int64 + State *InspectContainerState + StaticDir string + type InspectContainerHostConfig struct + AutoRemove bool + Binds []string + BlkioDeviceReadBps []InspectBlkioThrottleDevice + BlkioDeviceReadIOps []InspectBlkioThrottleDevice + BlkioDeviceWriteBps []InspectBlkioThrottleDevice + BlkioDeviceWriteIOps []InspectBlkioThrottleDevice + BlkioWeight uint16 + BlkioWeightDevice []InspectBlkioWeightDevice + CapAdd []string + CapDrop []string + Cgroup string + CgroupConf map[string]string + CgroupManager string + CgroupMode string + CgroupParent string + Cgroups string + ConsoleSize []uint + ContainerIDFile string + CpuCount uint64 + CpuPercent uint64 + CpuPeriod uint64 + CpuQuota int64 + CpuRealtimePeriod uint64 + CpuRealtimeRuntime int64 + CpuShares uint64 + CpusetCpus string + CpusetMems string + Devices []InspectDevice + DiskQuota uint64 + Dns []string + DnsOptions []string + DnsSearch []string + ExtraHosts []string + GroupAdd []string + IDMappings *InspectIDMappings + IOMaximumBandwidth uint64 + IOMaximumIOps uint64 + Init bool + IpcMode string + Isolation string + KernelMemory int64 + Links []string + LogConfig *InspectLogConfig + Memory int64 + MemoryReservation int64 + MemorySwap int64 + MemorySwappiness int64 + NanoCpus int64 + NetworkMode string + OomKillDisable bool + OomScoreAdj int + PidMode string + PidsLimit int64 + PortBindings map[string][]InspectHostPort + Privileged bool + PublishAllPorts bool + ReadonlyRootfs bool + RestartPolicy *InspectRestartPolicy + Runtime string + SecurityOpt []string + ShmSize int64 + Tmpfs map[string]string + UTSMode string + Ulimits []InspectUlimit + UsernsMode string + VolumeDriver string + VolumesFrom []string + type InspectContainerState struct + CgroupPath string + CheckpointLog string + CheckpointPath string + Checkpointed bool + CheckpointedAt time.Time + ConmonPid int + Dead bool + Error string + ExitCode int32 + FinishedAt time.Time + Health HealthCheckResults + OOMKilled bool + OciVersion string + Paused bool + Pid int + Restarting bool + RestoreLog string + Restored bool + RestoredAt time.Time + Running bool + StartedAt time.Time + Status string + func (s *InspectContainerState) Healthcheck() HealthCheckResults + type InspectDevice struct + CgroupPermissions string + PathInContainer string + PathOnHost string + type InspectExecProcess struct + Arguments []string + Entrypoint string + Privileged bool + Tty bool + User string + type InspectExecSession struct + CanRemove bool + ContainerID string + DetachKeys string + ExitCode int + ID string + OpenStderr bool + OpenStdin bool + OpenStdout bool + Pid int + ProcessConfig *InspectExecProcess + Running bool + type InspectHostPort struct + HostIP string + HostPort string + type InspectIDMappings struct + GIDMap []string + UIDMap []string + type InspectLogConfig struct + Config map[string]string + Path string + Size string + Tag string + Type string + type InspectMount struct + Destination string + Driver string + Mode string + Name string + Options []string + Propagation string + RW bool + Source string + Type string + type InspectNetworkSettings struct + Bridge string + HairpinMode bool + LinkLocalIPv6Address string + LinkLocalIPv6PrefixLen int + Networks map[string]*InspectAdditionalNetwork + Ports map[string][]InspectHostPort + SandboxID string + SandboxKey string + type InspectPodContainerInfo struct + ID string + Name string + State string + type InspectPodData struct + BlkioDeviceReadBps []InspectBlkioThrottleDevice + CPUPeriod uint64 + CPUQuota int64 + CPUSetCPUs string + CgroupParent string + CgroupPath string + Containers []InspectPodContainerInfo + CreateCgroup bool + CreateCommand []string + CreateInfra bool + Created time.Time + Devices []InspectDevice + ExitPolicy string + Hostname string + ID string + InfraConfig *InspectPodInfraConfig + InfraContainerID string + Labels map[string]string + Mounts []InspectMount + Name string + Namespace string + NumContainers uint + SecurityOpts []string + SharedNamespaces []string + State string + VolumesFrom []string + type InspectPodInfraConfig struct + CPUPeriod uint64 + CPUQuota int64 + CPUSetCPUs string + DNSOption []string + DNSSearch []string + DNSServer []string + HostAdd []string + HostNetwork bool + NetworkOptions map[string][]string + Networks []string + NoManageHosts bool + NoManageResolvConf bool + PidNS string + PortBindings map[string][]InspectHostPort + StaticIP net.IP + StaticMAC string + UserNS string + type InspectRestartPolicy struct + MaximumRetryCount uint + Name string + type InspectSecret struct + GID uint32 + ID string + Mode uint32 + Name string + UID uint32 + type InspectUlimit struct + Hard int64 + Name string + Soft int64 + type InspectVolumeData struct + Anonymous bool + CreatedAt time.Time + Driver string + GID int + Labels map[string]string + MountCount uint + Mountpoint string + Name string + NeedsChown bool + NeedsCopyUp bool + Options map[string]string + Scope string + Status map[string]interface{} + UID int + type OCIRuntimeInfo struct + Name string + Package string + Path string + Version string + type Plugins struct + Authorization []string + Log []string + Network []string + Volume []string + type RemoteSocket struct + Exists bool + Path string + type RuntimeStateStore int + const BoltDBStateStore + const ContainerCreateTimeout + const InMemoryStateStore + const InvalidStateStore + const SQLiteStateStore + type SecurityInfo struct + AppArmorEnabled bool + DefaultCapabilities string + Rootless bool + SECCOMPEnabled bool + SECCOMPProfilePath string + SELinuxEnabled bool + type SlirpInfo struct + Executable string + Package string + Version string + type StoreInfo struct + ConfigFile string + ContainerStore ContainerStore + GraphDriverName string + GraphOptions map[string]interface{} + GraphRoot string + GraphRootAllocated uint64 + GraphRootUsed uint64 + GraphStatus map[string]string + ImageCopyTmpDir string + ImageStore ImageStore + RunRoot string + VolumePath string + type TerminalSize struct + Height uint16 + Width uint16 + type Version struct + APIVersion string + Built int64 + BuiltTime string + GitCommit string + GoVersion string + Os string + OsArch string + Version string + func GetVersion() (Version, error)
Go to main page