Documentation ¶
Index ¶
- type Address
- type AuthConfig
- type AuthenticateOKBody
- type AutoUserNsOptions
- type BindOptions
- type CgroupSpec
- type CgroupnsMode
- type ComponentVersion
- type Config
- type ConfigReference
- type ConmonInfo
- type Consistency
- type ContainerBasicConfig
- type ContainerCgroupConfig
- type ContainerChangeResponseItem
- func (m *ContainerChangeResponseItem) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *ContainerChangeResponseItem) MarshalBinary() ([]byte, error)
- func (m *ContainerChangeResponseItem) UnmarshalBinary(b []byte) error
- func (m *ContainerChangeResponseItem) Validate(formats strfmt.Registry) error
- type ContainerCreateCreatedBody
- func (m *ContainerCreateCreatedBody) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *ContainerCreateCreatedBody) MarshalBinary() ([]byte, error)
- func (m *ContainerCreateCreatedBody) UnmarshalBinary(b []byte) error
- func (m *ContainerCreateCreatedBody) Validate(formats strfmt.Registry) error
- type ContainerHealthCheckConfig
- func (m *ContainerHealthCheckConfig) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *ContainerHealthCheckConfig) MarshalBinary() ([]byte, error)
- func (m *ContainerHealthCheckConfig) UnmarshalBinary(b []byte) error
- func (m *ContainerHealthCheckConfig) Validate(formats strfmt.Registry) error
- type ContainerNetworkConfig
- func (m *ContainerNetworkConfig) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *ContainerNetworkConfig) MarshalBinary() ([]byte, error)
- func (m *ContainerNetworkConfig) UnmarshalBinary(b []byte) error
- func (m *ContainerNetworkConfig) Validate(formats strfmt.Registry) error
- type ContainerNode
- type ContainerResourceConfig
- func (m *ContainerResourceConfig) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *ContainerResourceConfig) MarshalBinary() ([]byte, error)
- func (m *ContainerResourceConfig) UnmarshalBinary(b []byte) error
- func (m *ContainerResourceConfig) Validate(formats strfmt.Registry) error
- type ContainerSecurityConfig
- func (m *ContainerSecurityConfig) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *ContainerSecurityConfig) MarshalBinary() ([]byte, error)
- func (m *ContainerSecurityConfig) UnmarshalBinary(b []byte) error
- func (m *ContainerSecurityConfig) Validate(formats strfmt.Registry) error
- type ContainerSize
- type ContainerState
- type ContainerStorageConfig
- func (m *ContainerStorageConfig) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *ContainerStorageConfig) MarshalBinary() ([]byte, error)
- func (m *ContainerStorageConfig) UnmarshalBinary(b []byte) error
- func (m *ContainerStorageConfig) Validate(formats strfmt.Registry) error
- type ContainerStore
- type ContainerTopOKBody
- type ContainerUpdateOKBody
- type ContainerWaitOKBody
- type ContainerWaitOKBodyError
- func (m *ContainerWaitOKBodyError) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *ContainerWaitOKBodyError) MarshalBinary() ([]byte, error)
- func (m *ContainerWaitOKBodyError) UnmarshalBinary(b []byte) error
- func (m *ContainerWaitOKBodyError) Validate(formats strfmt.Registry) error
- type ContainersPruneReport
- type CreateContainerConfig
- type DeviceMapping
- type DeviceRequest
- type Digest
- type DistributionInfo
- type DockerVolumeCreate
- type Driver
- type DriverData
- type Duration
- type EndpointIPAMConfig
- type EndpointResource
- type EndpointSettings
- type ErrorResponse
- type FileMode
- type GraphDriverData
- type HardwareAddr
- type Health
- type HealthCheckLog
- type HealthCheckResults
- type HealthConfig
- type HealthcheckResult
- type History
- type HistoryResponseItem
- type HostConfig
- type HostInfo
- type IDMap
- type IDMappingOptions
- type IDMappings
- type IDResponse
- type IP
- type IPAM
- type IPAMConfig
- type IPMask
- type IPNet
- type ImageConfig
- type ImageDeleteResponseItem
- func (m *ImageDeleteResponseItem) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *ImageDeleteResponseItem) MarshalBinary() ([]byte, error)
- func (m *ImageDeleteResponseItem) UnmarshalBinary(b []byte) error
- func (m *ImageDeleteResponseItem) Validate(formats strfmt.Registry) error
- type ImageImportReport
- type ImageLoadReport
- type ImageMetadata
- type ImageStore
- type ImageSummary
- type ImageVolume
- type Info
- type InspectAdditionalNetwork
- func (m *InspectAdditionalNetwork) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *InspectAdditionalNetwork) MarshalBinary() ([]byte, error)
- func (m *InspectAdditionalNetwork) UnmarshalBinary(b []byte) error
- func (m *InspectAdditionalNetwork) Validate(formats strfmt.Registry) error
- type InspectBlkioThrottleDevice
- func (m *InspectBlkioThrottleDevice) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *InspectBlkioThrottleDevice) MarshalBinary() ([]byte, error)
- func (m *InspectBlkioThrottleDevice) UnmarshalBinary(b []byte) error
- func (m *InspectBlkioThrottleDevice) Validate(formats strfmt.Registry) error
- type InspectBlkioWeightDevice
- func (m *InspectBlkioWeightDevice) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *InspectBlkioWeightDevice) MarshalBinary() ([]byte, error)
- func (m *InspectBlkioWeightDevice) UnmarshalBinary(b []byte) error
- func (m *InspectBlkioWeightDevice) Validate(formats strfmt.Registry) error
- type InspectContainerConfig
- func (m *InspectContainerConfig) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *InspectContainerConfig) MarshalBinary() ([]byte, error)
- func (m *InspectContainerConfig) UnmarshalBinary(b []byte) error
- func (m *InspectContainerConfig) Validate(formats strfmt.Registry) error
- type InspectContainerHostConfig
- func (m *InspectContainerHostConfig) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *InspectContainerHostConfig) MarshalBinary() ([]byte, error)
- func (m *InspectContainerHostConfig) UnmarshalBinary(b []byte) error
- func (m *InspectContainerHostConfig) Validate(formats strfmt.Registry) error
- type InspectContainerState
- type InspectDevice
- type InspectHostPort
- type InspectIDMappings
- type InspectLogConfig
- type InspectMount
- type InspectNetworkSettings
- func (m *InspectNetworkSettings) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *InspectNetworkSettings) MarshalBinary() ([]byte, error)
- func (m *InspectNetworkSettings) UnmarshalBinary(b []byte) error
- func (m *InspectNetworkSettings) Validate(formats strfmt.Registry) error
- type InspectPodContainerInfo
- func (m *InspectPodContainerInfo) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *InspectPodContainerInfo) MarshalBinary() ([]byte, error)
- func (m *InspectPodContainerInfo) UnmarshalBinary(b []byte) error
- func (m *InspectPodContainerInfo) Validate(formats strfmt.Registry) error
- type InspectPodInfraConfig
- type InspectRestartPolicy
- type InspectSecret
- type InspectUlimit
- type IpcMode
- type Isolation
- type LeaseRange
- type LibpodContainersPruneReport
- func (m *LibpodContainersPruneReport) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *LibpodContainersPruneReport) MarshalBinary() ([]byte, error)
- func (m *LibpodContainersPruneReport) UnmarshalBinary(b []byte) error
- func (m *LibpodContainersPruneReport) Validate(formats strfmt.Registry) error
- type LibpodContainersRmReport
- func (m *LibpodContainersRmReport) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *LibpodContainersRmReport) MarshalBinary() ([]byte, error)
- func (m *LibpodContainersRmReport) UnmarshalBinary(b []byte) error
- func (m *LibpodContainersRmReport) Validate(formats strfmt.Registry) error
- type LibpodImageSummary
- type LibpodImagesPullReport
- func (m *LibpodImagesPullReport) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *LibpodImagesPullReport) MarshalBinary() ([]byte, error)
- func (m *LibpodImagesPullReport) UnmarshalBinary(b []byte) error
- func (m *LibpodImagesPullReport) Validate(formats strfmt.Registry) error
- type LibpodImagesRemoveReport
- func (m *LibpodImagesRemoveReport) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *LibpodImagesRemoveReport) MarshalBinary() ([]byte, error)
- func (m *LibpodImagesRemoveReport) UnmarshalBinary(b []byte) error
- func (m *LibpodImagesRemoveReport) Validate(formats strfmt.Registry) error
- type LinuxBlockIO
- type LinuxBlockIODevice
- type LinuxCPU
- type LinuxDevice
- type LinuxDeviceCgroup
- type LinuxHugepageLimit
- type LinuxInterfacePriority
- func (m *LinuxInterfacePriority) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *LinuxInterfacePriority) MarshalBinary() ([]byte, error)
- func (m *LinuxInterfacePriority) UnmarshalBinary(b []byte) error
- func (m *LinuxInterfacePriority) Validate(formats strfmt.Registry) error
- type LinuxMemory
- type LinuxNetwork
- type LinuxPersonality
- type LinuxPersonalityDomain
- type LinuxPersonalityFlag
- type LinuxPids
- type LinuxRdma
- type LinuxResources
- type LinuxThrottleDevice
- type LinuxWeightDevice
- type ListContainer
- type ListContainerNamespaces
- func (m *ListContainerNamespaces) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *ListContainerNamespaces) MarshalBinary() ([]byte, error)
- func (m *ListContainerNamespaces) UnmarshalBinary(b []byte) error
- func (m *ListContainerNamespaces) Validate(formats strfmt.Registry) error
- type ListPodContainer
- type ListPodsReport
- type LogConfig
- type MacAddress
- type ManifestAddOptions
- type ManifestAnnotateOptions
- func (m *ManifestAnnotateOptions) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *ManifestAnnotateOptions) MarshalBinary() ([]byte, error)
- func (m *ManifestAnnotateOptions) UnmarshalBinary(b []byte) error
- func (m *ManifestAnnotateOptions) Validate(formats strfmt.Registry) error
- type ManifestModifyOptions
- type ManifestModifyReport
- type ManifestRemoveOptions
- type Mount
- type MountPoint
- type NamedVolume
- type Namespace
- type NamespaceMode
- type NetOptions
- type Network
- type NetworkConnect
- type NetworkConnectOptions
- type NetworkCreate
- type NetworkCreateRequest
- type NetworkDisconnect
- type NetworkMode
- type NetworkPruneReport
- type NetworkResource
- type NetworkRmReport
- type NetworkSettings
- type NetworkingConfig
- type OCIRuntimeInfo
- type OverlayVolume
- type POSIXRlimit
- type PeerInfo
- type PerNetworkOptions
- type PidMode
- type PlayKubePod
- type PlayKubeReport
- type PlayKubeVolume
- type Plugin
- type PluginConfig
- type PluginConfigArgs
- type PluginConfigInterface
- type PluginConfigLinux
- type PluginConfigNetwork
- type PluginConfigRootfs
- type PluginConfigUser
- type PluginDevice
- type PluginEnv
- type PluginInterfaceType
- type PluginMount
- type PluginSettings
- type Plugins
- type PodBasicConfig
- type PodCgroupConfig
- type PodCreateConfig
- type PodCreateOptions
- type PodKillReport
- type PodNetworkConfig
- type PodPauseReport
- type PodPruneReport
- type PodResourceConfig
- type PodRestartReport
- type PodRmReport
- type PodSecurityConfig
- type PodSpecGenerator
- type PodStartReport
- type PodStopReport
- type PodStorageConfig
- type PodUnpauseReport
- type Port
- type PortBinding
- type PortMap
- type PortMapping
- type PortSet
- type Propagation
- type PruneReport
- type RemoteSocket
- type Resources
- type RestartPolicy
- type RootFS
- type Schema2HealthConfig
- type Schema2List
- type Schema2ManifestDescriptor
- func (m *Schema2ManifestDescriptor) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *Schema2ManifestDescriptor) MarshalBinary() ([]byte, error)
- func (m *Schema2ManifestDescriptor) UnmarshalBinary(b []byte) error
- func (m *Schema2ManifestDescriptor) Validate(formats strfmt.Registry) error
- type Schema2PlatformSpec
- type Secret
- type SecretCreateRequest
- type SecretDriverSpec
- type SecretInfoReport
- type SecretInfoReportCompat
- func (m *SecretInfoReportCompat) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *SecretInfoReportCompat) MarshalBinary() ([]byte, error)
- func (m *SecretInfoReportCompat) UnmarshalBinary(b []byte) error
- func (m *SecretInfoReportCompat) Validate(formats strfmt.Registry) error
- type SecretSpec
- type SecretVersion
- type SecurityInfo
- type ServiceInfo
- type ServiceUpdateResponse
- type Signal
- type SlirpInfo
- type SpecGenerator
- type StoreInfo
- type StrSlice
- type Subnet
- type SwagCompatNetworkConnectRequest
- func (m *SwagCompatNetworkConnectRequest) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *SwagCompatNetworkConnectRequest) MarshalBinary() ([]byte, error)
- func (m *SwagCompatNetworkConnectRequest) UnmarshalBinary(b []byte) error
- func (m *SwagCompatNetworkConnectRequest) Validate(formats strfmt.Registry) error
- type SwagCompatNetworkDisconnectRequest
- func (m *SwagCompatNetworkDisconnectRequest) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *SwagCompatNetworkDisconnectRequest) MarshalBinary() ([]byte, error)
- func (m *SwagCompatNetworkDisconnectRequest) UnmarshalBinary(b []byte) error
- func (m *SwagCompatNetworkDisconnectRequest) Validate(formats strfmt.Registry) error
- type SwagNetworkConnectRequest
- func (m *SwagNetworkConnectRequest) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *SwagNetworkConnectRequest) MarshalBinary() ([]byte, error)
- func (m *SwagNetworkConnectRequest) UnmarshalBinary(b []byte) error
- func (m *SwagNetworkConnectRequest) Validate(formats strfmt.Registry) error
- type SwagNetworkCreateLibpod
- func (m *SwagNetworkCreateLibpod) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *SwagNetworkCreateLibpod) MarshalBinary() ([]byte, error)
- func (m *SwagNetworkCreateLibpod) UnmarshalBinary(b []byte) error
- func (m *SwagNetworkCreateLibpod) Validate(formats strfmt.Registry) error
- type SystemDfContainerReport
- func (m *SystemDfContainerReport) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *SystemDfContainerReport) MarshalBinary() ([]byte, error)
- func (m *SystemDfContainerReport) UnmarshalBinary(b []byte) error
- func (m *SystemDfContainerReport) Validate(formats strfmt.Registry) error
- type SystemDfImageReport
- type SystemDfVolumeReport
- type Task
- type ThrottleDevice
- type TmpfsOptions
- type Type
- type UTSMode
- type Ulimit
- type UsernsMode
- type Version
- type Volume
- type VolumeConfigResponse
- type VolumeCreateBody
- type VolumeCreateOptions
- type VolumeListBody
- type VolumeListOKBody
- type VolumeOptions
- type VolumeUsageData
- type WeightDevice
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Address ¶
type Address struct { // addr Addr string `json:"Addr,omitempty"` // prefix length PrefixLength int64 `json:"PrefixLength,omitempty"` }
Address Address represents an IP address.
swagger:model Address
func (*Address) ContextValidate ¶
ContextValidate validates this address based on context it is used
func (*Address) MarshalBinary ¶
MarshalBinary interface implementation
func (*Address) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type AuthConfig ¶
type AuthConfig struct { // auth Auth string `json:"auth,omitempty"` // Email is an optional value associated with the username. // This field is deprecated and will be removed in a later // version of docker. Email string `json:"email,omitempty"` // IdentityToken is used to authenticate the user and get // an access token for the registry. IdentityToken string `json:"identitytoken,omitempty"` // password Password string `json:"password,omitempty"` // RegistryToken is a bearer token to be sent to a registry RegistryToken string `json:"registrytoken,omitempty"` // server address ServerAddress string `json:"serveraddress,omitempty"` // username Username string `json:"username,omitempty"` }
AuthConfig AuthConfig contains authorization information for connecting to a Registry
swagger:model AuthConfig
func (*AuthConfig) ContextValidate ¶
ContextValidate validates this auth config based on context it is used
func (*AuthConfig) MarshalBinary ¶
func (m *AuthConfig) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*AuthConfig) UnmarshalBinary ¶
func (m *AuthConfig) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type AuthenticateOKBody ¶
type AuthenticateOKBody struct { // An opaque token used to authenticate a user after a successful login // Required: true IdentityToken *string `json:"IdentityToken"` // The status of the authentication // Required: true Status *string `json:"Status"` }
AuthenticateOKBody AuthenticateOKBody authenticate o k body
swagger:model AuthenticateOKBody
func (*AuthenticateOKBody) ContextValidate ¶
ContextValidate validates this authenticate o k body based on context it is used
func (*AuthenticateOKBody) MarshalBinary ¶
func (m *AuthenticateOKBody) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*AuthenticateOKBody) UnmarshalBinary ¶
func (m *AuthenticateOKBody) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type AutoUserNsOptions ¶
type AutoUserNsOptions struct { // AdditionalGIDMappings specified additional GID mappings to include in // the generated user namespace. AdditionalGIDMappings []*IDMap `json:"AdditionalGIDMappings"` // AdditionalUIDMappings specified additional UID mappings to include in // the generated user namespace. AdditionalUIDMappings []*IDMap `json:"AdditionalUIDMappings"` // GroupFile to use if the container uses a volume. GroupFile string `json:"GroupFile,omitempty"` // InitialSize defines the minimum size for the user namespace. // The created user namespace will have at least this size. InitialSize uint32 `json:"InitialSize,omitempty"` // PasswdFile to use if the container uses a volume. PasswdFile string `json:"PasswdFile,omitempty"` // Size defines the size for the user namespace. If it is set to a // value bigger than 0, the user namespace will have exactly this size. // If it is not set, some heuristics will be used to find its size. Size uint32 `json:"Size,omitempty"` }
AutoUserNsOptions AutoUserNsOptions defines how to automatically create a user namespace.
swagger:model AutoUserNsOptions
func (*AutoUserNsOptions) ContextValidate ¶
ContextValidate validate this auto user ns options based on the context it is used
func (*AutoUserNsOptions) MarshalBinary ¶
func (m *AutoUserNsOptions) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*AutoUserNsOptions) UnmarshalBinary ¶
func (m *AutoUserNsOptions) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type BindOptions ¶
type BindOptions struct { // non recursive NonRecursive bool `json:"NonRecursive,omitempty"` // propagation Propagation Propagation `json:"Propagation,omitempty"` }
BindOptions BindOptions defines options specific to mounts of type "bind".
swagger:model BindOptions
func (*BindOptions) ContextValidate ¶
ContextValidate validate this bind options based on the context it is used
func (*BindOptions) MarshalBinary ¶
func (m *BindOptions) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*BindOptions) UnmarshalBinary ¶
func (m *BindOptions) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type CgroupSpec ¶
type CgroupSpec string
CgroupSpec CgroupSpec represents the cgroup to use for the container.
swagger:model CgroupSpec
func (CgroupSpec) ContextValidate ¶
ContextValidate validates this cgroup spec based on context it is used
type CgroupnsMode ¶
type CgroupnsMode string
CgroupnsMode CgroupnsMode represents the cgroup namespace mode of the container
swagger:model CgroupnsMode
func (CgroupnsMode) ContextValidate ¶
ContextValidate validates this cgroupns mode based on context it is used
type ComponentVersion ¶
type ComponentVersion struct { // details Details map[string]string `json:"Details,omitempty"` // name Name string `json:"Name,omitempty"` // version Version string `json:"Version,omitempty"` }
ComponentVersion ComponentVersion describes the version information for a specific component.
swagger:model ComponentVersion
func (*ComponentVersion) ContextValidate ¶
ContextValidate validates this component version based on context it is used
func (*ComponentVersion) MarshalBinary ¶
func (m *ComponentVersion) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ComponentVersion) UnmarshalBinary ¶
func (m *ComponentVersion) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Config ¶
type Config struct { // args escaped ArgsEscaped bool `json:"ArgsEscaped,omitempty"` // attach stderr AttachStderr bool `json:"AttachStderr,omitempty"` // attach stdin AttachStdin bool `json:"AttachStdin,omitempty"` // attach stdout AttachStdout bool `json:"AttachStdout,omitempty"` // cmd Cmd StrSlice `json:"Cmd,omitempty"` // domainname Domainname string `json:"Domainname,omitempty"` // entrypoint Entrypoint StrSlice `json:"Entrypoint,omitempty"` // env Env []string `json:"Env"` // exposed ports ExposedPorts PortSet `json:"ExposedPorts,omitempty"` // healthcheck Healthcheck *HealthConfig `json:"Healthcheck,omitempty"` // hostname Hostname string `json:"Hostname,omitempty"` // image Image string `json:"Image,omitempty"` // labels Labels map[string]string `json:"Labels,omitempty"` // mac address MacAddress string `json:"MacAddress,omitempty"` // network disabled NetworkDisabled bool `json:"NetworkDisabled,omitempty"` // on build OnBuild []string `json:"OnBuild"` // open stdin OpenStdin bool `json:"OpenStdin,omitempty"` // shell Shell StrSlice `json:"Shell,omitempty"` // stdin once StdinOnce bool `json:"StdinOnce,omitempty"` // stop signal StopSignal string `json:"StopSignal,omitempty"` // stop timeout StopTimeout int64 `json:"StopTimeout,omitempty"` // tty Tty bool `json:"Tty,omitempty"` // user User string `json:"User,omitempty"` // volumes Volumes map[string]interface{} `json:"Volumes,omitempty"` // working dir WorkingDir string `json:"WorkingDir,omitempty"` }
Config Config contains the configuration data about a container.
It should hold only portable information about the container. Here, "portable" means "independent from the host we are running on". Non-portable information *should* appear in HostConfig. All fields added to this struct must be marked `omitempty` to keep getting predictable hashes from the old `v1Compatibility` configuration.
swagger:model Config
func (*Config) ContextValidate ¶
ContextValidate validate this config based on the context it is used
func (*Config) MarshalBinary ¶
MarshalBinary interface implementation
func (*Config) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type ConfigReference ¶
type ConfigReference struct { // network Network string `json:"Network,omitempty"` }
ConfigReference ConfigReference specifies the source which provides a network's configuration
swagger:model ConfigReference
func (*ConfigReference) ContextValidate ¶
ContextValidate validates this config reference based on context it is used
func (*ConfigReference) MarshalBinary ¶
func (m *ConfigReference) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ConfigReference) UnmarshalBinary ¶
func (m *ConfigReference) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ConmonInfo ¶
type ConmonInfo struct { // package Package string `json:"package,omitempty"` // path Path string `json:"path,omitempty"` // version Version string `json:"version,omitempty"` }
ConmonInfo ConmonInfo describes the conmon executable being used
swagger:model ConmonInfo
func (*ConmonInfo) ContextValidate ¶
ContextValidate validates this conmon info based on context it is used
func (*ConmonInfo) MarshalBinary ¶
func (m *ConmonInfo) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ConmonInfo) UnmarshalBinary ¶
func (m *ConmonInfo) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Consistency ¶
type Consistency string
Consistency Consistency represents the consistency requirements of a mount.
swagger:model Consistency
func (Consistency) ContextValidate ¶
ContextValidate validates this consistency based on context it is used
type ContainerBasicConfig ¶
type ContainerBasicConfig struct { // Annotations are key-value options passed into the container runtime // that can be used to trigger special behavior. // Optional. Annotations map[string]string `json:"annotations,omitempty"` // Command is the container's command. // If not given and Image is specified, this will be populated by the // image's configuration. // Optional. Command []string `json:"command"` // ConmonPidFile is a path at which a PID file for Conmon will be // placed. // If not given, a default location will be used. // Optional. ConmonPidFile string `json:"conmon_pid_file,omitempty"` // ContainerCreateCommand is the command that was used to create this // container. // This will be shown in the output of Inspect() on the container, and // may also be used by some tools that wish to recreate the container // (e.g. `podman generate systemd --new`). // Optional. ContainerCreateCommand []string `json:"containerCreateCommand"` // DependencyContainers is an array of containers this container // depends on. Dependency containers must be started before this // container. Dependencies can be specified by name or full/partial ID. // Optional. DependencyContainers []string `json:"dependencyContainers"` // Entrypoint is the container's entrypoint. // If not given and Image is specified, this will be populated by the // image's configuration. // Optional. Entrypoint []string `json:"entrypoint"` // Env is a set of environment variables that will be set in the // container. // Optional. Env map[string]string `json:"env,omitempty"` // EnvHost indicates that the host environment should be added to container // Optional. EnvHost bool `json:"env_host,omitempty"` // EnvSecrets are secrets that will be set as environment variables // Optional. EnvSecrets map[string]string `json:"secret_env,omitempty"` // EnvHTTPProxy indicates that the http host proxy environment variables // should be added to container // Optional. HTTPProxy bool `json:"httpproxy,omitempty"` // HostUses is a list of host usernames or UIDs to add to the container // etc/passwd file HostUsers []string `json:"hostusers"` // Hostname is the container's hostname. If not set, the hostname will // not be modified (if UtsNS is not private) or will be set to the // container ID (if UtsNS is private). // Conflicts with UtsNS if UtsNS is not set to private. // Optional. Hostname string `json:"hostname,omitempty"` // InitContainerType describes if this container is an init container // and if so, what type: always or once InitContainerType string `json:"init_container_type,omitempty"` // Labels are key-value pairs that are used to add metadata to // containers. // Optional. Labels map[string]string `json:"labels,omitempty"` // Name is the name the container will be given. // If no name is provided, one will be randomly generated. // Optional. Name string `json:"name,omitempty"` // Namespace is the libpod namespace the container will be placed in. // Optional. Namespace string `json:"namespace,omitempty"` // OCIRuntime is the name of the OCI runtime that will be used to create // the container. // If not specified, the default will be used. // Optional. OCIRuntime string `json:"oci_runtime,omitempty"` // Passwd is a container run option that determines if we are validating users/groups before running the container Passwd bool `json:"manage_password,omitempty"` // Pod is the ID of the pod the container will join. // Optional. Pod string `json:"pod,omitempty"` // RawImageName is the user-specified and unprocessed input referring // to a local or a remote image. RawImageName string `json:"raw_image_name,omitempty"` // Remove indicates if the container should be removed once it has been started // and exits Remove bool `json:"remove,omitempty"` // RestartPolicy is the container's restart policy - an action which // will be taken when the container exits. // If not given, the default policy, which does nothing, will be used. // Optional. RestartPolicy string `json:"restart_policy,omitempty"` // RestartRetries is the number of attempts that will be made to restart // the container. // Only available when RestartPolicy is set to "on-failure". // Optional. RestartRetries uint64 `json:"restart_tries,omitempty"` // Determine how to handle the NOTIFY_SOCKET - do we participate or pass it through // "container" - let the OCI runtime deal with it, advertise conmon's MAINPID // "conmon-only" - advertise conmon's MAINPID, send READY when started, don't pass to OCI // "ignore" - unset NOTIFY_SOCKET SdNotifyMode string `json:"sdnotifyMode,omitempty"` // Stdin is whether the container will keep its STDIN open. Stdin bool `json:"stdin,omitempty"` // StopTimeout is a timeout between the container's stop signal being // sent and SIGKILL being sent. // If not provided, the default will be used. // If 0 is used, stop signal will not be sent, and SIGKILL will be sent // instead. // Optional. StopTimeout uint64 `json:"stop_timeout,omitempty"` // Sysctl sets kernel parameters for the container Sysctl map[string]string `json:"sysctl,omitempty"` // Systemd is whether the container will be started in systemd mode. // Valid options are "true", "false", and "always". // "true" enables this mode only if the binary run in the container is // sbin/init or systemd. "always" unconditionally enables systemd mode. // "false" unconditionally disables systemd mode. // If enabled, mounts and stop signal will be modified. // If set to "always" or set to "true" and conditionally triggered, // conflicts with StopSignal. // If not specified, "false" will be assumed. // Optional. Systemd string `json:"systemd,omitempty"` // Terminal is whether the container will create a PTY. // Optional. Terminal bool `json:"terminal,omitempty"` // Timeout is a maximum time in seconds the container will run before // main process is sent SIGKILL. // If 0 is used, signal will not be sent. Container can run indefinitely // Optional. Timeout uint64 `json:"timeout,omitempty"` // Timezone is the timezone inside the container. // Local means it has the same timezone as the host machine // Optional. Timezone string `json:"timezone,omitempty"` // UnsetEnv unsets the specified default environment variables from the image or from buildin or containers.conf // Optional. UnsetEnv []string `json:"unsetenv"` // UnsetEnvAll unsetall default environment variables from the image or from buildin or containers.conf // UnsetEnvAll unsets all default environment variables from the image or from buildin // Optional. UnsetEnvAll bool `json:"unsetenvall,omitempty"` // log configuration LogConfiguration *LogConfig `json:"log_configuration,omitempty"` // personality Personality *LinuxPersonality `json:"personality,omitempty"` // pidns Pidns *Namespace `json:"pidns,omitempty"` // stop signal StopSignal Signal `json:"stop_signal,omitempty"` // utsns Utsns *Namespace `json:"utsns,omitempty"` }
ContainerBasicConfig ContainerBasicConfig contains the basic parts of a container.
swagger:model ContainerBasicConfig
func (*ContainerBasicConfig) ContextValidate ¶
ContextValidate validate this container basic config based on the context it is used
func (*ContainerBasicConfig) MarshalBinary ¶
func (m *ContainerBasicConfig) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ContainerBasicConfig) UnmarshalBinary ¶
func (m *ContainerBasicConfig) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ContainerCgroupConfig ¶
type ContainerCgroupConfig struct { // CgroupParent is the container's Cgroup parent. // If not set, the default for the current cgroup driver will be used. // Optional. CgroupParent string `json:"cgroup_parent,omitempty"` // CgroupsMode sets a policy for how cgroups will be created in the // container, including the ability to disable creation entirely. CgroupsMode string `json:"cgroups_mode,omitempty"` // cgroupns Cgroupns *Namespace `json:"cgroupns,omitempty"` }
ContainerCgroupConfig ContainerCgroupConfig contains configuration information about a container's cgroups.
swagger:model ContainerCgroupConfig
func (*ContainerCgroupConfig) ContextValidate ¶
ContextValidate validate this container cgroup config based on the context it is used
func (*ContainerCgroupConfig) MarshalBinary ¶
func (m *ContainerCgroupConfig) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ContainerCgroupConfig) UnmarshalBinary ¶
func (m *ContainerCgroupConfig) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ContainerChangeResponseItem ¶
type ContainerChangeResponseItem struct { // Kind of change // Required: true Kind *uint8 `json:"Kind"` // Path to file that has changed // Required: true Path *string `json:"Path"` }
ContainerChangeResponseItem ContainerChangeResponseItem change item in response to ContainerChanges operation
swagger:model ContainerChangeResponseItem
func (*ContainerChangeResponseItem) ContextValidate ¶
func (m *ContainerChangeResponseItem) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validates this container change response item based on context it is used
func (*ContainerChangeResponseItem) MarshalBinary ¶
func (m *ContainerChangeResponseItem) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ContainerChangeResponseItem) UnmarshalBinary ¶
func (m *ContainerChangeResponseItem) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ContainerCreateCreatedBody ¶
type ContainerCreateCreatedBody struct { // The ID of the created container // Required: true ID *string `json:"Id"` // Warnings encountered when creating the container // Required: true Warnings []string `json:"Warnings"` }
ContainerCreateCreatedBody ContainerCreateCreatedBody OK response to ContainerCreate operation
swagger:model ContainerCreateCreatedBody
func (*ContainerCreateCreatedBody) ContextValidate ¶
func (m *ContainerCreateCreatedBody) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validates this container create created body based on context it is used
func (*ContainerCreateCreatedBody) MarshalBinary ¶
func (m *ContainerCreateCreatedBody) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ContainerCreateCreatedBody) UnmarshalBinary ¶
func (m *ContainerCreateCreatedBody) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ContainerHealthCheckConfig ¶
type ContainerHealthCheckConfig struct { // healthconfig Healthconfig *Schema2HealthConfig `json:"healthconfig,omitempty"` }
ContainerHealthCheckConfig ContainerHealthCheckConfig describes a container healthcheck with attributes like command, retries, interval, start period, and timeout.
swagger:model ContainerHealthCheckConfig
func (*ContainerHealthCheckConfig) ContextValidate ¶
func (m *ContainerHealthCheckConfig) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validate this container health check config based on the context it is used
func (*ContainerHealthCheckConfig) MarshalBinary ¶
func (m *ContainerHealthCheckConfig) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ContainerHealthCheckConfig) UnmarshalBinary ¶
func (m *ContainerHealthCheckConfig) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ContainerNetworkConfig ¶
type ContainerNetworkConfig struct { // CNINetworks is a list of CNI networks to join the container to. // If this list is empty, the default CNI network will be joined // instead. If at least one entry is present, we will not join the // default network (unless it is part of this list). // Only available if NetNS is set to bridge. // Optional. // Deprecated: as of podman 4.0 use "Networks" instead. CNINetworks []string `json:"cni_networks"` // DNSOptions is a set of DNS options that will be used in the // container's resolv.conf, replacing the host's DNS options which are // used by default. // Conflicts with UseImageResolvConf. // Optional. DNSOptions []string `json:"dns_option"` // DNSSearch is a set of DNS search domains that will be used in the // container's resolv.conf, replacing the host's DNS search domains // which are used by default. // Conflicts with UseImageResolvConf. // Optional. DNSSearch []string `json:"dns_search"` // DNSServers is a set of DNS servers that will be used in the // container's resolv.conf, replacing the host's DNS Servers which are // used by default. // Conflicts with UseImageResolvConf. // Optional. DNSServers []IP `json:"dns_server"` // Expose is a number of ports that will be forwarded to the container // if PublishExposedPorts is set. // Expose is a map of uint16 (port number) to a string representing // protocol i.e map[uint16]string. Allowed protocols are "tcp", "udp", and "sctp", or some // combination of the three separated by commas. // If protocol is set to "" we will assume TCP. // Only available if NetNS is set to Bridge or Slirp, and // PublishExposedPorts is set. // Optional. Expose interface{} `json:"expose,omitempty"` // HostAdd is a set of hosts which will be added to the container's // etc/hosts file. // Conflicts with UseImageHosts. // Optional. HostAdd []string `json:"hostadd"` // NetworkOptions are additional options for each network // Optional. NetworkOptions map[string][]string `json:"network_options,omitempty"` // Map of networks names or ids that the container should join. // You can request additional settings for each network, you can // set network aliases, static ips, static mac address and the // network interface name for this container on the specific network. // If the map is empty and the bridge network mode is set the container // will be joined to the default network. Networks map[string]PerNetworkOptions `json:"Networks,omitempty"` // PortBindings is a set of ports to map into the container. // Only available if NetNS is set to bridge or slirp. // Optional. PortMappings []*PortMapping `json:"portmappings"` // PublishExposedPorts will publish ports specified in the image to // random unused ports (guaranteed to be above 1024) on the host. // This is based on ports set in Expose below, and any ports specified // by the Image (if one is given). // Only available if NetNS is set to Bridge or Slirp. PublishExposedPorts bool `json:"publish_image_ports,omitempty"` // UseImageHosts indicates that /etc/hosts should not be managed by // Podman, and instead sourced from the image. // Conflicts with HostAdd. UseImageHosts bool `json:"use_image_hosts,omitempty"` // UseImageResolvConf indicates that resolv.conf should not be managed // by Podman, but instead sourced from the image. // Conflicts with DNSServer, DNSSearch, DNSOption. UseImageResolvConf bool `json:"use_image_resolve_conf,omitempty"` // netns Netns *Namespace `json:"netns,omitempty"` }
ContainerNetworkConfig ContainerNetworkConfig contains information on a container's network configuration.
swagger:model ContainerNetworkConfig
func (*ContainerNetworkConfig) ContextValidate ¶
func (m *ContainerNetworkConfig) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validate this container network config based on the context it is used
func (*ContainerNetworkConfig) MarshalBinary ¶
func (m *ContainerNetworkConfig) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ContainerNetworkConfig) UnmarshalBinary ¶
func (m *ContainerNetworkConfig) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ContainerNode ¶
type ContainerNode struct { // addr Addr string `json:"Addr,omitempty"` // cpus Cpus int64 `json:"Cpus,omitempty"` // ID ID string `json:"ID,omitempty"` // IP address IPAddress string `json:"IP,omitempty"` // labels Labels map[string]string `json:"Labels,omitempty"` // memory Memory int64 `json:"Memory,omitempty"` // name Name string `json:"Name,omitempty"` }
ContainerNode ContainerNode stores information about the node that a container is running on. It's only used by the Docker Swarm standalone API
swagger:model ContainerNode
func (*ContainerNode) ContextValidate ¶
ContextValidate validates this container node based on context it is used
func (*ContainerNode) MarshalBinary ¶
func (m *ContainerNode) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ContainerNode) UnmarshalBinary ¶
func (m *ContainerNode) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ContainerResourceConfig ¶
type ContainerResourceConfig struct { // CPU period of the cpuset, determined by --cpus CPUPeriod uint64 `json:"cpu_period,omitempty"` // CPU quota of the cpuset, determined by --cpus CPUQuota int64 `json:"cpu_quota,omitempty"` // CgroupConf are key-value options passed into the container runtime // that are used to configure cgroup v2. // Optional. CgroupConf map[string]string `json:"unified,omitempty"` // OOMScoreAdj adjusts the score used by the OOM killer to determine // processes to kill for the container's process. // Optional. OOMScoreAdj int64 `json:"oom_score_adj,omitempty"` // Rlimits are POSIX rlimits to apply to the container. // Optional. Rlimits []*POSIXRlimit `json:"r_limits"` // IO read rate limit per cgroup per device, bytes per second ThrottleReadBpsDevice map[string]LinuxThrottleDevice `json:"throttleReadBpsDevice,omitempty"` // IO read rate limit per cgroup per device, IO per second ThrottleReadIOPSDevice map[string]LinuxThrottleDevice `json:"throttleReadIOPSDevice,omitempty"` // IO write rate limit per cgroup per device, bytes per second ThrottleWriteBpsDevice map[string]LinuxThrottleDevice `json:"throttleWriteBpsDevice,omitempty"` // IO write rate limit per cgroup per device, IO per second ThrottleWriteIOPSDevice map[string]LinuxThrottleDevice `json:"throttleWriteIOPSDevice,omitempty"` // Weight per cgroup per device, can override BlkioWeight WeightDevice map[string]LinuxWeightDevice `json:"weightDevice,omitempty"` // resource limits ResourceLimits *LinuxResources `json:"resource_limits,omitempty"` }
ContainerResourceConfig ContainerResourceConfig contains information on container resource limits.
swagger:model ContainerResourceConfig
func (*ContainerResourceConfig) ContextValidate ¶
func (m *ContainerResourceConfig) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validate this container resource config based on the context it is used
func (*ContainerResourceConfig) MarshalBinary ¶
func (m *ContainerResourceConfig) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ContainerResourceConfig) UnmarshalBinary ¶
func (m *ContainerResourceConfig) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ContainerSecurityConfig ¶
type ContainerSecurityConfig struct { // ApparmorProfile is the name of the Apparmor profile the container // will use. // Optional. ApparmorProfile string `json:"apparmor_profile,omitempty"` // CapAdd are capabilities which will be added to the container. // Conflicts with Privileged. // Optional. CapAdd []string `json:"cap_add"` // CapDrop are capabilities which will be removed from the container. // Conflicts with Privileged. // Optional. CapDrop []string `json:"cap_drop"` // Groups are a list of supplemental groups the container's user will // be granted access to. // Optional. Groups []string `json:"groups"` // Mask is the path we want to mask in the container. This masks the paths // given in addition to the default list. // Optional Mask []string `json:"mask"` // NoNewPrivileges is whether the container will set the no new // privileges flag on create, which disables gaining additional // privileges (e.g. via setuid) in the container. NoNewPrivileges bool `json:"no_new_privileges,omitempty"` // Privileged is whether the container is privileged. // Privileged does the following: // Adds all devices on the system to the container. // Adds all capabilities to the container. // Disables Seccomp, SELinux, and Apparmor confinement. // (Though SELinux can be manually re-enabled). // TODO: this conflicts with things. // TODO: this does more. Privileged bool `json:"privileged,omitempty"` // ProcOpts are the options used for the proc mount. ProcOpts []string `json:"procfs_opts"` // ReadOnlyFilesystem indicates that everything will be mounted // as read-only ReadOnlyFilesystem bool `json:"read_only_filesystem,omitempty"` // SeccompPolicy determines which seccomp profile gets applied // the container. valid values: empty,default,image SeccompPolicy string `json:"seccomp_policy,omitempty"` // SeccompProfilePath is the path to a JSON file containing the // container's Seccomp profile. // If not specified, no Seccomp profile will be used. // Optional. SeccompProfilePath string `json:"seccomp_profile_path,omitempty"` // SelinuxProcessLabel is the process label the container will use. // If SELinux is enabled and this is not specified, a label will be // automatically generated if not specified. // Optional. SelinuxOpts []string `json:"selinux_opts"` // Umask is the umask the init process of the container will be run with. Umask string `json:"umask,omitempty"` // Unmask is the path we want to unmask in the container. To override // all the default paths that are masked, set unmask=ALL. Unmask []string `json:"unmask"` // User is the user the container will be run as. // Can be given as a UID or a username; if a username, it will be // resolved within the container, using the container's /etc/passwd. // If unset, the container will be run as root. // Optional. User string `json:"user,omitempty"` // idmappings Idmappings *IDMappingOptions `json:"idmappings,omitempty"` // userns Userns *Namespace `json:"userns,omitempty"` }
ContainerSecurityConfig ContainerSecurityConfig is a container's security features, including SELinux, Apparmor, and Seccomp.
swagger:model ContainerSecurityConfig
func (*ContainerSecurityConfig) ContextValidate ¶
func (m *ContainerSecurityConfig) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validate this container security config based on the context it is used
func (*ContainerSecurityConfig) MarshalBinary ¶
func (m *ContainerSecurityConfig) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ContainerSecurityConfig) UnmarshalBinary ¶
func (m *ContainerSecurityConfig) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ContainerSize ¶
type ContainerSize struct { // root fs size RootFsSize int64 `json:"rootFsSize,omitempty"` // rw size RwSize int64 `json:"rwSize,omitempty"` }
ContainerSize ContainerSize holds the size of the container's root filesystem and top read-write layer.
swagger:model ContainerSize
func (*ContainerSize) ContextValidate ¶
ContextValidate validates this container size based on context it is used
func (*ContainerSize) MarshalBinary ¶
func (m *ContainerSize) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ContainerSize) UnmarshalBinary ¶
func (m *ContainerSize) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ContainerState ¶
type ContainerState struct { // dead Dead bool `json:"Dead,omitempty"` // error Error string `json:"Error,omitempty"` // exit code ExitCode int64 `json:"ExitCode,omitempty"` // finished at FinishedAt string `json:"FinishedAt,omitempty"` // health Health *Health `json:"Health,omitempty"` // o o m killed OOMKilled bool `json:"OOMKilled,omitempty"` // paused Paused bool `json:"Paused,omitempty"` // pid Pid int64 `json:"Pid,omitempty"` // restarting Restarting bool `json:"Restarting,omitempty"` // running Running bool `json:"Running,omitempty"` // started at StartedAt string `json:"StartedAt,omitempty"` // status Status string `json:"Status,omitempty"` }
ContainerState ContainerState stores container's running state it's part of ContainerJSONBase and will return by "inspect" command
swagger:model ContainerState
func (*ContainerState) ContextValidate ¶
ContextValidate validate this container state based on the context it is used
func (*ContainerState) MarshalBinary ¶
func (m *ContainerState) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ContainerState) UnmarshalBinary ¶
func (m *ContainerState) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ContainerStorageConfig ¶
type ContainerStorageConfig struct { // Create the working directory if it doesn't exist. // If unset, it doesn't create it. // Optional. CreateWorkingDir bool `json:"create_working_dir,omitempty"` // DeviceCgroupRule are device cgroup rules that allow containers // to use additional types of devices. DeviceCgroupRule []*LinuxDeviceCgroup `json:"device_cgroup_rule"` // Devices are devices that will be added to the container. // Optional. Devices []*LinuxDevice `json:"devices"` // DevicesFrom is a way to ensure your container inherits device specific information from another container DevicesFrom []string `json:"devices_from"` // HostDeviceList is used to recreate the mounted device on inherited containers HostDeviceList []*LinuxDevice `json:"host_device_list"` // Image is the image the container will be based on. The image will be // used as the container's root filesystem, and its environment vars, // volumes, and other configuration will be applied to the container. // Conflicts with Rootfs. // At least one of Image or Rootfs must be specified. Image string `json:"image,omitempty"` // ImageVolumeMode indicates how image volumes will be created. // Supported modes are "ignore" (do not create), "tmpfs" (create as // tmpfs), and "anonymous" (create as anonymous volumes). // The default if unset is anonymous. // Optional. ImageVolumeMode string `json:"image_volume_mode,omitempty"` // Image volumes bind-mount a container-image mount into the container. // Optional. ImageVolumes []*ImageVolume `json:"image_volumes"` // Init specifies that an init binary will be mounted into the // container, and will be used as PID1. Init bool `json:"init,omitempty"` // InitPath specifies the path to the init binary that will be added if // Init is specified above. If not specified, the default set in the // Libpod config will be used. Ignored if Init above is not set. // Optional. InitPath string `json:"init_path,omitempty"` // Mounts are mounts that will be added to the container. // These will supersede Image Volumes and VolumesFrom volumes where // there are conflicts. // Optional. Mounts []*Mount `json:"mounts"` // Overlay volumes are named volumes that will be added to the container. // Optional. OverlayVolumes []*OverlayVolume `json:"overlay_volumes"` // Rootfs is the path to a directory that will be used as the // container's root filesystem. No modification will be made to the // directory, it will be directly mounted into the container as root. // Conflicts with Image. // At least one of Image or Rootfs must be specified. Rootfs string `json:"rootfs,omitempty"` // RootfsOverlay tells if rootfs is actually an overlay on top of base path RootfsOverlay bool `json:"rootfs_overlay,omitempty"` // RootfsPropagation is the rootfs propagation mode for the container. // If not set, the default of rslave will be used. // Optional. RootfsPropagation string `json:"rootfs_propagation,omitempty"` // Secrets are the secrets that will be added to the container // Optional. Secrets []*Secret `json:"secrets"` // ShmSize is the size of the tmpfs to mount in at /dev/shm, in bytes. // Conflicts with ShmSize if IpcNS is not private. // Optional. ShmSize int64 `json:"shm_size,omitempty"` // StorageOpts is the container's storage options // Optional. StorageOpts map[string]string `json:"storage_opts,omitempty"` // Volatile specifies whether the container storage can be optimized // at the cost of not syncing all the dirty files in memory. Volatile bool `json:"volatile,omitempty"` // Volumes are named volumes that will be added to the container. // These will supersede Image Volumes and VolumesFrom volumes where // there are conflicts. // Optional. Volumes []*NamedVolume `json:"volumes"` // VolumesFrom is a set of containers whose volumes will be added to // this container. The name or ID of the container must be provided, and // may optionally be followed by a : and then one or more // comma-separated options. Valid options are 'ro', 'rw', and 'z'. // Options will be used for all volumes sourced from the container. VolumesFrom []string `json:"volumes_from"` // WorkDir is the container's working directory. // If unset, the default, /, will be used. // Optional. WorkDir string `json:"work_dir,omitempty"` // ipcns Ipcns *Namespace `json:"ipcns,omitempty"` }
ContainerStorageConfig ContainerStorageConfig contains information on the storage configuration of a container.
swagger:model ContainerStorageConfig
func (*ContainerStorageConfig) ContextValidate ¶
func (m *ContainerStorageConfig) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validate this container storage config based on the context it is used
func (*ContainerStorageConfig) MarshalBinary ¶
func (m *ContainerStorageConfig) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ContainerStorageConfig) UnmarshalBinary ¶
func (m *ContainerStorageConfig) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ContainerStore ¶
type ContainerStore struct { // number Number int64 `json:"number,omitempty"` // paused Paused int64 `json:"paused,omitempty"` // running Running int64 `json:"running,omitempty"` // stopped Stopped int64 `json:"stopped,omitempty"` }
ContainerStore ContainerStore describes the quantity of containers in the store by status
swagger:model ContainerStore
func (*ContainerStore) ContextValidate ¶
ContextValidate validates this container store based on context it is used
func (*ContainerStore) MarshalBinary ¶
func (m *ContainerStore) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ContainerStore) UnmarshalBinary ¶
func (m *ContainerStore) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ContainerTopOKBody ¶
type ContainerTopOKBody struct { // Each process running in the container, where each is process // is an array of values corresponding to the titles. // Required: true Processes [][]string `json:"Processes"` // The ps column titles // Required: true Titles []string `json:"Titles"` }
ContainerTopOKBody ContainerTopOKBody OK response to ContainerTop operation
swagger:model ContainerTopOKBody
func (*ContainerTopOKBody) ContextValidate ¶
ContextValidate validates this container top o k body based on context it is used
func (*ContainerTopOKBody) MarshalBinary ¶
func (m *ContainerTopOKBody) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ContainerTopOKBody) UnmarshalBinary ¶
func (m *ContainerTopOKBody) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ContainerUpdateOKBody ¶
type ContainerUpdateOKBody struct { // warnings // Required: true Warnings []string `json:"Warnings"` }
ContainerUpdateOKBody ContainerUpdateOKBody OK response to ContainerUpdate operation
swagger:model ContainerUpdateOKBody
func (*ContainerUpdateOKBody) ContextValidate ¶
ContextValidate validates this container update o k body based on context it is used
func (*ContainerUpdateOKBody) MarshalBinary ¶
func (m *ContainerUpdateOKBody) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ContainerUpdateOKBody) UnmarshalBinary ¶
func (m *ContainerUpdateOKBody) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ContainerWaitOKBody ¶
type ContainerWaitOKBody struct { // error // Required: true Error *ContainerWaitOKBodyError `json:"Error"` // Exit code of the container // Required: true StatusCode *int64 `json:"StatusCode"` }
ContainerWaitOKBody ContainerWaitOKBody OK response to ContainerWait operation
swagger:model ContainerWaitOKBody
func (*ContainerWaitOKBody) ContextValidate ¶
ContextValidate validate this container wait o k body based on the context it is used
func (*ContainerWaitOKBody) MarshalBinary ¶
func (m *ContainerWaitOKBody) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ContainerWaitOKBody) UnmarshalBinary ¶
func (m *ContainerWaitOKBody) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ContainerWaitOKBodyError ¶
type ContainerWaitOKBodyError struct { // Details of an error Message string `json:"Message,omitempty"` }
ContainerWaitOKBodyError ContainerWaitOKBodyError container waiting error, if any
swagger:model ContainerWaitOKBodyError
func (*ContainerWaitOKBodyError) ContextValidate ¶
func (m *ContainerWaitOKBodyError) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validates this container wait o k body error based on context it is used
func (*ContainerWaitOKBodyError) MarshalBinary ¶
func (m *ContainerWaitOKBodyError) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ContainerWaitOKBodyError) UnmarshalBinary ¶
func (m *ContainerWaitOKBodyError) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ContainersPruneReport ¶
type ContainersPruneReport struct { // containers deleted ContainersDeleted []string `json:"ContainersDeleted"` // space reclaimed SpaceReclaimed uint64 `json:"SpaceReclaimed,omitempty"` }
ContainersPruneReport containers prune report
swagger:model ContainersPruneReport
func (*ContainersPruneReport) ContextValidate ¶
ContextValidate validates this containers prune report based on context it is used
func (*ContainersPruneReport) MarshalBinary ¶
func (m *ContainersPruneReport) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ContainersPruneReport) UnmarshalBinary ¶
func (m *ContainersPruneReport) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type CreateContainerConfig ¶
type CreateContainerConfig struct { // args escaped ArgsEscaped bool `json:"ArgsEscaped,omitempty"` // attach stderr AttachStderr bool `json:"AttachStderr,omitempty"` // attach stdin AttachStdin bool `json:"AttachStdin,omitempty"` // attach stdout AttachStdout bool `json:"AttachStdout,omitempty"` // cmd Cmd StrSlice `json:"Cmd,omitempty"` // domainname Domainname string `json:"Domainname,omitempty"` // entrypoint Entrypoint StrSlice `json:"Entrypoint,omitempty"` // env Env []string `json:"Env"` // exposed ports ExposedPorts PortSet `json:"ExposedPorts,omitempty"` // healthcheck Healthcheck *HealthConfig `json:"Healthcheck,omitempty"` // host config HostConfig *HostConfig `json:"HostConfig,omitempty"` // hostname Hostname string `json:"Hostname,omitempty"` // image Image string `json:"Image,omitempty"` // labels Labels map[string]string `json:"Labels,omitempty"` // mac address MacAddress string `json:"MacAddress,omitempty"` // name Name string `json:"Name,omitempty"` // network disabled NetworkDisabled bool `json:"NetworkDisabled,omitempty"` // networking config NetworkingConfig *NetworkingConfig `json:"NetworkingConfig,omitempty"` // on build OnBuild []string `json:"OnBuild"` // open stdin OpenStdin bool `json:"OpenStdin,omitempty"` // shell Shell StrSlice `json:"Shell,omitempty"` // stdin once StdinOnce bool `json:"StdinOnce,omitempty"` // stop signal StopSignal string `json:"StopSignal,omitempty"` // stop timeout StopTimeout int64 `json:"StopTimeout,omitempty"` // tty Tty bool `json:"Tty,omitempty"` // unset env UnsetEnv []string `json:"UnsetEnv"` // unset env all UnsetEnvAll bool `json:"UnsetEnvAll,omitempty"` // user User string `json:"User,omitempty"` // volumes Volumes map[string]interface{} `json:"Volumes,omitempty"` // working dir WorkingDir string `json:"WorkingDir,omitempty"` }
CreateContainerConfig CreateContainerConfig used when compatible endpoint creates a container
swagger:model CreateContainerConfig
func (*CreateContainerConfig) ContextValidate ¶
ContextValidate validate this create container config based on the context it is used
func (*CreateContainerConfig) MarshalBinary ¶
func (m *CreateContainerConfig) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*CreateContainerConfig) UnmarshalBinary ¶
func (m *CreateContainerConfig) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type DeviceMapping ¶
type DeviceMapping struct { // cgroup permissions CgroupPermissions string `json:"CgroupPermissions,omitempty"` // path in container PathInContainer string `json:"PathInContainer,omitempty"` // path on host PathOnHost string `json:"PathOnHost,omitempty"` }
DeviceMapping DeviceMapping represents the device mapping between the host and the container.
swagger:model DeviceMapping
func (*DeviceMapping) ContextValidate ¶
ContextValidate validates this device mapping based on context it is used
func (*DeviceMapping) MarshalBinary ¶
func (m *DeviceMapping) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*DeviceMapping) UnmarshalBinary ¶
func (m *DeviceMapping) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type DeviceRequest ¶
type DeviceRequest struct { // capabilities Capabilities [][]string `json:"Capabilities"` // count Count int64 `json:"Count,omitempty"` // device i ds DeviceIDs []string `json:"DeviceIDs"` // driver Driver string `json:"Driver,omitempty"` // options Options map[string]string `json:"Options,omitempty"` }
DeviceRequest DeviceRequest represents a request for devices from a device driver.
Used by GPU device drivers.
swagger:model DeviceRequest
func (*DeviceRequest) ContextValidate ¶
ContextValidate validates this device request based on context it is used
func (*DeviceRequest) MarshalBinary ¶
func (m *DeviceRequest) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*DeviceRequest) UnmarshalBinary ¶
func (m *DeviceRequest) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Digest ¶
type Digest string
Digest Digest allows simple protection of hex formatted digest strings, prefixed by their algorithm. Strings of type Digest have some guarantee of being in the correct format and it provides quick access to the components of a digest string.
The following is an example of the contents of Digest types:
sha256:7173b809ca12ec5dee4506cd86be934c4596dd234ee82c0662eac04a8c2c71dc
This allows to abstract the digest behind this type and work only in those terms.
swagger:model Digest
func (Digest) ContextValidate ¶
ContextValidate validates this digest based on context it is used
type DistributionInfo ¶
type DistributionInfo struct { // codename Codename string `json:"codename,omitempty"` // distribution Distribution string `json:"distribution,omitempty"` // variant Variant string `json:"variant,omitempty"` // version Version string `json:"version,omitempty"` }
DistributionInfo DistributionInfo describes the host distribution for libpod
swagger:model DistributionInfo
func (*DistributionInfo) ContextValidate ¶
ContextValidate validates this distribution info based on context it is used
func (*DistributionInfo) MarshalBinary ¶
func (m *DistributionInfo) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*DistributionInfo) UnmarshalBinary ¶
func (m *DistributionInfo) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type DockerVolumeCreate ¶
type DockerVolumeCreate struct {
VolumeCreateBody
}
DockerVolumeCreate docker volume create
swagger:model DockerVolumeCreate
func (*DockerVolumeCreate) ContextValidate ¶
ContextValidate validate this docker volume create based on the context it is used
func (DockerVolumeCreate) MarshalJSON ¶
func (m DockerVolumeCreate) MarshalJSON() ([]byte, error)
MarshalJSON marshals this object to a JSON structure
func (*DockerVolumeCreate) UnmarshalJSON ¶
func (m *DockerVolumeCreate) UnmarshalJSON(raw []byte) error
UnmarshalJSON unmarshals this object from a JSON structure
type Driver ¶
type Driver struct { // name Name string `json:"Name,omitempty"` // options Options map[string]string `json:"Options,omitempty"` }
Driver Driver represents a volume driver.
swagger:model Driver
func (*Driver) ContextValidate ¶
ContextValidate validates this driver based on context it is used
func (*Driver) MarshalBinary ¶
MarshalBinary interface implementation
func (*Driver) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type DriverData ¶
type DriverData struct { // data Data map[string]string `json:"Data,omitempty"` // name Name string `json:"Name,omitempty"` }
DriverData DriverData handles the data for a storage driver
swagger:model DriverData
func (*DriverData) ContextValidate ¶
ContextValidate validates this driver data based on context it is used
func (*DriverData) MarshalBinary ¶
func (m *DriverData) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*DriverData) UnmarshalBinary ¶
func (m *DriverData) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Duration ¶
type Duration int64
Duration A Duration represents the elapsed time between two instants as an int64 nanosecond count. The representation limits the largest representable duration to approximately 290 years.
swagger:model Duration
func (Duration) ContextValidate ¶
ContextValidate validates this duration based on context it is used
type EndpointIPAMConfig ¶
type EndpointIPAMConfig struct { // IPv4 address IPV4Address string `json:"IPv4Address,omitempty"` // IPv6 address IPV6Address string `json:"IPv6Address,omitempty"` // link local i ps LinkLocalIPs []string `json:"LinkLocalIPs"` }
EndpointIPAMConfig EndpointIPAMConfig represents IPAM configurations for the endpoint
swagger:model EndpointIPAMConfig
func (*EndpointIPAMConfig) ContextValidate ¶
ContextValidate validates this endpoint IP a m config based on context it is used
func (*EndpointIPAMConfig) MarshalBinary ¶
func (m *EndpointIPAMConfig) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*EndpointIPAMConfig) UnmarshalBinary ¶
func (m *EndpointIPAMConfig) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type EndpointResource ¶
type EndpointResource struct { // endpoint ID EndpointID string `json:"EndpointID,omitempty"` // IPv4 address IPV4Address string `json:"IPv4Address,omitempty"` // IPv6 address IPV6Address string `json:"IPv6Address,omitempty"` // mac address MacAddress string `json:"MacAddress,omitempty"` // name Name string `json:"Name,omitempty"` }
EndpointResource EndpointResource contains network resources allocated and used for a container in a network
swagger:model EndpointResource
func (*EndpointResource) ContextValidate ¶
ContextValidate validates this endpoint resource based on context it is used
func (*EndpointResource) MarshalBinary ¶
func (m *EndpointResource) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*EndpointResource) UnmarshalBinary ¶
func (m *EndpointResource) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type EndpointSettings ¶
type EndpointSettings struct { // aliases Aliases []string `json:"Aliases"` // driver opts DriverOpts map[string]string `json:"DriverOpts,omitempty"` // endpoint ID EndpointID string `json:"EndpointID,omitempty"` // gateway Gateway string `json:"Gateway,omitempty"` // global IPv6 address GlobalIPV6Address string `json:"GlobalIPv6Address,omitempty"` // global IPv6 prefix len GlobalIPV6PrefixLen int64 `json:"GlobalIPv6PrefixLen,omitempty"` // IP a m config IPAMConfig *EndpointIPAMConfig `json:"IPAMConfig,omitempty"` // IP address IPAddress string `json:"IPAddress,omitempty"` // IP prefix len IPPrefixLen int64 `json:"IPPrefixLen,omitempty"` // IPv6 gateway IPV6Gateway string `json:"IPv6Gateway,omitempty"` // links Links []string `json:"Links"` // mac address MacAddress string `json:"MacAddress,omitempty"` // Operational data NetworkID string `json:"NetworkID,omitempty"` }
EndpointSettings EndpointSettings stores the network endpoint details
swagger:model EndpointSettings
func (*EndpointSettings) ContextValidate ¶
ContextValidate validate this endpoint settings based on the context it is used
func (*EndpointSettings) MarshalBinary ¶
func (m *EndpointSettings) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*EndpointSettings) UnmarshalBinary ¶
func (m *EndpointSettings) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ErrorResponse ¶
type ErrorResponse struct { // The error message. // Required: true Message *string `json:"message"` }
ErrorResponse ErrorResponse Represents an error.
swagger:model ErrorResponse
func (*ErrorResponse) ContextValidate ¶
ContextValidate validates this error response based on context it is used
func (*ErrorResponse) MarshalBinary ¶
func (m *ErrorResponse) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ErrorResponse) UnmarshalBinary ¶
func (m *ErrorResponse) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type FileMode ¶
type FileMode uint32
FileMode A FileMode represents a file's mode and permission bits.
The bits have the same definition on all systems, so that information about files can be moved from one system to another portably. Not all bits apply to all systems. The only required bit is ModeDir for directories.
swagger:model FileMode
func (FileMode) ContextValidate ¶
ContextValidate validates this file mode based on context it is used
type GraphDriverData ¶
type GraphDriverData struct { // data // Required: true Data map[string]string `json:"Data"` // name // Required: true Name *string `json:"Name"` }
GraphDriverData GraphDriverData Information about a container's graph driver.
swagger:model GraphDriverData
func (*GraphDriverData) ContextValidate ¶
ContextValidate validates this graph driver data based on context it is used
func (*GraphDriverData) MarshalBinary ¶
func (m *GraphDriverData) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*GraphDriverData) UnmarshalBinary ¶
func (m *GraphDriverData) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type HardwareAddr ¶
type HardwareAddr []uint8
HardwareAddr A HardwareAddr represents a physical hardware address.
swagger:model HardwareAddr
func (HardwareAddr) ContextValidate ¶
ContextValidate validates this hardware addr based on context it is used
type Health ¶
type Health struct { // failing streak FailingStreak int64 `json:"FailingStreak,omitempty"` // log Log []*HealthcheckResult `json:"Log"` // status Status string `json:"Status,omitempty"` }
Health Health stores information about the container's healthcheck results
swagger:model Health
func (*Health) ContextValidate ¶
ContextValidate validate this health based on the context it is used
func (*Health) MarshalBinary ¶
MarshalBinary interface implementation
func (*Health) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type HealthCheckLog ¶
type HealthCheckLog struct { // End time as a string End string `json:"End,omitempty"` // Exitcode is 0 or 1 ExitCode int64 `json:"ExitCode,omitempty"` // Output is the stdout/stderr from the healthcheck command Output string `json:"Output,omitempty"` // Start time as string Start string `json:"Start,omitempty"` }
HealthCheckLog HealthCheckLog describes the results of a single healthcheck
swagger:model HealthCheckLog
func (*HealthCheckLog) ContextValidate ¶
ContextValidate validates this health check log based on context it is used
func (*HealthCheckLog) MarshalBinary ¶
func (m *HealthCheckLog) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*HealthCheckLog) UnmarshalBinary ¶
func (m *HealthCheckLog) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type HealthCheckResults ¶
type HealthCheckResults struct { // FailingStreak is the number of consecutive failed healthchecks FailingStreak int64 `json:"FailingStreak,omitempty"` // Log describes healthcheck attempts and results Log []*HealthCheckLog `json:"Log"` // Status healthy or unhealthy Status string `json:"Status,omitempty"` }
HealthCheckResults HealthCheckResults describes the results/logs from a healthcheck
swagger:model HealthCheckResults
func (*HealthCheckResults) ContextValidate ¶
ContextValidate validate this health check results based on the context it is used
func (*HealthCheckResults) MarshalBinary ¶
func (m *HealthCheckResults) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*HealthCheckResults) UnmarshalBinary ¶
func (m *HealthCheckResults) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type HealthConfig ¶
type HealthConfig struct { // interval Interval Duration `json:"Interval,omitempty"` // Retries is the number of consecutive failures needed to consider a container as unhealthy. // Zero means inherit. Retries int64 `json:"Retries,omitempty"` // start period StartPeriod Duration `json:"StartPeriod,omitempty"` // Test is the test to perform to check that the container is healthy. // An empty slice means to inherit the default. // The options are: // {} : inherit healthcheck // {"NONE"} : disable healthcheck // {"CMD", args...} : exec arguments directly // {"CMD-SHELL", command} : run command with system's default shell Test []string `json:"Test"` // timeout Timeout Duration `json:"Timeout,omitempty"` }
HealthConfig HealthConfig holds configuration settings for the HEALTHCHECK feature.
swagger:model HealthConfig
func (*HealthConfig) ContextValidate ¶
ContextValidate validate this health config based on the context it is used
func (*HealthConfig) MarshalBinary ¶
func (m *HealthConfig) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*HealthConfig) UnmarshalBinary ¶
func (m *HealthConfig) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type HealthcheckResult ¶
type HealthcheckResult struct { // end // Format: date-time End strfmt.DateTime `json:"End,omitempty"` // exit code ExitCode int64 `json:"ExitCode,omitempty"` // output Output string `json:"Output,omitempty"` // start // Format: date-time Start strfmt.DateTime `json:"Start,omitempty"` }
HealthcheckResult HealthcheckResult stores information about a single run of a healthcheck probe
swagger:model HealthcheckResult
func (*HealthcheckResult) ContextValidate ¶
ContextValidate validates this healthcheck result based on context it is used
func (*HealthcheckResult) MarshalBinary ¶
func (m *HealthcheckResult) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*HealthcheckResult) UnmarshalBinary ¶
func (m *HealthcheckResult) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type History ¶
type History struct { // Author is the author of the build point. Author string `json:"author,omitempty"` // Comment is a custom message set when creating the layer. Comment string `json:"comment,omitempty"` // Created is the combined date and time at which the layer was created, formatted as defined by RFC 3339, section 5.6. // Format: date-time Created strfmt.DateTime `json:"created,omitempty"` // CreatedBy is the command which created the layer. CreatedBy string `json:"created_by,omitempty"` // EmptyLayer is used to mark if the history item created a filesystem diff. EmptyLayer bool `json:"empty_layer,omitempty"` }
History History describes the history of a layer.
swagger:model History
func (*History) ContextValidate ¶
ContextValidate validates this history based on context it is used
func (*History) MarshalBinary ¶
MarshalBinary interface implementation
func (*History) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type HistoryResponseItem ¶
type HistoryResponseItem struct { // comment // Required: true Comment *string `json:"Comment"` // created // Required: true Created *int64 `json:"Created"` // created by // Required: true CreatedBy *string `json:"CreatedBy"` // Id // Required: true ID *string `json:"Id"` // size // Required: true Size *int64 `json:"Size"` // tags // Required: true Tags []string `json:"Tags"` }
HistoryResponseItem HistoryResponseItem individual image layer information in response to ImageHistory operation
swagger:model HistoryResponseItem
func (*HistoryResponseItem) ContextValidate ¶
ContextValidate validates this history response item based on context it is used
func (*HistoryResponseItem) MarshalBinary ¶
func (m *HistoryResponseItem) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*HistoryResponseItem) UnmarshalBinary ¶
func (m *HistoryResponseItem) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type HostConfig ¶
type HostConfig struct { // auto remove AutoRemove bool `json:"AutoRemove,omitempty"` // Applicable to all platforms Binds []string `json:"Binds"` // blkio device read bps BlkioDeviceReadBps []*ThrottleDevice `json:"BlkioDeviceReadBps"` // blkio device read i ops BlkioDeviceReadIOps []*ThrottleDevice `json:"BlkioDeviceReadIOps"` // blkio device write bps BlkioDeviceWriteBps []*ThrottleDevice `json:"BlkioDeviceWriteBps"` // blkio device write i ops BlkioDeviceWriteIOps []*ThrottleDevice `json:"BlkioDeviceWriteIOps"` // blkio weight BlkioWeight uint16 `json:"BlkioWeight,omitempty"` // blkio weight device BlkioWeightDevice []*WeightDevice `json:"BlkioWeightDevice"` // Applicable to Windows CPUCount int64 `json:"CpuCount,omitempty"` // CPU percent CPUPercent int64 `json:"CpuPercent,omitempty"` // CPU period CPUPeriod int64 `json:"CpuPeriod,omitempty"` // CPU quota CPUQuota int64 `json:"CpuQuota,omitempty"` // CPU realtime period CPURealtimePeriod int64 `json:"CpuRealtimePeriod,omitempty"` // CPU realtime runtime CPURealtimeRuntime int64 `json:"CpuRealtimeRuntime,omitempty"` CPUShares int64 `json:"CpuShares,omitempty"` // cap add CapAdd StrSlice `json:"CapAdd,omitempty"` // cap drop CapDrop StrSlice `json:"CapDrop,omitempty"` // cgroup Cgroup CgroupSpec `json:"Cgroup,omitempty"` // Applicable to UNIX platforms CgroupParent string `json:"CgroupParent,omitempty"` // cgroupns mode CgroupnsMode CgroupnsMode `json:"CgroupnsMode,omitempty"` // Applicable to Windows ConsoleSize []uint64 `json:"ConsoleSize"` // container ID file ContainerIDFile string `json:"ContainerIDFile,omitempty"` // cpuset cpus CpusetCpus string `json:"CpusetCpus,omitempty"` // cpuset mems CpusetMems string `json:"CpusetMems,omitempty"` // DNS DNS []string `json:"Dns"` // DNS options DNSOptions []string `json:"DnsOptions"` // DNS search DNSSearch []string `json:"DnsSearch"` // device cgroup rules DeviceCgroupRules []string `json:"DeviceCgroupRules"` // device requests DeviceRequests []*DeviceRequest `json:"DeviceRequests"` // devices Devices []*DeviceMapping `json:"Devices"` // extra hosts ExtraHosts []string `json:"ExtraHosts"` // group add GroupAdd []string `json:"GroupAdd"` // i o maximum bandwidth IOMaximumBandwidth uint64 `json:"IOMaximumBandwidth,omitempty"` // i o maximum i ops IOMaximumIOps uint64 `json:"IOMaximumIOps,omitempty"` // Run a custom init inside the container, if null, use the daemon's configured settings Init bool `json:"Init,omitempty"` // ipc mode IpcMode IpcMode `json:"IpcMode,omitempty"` // isolation Isolation Isolation `json:"Isolation,omitempty"` // kernel memory KernelMemory int64 `json:"KernelMemory,omitempty"` // kernel memory TCP KernelMemoryTCP int64 `json:"KernelMemoryTCP,omitempty"` // links Links []string `json:"Links"` // log config LogConfig *LogConfig `json:"LogConfig,omitempty"` // MaskedPaths is the list of paths to be masked inside the container (this overrides the default set of paths) MaskedPaths []string `json:"MaskedPaths"` // memory Memory int64 `json:"Memory,omitempty"` // memory reservation MemoryReservation int64 `json:"MemoryReservation,omitempty"` // memory swap MemorySwap int64 `json:"MemorySwap,omitempty"` // memory swappiness MemorySwappiness int64 `json:"MemorySwappiness,omitempty"` // Mounts specs used by the container Mounts []*Mount `json:"Mounts"` // nano c p us NanoCPUs int64 `json:"NanoCpus,omitempty"` // network mode NetworkMode NetworkMode `json:"NetworkMode,omitempty"` // oom kill disable OomKillDisable bool `json:"OomKillDisable,omitempty"` // oom score adj OomScoreAdj int64 `json:"OomScoreAdj,omitempty"` // pid mode PidMode PidMode `json:"PidMode,omitempty"` // pids limit PidsLimit int64 `json:"PidsLimit,omitempty"` // port bindings PortBindings PortMap `json:"PortBindings,omitempty"` // privileged Privileged bool `json:"Privileged,omitempty"` // publish all ports PublishAllPorts bool `json:"PublishAllPorts,omitempty"` // ReadonlyPaths is the list of paths to be set as read-only inside the container (this overrides the default set of paths) ReadonlyPaths []string `json:"ReadonlyPaths"` // readonly rootfs ReadonlyRootfs bool `json:"ReadonlyRootfs,omitempty"` // restart policy RestartPolicy *RestartPolicy `json:"RestartPolicy,omitempty"` // runtime Runtime string `json:"Runtime,omitempty"` // security opt SecurityOpt []string `json:"SecurityOpt"` // shm size ShmSize int64 `json:"ShmSize,omitempty"` // storage opt StorageOpt map[string]string `json:"StorageOpt,omitempty"` // sysctls Sysctls map[string]string `json:"Sysctls,omitempty"` // tmpfs Tmpfs map[string]string `json:"Tmpfs,omitempty"` // u t s mode UTSMode UTSMode `json:"UTSMode,omitempty"` // ulimits Ulimits []*Ulimit `json:"Ulimits"` // userns mode UsernsMode UsernsMode `json:"UsernsMode,omitempty"` // volume driver VolumeDriver string `json:"VolumeDriver,omitempty"` // volumes from VolumesFrom []string `json:"VolumesFrom"` }
HostConfig HostConfig the non-portable Config structure of a container.
Here, "non-portable" means "dependent of the host we are running on". Portable information *should* appear in Config.
swagger:model HostConfig
func (*HostConfig) ContextValidate ¶
ContextValidate validate this host config based on the context it is used
func (*HostConfig) MarshalBinary ¶
func (m *HostConfig) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*HostConfig) UnmarshalBinary ¶
func (m *HostConfig) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type HostInfo ¶
type HostInfo struct { // arch Arch string `json:"arch,omitempty"` // buildah version BuildahVersion string `json:"buildahVersion,omitempty"` // c p us CPUs int64 `json:"cpus,omitempty"` // cgroup controllers CgroupControllers []string `json:"cgroupControllers"` // cgroup manager CgroupManager string `json:"cgroupManager,omitempty"` // cgroups version CgroupsVersion string `json:"cgroupVersion,omitempty"` // event logger EventLogger string `json:"eventLogger,omitempty"` // hostname Hostname string `json:"hostname,omitempty"` // kernel Kernel string `json:"kernel,omitempty"` // linkmode Linkmode string `json:"linkmode,omitempty"` // log driver LogDriver string `json:"logDriver,omitempty"` // mem free MemFree int64 `json:"memFree,omitempty"` // mem total MemTotal int64 `json:"memTotal,omitempty"` // network backend NetworkBackend string `json:"networkBackend,omitempty"` // o s OS string `json:"os,omitempty"` // runtime info RuntimeInfo map[string]interface{} `json:"runtimeInfo,omitempty"` // ServiceIsRemote is true when the podman/libpod service is remote to the client ServiceIsRemote bool `json:"serviceIsRemote,omitempty"` // swap free SwapFree int64 `json:"swapFree,omitempty"` // swap total SwapTotal int64 `json:"swapTotal,omitempty"` // uptime Uptime string `json:"uptime,omitempty"` // conmon Conmon *ConmonInfo `json:"conmon,omitempty"` // distribution Distribution *DistributionInfo `json:"distribution,omitempty"` // id mappings IDMappings *IDMappings `json:"idMappings,omitempty"` // oci runtime OciRuntime *OCIRuntimeInfo `json:"ociRuntime,omitempty"` // remote socket RemoteSocket *RemoteSocket `json:"remoteSocket,omitempty"` // security Security *SecurityInfo `json:"security,omitempty"` // slirp4netns Slirp4netns *SlirpInfo `json:"slirp4netns,omitempty"` }
HostInfo HostInfo describes the libpod host
swagger:model HostInfo
func (*HostInfo) ContextValidate ¶
ContextValidate validate this host info based on the context it is used
func (*HostInfo) MarshalBinary ¶
MarshalBinary interface implementation
func (*HostInfo) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type IDMap ¶
type IDMap struct { // container ID ContainerID int64 `json:"container_id,omitempty"` // host ID HostID int64 `json:"host_id,omitempty"` // size Size int64 `json:"size,omitempty"` }
IDMap IDMap contains a single entry for user namespace range remapping. An array of IDMap entries represents the structure that will be provided to the Linux kernel for creating a user namespace.
swagger:model IDMap
func (*IDMap) ContextValidate ¶
ContextValidate validates this ID map based on context it is used
func (*IDMap) MarshalBinary ¶
MarshalBinary interface implementation
func (*IDMap) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type IDMappingOptions ¶
type IDMappingOptions struct { // auto user ns AutoUserNs bool `json:"AutoUserNs,omitempty"` // auto user ns opts AutoUserNsOpts *AutoUserNsOptions `json:"AutoUserNsOpts,omitempty"` // g ID map GIDMap []*IDMap `json:"GIDMap"` // host g ID mapping HostGIDMapping bool `json:"HostGIDMapping,omitempty"` // UIDMap and GIDMap are used for setting up a layer's root filesystem // for use inside of a user namespace where ID mapping is being used. // If HostUIDMapping/HostGIDMapping is true, no mapping of the // respective type will be used. Otherwise, if UIDMap and/or GIDMap // contain at least one mapping, one or both will be used. By default, // if neither of those conditions apply, if the layer has a parent // layer, the parent layer's mapping will be used, and if it does not // have a parent layer, the mapping which was passed to the Store // object when it was initialized will be used. HostUIDMapping bool `json:"HostUIDMapping,omitempty"` // UID map UIDMap []*IDMap `json:"UIDMap"` }
IDMappingOptions IDMappingOptions are used for specifying how ID mapping should be set up for a layer or container.
swagger:model IDMappingOptions
func (*IDMappingOptions) ContextValidate ¶
ContextValidate validate this ID mapping options based on the context it is used
func (*IDMappingOptions) MarshalBinary ¶
func (m *IDMappingOptions) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*IDMappingOptions) UnmarshalBinary ¶
func (m *IDMappingOptions) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type IDMappings ¶
type IDMappings struct { // g ID map GIDMap []*IDMap `json:"gidmap"` // UID map UIDMap []*IDMap `json:"uidmap"` }
IDMappings IDMappings describe the GID and UID mappings
swagger:model IDMappings
func (*IDMappings) ContextValidate ¶
ContextValidate validate this ID mappings based on the context it is used
func (*IDMappings) MarshalBinary ¶
func (m *IDMappings) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*IDMappings) UnmarshalBinary ¶
func (m *IDMappings) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type IDResponse ¶
type IDResponse struct { // ID ID string `json:"Id,omitempty"` }
IDResponse ID response
swagger:model IDResponse
func (*IDResponse) ContextValidate ¶
ContextValidate validates this ID response based on context it is used
func (*IDResponse) MarshalBinary ¶
func (m *IDResponse) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*IDResponse) UnmarshalBinary ¶
func (m *IDResponse) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type IP ¶
type IP []uint8
IP An IP is a single IP address, a slice of bytes. Functions in this package accept either 4-byte (IPv4) or 16-byte (IPv6) slices as input.
Note that in this documentation, referring to an IP address as an IPv4 address or an IPv6 address is a semantic property of the address, not just the length of the byte slice: a 16-byte slice can still be an IPv4 address.
swagger:model IP
func (IP) ContextValidate ¶
ContextValidate validates this IP based on context it is used
type IPAM ¶
type IPAM struct { // config Config []*IPAMConfig `json:"Config"` // driver Driver string `json:"Driver,omitempty"` // options Options map[string]string `json:"Options,omitempty"` }
IPAM IPAM represents IP Address Management
swagger:model IPAM
func (*IPAM) ContextValidate ¶
ContextValidate validate this IP a m based on the context it is used
func (*IPAM) MarshalBinary ¶
MarshalBinary interface implementation
func (*IPAM) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type IPAMConfig ¶
type IPAMConfig struct { // aux address AuxAddress map[string]string `json:"AuxiliaryAddresses,omitempty"` // gateway Gateway string `json:"Gateway,omitempty"` // IP range IPRange string `json:"IPRange,omitempty"` // subnet Subnet string `json:"Subnet,omitempty"` }
IPAMConfig IPAMConfig represents IPAM configurations
swagger:model IPAMConfig
func (*IPAMConfig) ContextValidate ¶
ContextValidate validates this IP a m config based on context it is used
func (*IPAMConfig) MarshalBinary ¶
func (m *IPAMConfig) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*IPAMConfig) UnmarshalBinary ¶
func (m *IPAMConfig) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type IPMask ¶
type IPMask []uint8
IPMask An IPMask is a bitmask that can be used to manipulate IP addresses for IP addressing and routing.
See type IPNet and func ParseCIDR for details.
swagger:model IPMask
func (IPMask) ContextValidate ¶
ContextValidate validates this IP mask based on context it is used
type IPNet ¶
IPNet An IPNet represents an IP network.
swagger:model IPNet
func (*IPNet) ContextValidate ¶
ContextValidate validate this IP net based on the context it is used
func (*IPNet) MarshalBinary ¶
MarshalBinary interface implementation
func (*IPNet) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type ImageConfig ¶
type ImageConfig struct { // Cmd defines the default arguments to the entrypoint of the container. Cmd []string `json:"Cmd"` // Entrypoint defines a list of arguments to use as the command to execute when the container starts. Entrypoint []string `json:"Entrypoint"` // Env is a list of environment variables to be used in a container. Env []string `json:"Env"` // ExposedPorts a set of ports to expose from a container running this image. ExposedPorts map[string]interface{} `json:"ExposedPorts,omitempty"` // Labels contains arbitrary metadata for the container. Labels map[string]string `json:"Labels,omitempty"` // StopSignal contains the system call signal that will be sent to the container to exit. StopSignal string `json:"StopSignal,omitempty"` // User defines the username or UID which the process in the container should run as. User string `json:"User,omitempty"` // Volumes is a set of directories describing where the process is likely write data specific to a container instance. Volumes map[string]interface{} `json:"Volumes,omitempty"` // WorkingDir sets the current working directory of the entrypoint process in the container. WorkingDir string `json:"WorkingDir,omitempty"` }
ImageConfig ImageConfig defines the execution parameters which should be used as a base when running a container using an image.
swagger:model ImageConfig
func (*ImageConfig) ContextValidate ¶
ContextValidate validates this image config based on context it is used
func (*ImageConfig) MarshalBinary ¶
func (m *ImageConfig) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ImageConfig) UnmarshalBinary ¶
func (m *ImageConfig) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ImageDeleteResponseItem ¶
type ImageDeleteResponseItem struct { // The image ID of an image that was deleted Deleted string `json:"Deleted,omitempty"` // The image ID of an image that was untagged Untagged string `json:"Untagged,omitempty"` }
ImageDeleteResponseItem ImageDeleteResponseItem image delete response item
swagger:model ImageDeleteResponseItem
func (*ImageDeleteResponseItem) ContextValidate ¶
func (m *ImageDeleteResponseItem) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validates this image delete response item based on context it is used
func (*ImageDeleteResponseItem) MarshalBinary ¶
func (m *ImageDeleteResponseItem) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ImageDeleteResponseItem) UnmarshalBinary ¶
func (m *ImageDeleteResponseItem) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ImageImportReport ¶
type ImageImportReport struct { // Id ID string `json:"Id,omitempty"` }
ImageImportReport image import report
swagger:model ImageImportReport
func (*ImageImportReport) ContextValidate ¶
ContextValidate validates this image import report based on context it is used
func (*ImageImportReport) MarshalBinary ¶
func (m *ImageImportReport) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ImageImportReport) UnmarshalBinary ¶
func (m *ImageImportReport) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ImageLoadReport ¶
type ImageLoadReport struct { // names Names []string `json:"Names"` }
ImageLoadReport image load report
swagger:model ImageLoadReport
func (*ImageLoadReport) ContextValidate ¶
ContextValidate validates this image load report based on context it is used
func (*ImageLoadReport) MarshalBinary ¶
func (m *ImageLoadReport) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ImageLoadReport) UnmarshalBinary ¶
func (m *ImageLoadReport) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ImageMetadata ¶
type ImageMetadata struct { // last tag time // Format: date-time LastTagTime strfmt.DateTime `json:"LastTagTime,omitempty"` }
ImageMetadata ImageMetadata contains engine-local data about the image
swagger:model ImageMetadata
func (*ImageMetadata) ContextValidate ¶
ContextValidate validates this image metadata based on context it is used
func (*ImageMetadata) MarshalBinary ¶
func (m *ImageMetadata) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ImageMetadata) UnmarshalBinary ¶
func (m *ImageMetadata) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ImageStore ¶
type ImageStore struct { // number Number int64 `json:"number,omitempty"` }
ImageStore ImageStore describes the image store. Right now only the number of images present
swagger:model ImageStore
func (*ImageStore) ContextValidate ¶
ContextValidate validates this image store based on context it is used
func (*ImageStore) MarshalBinary ¶
func (m *ImageStore) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ImageStore) UnmarshalBinary ¶
func (m *ImageStore) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ImageSummary ¶
type ImageSummary struct { // containers // Required: true Containers *int64 `json:"Containers"` // created // Required: true Created *int64 `json:"Created"` // Id // Required: true ID *string `json:"Id"` // labels // Required: true Labels map[string]string `json:"Labels"` // parent Id // Required: true ParentID *string `json:"ParentId"` // repo digests // Required: true RepoDigests []string `json:"RepoDigests"` // repo tags // Required: true RepoTags []string `json:"RepoTags"` // Required: true SharedSize *int64 `json:"SharedSize"` // size // Required: true Size *int64 `json:"Size"` // virtual size // Required: true VirtualSize *int64 `json:"VirtualSize"` }
ImageSummary ImageSummary image summary
swagger:model ImageSummary
func (*ImageSummary) ContextValidate ¶
ContextValidate validates this image summary based on context it is used
func (*ImageSummary) MarshalBinary ¶
func (m *ImageSummary) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ImageSummary) UnmarshalBinary ¶
func (m *ImageSummary) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ImageVolume ¶
type ImageVolume struct { // Destination is the absolute path of the mount in the container. Destination string `json:"Destination,omitempty"` // ReadWrite sets the volume writable. ReadWrite bool `json:"ReadWrite,omitempty"` // Source is the source of the image volume. The image can be referred // to by name and by ID. Source string `json:"Source,omitempty"` }
ImageVolume ImageVolume is a volume based on a container image. The container image is first mounted on the host and is then bind-mounted into the container. An ImageVolume is always mounted read only.
swagger:model ImageVolume
func (*ImageVolume) ContextValidate ¶
ContextValidate validates this image volume based on context it is used
func (*ImageVolume) MarshalBinary ¶
func (m *ImageVolume) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ImageVolume) UnmarshalBinary ¶
func (m *ImageVolume) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Info ¶
type Info struct { // registries Registries map[string]interface{} `json:"registries,omitempty"` // host Host *HostInfo `json:"host,omitempty"` // plugins Plugins *Plugins `json:"plugins,omitempty"` // store Store *StoreInfo `json:"store,omitempty"` // version Version *Version `json:"version,omitempty"` }
Info Info is the overall struct that describes the host system running libpod/podman
swagger:model Info
func (*Info) ContextValidate ¶
ContextValidate validate this info based on the context it is used
func (*Info) MarshalBinary ¶
MarshalBinary interface implementation
func (*Info) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type InspectAdditionalNetwork ¶
type InspectAdditionalNetwork struct { // AdditionalMacAddresses is a set of additional MAC Addresses beyond // the first. CNI may configure more than one interface for a single // network, which can cause this. AdditionalMacAddresses []string `json:"AdditionalMACAddresses"` // Aliases are any network aliases the container has in this network. Aliases []string `json:"Aliases"` // DriverOpts is presently unused and maintained exclusively for // compatibility. DriverOpts map[string]string `json:"DriverOpts,omitempty"` // EndpointID is unused, maintained exclusively for compatibility. EndpointID string `json:"EndpointID,omitempty"` // Gateway is the IP address of the gateway this network will use. Gateway string `json:"Gateway,omitempty"` // GlobalIPv6Address is the global-scope IPv6 Address for this network. GlobalIPV6Address string `json:"GlobalIPv6Address,omitempty"` // GlobalIPv6PrefixLen is the length of the subnet mask of this network. GlobalIPV6PrefixLen int64 `json:"GlobalIPv6PrefixLen,omitempty"` // IPAMConfig is presently unused and maintained exclusively for // compatibility. IPAMConfig map[string]string `json:"IPAMConfig,omitempty"` // IPAddress is the IP address for this network. IPAddress string `json:"IPAddress,omitempty"` // IPPrefixLen is the length of the subnet mask of this network. IPPrefixLen int64 `json:"IPPrefixLen,omitempty"` // IPv6Gateway is the IPv6 gateway this network will use. IPV6Gateway string `json:"IPv6Gateway,omitempty"` // Links is presently unused and maintained exclusively for // compatibility. Links []string `json:"Links"` // MacAddress is the MAC address for the interface in this network. MacAddress string `json:"MacAddress,omitempty"` // Name of the network we're connecting to. NetworkID string `json:"NetworkID,omitempty"` // SecondaryIPAddresses is a list of extra IP Addresses that the // container has been assigned in this network. SecondaryIPAddresses []*Address `json:"SecondaryIPAddresses"` // SecondaryIPv6Addresses is a list of extra IPv6 Addresses that the // container has been assigned in this network. SecondaryIPV6Addresses []*Address `json:"SecondaryIPv6Addresses"` }
InspectAdditionalNetwork InspectAdditionalNetwork holds information about non-default CNI networks the container has been connected to. As with InspectNetworkSettings, many fields are unused and maintained only for compatibility with Docker.
swagger:model InspectAdditionalNetwork
func (*InspectAdditionalNetwork) ContextValidate ¶
func (m *InspectAdditionalNetwork) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validate this inspect additional network based on the context it is used
func (*InspectAdditionalNetwork) MarshalBinary ¶
func (m *InspectAdditionalNetwork) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*InspectAdditionalNetwork) UnmarshalBinary ¶
func (m *InspectAdditionalNetwork) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type InspectBlkioThrottleDevice ¶
type InspectBlkioThrottleDevice struct { // Path is the path to the device this applies to. Path string `json:"Path,omitempty"` // Rate is the maximum rate. It is in either bytes per second or iops // per second, determined by where it is used - documentation will // indicate which is appropriate. Rate uint64 `json:"Rate,omitempty"` }
InspectBlkioThrottleDevice InspectBlkioThrottleDevice holds information about a speed cap for a device node. This cap applies to a specific operation (read, write, etc) on the given node.
swagger:model InspectBlkioThrottleDevice
func (*InspectBlkioThrottleDevice) ContextValidate ¶
func (m *InspectBlkioThrottleDevice) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validates this inspect blkio throttle device based on context it is used
func (*InspectBlkioThrottleDevice) MarshalBinary ¶
func (m *InspectBlkioThrottleDevice) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*InspectBlkioThrottleDevice) UnmarshalBinary ¶
func (m *InspectBlkioThrottleDevice) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type InspectBlkioWeightDevice ¶
type InspectBlkioWeightDevice struct { // Path is the path to the device this applies to. Path string `json:"Path,omitempty"` // Weight is the relative weight the scheduler will use when scheduling // I/O. Weight uint16 `json:"Weight,omitempty"` }
InspectBlkioWeightDevice InspectBlkioWeightDevice holds information about the relative weight of an individual device node. Weights are used in the I/O scheduler to give relative priority to some accesses.
swagger:model InspectBlkioWeightDevice
func (*InspectBlkioWeightDevice) ContextValidate ¶
func (m *InspectBlkioWeightDevice) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validates this inspect blkio weight device based on context it is used
func (*InspectBlkioWeightDevice) MarshalBinary ¶
func (m *InspectBlkioWeightDevice) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*InspectBlkioWeightDevice) UnmarshalBinary ¶
func (m *InspectBlkioWeightDevice) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type InspectContainerConfig ¶
type InspectContainerConfig struct { // Container annotations Annotations map[string]string `json:"Annotations,omitempty"` // Unused, at present AttachStderr bool `json:"AttachStderr,omitempty"` // Unused, at present AttachStdin bool `json:"AttachStdin,omitempty"` // Unused, at present AttachStdout bool `json:"AttachStdout,omitempty"` // Container command Cmd []string `json:"Cmd"` // CreateCommand is the full command plus arguments of the process the // container has been created with. CreateCommand []string `json:"CreateCommand"` // Container domain name - unused at present DomainName string `json:"Domainname,omitempty"` // Container entrypoint Entrypoint string `json:"Entrypoint,omitempty"` // Container environment variables Env []string `json:"Env"` // healthcheck Healthcheck *Schema2HealthConfig `json:"Healthcheck,omitempty"` // Container hostname Hostname string `json:"Hostname,omitempty"` // Container image Image string `json:"Image,omitempty"` // Container labels Labels map[string]string `json:"Labels,omitempty"` // On-build arguments - presently unused. More of Buildah's domain. OnBuild string `json:"OnBuild,omitempty"` // Whether the container leaves STDIN open OpenStdin bool `json:"OpenStdin,omitempty"` // Passwd determines whether or not podman can add entries to /etc/passwd and /etc/group Passwd bool `json:"Passwd,omitempty"` // Secrets are the secrets mounted in the container Secrets []*InspectSecret `json:"Secrets"` // Whether STDIN is only left open once. // Presently not supported by Podman, unused. StdinOnce bool `json:"StdinOnce,omitempty"` // StopTimeout is time before container is stopped when calling stop StopTimeout uint64 `json:"StopTimeout,omitempty"` // SystemdMode is whether the container is running in systemd mode. In // systemd mode, the container configuration is customized to optimize // running systemd in the container. SystemdMode bool `json:"SystemdMode,omitempty"` // Timeout is time before container is killed by conmon Timeout uint64 `json:"Timeout,omitempty"` // Timezone is the timezone inside the container. // Local means it has the same timezone as the host machine Timezone string `json:"Timezone,omitempty"` // Whether the container creates a TTY Tty bool `json:"Tty,omitempty"` // Umask is the umask inside the container. Umask string `json:"Umask,omitempty"` // User the container was launched with User string `json:"User,omitempty"` // Unused, at present. I've never seen this field populated. Volumes map[string]interface{} `json:"Volumes,omitempty"` // Container working directory WorkingDir string `json:"WorkingDir,omitempty"` }
InspectContainerConfig InspectContainerConfig holds further data about how a container was initially configured.
swagger:model InspectContainerConfig
func (*InspectContainerConfig) ContextValidate ¶
func (m *InspectContainerConfig) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validate this inspect container config based on the context it is used
func (*InspectContainerConfig) MarshalBinary ¶
func (m *InspectContainerConfig) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*InspectContainerConfig) UnmarshalBinary ¶
func (m *InspectContainerConfig) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type InspectContainerHostConfig ¶
type InspectContainerHostConfig struct { // AutoRemove is whether the container will be automatically removed on // exiting. // It is not handled directly within libpod and is stored in an // annotation. AutoRemove bool `json:"AutoRemove,omitempty"` // Binds contains an array of user-added mounts. // Both volume mounts and named volumes are included. // Tmpfs mounts are NOT included. // In 'docker inspect' this is separated into 'Binds' and 'Mounts' based // on how a mount was added. We do not make this distinction and do not // include a Mounts field in inspect. // Format: <src>:<destination>[:<comma-separated options>] Binds []string `json:"Binds"` // BlkioDeviceReadBps is an array of I/O throttle parameters for // individual device nodes. // This specifically sets read rate cap in bytes per second for device // nodes. // As with BlkioWeightDevice, we pull the path from /sys/dev, and we // don't guarantee the path will be identical to the original (though // the node will be). BlkioDeviceReadBps []*InspectBlkioThrottleDevice `json:"BlkioDeviceReadBps"` // BlkioDeviceReadIOps is an array of I/O throttle parameters for // individual device nodes. // This specifically sets the read rate cap in iops per second for // device nodes. // As with BlkioWeightDevice, we pull the path from /sys/dev, and we // don't guarantee the path will be identical to the original (though // the node will be). BlkioDeviceReadIOps []*InspectBlkioThrottleDevice `json:"BlkioDeviceReadIOps"` // BlkioDeviceWriteBps is an array of I/O throttle parameters for // individual device nodes. // this specifically sets write rate cap in bytes per second for device // nodes. // as with BlkioWeightDevice, we pull the path from /sys/dev, and we // don't guarantee the path will be identical to the original (though // the node will be). BlkioDeviceWriteBps []*InspectBlkioThrottleDevice `json:"BlkioDeviceWriteBps"` // BlkioDeviceWriteIOps is an array of I/O throttle parameters for // individual device nodes. // This specifically sets the write rate cap in iops per second for // device nodes. // As with BlkioWeightDevice, we pull the path from /sys/dev, and we // don't guarantee the path will be identical to the original (though // the node will be). BlkioDeviceWriteIOps []*InspectBlkioThrottleDevice `json:"BlkioDeviceWriteIOps"` // BlkioWeight indicates the I/O resources allocated to the container. // It is a relative weight in the scheduler for assigning I/O time // versus other Cgroups. BlkioWeight uint16 `json:"BlkioWeight,omitempty"` // BlkioWeightDevice is an array of I/O resource priorities for // individual device nodes. // Unfortunately, the spec only stores the device's Major/Minor numbers // and not the path, which is used here. // Fortunately, the kernel provides an interface for retrieving the path // of a given node by major:minor at /sys/dev/. However, the exact path // in use may not be what was used in the original CLI invocation - // though it is guaranteed that the device node will be the same, and // using the given path will be functionally identical. BlkioWeightDevice []*InspectBlkioWeightDevice `json:"BlkioWeightDevice"` // CapAdd is a list of capabilities added to the container. // It is not directly stored by Libpod, and instead computed from the // capabilities listed in the container's spec, compared against a set // of default capabilities. CapAdd []string `json:"CapAdd"` // CapDrop is a list of capabilities removed from the container. // It is not directly stored by libpod, and instead computed from the // capabilities listed in the container's spec, compared against a set // of default capabilities. CapDrop []string `json:"CapDrop"` // Cgroup contains the container's cgroup. It is presently not // populated. // TODO. Cgroup string `json:"Cgroup,omitempty"` // CgroupConf is the configuration for cgroup v2. CgroupConf map[string]string `json:"CgroupConf,omitempty"` // CgroupManager is the cgroup manager used by the container. // At present, allowed values are either "cgroupfs" or "systemd". CgroupManager string `json:"CgroupManager,omitempty"` // CgroupMode is the configuration of the container's cgroup namespace. // Populated as follows: // private - a cgroup namespace has been created // host - No cgroup namespace created // container:<id> - Using another container's cgroup namespace // ns:<path> - A path to a cgroup namespace has been specified CgroupMode string `json:"CgroupMode,omitempty"` // CgroupParent is the Cgroup parent of the container. // Only set if not default. CgroupParent string `json:"CgroupParent,omitempty"` // Cgroups contains the container's Cgroup mode. // Allowed values are "default" (container is creating Cgroups) and // "disabled" (container is not creating Cgroups). // This is Libpod-specific and not included in `docker inspect`. Cgroups string `json:"Cgroups,omitempty"` // ConsoleSize is an array of 2 integers showing the size of the // container's console. // It is only set if the container is creating a terminal. // TODO. ConsoleSize []uint64 `json:"ConsoleSize"` // ContainerIDFile is a file created during container creation to hold // the ID of the created container. // This is not handled within libpod and is stored in an annotation. ContainerIDFile string `json:"ContainerIDFile,omitempty"` // CpuCount is Windows-only and not presently implemented. CPUCount uint64 `json:"CpuCount,omitempty"` // CpuPercent is Windows-only and not presently implemented. CPUPercent uint64 `json:"CpuPercent,omitempty"` // CpuPeriod is the length of a CPU period in microseconds. // It relates directly to CpuQuota. CPUPeriod uint64 `json:"CpuPeriod,omitempty"` // CpuPeriod is the amount of time (in microseconds) that a container // can use the CPU in every CpuPeriod. CPUQuota int64 `json:"CpuQuota,omitempty"` // CpuRealtimePeriod is the length of time (in microseconds) of the CPU // realtime period. If set to 0, no time will be allocated to realtime // tasks. CPURealtimePeriod uint64 `json:"CpuRealtimePeriod,omitempty"` // CpuRealtimeRuntime is the length of time (in microseconds) allocated // for realtime tasks within every CpuRealtimePeriod. CPURealtimeRuntime int64 `json:"CpuRealtimeRuntime,omitempty"` // It is a relative weight in the scheduler for assigning CPU time // versus other Cgroups. CPUShares uint64 `json:"CpuShares,omitempty"` // CpusetCpus is the is the set of CPUs that the container will execute // on. Formatted as `0-3` or `0,2`. Default (if unset) is all CPUs. CpusetCpus string `json:"CpusetCpus,omitempty"` // CpusetMems is the set of memory nodes the container will use. // Formatted as `0-3` or `0,2`. Default (if unset) is all memory nodes. CpusetMems string `json:"CpusetMems,omitempty"` // Devices is a list of device nodes that will be added to the // container. // These are stored in the OCI spec only as type, major, minor while we // display the host path. We convert this with /sys/dev, but we cannot // guarantee that the host path will be identical - only that the actual // device will be. Devices []*InspectDevice `json:"Devices"` // DiskQuota is the maximum amount of disk space the container may use // (in bytes). // Presently not populated. // TODO. DiskQuota uint64 `json:"DiskQuota,omitempty"` // Dns is a list of DNS nameservers that will be added to the // container's resolv.conf DNS []string `json:"Dns"` // DnsOptions is a list of DNS options that will be set in the // container's resolv.conf DNSOptions []string `json:"DnsOptions"` // DnsSearch is a list of DNS search domains that will be set in the // container's resolv.conf DNSSearch []string `json:"DnsSearch"` // ExtraHosts contains hosts that will be added to the container's // etc/hosts. ExtraHosts []string `json:"ExtraHosts"` // GroupAdd contains groups that the user inside the container will be // added to. GroupAdd []string `json:"GroupAdd"` // ID mappings IDMappings *InspectIDMappings `json:"IDMappings,omitempty"` // IOMaximumBandwidth is Windows-only and not presently implemented. IOMaximumBandwidth uint64 `json:"IOMaximumBandwidth,omitempty"` // IOMaximumIOps is Windows-only and not presently implemented. IOMaximumIOps uint64 `json:"IOMaximumIOps,omitempty"` // Init indicates whether the container has an init mounted into it. Init bool `json:"Init,omitempty"` // IpcMode represents the configuration of the container's IPC // namespace. // Populated as follows: // "" (empty string) - Default, an IPC namespace will be created // host - No IPC namespace created // container:<id> - Using another container's IPC namespace // ns:<path> - A path to an IPC namespace has been specified IpcMode string `json:"IpcMode,omitempty"` // Isolation is presently unused and provided solely for Docker // compatibility. Isolation string `json:"Isolation,omitempty"` // KernelMemory is the maximum amount of memory the kernel will devote // to the container. KernelMemory int64 `json:"KernelMemory,omitempty"` // Links is unused, and provided purely for Docker compatibility. Links []string `json:"Links"` // log config LogConfig *InspectLogConfig `json:"LogConfig,omitempty"` // Memory indicates the memory resources allocated to the container. // This is the limit (in bytes) of RAM the container may use. Memory int64 `json:"Memory,omitempty"` // MemoryReservation is the reservation (soft limit) of memory available // to the container. Soft limits are warnings only and can be exceeded. MemoryReservation int64 `json:"MemoryReservation,omitempty"` // MemorySwap is the total limit for all memory available to the // container, including swap. 0 indicates that there is no limit to the // amount of memory available. MemorySwap int64 `json:"MemorySwap,omitempty"` // MemorySwappiness is the willingness of the kernel to page container // memory to swap. It is an integer from 0 to 100, with low numbers // being more likely to be put into swap. // 1, the default, will not set swappiness and use the system defaults. MemorySwappiness int64 `json:"MemorySwappiness,omitempty"` // NanoCpus indicates number of CPUs allocated to the container. // It is an integer where one full CPU is indicated by 1000000000 (one // billion). // Thus, 2.5 CPUs (fractional portions of CPUs are allowed) would be // 2500000000 (2.5 billion). // In 'docker inspect' this is set exclusively of two further options in // the output (CpuPeriod and CpuQuota) which are both used to implement // this functionality. // We can't distinguish here, so if CpuQuota is set to the default of // 100000, we will set both CpuQuota, CpuPeriod, and NanoCpus. If // CpuQuota is not the default, we will not set NanoCpus. NanoCpus int64 `json:"NanoCpus,omitempty"` // NetworkMode is the configuration of the container's network // namespace. // Populated as follows: // default - A network namespace is being created and configured via CNI // none - A network namespace is being created, not configured via CNI // host - No network namespace created // container:<id> - Using another container's network namespace // ns:<path> - A path to a network namespace has been specified NetworkMode string `json:"NetworkMode,omitempty"` // OomKillDisable indicates whether the kernel OOM killer is disabled // for the container. OomKillDisable bool `json:"OomKillDisable,omitempty"` // OOMScoreAdj is an adjustment that will be made to the container's OOM // score. OomScoreAdj int64 `json:"OomScoreAdj,omitempty"` // PidMode represents the configuration of the container's PID // namespace. // Populated as follows: // "" (empty string) - Default, a PID namespace will be created // host - No PID namespace created // container:<id> - Using another container's PID namespace // ns:<path> - A path to a PID namespace has been specified PidMode string `json:"PidMode,omitempty"` // PidsLimit is the maximum number of PIDs what may be created within // the container. 0, the default, indicates no limit. PidsLimit int64 `json:"PidsLimit,omitempty"` // PortBindings contains the container's port bindings. // It is formatted as map[string][]InspectHostPort. // The string key here is formatted as <integer port number>/<protocol> // and represents the container port. A single container port may be // bound to multiple host ports (on different IPs). PortBindings map[string][]InspectHostPort `json:"PortBindings,omitempty"` // Privileged indicates whether the container is running with elevated // privileges. // This has a very specific meaning in the Docker sense, so it's very // difficult to decode from the spec and config, and so is stored as an // annotation. Privileged bool `json:"Privileged,omitempty"` // PublishAllPorts indicates whether image ports are being published. // This is not directly stored in libpod and is saved as an annotation. PublishAllPorts bool `json:"PublishAllPorts,omitempty"` // ReadonlyRootfs is whether the container will be mounted read-only. ReadonlyRootfs bool `json:"ReadonlyRootfs,omitempty"` // restart policy RestartPolicy *InspectRestartPolicy `json:"RestartPolicy,omitempty"` // Runtime is provided purely for Docker compatibility. // It is set unconditionally to "oci" as Podman does not presently // support non-OCI runtimes. Runtime string `json:"Runtime,omitempty"` // SecurityOpt is a list of security-related options that are set in the // container. SecurityOpt []string `json:"SecurityOpt"` // shm size ShmSize int64 `json:"ShmSize,omitempty"` // Tmpfs is a list of tmpfs filesystems that will be mounted into the // container. // It is a map of destination path to options for the mount. Tmpfs map[string]string `json:"Tmpfs,omitempty"` // UTSMode represents the configuration of the container's UID // namespace. // Populated as follows: // "" (empty string) - Default, a UTS namespace will be created // host - no UTS namespace created // container:<id> - Using another container's UTS namespace // ns:<path> - A path to a UTS namespace has been specified UTSMode string `json:"UTSMode,omitempty"` // Ulimits is a set of ulimits that will be set within the container. Ulimits []*InspectUlimit `json:"Ulimits"` // UsernsMode represents the configuration of the container's user // namespace. // When running rootless, a user namespace is created outside of libpod // to allow some privileged operations. This will not be reflected here. // Populated as follows: // "" (empty string) - No user namespace will be created // private - The container will be run in a user namespace // container:<id> - Using another container's user namespace // ns:<path> - A path to a user namespace has been specified // TODO Rootless has an additional 'keep-id' option, presently not // reflected here. UsernsMode string `json:"UsernsMode,omitempty"` // VolumeDriver is presently unused and is retained for Docker // compatibility. VolumeDriver string `json:"VolumeDriver,omitempty"` // VolumesFrom is a list of containers which this container uses volumes // from. This is not handled directly within libpod and is stored in an // annotation. // It is formatted as an array of container names and IDs. VolumesFrom []string `json:"VolumesFrom"` }
InspectContainerHostConfig InspectContainerHostConfig holds information used when the container was created. It's very much a Docker-specific struct, retained (mostly) as-is for compatibility. We fill individual fields as best as we can, inferring as much as possible from the spec and container config. Some things cannot be inferred. These will be populated by spec annotations (if available). Field names are fixed for compatibility and cannot be changed. As such, silence lint warnings about them. nolint
swagger:model InspectContainerHostConfig
func (*InspectContainerHostConfig) ContextValidate ¶
func (m *InspectContainerHostConfig) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validate this inspect container host config based on the context it is used
func (*InspectContainerHostConfig) MarshalBinary ¶
func (m *InspectContainerHostConfig) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*InspectContainerHostConfig) UnmarshalBinary ¶
func (m *InspectContainerHostConfig) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type InspectContainerState ¶
type InspectContainerState struct { // cgroup path CgroupPath string `json:"CgroupPath,omitempty"` // checkpoint log CheckpointLog string `json:"CheckpointLog,omitempty"` // checkpoint path CheckpointPath string `json:"CheckpointPath,omitempty"` // checkpointed Checkpointed bool `json:"Checkpointed,omitempty"` // checkpointed at // Format: date-time CheckpointedAt strfmt.DateTime `json:"CheckpointedAt,omitempty"` // conmon pid ConmonPid int64 `json:"ConmonPid,omitempty"` // dead Dead bool `json:"Dead,omitempty"` // error Error string `json:"Error,omitempty"` // exit code ExitCode int32 `json:"ExitCode,omitempty"` // finished at // Format: date-time FinishedAt strfmt.DateTime `json:"FinishedAt,omitempty"` // health Health *HealthCheckResults `json:"Health,omitempty"` // o o m killed OOMKilled bool `json:"OOMKilled,omitempty"` // oci version OciVersion string `json:"OciVersion,omitempty"` // paused Paused bool `json:"Paused,omitempty"` // pid Pid int64 `json:"Pid,omitempty"` // restarting Restarting bool `json:"Restarting,omitempty"` // restore log RestoreLog string `json:"RestoreLog,omitempty"` // restored Restored bool `json:"Restored,omitempty"` // restored at // Format: date-time RestoredAt strfmt.DateTime `json:"RestoredAt,omitempty"` // running Running bool `json:"Running,omitempty"` // started at // Format: date-time StartedAt strfmt.DateTime `json:"StartedAt,omitempty"` // status Status string `json:"Status,omitempty"` }
InspectContainerState InspectContainerState provides a detailed record of a container's current state. It is returned as part of InspectContainerData. As with InspectContainerData, many portions of this struct are matched to Docker, but here we see more fields that are unused (nonsensical in the context of Libpod).
swagger:model InspectContainerState
func (*InspectContainerState) ContextValidate ¶
ContextValidate validate this inspect container state based on the context it is used
func (*InspectContainerState) MarshalBinary ¶
func (m *InspectContainerState) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*InspectContainerState) UnmarshalBinary ¶
func (m *InspectContainerState) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type InspectDevice ¶
type InspectDevice struct { // CgroupPermissions is the permissions of the mounted device. // Presently not populated. // TODO. CgroupPermissions string `json:"CgroupPermissions,omitempty"` // PathInContainer is the path of the device within the container. PathInContainer string `json:"PathInContainer,omitempty"` // PathOnHost is the path of the device on the host. PathOnHost string `json:"PathOnHost,omitempty"` }
InspectDevice InspectDevice is a single device that will be mounted into the container.
swagger:model InspectDevice
func (*InspectDevice) ContextValidate ¶
ContextValidate validates this inspect device based on context it is used
func (*InspectDevice) MarshalBinary ¶
func (m *InspectDevice) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*InspectDevice) UnmarshalBinary ¶
func (m *InspectDevice) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type InspectHostPort ¶
type InspectHostPort struct { // IP on the host we are bound to. "" if not specified (binding to all // IPs). HostIP string `json:"HostIp,omitempty"` // Port on the host we are bound to. No special formatting - just an // integer stuffed into a string. HostPort string `json:"HostPort,omitempty"` }
InspectHostPort InspectHostPort provides information on a port on the host that a container's port is bound to.
swagger:model InspectHostPort
func (*InspectHostPort) ContextValidate ¶
ContextValidate validates this inspect host port based on context it is used
func (*InspectHostPort) MarshalBinary ¶
func (m *InspectHostPort) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*InspectHostPort) UnmarshalBinary ¶
func (m *InspectHostPort) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type InspectIDMappings ¶
type InspectIDMappings struct { // g ID map GIDMap []string `json:"GidMap"` // UID map UIDMap []string `json:"UidMap"` }
InspectIDMappings inspect ID mappings
swagger:model InspectIDMappings
func (*InspectIDMappings) ContextValidate ¶
ContextValidate validates this inspect ID mappings based on context it is used
func (*InspectIDMappings) MarshalBinary ¶
func (m *InspectIDMappings) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*InspectIDMappings) UnmarshalBinary ¶
func (m *InspectIDMappings) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type InspectLogConfig ¶
type InspectLogConfig struct { // config Config map[string]string `json:"Config,omitempty"` // Path specifies a path to the log file Path string `json:"Path,omitempty"` // Size specifies a maximum size of the container log Size string `json:"Size,omitempty"` // Tag specifies a custom log tag for the container Tag string `json:"Tag,omitempty"` // type Type string `json:"Type,omitempty"` }
InspectLogConfig InspectLogConfig holds information about a container's configured log driver
swagger:model InspectLogConfig
func (*InspectLogConfig) ContextValidate ¶
ContextValidate validates this inspect log config based on context it is used
func (*InspectLogConfig) MarshalBinary ¶
func (m *InspectLogConfig) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*InspectLogConfig) UnmarshalBinary ¶
func (m *InspectLogConfig) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type InspectMount ¶
type InspectMount struct { // The destination directory for the volume. Specified as a path within // the container, as it would be passed into the OCI runtime. Destination string `json:"Destination,omitempty"` // The driver used for the named volume. Empty for bind mounts. Driver string `json:"Driver,omitempty"` // Contains SELinux :z/:Z mount options. Unclear what, if anything, else // goes in here. Mode string `json:"Mode,omitempty"` // The name of the volume. Empty for bind mounts. Name string `json:"Name,omitempty"` // All remaining mount options. Additional data, not present in the // original output. Options []string `json:"Options"` // Mount propagation for the mount. Can be empty if not specified, but // is always printed - no omitempty. Propagation string `json:"Propagation,omitempty"` // Whether the volume is read-write RW bool `json:"RW,omitempty"` // The source directory for the volume. Source string `json:"Source,omitempty"` // Whether the mount is a volume or bind mount. Allowed values are // "volume" and "bind". Type string `json:"Type,omitempty"` }
InspectMount InspectMount provides a record of a single mount in a container. It contains fields for both named and normal volumes. Only user-specified volumes will be included, and tmpfs volumes are not included even if the user specified them.
swagger:model InspectMount
func (*InspectMount) ContextValidate ¶
ContextValidate validates this inspect mount based on context it is used
func (*InspectMount) MarshalBinary ¶
func (m *InspectMount) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*InspectMount) UnmarshalBinary ¶
func (m *InspectMount) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type InspectNetworkSettings ¶
type InspectNetworkSettings struct { // AdditionalMacAddresses is a set of additional MAC Addresses beyond // the first. CNI may configure more than one interface for a single // network, which can cause this. AdditionalMacAddresses []string `json:"AdditionalMACAddresses"` // bridge Bridge string `json:"Bridge,omitempty"` // EndpointID is unused, maintained exclusively for compatibility. EndpointID string `json:"EndpointID,omitempty"` // Gateway is the IP address of the gateway this network will use. Gateway string `json:"Gateway,omitempty"` // GlobalIPv6Address is the global-scope IPv6 Address for this network. GlobalIPV6Address string `json:"GlobalIPv6Address,omitempty"` // GlobalIPv6PrefixLen is the length of the subnet mask of this network. GlobalIPV6PrefixLen int64 `json:"GlobalIPv6PrefixLen,omitempty"` // hairpin mode HairpinMode bool `json:"HairpinMode,omitempty"` // IPAddress is the IP address for this network. IPAddress string `json:"IPAddress,omitempty"` // IPPrefixLen is the length of the subnet mask of this network. IPPrefixLen int64 `json:"IPPrefixLen,omitempty"` // IPv6Gateway is the IPv6 gateway this network will use. IPV6Gateway string `json:"IPv6Gateway,omitempty"` // link local IPv6 address LinkLocalIPV6Address string `json:"LinkLocalIPv6Address,omitempty"` // link local IPv6 prefix len LinkLocalIPV6PrefixLen int64 `json:"LinkLocalIPv6PrefixLen,omitempty"` // MacAddress is the MAC address for the interface in this network. MacAddress string `json:"MacAddress,omitempty"` // Networks contains information on non-default CNI networks this // container has joined. // It is a map of network name to network information. Networks map[string]InspectAdditionalNetwork `json:"Networks,omitempty"` // ports Ports map[string][]InspectHostPort `json:"Ports,omitempty"` // sandbox ID SandboxID string `json:"SandboxID,omitempty"` // sandbox key SandboxKey string `json:"SandboxKey,omitempty"` // SecondaryIPAddresses is a list of extra IP Addresses that the // container has been assigned in this network. SecondaryIPAddresses []*Address `json:"SecondaryIPAddresses"` // SecondaryIPv6Addresses is a list of extra IPv6 Addresses that the // container has been assigned in this network. SecondaryIPV6Addresses []*Address `json:"SecondaryIPv6Addresses"` }
InspectNetworkSettings InspectNetworkSettings holds information about the network settings of the container. Many fields are maintained only for compatibility with `docker inspect` and are unused within Libpod.
swagger:model InspectNetworkSettings
func (*InspectNetworkSettings) ContextValidate ¶
func (m *InspectNetworkSettings) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validate this inspect network settings based on the context it is used
func (*InspectNetworkSettings) MarshalBinary ¶
func (m *InspectNetworkSettings) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*InspectNetworkSettings) UnmarshalBinary ¶
func (m *InspectNetworkSettings) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type InspectPodContainerInfo ¶
type InspectPodContainerInfo struct { // ID is the ID of the container. ID string `json:"Id,omitempty"` // Name is the name of the container. Name string `json:"Name,omitempty"` // State is the current status of the container. State string `json:"State,omitempty"` }
InspectPodContainerInfo InspectPodContainerInfo contains information on a container in a pod.
swagger:model InspectPodContainerInfo
func (*InspectPodContainerInfo) ContextValidate ¶
func (m *InspectPodContainerInfo) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validates this inspect pod container info based on context it is used
func (*InspectPodContainerInfo) MarshalBinary ¶
func (m *InspectPodContainerInfo) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*InspectPodContainerInfo) UnmarshalBinary ¶
func (m *InspectPodContainerInfo) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type InspectPodInfraConfig ¶
type InspectPodInfraConfig struct { // CPUPeriod contains the CPU period of the pod CPUPeriod uint64 `json:"cpu_period,omitempty"` // CPUQuota contains the CPU quota of the pod CPUQuota int64 `json:"cpu_quota,omitempty"` // CPUSetCPUs contains linux specific CPU data for the container CPUSetCPUs string `json:"cpuset_cpus,omitempty"` // DNSOption is a set of DNS options that will be used by the infra // container's resolv.conf and shared with the remainder of the pod. DNSOption []string `json:"DNSOption"` // DNSSearch is a set of DNS search domains that will be used by the // infra container's resolv.conf and shared with the remainder of the // pod. DNSSearch []string `json:"DNSSearch"` // DNSServer is a set of DNS Servers that will be used by the infra // container's resolv.conf and shared with the remainder of the pod. DNSServer []string `json:"DNSServer"` // HostAdd adds a number of hosts to the infra container's resolv.conf // which will be shared with the rest of the pod. HostAdd []string `json:"HostAdd"` // HostNetwork is whether the infra container (and thus the whole pod) // will use the host's network and not create a network namespace. HostNetwork bool `json:"HostNetwork,omitempty"` // NetworkOptions are additional options for each network NetworkOptions map[string][]string `json:"NetworkOptions,omitempty"` // Networks is a list of CNI networks the pod will join. Networks []string `json:"Networks"` // NoManageHosts indicates that the pod will not manage /etc/hosts and // instead each container will handle their own. NoManageHosts bool `json:"NoManageHosts,omitempty"` // NoManageResolvConf indicates that the pod will not manage resolv.conf // and instead each container will handle their own. NoManageResolvConf bool `json:"NoManageResolvConf,omitempty"` // Pid is the PID namespace mode of the pod's infra container PidNS string `json:"pid_ns,omitempty"` // PortBindings are ports that will be forwarded to the infra container // and then shared with the pod. PortBindings map[string][]InspectHostPort `json:"PortBindings,omitempty"` // static IP StaticIP IP `json:"StaticIP,omitempty"` // StaticMAC is a static MAC address that will be assigned to the infra // container and then used by the pod. StaticMAC string `json:"StaticMAC,omitempty"` // UserNS is the usernamespace that all the containers in the pod will join. UserNS string `json:"userns,omitempty"` }
InspectPodInfraConfig InspectPodInfraConfig contains the configuration of the pod's infra container.
swagger:model InspectPodInfraConfig
func (*InspectPodInfraConfig) ContextValidate ¶
ContextValidate validate this inspect pod infra config based on the context it is used
func (*InspectPodInfraConfig) MarshalBinary ¶
func (m *InspectPodInfraConfig) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*InspectPodInfraConfig) UnmarshalBinary ¶
func (m *InspectPodInfraConfig) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type InspectRestartPolicy ¶
type InspectRestartPolicy struct { // MaximumRetryCount is the maximum number of retries allowed if the // "on-failure" restart policy is in use. Not used if "on-failure" is // not set. MaximumRetryCount uint64 `json:"MaximumRetryCount,omitempty"` // Name contains the container's restart policy. // Allowable values are "no" or "" (take no action), // "on-failure" (restart on non-zero exit code, with an optional max // retry count), and "always" (always restart on container stop, unless // explicitly requested by API). // Note that this is NOT actually a name of any sort - the poor naming // is for Docker compatibility. Name string `json:"Name,omitempty"` }
InspectRestartPolicy InspectRestartPolicy holds information about the container's restart policy.
swagger:model InspectRestartPolicy
func (*InspectRestartPolicy) ContextValidate ¶
ContextValidate validates this inspect restart policy based on context it is used
func (*InspectRestartPolicy) MarshalBinary ¶
func (m *InspectRestartPolicy) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*InspectRestartPolicy) UnmarshalBinary ¶
func (m *InspectRestartPolicy) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type InspectSecret ¶
type InspectSecret struct { // ID is the GID of the mounted secret file GID uint32 `json:"GID,omitempty"` // ID is the ID of the secret ID string `json:"ID,omitempty"` // ID is the ID of the mode of the mounted secret file Mode uint32 `json:"Mode,omitempty"` // Name is the name of the secret Name string `json:"Name,omitempty"` // ID is the UID of the mounted secret file UID uint32 `json:"UID,omitempty"` }
InspectSecret InspectSecret contains information on secrets mounted inside the container
swagger:model InspectSecret
func (*InspectSecret) ContextValidate ¶
ContextValidate validates this inspect secret based on context it is used
func (*InspectSecret) MarshalBinary ¶
func (m *InspectSecret) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*InspectSecret) UnmarshalBinary ¶
func (m *InspectSecret) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type InspectUlimit ¶
type InspectUlimit struct { // Hard is the hard limit that will be applied. Hard int64 `json:"Hard,omitempty"` // Name is the name (type) of the ulimit. Name string `json:"Name,omitempty"` // Soft is the soft limit that will be applied. Soft int64 `json:"Soft,omitempty"` }
InspectUlimit InspectUlimit is a ulimit that will be applied to the container.
swagger:model InspectUlimit
func (*InspectUlimit) ContextValidate ¶
ContextValidate validates this inspect ulimit based on context it is used
func (*InspectUlimit) MarshalBinary ¶
func (m *InspectUlimit) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*InspectUlimit) UnmarshalBinary ¶
func (m *InspectUlimit) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type IpcMode ¶
type IpcMode string
IpcMode IpcMode represents the container ipc stack.
swagger:model IpcMode
func (IpcMode) ContextValidate ¶
ContextValidate validates this ipc mode based on context it is used
type Isolation ¶
type Isolation string
Isolation Isolation represents the isolation technology of a container. The supported values are platform specific
swagger:model Isolation
func (Isolation) ContextValidate ¶
ContextValidate validates this isolation based on context it is used
type LeaseRange ¶
type LeaseRange struct { // EndIP last IP in the subnet which should be used to assign ips. EndIP string `json:"end_ip,omitempty"` // StartIP first IP in the subnet which should be used to assign ips. StartIP string `json:"start_ip,omitempty"` }
LeaseRange LeaseRange contains the range where IP are leased.
swagger:model LeaseRange
func (*LeaseRange) ContextValidate ¶
ContextValidate validates this lease range based on context it is used
func (*LeaseRange) MarshalBinary ¶
func (m *LeaseRange) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*LeaseRange) UnmarshalBinary ¶
func (m *LeaseRange) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type LibpodContainersPruneReport ¶
type LibpodContainersPruneReport struct { // ID ID string `json:"Id,omitempty"` // Error which occurred during prune operation (if any). // This field is optional and may be omitted if no error occurred. PruneError *string `json:"Err,omitempty"` // space reclaimed SpaceReclaimed int64 `json:"Size,omitempty"` }
LibpodContainersPruneReport libpod containers prune report
swagger:model LibpodContainersPruneReport
func (*LibpodContainersPruneReport) ContextValidate ¶
func (m *LibpodContainersPruneReport) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validates this libpod containers prune report based on context it is used
func (*LibpodContainersPruneReport) MarshalBinary ¶
func (m *LibpodContainersPruneReport) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*LibpodContainersPruneReport) UnmarshalBinary ¶
func (m *LibpodContainersPruneReport) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type LibpodContainersRmReport ¶
type LibpodContainersRmReport struct { // ID ID string `json:"Id,omitempty"` // Error which occurred during Rm operation (if any). // This field is optional and may be omitted if no error occurred. RmError *string `json:"Err,omitempty"` }
LibpodContainersRmReport libpod containers rm report
swagger:model LibpodContainersRmReport
func (*LibpodContainersRmReport) ContextValidate ¶
func (m *LibpodContainersRmReport) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validates this libpod containers rm report based on context it is used
func (*LibpodContainersRmReport) MarshalBinary ¶
func (m *LibpodContainersRmReport) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*LibpodContainersRmReport) UnmarshalBinary ¶
func (m *LibpodContainersRmReport) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type LibpodImageSummary ¶
type LibpodImageSummary struct { // config digest ConfigDigest string `json:"ConfigDigest,omitempty"` // containers Containers int64 `json:"Containers,omitempty"` // created Created int64 `json:"Created,omitempty"` // dangling Dangling bool `json:"Dangling,omitempty"` // digest Digest string `json:"Digest,omitempty"` // history History []string `json:"History"` // ID ID string `json:"Id,omitempty"` // labels Labels map[string]string `json:"Labels,omitempty"` // Podman extensions Names []string `json:"Names"` // parent Id ParentID string `json:"ParentId,omitempty"` // read only ReadOnly bool `json:"ReadOnly,omitempty"` // repo digests RepoDigests []string `json:"RepoDigests"` // repo tags RepoTags []string `json:"RepoTags"` SharedSize int64 `json:"SharedSize,omitempty"` // size Size int64 `json:"Size,omitempty"` // virtual size VirtualSize int64 `json:"VirtualSize,omitempty"` }
LibpodImageSummary libpod image summary
swagger:model LibpodImageSummary
func (*LibpodImageSummary) ContextValidate ¶
ContextValidate validates this libpod image summary based on context it is used
func (*LibpodImageSummary) MarshalBinary ¶
func (m *LibpodImageSummary) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*LibpodImageSummary) UnmarshalBinary ¶
func (m *LibpodImageSummary) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type LibpodImagesPullReport ¶
type LibpodImagesPullReport struct { // Error contains text of errors from c/image Error string `json:"error,omitempty"` // ID contains image id (retained for backwards compatibility) ID string `json:"id,omitempty"` // Images contains the ID's of the images pulled Images []string `json:"images"` // Stream used to provide output from c/image Stream string `json:"stream,omitempty"` }
LibpodImagesPullReport libpod images pull report
swagger:model LibpodImagesPullReport
func (*LibpodImagesPullReport) ContextValidate ¶
func (m *LibpodImagesPullReport) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validates this libpod images pull report based on context it is used
func (*LibpodImagesPullReport) MarshalBinary ¶
func (m *LibpodImagesPullReport) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*LibpodImagesPullReport) UnmarshalBinary ¶
func (m *LibpodImagesPullReport) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type LibpodImagesRemoveReport ¶
type LibpodImagesRemoveReport struct { // Deleted images. Deleted []string `json:"Deleted"` // Image removal requires is to return data and an error. Errors []string `json:"Errors"` // ExitCode describes the exit codes as described in the `podman rmi` // man page. ExitCode int64 `json:"ExitCode,omitempty"` // Untagged images. Can be longer than Deleted. Untagged []string `json:"Untagged"` }
LibpodImagesRemoveReport LibpodImagesRemoveReport is the return type for image removal via the rest api.
swagger:model LibpodImagesRemoveReport
func (*LibpodImagesRemoveReport) ContextValidate ¶
func (m *LibpodImagesRemoveReport) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validates this libpod images remove report based on context it is used
func (*LibpodImagesRemoveReport) MarshalBinary ¶
func (m *LibpodImagesRemoveReport) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*LibpodImagesRemoveReport) UnmarshalBinary ¶
func (m *LibpodImagesRemoveReport) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type LinuxBlockIO ¶
type LinuxBlockIO struct { // Specifies tasks' weight in the given cgroup while competing with the cgroup's child cgroups, CFQ scheduler only LeafWeight uint16 `json:"leafWeight,omitempty"` // IO read rate limit per cgroup per device, bytes per second ThrottleReadBpsDevice []*LinuxThrottleDevice `json:"throttleReadBpsDevice"` // IO read rate limit per cgroup per device, IO per second ThrottleReadIOPSDevice []*LinuxThrottleDevice `json:"throttleReadIOPSDevice"` // IO write rate limit per cgroup per device, bytes per second ThrottleWriteBpsDevice []*LinuxThrottleDevice `json:"throttleWriteBpsDevice"` // IO write rate limit per cgroup per device, IO per second ThrottleWriteIOPSDevice []*LinuxThrottleDevice `json:"throttleWriteIOPSDevice"` // Specifies per cgroup weight Weight uint16 `json:"weight,omitempty"` // Weight per cgroup per device, can override BlkioWeight WeightDevice []*LinuxWeightDevice `json:"weightDevice"` }
LinuxBlockIO LinuxBlockIO for Linux cgroup 'blkio' resource management
swagger:model LinuxBlockIO
func (*LinuxBlockIO) ContextValidate ¶
ContextValidate validate this linux block i o based on the context it is used
func (*LinuxBlockIO) MarshalBinary ¶
func (m *LinuxBlockIO) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*LinuxBlockIO) UnmarshalBinary ¶
func (m *LinuxBlockIO) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type LinuxBlockIODevice ¶
type LinuxBlockIODevice struct { // Major is the device's major number. Major int64 `json:"major,omitempty"` // Minor is the device's minor number. Minor int64 `json:"minor,omitempty"` }
LinuxBlockIODevice linuxBlockIODevice holds major:minor format supported in blkio cgroup
swagger:model linuxBlockIODevice
func (*LinuxBlockIODevice) ContextValidate ¶
ContextValidate validates this linux block i o device based on context it is used
func (*LinuxBlockIODevice) MarshalBinary ¶
func (m *LinuxBlockIODevice) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*LinuxBlockIODevice) UnmarshalBinary ¶
func (m *LinuxBlockIODevice) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type LinuxCPU ¶
type LinuxCPU struct { // CPUs to use within the cpuset. Default is to use any CPU available. Cpus string `json:"cpus,omitempty"` // List of memory nodes in the cpuset. Default is to use any available memory node. Mems string `json:"mems,omitempty"` // CPU period to be used for hardcapping (in usecs). Period uint64 `json:"period,omitempty"` // CPU hardcap limit (in usecs). Allowed cpu time in a given period. Quota int64 `json:"quota,omitempty"` // CPU period to be used for realtime scheduling (in usecs). RealtimePeriod uint64 `json:"realtimePeriod,omitempty"` // How much time realtime scheduling may use (in usecs). RealtimeRuntime int64 `json:"realtimeRuntime,omitempty"` Shares uint64 `json:"shares,omitempty"` }
LinuxCPU LinuxCPU for Linux cgroup 'cpu' resource management
swagger:model LinuxCPU
func (*LinuxCPU) ContextValidate ¶
ContextValidate validates this linux CPU based on context it is used
func (*LinuxCPU) MarshalBinary ¶
MarshalBinary interface implementation
func (*LinuxCPU) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type LinuxDevice ¶
type LinuxDevice struct { // Gid of the device. GID uint32 `json:"gid,omitempty"` // Major is the device's major number. Major int64 `json:"major,omitempty"` // Minor is the device's minor number. Minor int64 `json:"minor,omitempty"` // Path to the device. Path string `json:"path,omitempty"` // Device type, block, char, etc. Type string `json:"type,omitempty"` // UID of the device. UID uint32 `json:"uid,omitempty"` // file mode FileMode FileMode `json:"fileMode,omitempty"` }
LinuxDevice LinuxDevice represents the mknod information for a Linux special device file
swagger:model LinuxDevice
func (*LinuxDevice) ContextValidate ¶
ContextValidate validate this linux device based on the context it is used
func (*LinuxDevice) MarshalBinary ¶
func (m *LinuxDevice) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*LinuxDevice) UnmarshalBinary ¶
func (m *LinuxDevice) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type LinuxDeviceCgroup ¶
type LinuxDeviceCgroup struct { // Cgroup access permissions format, rwm. Access string `json:"access,omitempty"` // Allow or deny Allow bool `json:"allow,omitempty"` // Major is the device's major number. Major int64 `json:"major,omitempty"` // Minor is the device's minor number. Minor int64 `json:"minor,omitempty"` // Device type, block, char, etc. Type string `json:"type,omitempty"` }
LinuxDeviceCgroup LinuxDeviceCgroup represents a device rule for the devices specified to the device controller
swagger:model LinuxDeviceCgroup
func (*LinuxDeviceCgroup) ContextValidate ¶
ContextValidate validates this linux device cgroup based on context it is used
func (*LinuxDeviceCgroup) MarshalBinary ¶
func (m *LinuxDeviceCgroup) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*LinuxDeviceCgroup) UnmarshalBinary ¶
func (m *LinuxDeviceCgroup) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type LinuxHugepageLimit ¶
type LinuxHugepageLimit struct { // Limit is the limit of "hugepagesize" hugetlb usage Limit uint64 `json:"limit,omitempty"` // Pagesize is the hugepage size // Format: "<size><unit-prefix>B' (e.g. 64KB, 2MB, 1GB, etc.) Pagesize string `json:"pageSize,omitempty"` }
LinuxHugepageLimit LinuxHugepageLimit structure corresponds to limiting kernel hugepages
swagger:model LinuxHugepageLimit
func (*LinuxHugepageLimit) ContextValidate ¶
ContextValidate validates this linux hugepage limit based on context it is used
func (*LinuxHugepageLimit) MarshalBinary ¶
func (m *LinuxHugepageLimit) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*LinuxHugepageLimit) UnmarshalBinary ¶
func (m *LinuxHugepageLimit) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type LinuxInterfacePriority ¶
type LinuxInterfacePriority struct { // Name is the name of the network interface Name string `json:"name,omitempty"` // Priority for the interface Priority uint32 `json:"priority,omitempty"` }
LinuxInterfacePriority LinuxInterfacePriority for network interfaces
swagger:model LinuxInterfacePriority
func (*LinuxInterfacePriority) ContextValidate ¶
func (m *LinuxInterfacePriority) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validates this linux interface priority based on context it is used
func (*LinuxInterfacePriority) MarshalBinary ¶
func (m *LinuxInterfacePriority) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*LinuxInterfacePriority) UnmarshalBinary ¶
func (m *LinuxInterfacePriority) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type LinuxMemory ¶
type LinuxMemory struct { // DisableOOMKiller disables the OOM killer for out of memory conditions DisableOOMKiller bool `json:"disableOOMKiller,omitempty"` // Kernel memory limit (in bytes). Kernel int64 `json:"kernel,omitempty"` // Kernel memory limit for tcp (in bytes) KernelTCP int64 `json:"kernelTCP,omitempty"` // Memory limit (in bytes). Limit int64 `json:"limit,omitempty"` // Memory reservation or soft_limit (in bytes). Reservation int64 `json:"reservation,omitempty"` // Total memory limit (memory + swap). Swap int64 `json:"swap,omitempty"` // How aggressive the kernel will swap memory pages. Swappiness uint64 `json:"swappiness,omitempty"` // Enables hierarchical memory accounting UseHierarchy bool `json:"useHierarchy,omitempty"` }
LinuxMemory LinuxMemory for Linux cgroup 'memory' resource management
swagger:model LinuxMemory
func (*LinuxMemory) ContextValidate ¶
ContextValidate validates this linux memory based on context it is used
func (*LinuxMemory) MarshalBinary ¶
func (m *LinuxMemory) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*LinuxMemory) UnmarshalBinary ¶
func (m *LinuxMemory) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type LinuxNetwork ¶
type LinuxNetwork struct { // Set class identifier for container's network packets ClassID uint32 `json:"classID,omitempty"` // Set priority of network traffic for container Priorities []*LinuxInterfacePriority `json:"priorities"` }
LinuxNetwork LinuxNetwork identification and priority configuration
swagger:model LinuxNetwork
func (*LinuxNetwork) ContextValidate ¶
ContextValidate validate this linux network based on the context it is used
func (*LinuxNetwork) MarshalBinary ¶
func (m *LinuxNetwork) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*LinuxNetwork) UnmarshalBinary ¶
func (m *LinuxNetwork) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type LinuxPersonality ¶
type LinuxPersonality struct { // Additional flags Flags []LinuxPersonalityFlag `json:"flags"` // domain Domain LinuxPersonalityDomain `json:"domain,omitempty"` }
LinuxPersonality LinuxPersonality represents the Linux personality syscall input
swagger:model LinuxPersonality
func (*LinuxPersonality) ContextValidate ¶
ContextValidate validate this linux personality based on the context it is used
func (*LinuxPersonality) MarshalBinary ¶
func (m *LinuxPersonality) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*LinuxPersonality) UnmarshalBinary ¶
func (m *LinuxPersonality) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type LinuxPersonalityDomain ¶
type LinuxPersonalityDomain string
LinuxPersonalityDomain LinuxPersonalityDomain refers to a personality domain.
swagger:model LinuxPersonalityDomain
func (LinuxPersonalityDomain) ContextValidate ¶
ContextValidate validates this linux personality domain based on context it is used
type LinuxPersonalityFlag ¶
type LinuxPersonalityFlag string
LinuxPersonalityFlag LinuxPersonalityFlag refers to an additional personality flag. None are currently defined.
swagger:model LinuxPersonalityFlag
func (LinuxPersonalityFlag) ContextValidate ¶
ContextValidate validates this linux personality flag based on context it is used
type LinuxPids ¶
type LinuxPids struct { // Maximum number of PIDs. Default is "no limit". Limit int64 `json:"limit,omitempty"` }
LinuxPids LinuxPids for Linux cgroup 'pids' resource management (Linux 4.3)
swagger:model LinuxPids
func (*LinuxPids) ContextValidate ¶
ContextValidate validates this linux pids based on context it is used
func (*LinuxPids) MarshalBinary ¶
MarshalBinary interface implementation
func (*LinuxPids) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type LinuxRdma ¶
type LinuxRdma struct { // Maximum number of HCA handles that can be opened. Default is "no limit". HcaHandles uint32 `json:"hcaHandles,omitempty"` // Maximum number of HCA objects that can be created. Default is "no limit". HcaObjects uint32 `json:"hcaObjects,omitempty"` }
LinuxRdma LinuxRdma for Linux cgroup 'rdma' resource management (Linux 4.11)
swagger:model LinuxRdma
func (*LinuxRdma) ContextValidate ¶
ContextValidate validates this linux rdma based on context it is used
func (*LinuxRdma) MarshalBinary ¶
MarshalBinary interface implementation
func (*LinuxRdma) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type LinuxResources ¶
type LinuxResources struct { // Devices configures the device allowlist. Devices []*LinuxDeviceCgroup `json:"devices"` // Hugetlb limit (in bytes) HugepageLimits []*LinuxHugepageLimit `json:"hugepageLimits"` // Rdma resource restriction configuration. // Limits are a set of key value pairs that define RDMA resource limits, // where the key is device name and value is resource limits. Rdma map[string]LinuxRdma `json:"rdma,omitempty"` // Unified resources. Unified map[string]string `json:"unified,omitempty"` // block i o BlockIO *LinuxBlockIO `json:"blockIO,omitempty"` // cpu CPU *LinuxCPU `json:"cpu,omitempty"` // memory Memory *LinuxMemory `json:"memory,omitempty"` // network Network *LinuxNetwork `json:"network,omitempty"` // pids Pids *LinuxPids `json:"pids,omitempty"` }
LinuxResources LinuxResources has container runtime resource constraints
swagger:model LinuxResources
func (*LinuxResources) ContextValidate ¶
ContextValidate validate this linux resources based on the context it is used
func (*LinuxResources) MarshalBinary ¶
func (m *LinuxResources) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*LinuxResources) UnmarshalBinary ¶
func (m *LinuxResources) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type LinuxThrottleDevice ¶
type LinuxThrottleDevice struct { // Major is the device's major number. Major int64 `json:"major,omitempty"` // Minor is the device's minor number. Minor int64 `json:"minor,omitempty"` // Rate is the IO rate limit per cgroup per device Rate uint64 `json:"rate,omitempty"` }
LinuxThrottleDevice LinuxThrottleDevice struct holds a `major:minor rate_per_second` pair
swagger:model LinuxThrottleDevice
func (*LinuxThrottleDevice) ContextValidate ¶
ContextValidate validates this linux throttle device based on context it is used
func (*LinuxThrottleDevice) MarshalBinary ¶
func (m *LinuxThrottleDevice) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*LinuxThrottleDevice) UnmarshalBinary ¶
func (m *LinuxThrottleDevice) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type LinuxWeightDevice ¶
type LinuxWeightDevice struct { // LeafWeight is the bandwidth rate for the device while competing with the cgroup's child cgroups, CFQ scheduler only LeafWeight uint16 `json:"leafWeight,omitempty"` // Major is the device's major number. Major int64 `json:"major,omitempty"` // Minor is the device's minor number. Minor int64 `json:"minor,omitempty"` // Weight is the bandwidth rate for the device. Weight uint16 `json:"weight,omitempty"` }
LinuxWeightDevice LinuxWeightDevice struct holds a `major:minor weight` pair for weightDevice
swagger:model LinuxWeightDevice
func (*LinuxWeightDevice) ContextValidate ¶
ContextValidate validates this linux weight device based on context it is used
func (*LinuxWeightDevice) MarshalBinary ¶
func (m *LinuxWeightDevice) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*LinuxWeightDevice) UnmarshalBinary ¶
func (m *LinuxWeightDevice) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ListContainer ¶
type ListContainer struct { // AutoRemove AutoRemove bool `json:"AutoRemove,omitempty"` // Container command Command []string `json:"Command"` // Container creation time // Format: date-time Created strfmt.DateTime `json:"Created,omitempty"` // Human-readable container creation time. CreatedAt string `json:"CreatedAt,omitempty"` // If container has exited, the return code from the command ExitCode int32 `json:"ExitCode,omitempty"` // If container has exited/stopped Exited bool `json:"Exited,omitempty"` // Time container exited ExitedAt int64 `json:"ExitedAt,omitempty"` // The unique identifier for the container ID string `json:"Id,omitempty"` // Container image Image string `json:"Image,omitempty"` // Container image ID ImageID string `json:"ImageID,omitempty"` // If this container is a Pod infra container IsInfra bool `json:"IsInfra,omitempty"` // Labels for container Labels map[string]string `json:"Labels,omitempty"` // User volume mounts Mounts []string `json:"Mounts"` // The names assigned to the container Names []string `json:"Names"` // namespaces Namespaces *ListContainerNamespaces `json:"Namespaces,omitempty"` // The network names assigned to the container Networks []string `json:"Networks"` // The process id of the container Pid int64 `json:"Pid,omitempty"` // If the container is part of Pod, the Pod ID. Requires the pod // boolean to be set Pod string `json:"Pod,omitempty"` // If the container is part of Pod, the Pod name. Requires the pod // boolean to be set PodName string `json:"PodName,omitempty"` // Port mappings Ports []*PortMapping `json:"Ports"` // size Size *ContainerSize `json:"Size,omitempty"` // Time when container started StartedAt int64 `json:"StartedAt,omitempty"` // State of container State string `json:"State,omitempty"` // Status is a human-readable approximation of a duration for json output Status string `json:"Status,omitempty"` }
ListContainer ListContainer describes a container suitable for listing
swagger:model ListContainer
func (*ListContainer) ContextValidate ¶
ContextValidate validate this list container based on the context it is used
func (*ListContainer) MarshalBinary ¶
func (m *ListContainer) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ListContainer) UnmarshalBinary ¶
func (m *ListContainer) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ListContainerNamespaces ¶
type ListContainerNamespaces struct { // Cgroup namespace Cgroup string `json:"Cgroup,omitempty"` // IPC namespace IPC string `json:"Ipc,omitempty"` // Mount namespace MNT string `json:"Mnt,omitempty"` // Network namespace NET string `json:"Net,omitempty"` // PID namespace PIDNS string `json:"Pidns,omitempty"` // UTS namespace UTS string `json:"Uts,omitempty"` // User namespace User string `json:"User,omitempty"` }
ListContainerNamespaces ListContainerNamespaces contains the identifiers of the container's Linux namespaces
swagger:model ListContainerNamespaces
func (*ListContainerNamespaces) ContextValidate ¶
func (m *ListContainerNamespaces) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validates this list container namespaces based on context it is used
func (*ListContainerNamespaces) MarshalBinary ¶
func (m *ListContainerNamespaces) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ListContainerNamespaces) UnmarshalBinary ¶
func (m *ListContainerNamespaces) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ListPodContainer ¶
type ListPodContainer struct { // Id ID string `json:"Id,omitempty"` // names Names string `json:"Names,omitempty"` // status Status string `json:"Status,omitempty"` }
ListPodContainer list pod container
swagger:model ListPodContainer
func (*ListPodContainer) ContextValidate ¶
ContextValidate validates this list pod container based on context it is used
func (*ListPodContainer) MarshalBinary ¶
func (m *ListPodContainer) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ListPodContainer) UnmarshalBinary ¶
func (m *ListPodContainer) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ListPodsReport ¶
type ListPodsReport struct { // cgroup Cgroup string `json:"Cgroup,omitempty"` // containers Containers []*ListPodContainer `json:"Containers"` // created // Format: date-time Created strfmt.DateTime `json:"Created,omitempty"` // Id ID string `json:"Id,omitempty"` // infra Id InfraID string `json:"InfraId,omitempty"` // labels Labels map[string]string `json:"Labels,omitempty"` // name Name string `json:"Name,omitempty"` // namespace Namespace string `json:"Namespace,omitempty"` // Network names connected to infra container Networks []string `json:"Networks"` // status Status string `json:"Status,omitempty"` }
ListPodsReport list pods report
swagger:model ListPodsReport
func (*ListPodsReport) ContextValidate ¶
ContextValidate validate this list pods report based on the context it is used
func (*ListPodsReport) MarshalBinary ¶
func (m *ListPodsReport) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ListPodsReport) UnmarshalBinary ¶
func (m *ListPodsReport) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type LogConfig ¶
type LogConfig struct { // config Config map[string]string `json:"Config,omitempty"` // type Type string `json:"Type,omitempty"` }
LogConfig LogConfig represents the logging configuration of the container.
swagger:model LogConfig
func (*LogConfig) ContextValidate ¶
ContextValidate validates this log config based on context it is used
func (*LogConfig) MarshalBinary ¶
MarshalBinary interface implementation
func (*LogConfig) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type ManifestAddOptions ¶
type ManifestAddOptions struct { // True when operating on a list to include all images All bool `json:"all,omitempty"` // Annotation to add to manifest list Annotation []string `json:"annotation"` // Arch overrides the architecture for the image Arch string `json:"arch,omitempty"` // Feature list for the image Features []string `json:"features"` // Images is an optional list of images to add to manifest list Images []string `json:"images"` // OS overrides the operating system for the image OS string `json:"os,omitempty"` // OS features for the image OSFeatures []string `json:"os_features"` // OSVersion overrides the operating system for the image OSVersion string `json:"os_version,omitempty"` // Variant for the image Variant string `json:"variant,omitempty"` }
ManifestAddOptions ManifestAddOptions provides model for adding digests to manifest list
swagger:model ManifestAddOptions
func (*ManifestAddOptions) ContextValidate ¶
ContextValidate validates this manifest add options based on context it is used
func (*ManifestAddOptions) MarshalBinary ¶
func (m *ManifestAddOptions) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ManifestAddOptions) UnmarshalBinary ¶
func (m *ManifestAddOptions) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ManifestAnnotateOptions ¶
type ManifestAnnotateOptions struct { // Annotation to add to manifest list Annotation []string `json:"annotation"` // Arch overrides the architecture for the image Arch string `json:"arch,omitempty"` // Feature list for the image Features []string `json:"features"` // OS overrides the operating system for the image OS string `json:"os,omitempty"` // OS features for the image OSFeatures []string `json:"os_features"` // OSVersion overrides the operating system for the image OSVersion string `json:"os_version,omitempty"` // Variant for the image Variant string `json:"variant,omitempty"` }
ManifestAnnotateOptions ManifestAnnotateOptions provides model for annotating manifest list
swagger:model ManifestAnnotateOptions
func (*ManifestAnnotateOptions) ContextValidate ¶
func (m *ManifestAnnotateOptions) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validates this manifest annotate options based on context it is used
func (*ManifestAnnotateOptions) MarshalBinary ¶
func (m *ManifestAnnotateOptions) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ManifestAnnotateOptions) UnmarshalBinary ¶
func (m *ManifestAnnotateOptions) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ManifestModifyOptions ¶
type ManifestModifyOptions struct { // True when operating on a list to include all images All bool `json:"all,omitempty"` // Annotation to add to manifest list Annotation []string `json:"annotation"` // Arch overrides the architecture for the image Arch string `json:"arch,omitempty"` // Feature list for the image Features []string `json:"features"` // Images is an optional list of images to add to manifest list Images []string `json:"images"` // OS overrides the operating system for the image OS string `json:"os,omitempty"` // OS features for the image OSFeatures []string `json:"os_features"` // OSVersion overrides the operating system for the image OSVersion string `json:"os_version,omitempty"` // operation Operation string `json:"operation,omitempty"` // Variant for the image Variant string `json:"variant,omitempty"` }
ManifestModifyOptions ManifestModifyOptions provides the model for mutating a manifest
swagger 2.0 does not support oneOf for schema validation.
Operation "update" uses all fields. Operation "remove" uses fields: Operation and Images Operation "annotate" uses fields: Operation and Annotations
swagger:model ManifestModifyOptions
func (*ManifestModifyOptions) ContextValidate ¶
ContextValidate validates this manifest modify options based on context it is used
func (*ManifestModifyOptions) MarshalBinary ¶
func (m *ManifestModifyOptions) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ManifestModifyOptions) UnmarshalBinary ¶
func (m *ManifestModifyOptions) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ManifestModifyReport ¶
type ManifestModifyReport struct { // Errors associated with operation Errors []string `json:"errors"` // Manifest List ID ID string `json:"Id,omitempty"` // Images to removed from manifest list, otherwise not provided. Images []string `json:"images"` }
ManifestModifyReport ManifestModifyReport provides the model for removed digests and changed manifest
swagger:model ManifestModifyReport
func (*ManifestModifyReport) ContextValidate ¶
ContextValidate validates this manifest modify report based on context it is used
func (*ManifestModifyReport) MarshalBinary ¶
func (m *ManifestModifyReport) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ManifestModifyReport) UnmarshalBinary ¶
func (m *ManifestModifyReport) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ManifestRemoveOptions ¶
type ManifestRemoveOptions interface{}
ManifestRemoveOptions ManifestRemoveOptions provides the model for removing digests from a manifest
swagger:model ManifestRemoveOptions
type Mount ¶
type Mount struct { // bind options BindOptions *BindOptions `json:"BindOptions,omitempty"` // consistency Consistency Consistency `json:"Consistency,omitempty"` // destination Destination string `json:"Destination,omitempty"` // options Options []string `json:"Options"` // read only ReadOnly bool `json:"ReadOnly,omitempty"` // Source specifies the name of the mount. Depending on mount type, this // may be a volume name or a host path, or even ignored. // Source is not supported for tmpfs (must be an empty value) Source string `json:"Source,omitempty"` // target Target string `json:"Target,omitempty"` // tmpfs options TmpfsOptions *TmpfsOptions `json:"TmpfsOptions,omitempty"` // type Type Type `json:"Type,omitempty"` // volume options VolumeOptions *VolumeOptions `json:"VolumeOptions,omitempty"` }
Mount Mount represents a mount (volume).
swagger:model Mount
func (*Mount) ContextValidate ¶
ContextValidate validate this mount based on the context it is used
func (*Mount) MarshalBinary ¶
MarshalBinary interface implementation
func (*Mount) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type MountPoint ¶
type MountPoint struct { // destination Destination string `json:"Destination,omitempty"` // driver Driver string `json:"Driver,omitempty"` // mode Mode string `json:"Mode,omitempty"` // name Name string `json:"Name,omitempty"` // propagation Propagation Propagation `json:"Propagation,omitempty"` // r w RW bool `json:"RW,omitempty"` // source Source string `json:"Source,omitempty"` // type Type Type `json:"Type,omitempty"` }
MountPoint MountPoint represents a mount point configuration inside the container.
This is used for reporting the mountpoints in use by a container.
swagger:model MountPoint
func (*MountPoint) ContextValidate ¶
ContextValidate validate this mount point based on the context it is used
func (*MountPoint) MarshalBinary ¶
func (m *MountPoint) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*MountPoint) UnmarshalBinary ¶
func (m *MountPoint) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type NamedVolume ¶
type NamedVolume struct { // Destination to mount the named volume within the container. Must be // an absolute path. Path will be created if it does not exist. Dest string `json:"Dest,omitempty"` // Name is the name of the named volume to be mounted. May be empty. // If empty, a new named volume with a pseudorandomly generated name // will be mounted at the given destination. Name string `json:"Name,omitempty"` // Options are options that the named volume will be mounted with. Options []string `json:"Options"` }
NamedVolume NamedVolume holds information about a named volume that will be mounted into the container.
swagger:model NamedVolume
func (*NamedVolume) ContextValidate ¶
ContextValidate validates this named volume based on context it is used
func (*NamedVolume) MarshalBinary ¶
func (m *NamedVolume) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*NamedVolume) UnmarshalBinary ¶
func (m *NamedVolume) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Namespace ¶
type Namespace struct { // value Value string `json:"value,omitempty"` // nsmode Nsmode NamespaceMode `json:"nsmode,omitempty"` }
Namespace Namespace describes the namespace
swagger:model Namespace
func (*Namespace) ContextValidate ¶
ContextValidate validate this namespace based on the context it is used
func (*Namespace) MarshalBinary ¶
MarshalBinary interface implementation
func (*Namespace) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type NamespaceMode ¶
type NamespaceMode string
NamespaceMode namespace mode
swagger:model NamespaceMode
func (NamespaceMode) ContextValidate ¶
ContextValidate validates this namespace mode based on context it is used
type NetOptions ¶
type NetOptions struct { // add hosts AddHosts []string `json:"hostadd"` // aliases Aliases []string `json:"network_alias"` // DNS options DNSOptions []string `json:"dns_option"` // DNS search DNSSearch []string `json:"dns_search"` // DNS servers DNSServers []IP `json:"dns_server"` // NetworkOptions are additional options for each network NetworkOptions map[string][]string `json:"network_options,omitempty"` // networks Networks map[string]PerNetworkOptions `json:"networks,omitempty"` // no hosts NoHosts bool `json:"no_manage_hosts,omitempty"` // publish ports PublishPorts []*PortMapping `json:"portmappings"` // use image resolv conf UseImageResolvConf bool `json:"no_manage_resolv_conf,omitempty"` // netns Netns *Namespace `json:"netns,omitempty"` }
NetOptions NetOptions reflect the shared network options between pods and containers
swagger:model NetOptions
func (*NetOptions) ContextValidate ¶
ContextValidate validate this net options based on the context it is used
func (*NetOptions) MarshalBinary ¶
func (m *NetOptions) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*NetOptions) UnmarshalBinary ¶
func (m *NetOptions) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Network ¶
type Network struct { // Created contains the timestamp when this network was created. // Format: date-time Created strfmt.DateTime `json:"created,omitempty"` // DNSEnabled is whether name resolution is active for container on // this Network. DNSEnabled bool `json:"dns_enabled,omitempty"` // Driver for this Network, e.g. bridge, macvlan... Driver string `json:"driver,omitempty"` // ID of the Network. ID string `json:"id,omitempty"` // IPAMOptions contains options used for the ip assignment. IPAMOptions map[string]string `json:"ipam_options,omitempty"` // IPv6Enabled if set to true an ipv6 subnet should be created for this net. IPV6Enabled bool `json:"ipv6_enabled,omitempty"` // Internal is whether the Network should not have external routes // to public or other Networks. Internal bool `json:"internal,omitempty"` // Labels is a set of key-value labels that have been applied to the // Network. Labels map[string]string `json:"labels,omitempty"` // Name of the Network. Name string `json:"name,omitempty"` // NetworkInterface is the network interface name on the host. NetworkInterface string `json:"network_interface,omitempty"` // Options is a set of key-value options that have been applied to // the Network. Options map[string]string `json:"options,omitempty"` // Subnets to use for this network. Subnets []*Subnet `json:"subnets"` }
Network Network describes the Network attributes.
swagger:model Network
func (*Network) ContextValidate ¶
ContextValidate validate this network based on the context it is used
func (*Network) MarshalBinary ¶
MarshalBinary interface implementation
func (*Network) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type NetworkConnect ¶
type NetworkConnect struct { // container Container string `json:"Container,omitempty"` // endpoint config EndpointConfig *EndpointSettings `json:"EndpointConfig,omitempty"` }
NetworkConnect NetworkConnect represents the data to be used to connect a container to the network
swagger:model NetworkConnect
func (*NetworkConnect) ContextValidate ¶
ContextValidate validate this network connect based on the context it is used
func (*NetworkConnect) MarshalBinary ¶
func (m *NetworkConnect) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*NetworkConnect) UnmarshalBinary ¶
func (m *NetworkConnect) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type NetworkConnectOptions ¶
type NetworkConnectOptions struct { // Aliases contains a list of names which the dns server should resolve // to this container. Should only be set when DNSEnabled is true on the Network. // If aliases are set but there is no dns support for this network the // network interface implementation should ignore this and NOT error. // Optional. Aliases []string `json:"aliases"` // container Container string `json:"container,omitempty"` // InterfaceName for this container. Required in the backend. // Optional in the frontend. Will be filled with ethX (where X is a integer) when empty. InterfaceName string `json:"interface_name,omitempty"` // StaticIPs for this container. Optional. StaticIPs []IP `json:"static_ips"` // static mac StaticMac MacAddress `json:"static_mac,omitempty"` }
NetworkConnectOptions NetworkConnectOptions describes options for connecting a container to a network
swagger:model NetworkConnectOptions
func (*NetworkConnectOptions) ContextValidate ¶
ContextValidate validate this network connect options based on the context it is used
func (*NetworkConnectOptions) MarshalBinary ¶
func (m *NetworkConnectOptions) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*NetworkConnectOptions) UnmarshalBinary ¶
func (m *NetworkConnectOptions) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type NetworkCreate ¶
type NetworkCreate struct { // attachable Attachable bool `json:"Attachable,omitempty"` // Check for networks with duplicate names. // Network is primarily keyed based on a random ID and not on the name. // Network name is strictly a user-friendly alias to the network // which is uniquely identified using ID. // And there is no guaranteed way to check for duplicates. // Option CheckDuplicate is there to provide a best effort checking of any networks // which has the same name but it is not guaranteed to catch all name collisions. CheckDuplicate bool `json:"CheckDuplicate,omitempty"` // config from ConfigFrom *ConfigReference `json:"ConfigFrom,omitempty"` // config only ConfigOnly bool `json:"ConfigOnly,omitempty"` // driver Driver string `json:"Driver,omitempty"` // enable IPv6 EnableIPV6 bool `json:"EnableIPv6,omitempty"` // IP a m IPAM *IPAM `json:"IPAM,omitempty"` // ingress Ingress bool `json:"Ingress,omitempty"` // internal Internal bool `json:"Internal,omitempty"` // labels Labels map[string]string `json:"Labels,omitempty"` // options Options map[string]string `json:"Options,omitempty"` // scope Scope string `json:"Scope,omitempty"` }
NetworkCreate NetworkCreate is the expected body of the "create network" http request message
swagger:model NetworkCreate
func (*NetworkCreate) ContextValidate ¶
ContextValidate validate this network create based on the context it is used
func (*NetworkCreate) MarshalBinary ¶
func (m *NetworkCreate) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*NetworkCreate) UnmarshalBinary ¶
func (m *NetworkCreate) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type NetworkCreateRequest ¶
type NetworkCreateRequest struct { // attachable Attachable bool `json:"Attachable,omitempty"` // Check for networks with duplicate names. // Network is primarily keyed based on a random ID and not on the name. // Network name is strictly a user-friendly alias to the network // which is uniquely identified using ID. // And there is no guaranteed way to check for duplicates. // Option CheckDuplicate is there to provide a best effort checking of any networks // which has the same name but it is not guaranteed to catch all name collisions. CheckDuplicate bool `json:"CheckDuplicate,omitempty"` // config from ConfigFrom *ConfigReference `json:"ConfigFrom,omitempty"` // config only ConfigOnly bool `json:"ConfigOnly,omitempty"` // driver Driver string `json:"Driver,omitempty"` // enable IPv6 EnableIPV6 bool `json:"EnableIPv6,omitempty"` // IP a m IPAM *IPAM `json:"IPAM,omitempty"` // ingress Ingress bool `json:"Ingress,omitempty"` // internal Internal bool `json:"Internal,omitempty"` // labels Labels map[string]string `json:"Labels,omitempty"` // name Name string `json:"Name,omitempty"` // options Options map[string]string `json:"Options,omitempty"` // scope Scope string `json:"Scope,omitempty"` }
NetworkCreateRequest NetworkCreateRequest is the request message sent to the server for network create call.
swagger:model NetworkCreateRequest
func (*NetworkCreateRequest) ContextValidate ¶
ContextValidate validate this network create request based on the context it is used
func (*NetworkCreateRequest) MarshalBinary ¶
func (m *NetworkCreateRequest) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*NetworkCreateRequest) UnmarshalBinary ¶
func (m *NetworkCreateRequest) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type NetworkDisconnect ¶
type NetworkDisconnect struct { // container Container string `json:"Container,omitempty"` // force Force bool `json:"Force,omitempty"` }
NetworkDisconnect NetworkDisconnect represents the data to be used to disconnect a container from the network
swagger:model NetworkDisconnect
func (*NetworkDisconnect) ContextValidate ¶
ContextValidate validates this network disconnect based on context it is used
func (*NetworkDisconnect) MarshalBinary ¶
func (m *NetworkDisconnect) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*NetworkDisconnect) UnmarshalBinary ¶
func (m *NetworkDisconnect) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type NetworkMode ¶
type NetworkMode string
NetworkMode NetworkMode represents the container network stack.
swagger:model NetworkMode
func (NetworkMode) ContextValidate ¶
ContextValidate validates this network mode based on context it is used
type NetworkPruneReport ¶
type NetworkPruneReport struct { // error Error string `json:"Error,omitempty"` // name Name string `json:"Name,omitempty"` }
NetworkPruneReport NetworkPruneReport containers the name of network and an error associated in its pruning (removal)
swagger:model NetworkPruneReport
func (*NetworkPruneReport) ContextValidate ¶
ContextValidate validates this network prune report based on context it is used
func (*NetworkPruneReport) MarshalBinary ¶
func (m *NetworkPruneReport) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*NetworkPruneReport) UnmarshalBinary ¶
func (m *NetworkPruneReport) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type NetworkResource ¶
type NetworkResource struct { // attachable Attachable bool `json:"Attachable,omitempty"` // config from ConfigFrom *ConfigReference `json:"ConfigFrom,omitempty"` // config only ConfigOnly bool `json:"ConfigOnly,omitempty"` // containers Containers map[string]EndpointResource `json:"Containers,omitempty"` // created // Format: date-time Created strfmt.DateTime `json:"Created,omitempty"` // driver Driver string `json:"Driver,omitempty"` // enable IPv6 EnableIPV6 bool `json:"EnableIPv6,omitempty"` // ID ID string `json:"Id,omitempty"` // IP a m IPAM *IPAM `json:"IPAM,omitempty"` // ingress Ingress bool `json:"Ingress,omitempty"` // internal Internal bool `json:"Internal,omitempty"` // labels Labels map[string]string `json:"Labels,omitempty"` // name Name string `json:"Name,omitempty"` // options Options map[string]string `json:"Options,omitempty"` // peers Peers []*PeerInfo `json:"Peers"` // scope Scope string `json:"Scope,omitempty"` // services Services map[string]ServiceInfo `json:"Services,omitempty"` }
NetworkResource NetworkResource is the body of the "get network" http response message
swagger:model NetworkResource
func (*NetworkResource) ContextValidate ¶
ContextValidate validate this network resource based on the context it is used
func (*NetworkResource) MarshalBinary ¶
func (m *NetworkResource) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*NetworkResource) UnmarshalBinary ¶
func (m *NetworkResource) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type NetworkRmReport ¶
type NetworkRmReport struct { // err Err string `json:"Err,omitempty"` // name Name string `json:"Name,omitempty"` }
NetworkRmReport NetworkRmReport describes the results of network removal
swagger:model NetworkRmReport
func (*NetworkRmReport) ContextValidate ¶
ContextValidate validates this network rm report based on context it is used
func (*NetworkRmReport) MarshalBinary ¶
func (m *NetworkRmReport) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*NetworkRmReport) UnmarshalBinary ¶
func (m *NetworkRmReport) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type NetworkSettings ¶
type NetworkSettings struct { // bridge Bridge string `json:"Bridge,omitempty"` // endpoint ID EndpointID string `json:"EndpointID,omitempty"` // gateway Gateway string `json:"Gateway,omitempty"` // global IPv6 address GlobalIPV6Address string `json:"GlobalIPv6Address,omitempty"` // global IPv6 prefix len GlobalIPV6PrefixLen int64 `json:"GlobalIPv6PrefixLen,omitempty"` // hairpin mode HairpinMode bool `json:"HairpinMode,omitempty"` // IP address IPAddress string `json:"IPAddress,omitempty"` // IP prefix len IPPrefixLen int64 `json:"IPPrefixLen,omitempty"` // IPv6 gateway IPV6Gateway string `json:"IPv6Gateway,omitempty"` // link local IPv6 address LinkLocalIPV6Address string `json:"LinkLocalIPv6Address,omitempty"` // link local IPv6 prefix len LinkLocalIPV6PrefixLen int64 `json:"LinkLocalIPv6PrefixLen,omitempty"` // mac address MacAddress string `json:"MacAddress,omitempty"` // networks Networks map[string]EndpointSettings `json:"Networks,omitempty"` // ports Ports PortMap `json:"Ports,omitempty"` // sandbox ID SandboxID string `json:"SandboxID,omitempty"` // sandbox key SandboxKey string `json:"SandboxKey,omitempty"` // secondary IP addresses SecondaryIPAddresses []*Address `json:"SecondaryIPAddresses"` // secondary IPv6 addresses SecondaryIPV6Addresses []*Address `json:"SecondaryIPv6Addresses"` }
NetworkSettings NetworkSettings exposes the network settings in the api
swagger:model NetworkSettings
func (*NetworkSettings) ContextValidate ¶
ContextValidate validate this network settings based on the context it is used
func (*NetworkSettings) MarshalBinary ¶
func (m *NetworkSettings) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*NetworkSettings) UnmarshalBinary ¶
func (m *NetworkSettings) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type NetworkingConfig ¶
type NetworkingConfig struct { // endpoints config EndpointsConfig map[string]EndpointSettings `json:"EndpointsConfig,omitempty"` }
NetworkingConfig NetworkingConfig represents the container's networking configuration for each of its interfaces Carries the networking configs specified in the `docker run` and `docker network connect` commands
swagger:model NetworkingConfig
func (*NetworkingConfig) ContextValidate ¶
ContextValidate validate this networking config based on the context it is used
func (*NetworkingConfig) MarshalBinary ¶
func (m *NetworkingConfig) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*NetworkingConfig) UnmarshalBinary ¶
func (m *NetworkingConfig) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type OCIRuntimeInfo ¶
type OCIRuntimeInfo struct { // name Name string `json:"name,omitempty"` // package Package string `json:"package,omitempty"` // path Path string `json:"path,omitempty"` // version Version string `json:"version,omitempty"` }
OCIRuntimeInfo OCIRuntimeInfo describes the runtime (crun or runc) being used with podman
swagger:model OCIRuntimeInfo
func (*OCIRuntimeInfo) ContextValidate ¶
ContextValidate validates this o c i runtime info based on context it is used
func (*OCIRuntimeInfo) MarshalBinary ¶
func (m *OCIRuntimeInfo) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*OCIRuntimeInfo) UnmarshalBinary ¶
func (m *OCIRuntimeInfo) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type OverlayVolume ¶
type OverlayVolume struct { // Destination is the absolute path where the mount will be placed in the container. Destination string `json:"destination,omitempty"` // Options holds overlay volume options. Options []string `json:"options"` // Source specifies the source path of the mount. Source string `json:"source,omitempty"` }
OverlayVolume OverlayVolume holds information about a overlay volume that will be mounted into the container.
swagger:model OverlayVolume
func (*OverlayVolume) ContextValidate ¶
ContextValidate validates this overlay volume based on context it is used
func (*OverlayVolume) MarshalBinary ¶
func (m *OverlayVolume) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*OverlayVolume) UnmarshalBinary ¶
func (m *OverlayVolume) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type POSIXRlimit ¶
type POSIXRlimit struct { // Hard is the hard limit for the specified type Hard uint64 `json:"hard,omitempty"` // Soft is the soft limit for the specified type Soft uint64 `json:"soft,omitempty"` // Type of the rlimit to set Type string `json:"type,omitempty"` }
POSIXRlimit POSIXRlimit type and restrictions
swagger:model POSIXRlimit
func (*POSIXRlimit) ContextValidate ¶
ContextValidate validates this p o s i x rlimit based on context it is used
func (*POSIXRlimit) MarshalBinary ¶
func (m *POSIXRlimit) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*POSIXRlimit) UnmarshalBinary ¶
func (m *POSIXRlimit) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type PeerInfo ¶
type PeerInfo struct { // IP IP string `json:"IP,omitempty"` // name Name string `json:"Name,omitempty"` }
PeerInfo PeerInfo represents one peer of an overlay network
swagger:model PeerInfo
func (*PeerInfo) ContextValidate ¶
ContextValidate validates this peer info based on context it is used
func (*PeerInfo) MarshalBinary ¶
MarshalBinary interface implementation
func (*PeerInfo) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type PerNetworkOptions ¶
type PerNetworkOptions struct { // Aliases contains a list of names which the dns server should resolve // to this container. Should only be set when DNSEnabled is true on the Network. // If aliases are set but there is no dns support for this network the // network interface implementation should ignore this and NOT error. // Optional. Aliases []string `json:"aliases"` // InterfaceName for this container. Required in the backend. // Optional in the frontend. Will be filled with ethX (where X is a integer) when empty. InterfaceName string `json:"interface_name,omitempty"` // StaticIPs for this container. Optional. StaticIPs []IP `json:"static_ips"` // static mac StaticMac MacAddress `json:"static_mac,omitempty"` }
PerNetworkOptions PerNetworkOptions are options which should be set on a per network basis.
swagger:model PerNetworkOptions
func (*PerNetworkOptions) ContextValidate ¶
ContextValidate validate this per network options based on the context it is used
func (*PerNetworkOptions) MarshalBinary ¶
func (m *PerNetworkOptions) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*PerNetworkOptions) UnmarshalBinary ¶
func (m *PerNetworkOptions) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type PidMode ¶
type PidMode string
PidMode PidMode represents the pid namespace of the container.
swagger:model PidMode
func (PidMode) ContextValidate ¶
ContextValidate validates this pid mode based on context it is used
type PlayKubePod ¶
type PlayKubePod struct { // ContainerErrors - any errors that occurred while starting containers // in the pod. ContainerErrors []string `json:"ContainerErrors"` // Containers - the IDs of the containers running in the created pod. Containers []string `json:"Containers"` // ID - ID of the pod created as a result of play kube. ID string `json:"ID,omitempty"` // InitContainers - the IDs of the init containers to be run in the created pod. InitContainers []string `json:"InitContainers"` // Logs - non-fatal errors and log messages while processing. Logs []string `json:"Logs"` }
PlayKubePod PlayKubePod represents a single pod and associated containers created by play kube
swagger:model PlayKubePod
func (*PlayKubePod) ContextValidate ¶
ContextValidate validates this play kube pod based on context it is used
func (*PlayKubePod) MarshalBinary ¶
func (m *PlayKubePod) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*PlayKubePod) UnmarshalBinary ¶
func (m *PlayKubePod) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type PlayKubeReport ¶
type PlayKubeReport struct { // Pods - pods created by play kube. Pods []*PlayKubePod `json:"Pods"` // rm report RmReport []*PodRmReport `json:"RmReport"` // stop report StopReport []*PodStopReport `json:"StopReport"` // Volumes - volumes created by play kube. Volumes []*PlayKubeVolume `json:"Volumes"` }
PlayKubeReport PlayKubeReport contains the results of running play kube.
swagger:model PlayKubeReport
func (*PlayKubeReport) ContextValidate ¶
ContextValidate validate this play kube report based on the context it is used
func (*PlayKubeReport) MarshalBinary ¶
func (m *PlayKubeReport) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*PlayKubeReport) UnmarshalBinary ¶
func (m *PlayKubeReport) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type PlayKubeVolume ¶
type PlayKubeVolume struct { // Name - Name of the volume created by play kube. Name string `json:"Name,omitempty"` }
PlayKubeVolume PlayKubeVolume represents a single volume created by play kube.
swagger:model PlayKubeVolume
func (*PlayKubeVolume) ContextValidate ¶
ContextValidate validates this play kube volume based on context it is used
func (*PlayKubeVolume) MarshalBinary ¶
func (m *PlayKubeVolume) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*PlayKubeVolume) UnmarshalBinary ¶
func (m *PlayKubeVolume) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Plugin ¶
type Plugin struct { // config // Required: true Config *PluginConfig `json:"Config"` // True if the plugin is running. False if the plugin is not running, only installed. // Required: true Enabled *bool `json:"Enabled"` // Id ID string `json:"Id,omitempty"` // name // Required: true Name *string `json:"Name"` // plugin remote reference used to push/pull the plugin PluginReference string `json:"PluginReference,omitempty"` // settings // Required: true Settings *PluginSettings `json:"Settings"` }
Plugin Plugin A plugin for the Engine API
swagger:model Plugin
func (*Plugin) ContextValidate ¶
ContextValidate validate this plugin based on the context it is used
func (*Plugin) MarshalBinary ¶
MarshalBinary interface implementation
func (*Plugin) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type PluginConfig ¶
type PluginConfig struct { // args // Required: true Args *PluginConfigArgs `json:"Args"` // description // Required: true Description *string `json:"Description"` // Docker Version used to create the plugin DockerVersion string `json:"DockerVersion,omitempty"` // documentation // Required: true Documentation *string `json:"Documentation"` // entrypoint // Required: true Entrypoint []string `json:"Entrypoint"` // env // Required: true Env []*PluginEnv `json:"Env"` // interface // Required: true Interface *PluginConfigInterface `json:"Interface"` // ipc host // Required: true IpcHost *bool `json:"IpcHost"` // linux // Required: true Linux *PluginConfigLinux `json:"Linux"` // mounts // Required: true Mounts []*PluginMount `json:"Mounts"` // network // Required: true Network *PluginConfigNetwork `json:"Network"` // pid host // Required: true PidHost *bool `json:"PidHost"` // propagated mount // Required: true PropagatedMount *string `json:"PropagatedMount"` // user User *PluginConfigUser `json:"User,omitempty"` // work dir // Required: true WorkDir *string `json:"WorkDir"` // rootfs Rootfs *PluginConfigRootfs `json:"rootfs,omitempty"` }
PluginConfig PluginConfig The config of a plugin.
swagger:model PluginConfig
func (*PluginConfig) ContextValidate ¶
ContextValidate validate this plugin config based on the context it is used
func (*PluginConfig) MarshalBinary ¶
func (m *PluginConfig) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*PluginConfig) UnmarshalBinary ¶
func (m *PluginConfig) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type PluginConfigArgs ¶
type PluginConfigArgs struct { // description // Required: true Description *string `json:"Description"` // name // Required: true Name *string `json:"Name"` // settable // Required: true Settable []string `json:"Settable"` // value // Required: true Value []string `json:"Value"` }
PluginConfigArgs PluginConfigArgs plugin config args
swagger:model PluginConfigArgs
func (*PluginConfigArgs) ContextValidate ¶
ContextValidate validates this plugin config args based on context it is used
func (*PluginConfigArgs) MarshalBinary ¶
func (m *PluginConfigArgs) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*PluginConfigArgs) UnmarshalBinary ¶
func (m *PluginConfigArgs) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type PluginConfigInterface ¶
type PluginConfigInterface struct { // Protocol to use for clients connecting to the plugin. ProtocolScheme string `json:"ProtocolScheme,omitempty"` // socket // Required: true Socket *string `json:"Socket"` // types // Required: true Types []*PluginInterfaceType `json:"Types"` }
PluginConfigInterface PluginConfigInterface The interface between Docker and the plugin
swagger:model PluginConfigInterface
func (*PluginConfigInterface) ContextValidate ¶
ContextValidate validate this plugin config interface based on the context it is used
func (*PluginConfigInterface) MarshalBinary ¶
func (m *PluginConfigInterface) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*PluginConfigInterface) UnmarshalBinary ¶
func (m *PluginConfigInterface) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type PluginConfigLinux ¶
type PluginConfigLinux struct { // allow all devices // Required: true AllowAllDevices *bool `json:"AllowAllDevices"` // capabilities // Required: true Capabilities []string `json:"Capabilities"` // devices // Required: true Devices []*PluginDevice `json:"Devices"` }
PluginConfigLinux PluginConfigLinux plugin config linux
swagger:model PluginConfigLinux
func (*PluginConfigLinux) ContextValidate ¶
ContextValidate validate this plugin config linux based on the context it is used
func (*PluginConfigLinux) MarshalBinary ¶
func (m *PluginConfigLinux) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*PluginConfigLinux) UnmarshalBinary ¶
func (m *PluginConfigLinux) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type PluginConfigNetwork ¶
type PluginConfigNetwork struct { // type // Required: true Type *string `json:"Type"` }
PluginConfigNetwork PluginConfigNetwork plugin config network
swagger:model PluginConfigNetwork
func (*PluginConfigNetwork) ContextValidate ¶
ContextValidate validates this plugin config network based on context it is used
func (*PluginConfigNetwork) MarshalBinary ¶
func (m *PluginConfigNetwork) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*PluginConfigNetwork) UnmarshalBinary ¶
func (m *PluginConfigNetwork) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type PluginConfigRootfs ¶
type PluginConfigRootfs struct { // diff ids DiffIds []string `json:"diff_ids"` // type Type string `json:"type,omitempty"` }
PluginConfigRootfs PluginConfigRootfs plugin config rootfs
swagger:model PluginConfigRootfs
func (*PluginConfigRootfs) ContextValidate ¶
ContextValidate validates this plugin config rootfs based on context it is used
func (*PluginConfigRootfs) MarshalBinary ¶
func (m *PluginConfigRootfs) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*PluginConfigRootfs) UnmarshalBinary ¶
func (m *PluginConfigRootfs) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type PluginConfigUser ¶
type PluginConfigUser struct { // g ID GID uint32 `json:"GID,omitempty"` // UID UID uint32 `json:"UID,omitempty"` }
PluginConfigUser PluginConfigUser plugin config user
swagger:model PluginConfigUser
func (*PluginConfigUser) ContextValidate ¶
ContextValidate validates this plugin config user based on context it is used
func (*PluginConfigUser) MarshalBinary ¶
func (m *PluginConfigUser) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*PluginConfigUser) UnmarshalBinary ¶
func (m *PluginConfigUser) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type PluginDevice ¶
type PluginDevice struct { // description // Required: true Description *string `json:"Description"` // name // Required: true Name *string `json:"Name"` // path // Required: true Path *string `json:"Path"` // settable // Required: true Settable []string `json:"Settable"` }
PluginDevice PluginDevice plugin device
swagger:model PluginDevice
func (*PluginDevice) ContextValidate ¶
ContextValidate validates this plugin device based on context it is used
func (*PluginDevice) MarshalBinary ¶
func (m *PluginDevice) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*PluginDevice) UnmarshalBinary ¶
func (m *PluginDevice) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type PluginEnv ¶
type PluginEnv struct { // description // Required: true Description *string `json:"Description"` // name // Required: true Name *string `json:"Name"` // settable // Required: true Settable []string `json:"Settable"` // value // Required: true Value *string `json:"Value"` }
PluginEnv PluginEnv plugin env
swagger:model PluginEnv
func (*PluginEnv) ContextValidate ¶
ContextValidate validates this plugin env based on context it is used
func (*PluginEnv) MarshalBinary ¶
MarshalBinary interface implementation
func (*PluginEnv) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type PluginInterfaceType ¶
type PluginInterfaceType struct { // capability // Required: true Capability *string `json:"Capability"` // prefix // Required: true Prefix *string `json:"Prefix"` // version // Required: true Version *string `json:"Version"` }
PluginInterfaceType PluginInterfaceType plugin interface type
swagger:model PluginInterfaceType
func (*PluginInterfaceType) ContextValidate ¶
ContextValidate validates this plugin interface type based on context it is used
func (*PluginInterfaceType) MarshalBinary ¶
func (m *PluginInterfaceType) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*PluginInterfaceType) UnmarshalBinary ¶
func (m *PluginInterfaceType) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type PluginMount ¶
type PluginMount struct { // description // Required: true Description *string `json:"Description"` // destination // Required: true Destination *string `json:"Destination"` // name // Required: true Name *string `json:"Name"` // options // Required: true Options []string `json:"Options"` // settable // Required: true Settable []string `json:"Settable"` // source // Required: true Source *string `json:"Source"` // type // Required: true Type *string `json:"Type"` }
PluginMount PluginMount plugin mount
swagger:model PluginMount
func (*PluginMount) ContextValidate ¶
ContextValidate validates this plugin mount based on context it is used
func (*PluginMount) MarshalBinary ¶
func (m *PluginMount) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*PluginMount) UnmarshalBinary ¶
func (m *PluginMount) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type PluginSettings ¶
type PluginSettings struct { // args // Required: true Args []string `json:"Args"` // devices // Required: true Devices []*PluginDevice `json:"Devices"` // env // Required: true Env []string `json:"Env"` // mounts // Required: true Mounts []*PluginMount `json:"Mounts"` }
PluginSettings PluginSettings Settings that can be modified by users.
swagger:model PluginSettings
func (*PluginSettings) ContextValidate ¶
ContextValidate validate this plugin settings based on the context it is used
func (*PluginSettings) MarshalBinary ¶
func (m *PluginSettings) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*PluginSettings) UnmarshalBinary ¶
func (m *PluginSettings) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Plugins ¶
type Plugins struct { // log Log []string `json:"log"` // network Network []string `json:"network"` // volume Volume []string `json:"volume"` }
Plugins plugins
swagger:model Plugins
func (*Plugins) ContextValidate ¶
ContextValidate validates this plugins based on context it is used
func (*Plugins) MarshalBinary ¶
MarshalBinary interface implementation
func (*Plugins) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type PodBasicConfig ¶
type PodBasicConfig struct { // Devices contains user specified Devices to be added to the Pod Devices []string `json:"pod_devices"` // Hostname is the pod's hostname. If not set, the name of the pod will // be used (if a name was not provided here, the name auto-generated for // the pod will be used). This will be used by the infra container and // all containers in the pod as long as the UTS namespace is shared. // Optional. Hostname string `json:"hostname,omitempty"` // InfraCommand sets the command that will be used to start the infra // container. // If not set, the default set in the Libpod configuration file will be // used. // Conflicts with NoInfra=true. // Optional. InfraCommand []string `json:"infra_command"` // InfraConmonPidFile is a custom path to store the infra container's // conmon PID. InfraConmonPidFile string `json:"infra_conmon_pid_file,omitempty"` // InfraImage is the image that will be used for the infra container. // If not set, the default set in the Libpod configuration file will be // used. // Conflicts with NoInfra=true. // Optional. InfraImage string `json:"infra_image,omitempty"` // InfraName is the name that will be used for the infra container. // If not set, the default set in the Libpod configuration file will be // used. // Conflicts with NoInfra=true. // Optional. InfraName string `json:"infra_name,omitempty"` // Labels are key-value pairs that are used to add metadata to pods. // Optional. Labels map[string]string `json:"labels,omitempty"` // Name is the name of the pod. // If not provided, a name will be generated when the pod is created. // Optional. Name string `json:"name,omitempty"` // NoInfra tells the pod not to create an infra container. If this is // done, many networking-related options will become unavailable. // Conflicts with setting any options in PodNetworkConfig, and the // InfraCommand and InfraImages in this struct. // Optional. NoInfra bool `json:"no_infra,omitempty"` // pod create command PodCreateCommand []string `json:"pod_create_command"` // This will be shown in the output of Inspect() on the pod, and may // also be used by some tools that wish to recreate the pod // (e.g. `podman generate systemd --new`). // Optional. // ShareParent determines if all containers in the pod will share the pod's cgroup as the cgroup parent ShareParent bool `json:"share_parent,omitempty"` // Shared namespaces will be joined (by default) by every container // which joins the pod. // If not set and NoInfra is false, the pod will set a default set of // namespaces to share. // Conflicts with NoInfra=true. // Optional. SharedNamespaces []string `json:"shared_namespaces"` // Sysctl sets kernel parameters for the pod Sysctl map[string]string `json:"sysctl,omitempty"` // pidns Pidns *Namespace `json:"pidns,omitempty"` // userns Userns *Namespace `json:"userns,omitempty"` }
PodBasicConfig PodBasicConfig contains basic configuration options for pods.
swagger:model PodBasicConfig
func (*PodBasicConfig) ContextValidate ¶
ContextValidate validate this pod basic config based on the context it is used
func (*PodBasicConfig) MarshalBinary ¶
func (m *PodBasicConfig) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*PodBasicConfig) UnmarshalBinary ¶
func (m *PodBasicConfig) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type PodCgroupConfig ¶
type PodCgroupConfig struct { // CgroupParent is the parent for the Cgroup that the pod will create. // This pod cgroup will, in turn, be the default cgroup parent for all // containers in the pod. // Optional. CgroupParent string `json:"cgroup_parent,omitempty"` }
PodCgroupConfig PodCgroupConfig contains configuration options about a pod's cgroups.
This will be expanded in future updates to pods.
swagger:model PodCgroupConfig
func (*PodCgroupConfig) ContextValidate ¶
ContextValidate validates this pod cgroup config based on context it is used
func (*PodCgroupConfig) MarshalBinary ¶
func (m *PodCgroupConfig) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*PodCgroupConfig) UnmarshalBinary ¶
func (m *PodCgroupConfig) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type PodCreateConfig ¶
type PodCreateConfig struct { // cgroup parent CgroupParent string `json:"cgroup-parent,omitempty"` // hostname Hostname string `json:"hostname,omitempty"` // infra Infra bool `json:"infra,omitempty"` // infra command InfraCommand string `json:"infra-command,omitempty"` // infra image InfraImage string `json:"infra-image,omitempty"` // infra name InfraName string `json:"infra-name,omitempty"` // labels Labels []string `json:"labels"` // name Name string `json:"name,omitempty"` // publish Publish []string `json:"publish"` Share string `json:"share,omitempty"` }
PodCreateConfig pod create config
swagger:model PodCreateConfig
func (*PodCreateConfig) ContextValidate ¶
ContextValidate validates this pod create config based on context it is used
func (*PodCreateConfig) MarshalBinary ¶
func (m *PodCreateConfig) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*PodCreateConfig) UnmarshalBinary ¶
func (m *PodCreateConfig) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type PodCreateOptions ¶
type PodCreateOptions struct { // cgroup parent CgroupParent string `json:"cgroup_parent,omitempty"` // cpus Cpus float64 `json:"cpus,omitempty"` // cpuset cpus CpusetCpus string `json:"cpuset_cpus,omitempty"` // create command CreateCommand []string `json:"create_command"` // device read b ps DeviceReadBPs []string `json:"device_read_bps"` // devices Devices []string `json:"devices"` // hostname Hostname string `json:"hostname,omitempty"` // infra Infra bool `json:"infra,omitempty"` // infra command InfraCommand string `json:"container_command,omitempty"` // infra conmon pid file InfraConmonPidFile string `json:"container_conmon_pidfile,omitempty"` // infra image InfraImage string `json:"infra_image,omitempty"` // infra name InfraName string `json:"container_name,omitempty"` // labels Labels map[string]string `json:"labels,omitempty"` // name Name string `json:"name,omitempty"` // pid Pid string `json:"pid,omitempty"` // security opt SecurityOpt []string `json:"security_opt"` Share []string `json:"share"` ShareParent bool `json:"share_parent,omitempty"` // sysctl Sysctl []string `json:"sysctl"` // volume Volume []string `json:"volume"` // volumes from VolumesFrom []string `json:"volumes_from"` // net Net *NetOptions `json:"net,omitempty"` }
PodCreateOptions PodCreateOptions provides all possible options for creating a pod and its infra container.
The JSON tags below are made to match the respective field in ContainerCreateOptions for the purpose of mapping.
swagger:model PodCreateOptions
func (*PodCreateOptions) ContextValidate ¶
ContextValidate validate this pod create options based on the context it is used
func (*PodCreateOptions) MarshalBinary ¶
func (m *PodCreateOptions) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*PodCreateOptions) UnmarshalBinary ¶
func (m *PodCreateOptions) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type PodKillReport ¶
type PodKillReport struct { // errs Errs []string `json:"Errs"` // Id ID string `json:"Id,omitempty"` }
PodKillReport pod kill report
swagger:model PodKillReport
func (*PodKillReport) ContextValidate ¶
ContextValidate validates this pod kill report based on context it is used
func (*PodKillReport) MarshalBinary ¶
func (m *PodKillReport) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*PodKillReport) UnmarshalBinary ¶
func (m *PodKillReport) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type PodNetworkConfig ¶
type PodNetworkConfig struct { // CNINetworks is a list of CNI networks to join the container to. // If this list is empty, the default CNI network will be joined // instead. If at least one entry is present, we will not join the // default network (unless it is part of this list). // Only available if NetNS is set to bridge. // Optional. // Deprecated: as of podman 4.0 use "Networks" instead. CNINetworks []string `json:"cni_networks"` // DNSOption is a set of DNS options that will be used in the infra // container's resolv.conf, which will, by default, be shared with all // containers in the pod. // Conflicts with NoInfra=true. // Optional. DNSOption []string `json:"dns_option"` // DNSSearch is a set of DNS search domains that will be used in the // infra container's resolv.conf, which will, by default, be shared with // all containers in the pod. // If not provided, DNS search domains from the host's resolv.conf will // be used. // Conflicts with NoInfra=true. // Optional. DNSSearch []string `json:"dns_search"` // DNSServer is a set of DNS servers that will be used in the infra // container's resolv.conf, which will, by default, be shared with all // containers in the pod. // If not provided, the host's DNS servers will be used, unless the only // server set is a localhost address. As the container cannot connect to // the host's localhost, a default server will instead be set. // Conflicts with NoInfra=true. // Optional. DNSServer []IP `json:"dns_server"` // HostAdd is a set of hosts that will be added to the infra container's // etc/hosts that will, by default, be shared with all containers in // the pod. // Conflicts with NoInfra=true and NoManageHosts. // Optional. HostAdd []string `json:"hostadd"` // NetworkOptions are additional options for each network // Optional. NetworkOptions map[string][]string `json:"network_options,omitempty"` // Map of networks names to ids the container should join to. // You can request additional settings for each network, you can // set network aliases, static ips, static mac address and the // network interface name for this container on the specific network. // If the map is empty and the bridge network mode is set the container // will be joined to the default network. Networks map[string]PerNetworkOptions `json:"Networks,omitempty"` // NoManageHosts indicates that /etc/hosts should not be managed by the // pod. Instead, each container will create a separate /etc/hosts as // they would if not in a pod. // Conflicts with HostAdd. NoManageHosts bool `json:"no_manage_hosts,omitempty"` // NoManageResolvConf indicates that /etc/resolv.conf should not be // managed by the pod. Instead, each container will create and manage a // separate resolv.conf as if they had not joined a pod. // Conflicts with NoInfra=true and DNSServer, DNSSearch, DNSOption. // Optional. NoManageResolvConf bool `json:"no_manage_resolv_conf,omitempty"` // PortMappings is a set of ports to map into the infra container. // As, by default, containers share their network with the infra // container, this will forward the ports to the entire pod. // Only available if NetNS is set to Bridge or Slirp. // Optional. PortMappings []*PortMapping `json:"portmappings"` // netns Netns *Namespace `json:"netns,omitempty"` }
PodNetworkConfig PodNetworkConfig contains networking configuration for a pod.
swagger:model PodNetworkConfig
func (*PodNetworkConfig) ContextValidate ¶
ContextValidate validate this pod network config based on the context it is used
func (*PodNetworkConfig) MarshalBinary ¶
func (m *PodNetworkConfig) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*PodNetworkConfig) UnmarshalBinary ¶
func (m *PodNetworkConfig) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type PodPauseReport ¶
type PodPauseReport struct { // errs Errs []string `json:"Errs"` // Id ID string `json:"Id,omitempty"` }
PodPauseReport pod pause report
swagger:model PodPauseReport
func (*PodPauseReport) ContextValidate ¶
ContextValidate validates this pod pause report based on context it is used
func (*PodPauseReport) MarshalBinary ¶
func (m *PodPauseReport) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*PodPauseReport) UnmarshalBinary ¶
func (m *PodPauseReport) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type PodPruneReport ¶
type PodPruneReport struct { // err Err string `json:"Err,omitempty"` // Id ID string `json:"Id,omitempty"` }
PodPruneReport pod prune report
swagger:model PodPruneReport
func (*PodPruneReport) ContextValidate ¶
ContextValidate validates this pod prune report based on context it is used
func (*PodPruneReport) MarshalBinary ¶
func (m *PodPruneReport) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*PodPruneReport) UnmarshalBinary ¶
func (m *PodPruneReport) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type PodResourceConfig ¶
type PodResourceConfig struct { // CPU period of the cpuset, determined by --cpus CPUPeriod uint64 `json:"cpu_period,omitempty"` // CPU quota of the cpuset, determined by --cpus CPUQuota int64 `json:"cpu_quota,omitempty"` // ThrottleReadBpsDevice contains the rate at which the devices in the pod can be read from/accessed ThrottleReadBpsDevice map[string]LinuxThrottleDevice `json:"throttleReadBpsDevice,omitempty"` // resource limits ResourceLimits *LinuxResources `json:"resource_limits,omitempty"` }
PodResourceConfig pod resource config
swagger:model PodResourceConfig
func (*PodResourceConfig) ContextValidate ¶
ContextValidate validate this pod resource config based on the context it is used
func (*PodResourceConfig) MarshalBinary ¶
func (m *PodResourceConfig) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*PodResourceConfig) UnmarshalBinary ¶
func (m *PodResourceConfig) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type PodRestartReport ¶
type PodRestartReport struct { // errs Errs []string `json:"Errs"` // Id ID string `json:"Id,omitempty"` }
PodRestartReport pod restart report
swagger:model PodRestartReport
func (*PodRestartReport) ContextValidate ¶
ContextValidate validates this pod restart report based on context it is used
func (*PodRestartReport) MarshalBinary ¶
func (m *PodRestartReport) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*PodRestartReport) UnmarshalBinary ¶
func (m *PodRestartReport) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type PodRmReport ¶
type PodRmReport struct { // err Err string `json:"Err,omitempty"` // Id ID string `json:"Id,omitempty"` }
PodRmReport pod rm report
swagger:model PodRmReport
func (*PodRmReport) ContextValidate ¶
ContextValidate validates this pod rm report based on context it is used
func (*PodRmReport) MarshalBinary ¶
func (m *PodRmReport) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*PodRmReport) UnmarshalBinary ¶
func (m *PodRmReport) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type PodSecurityConfig ¶
type PodSecurityConfig struct { // security opt SecurityOpt []string `json:"security_opt"` }
PodSecurityConfig pod security config
swagger:model PodSecurityConfig
func (*PodSecurityConfig) ContextValidate ¶
ContextValidate validates this pod security config based on context it is used
func (*PodSecurityConfig) MarshalBinary ¶
func (m *PodSecurityConfig) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*PodSecurityConfig) UnmarshalBinary ¶
func (m *PodSecurityConfig) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type PodSpecGenerator ¶
type PodSpecGenerator struct { // CNINetworks is a list of CNI networks to join the container to. // If this list is empty, the default CNI network will be joined // instead. If at least one entry is present, we will not join the // default network (unless it is part of this list). // Only available if NetNS is set to bridge. // Optional. // Deprecated: as of podman 4.0 use "Networks" instead. CNINetworks []string `json:"cni_networks"` // CPU period of the cpuset, determined by --cpus CPUPeriod uint64 `json:"cpu_period,omitempty"` // CPU quota of the cpuset, determined by --cpus CPUQuota int64 `json:"cpu_quota,omitempty"` // CgroupParent is the parent for the Cgroup that the pod will create. // This pod cgroup will, in turn, be the default cgroup parent for all // containers in the pod. // Optional. CgroupParent string `json:"cgroup_parent,omitempty"` // DNSOption is a set of DNS options that will be used in the infra // container's resolv.conf, which will, by default, be shared with all // containers in the pod. // Conflicts with NoInfra=true. // Optional. DNSOption []string `json:"dns_option"` // DNSSearch is a set of DNS search domains that will be used in the // infra container's resolv.conf, which will, by default, be shared with // all containers in the pod. // If not provided, DNS search domains from the host's resolv.conf will // be used. // Conflicts with NoInfra=true. // Optional. DNSSearch []string `json:"dns_search"` // DNSServer is a set of DNS servers that will be used in the infra // container's resolv.conf, which will, by default, be shared with all // containers in the pod. // If not provided, the host's DNS servers will be used, unless the only // server set is a localhost address. As the container cannot connect to // the host's localhost, a default server will instead be set. // Conflicts with NoInfra=true. // Optional. DNSServer []IP `json:"dns_server"` // Devices contains user specified Devices to be added to the Pod Devices []string `json:"pod_devices"` // HostAdd is a set of hosts that will be added to the infra container's // etc/hosts that will, by default, be shared with all containers in // the pod. // Conflicts with NoInfra=true and NoManageHosts. // Optional. HostAdd []string `json:"hostadd"` // Hostname is the pod's hostname. If not set, the name of the pod will // be used (if a name was not provided here, the name auto-generated for // the pod will be used). This will be used by the infra container and // all containers in the pod as long as the UTS namespace is shared. // Optional. Hostname string `json:"hostname,omitempty"` // Image volumes bind-mount a container-image mount into the pod's infra container. // Optional. ImageVolumes []*ImageVolume `json:"image_volumes"` // InfraCommand sets the command that will be used to start the infra // container. // If not set, the default set in the Libpod configuration file will be // used. // Conflicts with NoInfra=true. // Optional. InfraCommand []string `json:"infra_command"` // InfraConmonPidFile is a custom path to store the infra container's // conmon PID. InfraConmonPidFile string `json:"infra_conmon_pid_file,omitempty"` // InfraImage is the image that will be used for the infra container. // If not set, the default set in the Libpod configuration file will be // used. // Conflicts with NoInfra=true. // Optional. InfraImage string `json:"infra_image,omitempty"` // InfraName is the name that will be used for the infra container. // If not set, the default set in the Libpod configuration file will be // used. // Conflicts with NoInfra=true. // Optional. InfraName string `json:"infra_name,omitempty"` // Labels are key-value pairs that are used to add metadata to pods. // Optional. Labels map[string]string `json:"labels,omitempty"` // Mounts are mounts that will be added to the pod. // These will supersede Image Volumes and VolumesFrom volumes where // there are conflicts. // Optional. Mounts []*Mount `json:"mounts"` // Name is the name of the pod. // If not provided, a name will be generated when the pod is created. // Optional. Name string `json:"name,omitempty"` // NetworkOptions are additional options for each network // Optional. NetworkOptions map[string][]string `json:"network_options,omitempty"` // Map of networks names to ids the container should join to. // You can request additional settings for each network, you can // set network aliases, static ips, static mac address and the // network interface name for this container on the specific network. // If the map is empty and the bridge network mode is set the container // will be joined to the default network. Networks map[string]PerNetworkOptions `json:"Networks,omitempty"` // NoInfra tells the pod not to create an infra container. If this is // done, many networking-related options will become unavailable. // Conflicts with setting any options in PodNetworkConfig, and the // InfraCommand and InfraImages in this struct. // Optional. NoInfra bool `json:"no_infra,omitempty"` // NoManageHosts indicates that /etc/hosts should not be managed by the // pod. Instead, each container will create a separate /etc/hosts as // they would if not in a pod. // Conflicts with HostAdd. NoManageHosts bool `json:"no_manage_hosts,omitempty"` // NoManageResolvConf indicates that /etc/resolv.conf should not be // managed by the pod. Instead, each container will create and manage a // separate resolv.conf as if they had not joined a pod. // Conflicts with NoInfra=true and DNSServer, DNSSearch, DNSOption. // Optional. NoManageResolvConf bool `json:"no_manage_resolv_conf,omitempty"` // Overlay volumes are named volumes that will be added to the pod. // Optional. OverlayVolumes []*OverlayVolume `json:"overlay_volumes"` // pod create command PodCreateCommand []string `json:"pod_create_command"` // PortMappings is a set of ports to map into the infra container. // As, by default, containers share their network with the infra // container, this will forward the ports to the entire pod. // Only available if NetNS is set to Bridge or Slirp. // Optional. PortMappings []*PortMapping `json:"portmappings"` // security opt SecurityOpt []string `json:"security_opt"` // This will be shown in the output of Inspect() on the pod, and may // also be used by some tools that wish to recreate the pod // (e.g. `podman generate systemd --new`). // Optional. // ShareParent determines if all containers in the pod will share the pod's cgroup as the cgroup parent ShareParent bool `json:"share_parent,omitempty"` // Shared namespaces will be joined (by default) by every container // which joins the pod. // If not set and NoInfra is false, the pod will set a default set of // namespaces to share. // Conflicts with NoInfra=true. // Optional. SharedNamespaces []string `json:"shared_namespaces"` // Sysctl sets kernel parameters for the pod Sysctl map[string]string `json:"sysctl,omitempty"` // ThrottleReadBpsDevice contains the rate at which the devices in the pod can be read from/accessed ThrottleReadBpsDevice map[string]LinuxThrottleDevice `json:"throttleReadBpsDevice,omitempty"` // Volumes are named volumes that will be added to the pod. // These will supersede Image Volumes and VolumesFrom volumes where // there are conflicts. // Optional. Volumes []*NamedVolume `json:"volumes"` // VolumesFrom is a set of containers whose volumes will be added to // this pod. The name or ID of the container must be provided, and // may optionally be followed by a : and then one or more // comma-separated options. Valid options are 'ro', 'rw', and 'z'. // Options will be used for all volumes sourced from the container. VolumesFrom []string `json:"volumes_from"` // netns Netns *Namespace `json:"netns,omitempty"` // pidns Pidns *Namespace `json:"pidns,omitempty"` // resource limits ResourceLimits *LinuxResources `json:"resource_limits,omitempty"` // userns Userns *Namespace `json:"userns,omitempty"` }
PodSpecGenerator PodSpecGenerator describes options to create a pod
swagger:model PodSpecGenerator
func (*PodSpecGenerator) ContextValidate ¶
ContextValidate validate this pod spec generator based on the context it is used
func (*PodSpecGenerator) MarshalBinary ¶
func (m *PodSpecGenerator) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*PodSpecGenerator) UnmarshalBinary ¶
func (m *PodSpecGenerator) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type PodStartReport ¶
type PodStartReport struct { // errs Errs []string `json:"Errs"` // Id ID string `json:"Id,omitempty"` }
PodStartReport pod start report
swagger:model PodStartReport
func (*PodStartReport) ContextValidate ¶
ContextValidate validates this pod start report based on context it is used
func (*PodStartReport) MarshalBinary ¶
func (m *PodStartReport) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*PodStartReport) UnmarshalBinary ¶
func (m *PodStartReport) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type PodStopReport ¶
type PodStopReport struct { // errs Errs []string `json:"Errs"` // Id ID string `json:"Id,omitempty"` }
PodStopReport pod stop report
swagger:model PodStopReport
func (*PodStopReport) ContextValidate ¶
ContextValidate validates this pod stop report based on context it is used
func (*PodStopReport) MarshalBinary ¶
func (m *PodStopReport) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*PodStopReport) UnmarshalBinary ¶
func (m *PodStopReport) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type PodStorageConfig ¶
type PodStorageConfig struct { // Image volumes bind-mount a container-image mount into the pod's infra container. // Optional. ImageVolumes []*ImageVolume `json:"image_volumes"` // Mounts are mounts that will be added to the pod. // These will supersede Image Volumes and VolumesFrom volumes where // there are conflicts. // Optional. Mounts []*Mount `json:"mounts"` // Overlay volumes are named volumes that will be added to the pod. // Optional. OverlayVolumes []*OverlayVolume `json:"overlay_volumes"` // Volumes are named volumes that will be added to the pod. // These will supersede Image Volumes and VolumesFrom volumes where // there are conflicts. // Optional. Volumes []*NamedVolume `json:"volumes"` // VolumesFrom is a set of containers whose volumes will be added to // this pod. The name or ID of the container must be provided, and // may optionally be followed by a : and then one or more // comma-separated options. Valid options are 'ro', 'rw', and 'z'. // Options will be used for all volumes sourced from the container. VolumesFrom []string `json:"volumes_from"` }
PodStorageConfig PodStorageConfig contains all of the storage related options for the pod and its infra container.
swagger:model PodStorageConfig
func (*PodStorageConfig) ContextValidate ¶
ContextValidate validate this pod storage config based on the context it is used
func (*PodStorageConfig) MarshalBinary ¶
func (m *PodStorageConfig) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*PodStorageConfig) UnmarshalBinary ¶
func (m *PodStorageConfig) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type PodUnpauseReport ¶
type PodUnpauseReport struct { // errs Errs []string `json:"Errs"` // Id ID string `json:"Id,omitempty"` }
PodUnpauseReport pod unpause report
swagger:model PodUnpauseReport
func (*PodUnpauseReport) ContextValidate ¶
ContextValidate validates this pod unpause report based on context it is used
func (*PodUnpauseReport) MarshalBinary ¶
func (m *PodUnpauseReport) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*PodUnpauseReport) UnmarshalBinary ¶
func (m *PodUnpauseReport) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Port ¶
type Port struct { // Host IP address that the container's port is mapped to IP string `json:"IP,omitempty"` // Port on the container // Required: true PrivatePort *uint16 `json:"PrivatePort"` // Port exposed on the host PublicPort uint16 `json:"PublicPort,omitempty"` // type // Required: true Type *string `json:"Type"` }
Port Port An open port on a container
swagger:model Port
func (*Port) ContextValidate ¶
ContextValidate validates this port based on context it is used
func (*Port) MarshalBinary ¶
MarshalBinary interface implementation
func (*Port) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type PortBinding ¶
type PortBinding struct { // HostIP is the host IP Address HostIP string `json:"HostIp,omitempty"` // HostPort is the host port number HostPort string `json:"HostPort,omitempty"` }
PortBinding PortBinding represents a binding between a Host IP address and a Host Port
swagger:model PortBinding
func (*PortBinding) ContextValidate ¶
ContextValidate validates this port binding based on context it is used
func (*PortBinding) MarshalBinary ¶
func (m *PortBinding) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*PortBinding) UnmarshalBinary ¶
func (m *PortBinding) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type PortMap ¶
type PortMap map[string][]PortBinding
PortMap PortMap is a collection of PortBinding indexed by Port
swagger:model PortMap
func (PortMap) ContextValidate ¶
ContextValidate validate this port map based on the context it is used
type PortMapping ¶
type PortMapping struct { // ContainerPort is the port number that will be exposed from the // container. // Mandatory. ContainerPort uint16 `json:"container_port,omitempty"` // HostIP is the IP that we will bind to on the host. // If unset, assumed to be 0.0.0.0 (all interfaces). HostIP string `json:"host_ip,omitempty"` // HostPort is the port number that will be forwarded from the host into // the container. // If omitted, a random port on the host (guaranteed to be over 1024) // will be assigned. HostPort uint16 `json:"host_port,omitempty"` // Protocol is the protocol forward. // Must be either "tcp", "udp", and "sctp", or some combination of these // separated by commas. // If unset, assumed to be TCP. Protocol string `json:"protocol,omitempty"` // Range is the number of ports that will be forwarded, starting at // HostPort and ContainerPort and counting up. // This is 1-indexed, so 1 is assumed to be a single port (only the // Hostport:Containerport mapping will be added), 2 is two ports (both // Hostport:Containerport and Hostport+1:Containerport+1), etc. // If unset, assumed to be 1 (a single port). // Both hostport + range and containerport + range must be less than // 65536. Range uint16 `json:"range,omitempty"` }
PortMapping PortMapping is one or more ports that will be mapped into the container.
swagger:model PortMapping
func (*PortMapping) ContextValidate ¶
ContextValidate validates this port mapping based on context it is used
func (*PortMapping) MarshalBinary ¶
func (m *PortMapping) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*PortMapping) UnmarshalBinary ¶
func (m *PortMapping) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type PortSet ¶
type PortSet map[string]interface{}
PortSet PortSet is a collection of structs indexed by Port
swagger:model PortSet
func (PortSet) ContextValidate ¶
ContextValidate validates this port set based on context it is used
type Propagation ¶
type Propagation string
Propagation Propagation represents the propagation of a mount.
swagger:model Propagation
func (Propagation) ContextValidate ¶
ContextValidate validates this propagation based on context it is used
type PruneReport ¶
type PruneReport struct { // err Err string `json:"Err,omitempty"` // Id ID string `json:"Id,omitempty"` // size Size uint64 `json:"Size,omitempty"` }
PruneReport prune report
swagger:model PruneReport
func (*PruneReport) ContextValidate ¶
ContextValidate validates this prune report based on context it is used
func (*PruneReport) MarshalBinary ¶
func (m *PruneReport) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*PruneReport) UnmarshalBinary ¶
func (m *PruneReport) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type RemoteSocket ¶
type RemoteSocket struct { // exists Exists bool `json:"exists,omitempty"` // path Path string `json:"path,omitempty"` }
RemoteSocket RemoteSocket describes information about the API socket
swagger:model RemoteSocket
func (*RemoteSocket) ContextValidate ¶
ContextValidate validates this remote socket based on context it is used
func (*RemoteSocket) MarshalBinary ¶
func (m *RemoteSocket) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*RemoteSocket) UnmarshalBinary ¶
func (m *RemoteSocket) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Resources ¶
type Resources struct { // blkio device read bps BlkioDeviceReadBps []*ThrottleDevice `json:"BlkioDeviceReadBps"` // blkio device read i ops BlkioDeviceReadIOps []*ThrottleDevice `json:"BlkioDeviceReadIOps"` // blkio device write bps BlkioDeviceWriteBps []*ThrottleDevice `json:"BlkioDeviceWriteBps"` // blkio device write i ops BlkioDeviceWriteIOps []*ThrottleDevice `json:"BlkioDeviceWriteIOps"` // blkio weight BlkioWeight uint16 `json:"BlkioWeight,omitempty"` // blkio weight device BlkioWeightDevice []*WeightDevice `json:"BlkioWeightDevice"` // Applicable to Windows CPUCount int64 `json:"CpuCount,omitempty"` // CPU percent CPUPercent int64 `json:"CpuPercent,omitempty"` // CPU period CPUPeriod int64 `json:"CpuPeriod,omitempty"` // CPU quota CPUQuota int64 `json:"CpuQuota,omitempty"` // CPU realtime period CPURealtimePeriod int64 `json:"CpuRealtimePeriod,omitempty"` // CPU realtime runtime CPURealtimeRuntime int64 `json:"CpuRealtimeRuntime,omitempty"` CPUShares int64 `json:"CpuShares,omitempty"` // Applicable to UNIX platforms CgroupParent string `json:"CgroupParent,omitempty"` // cpuset cpus CpusetCpus string `json:"CpusetCpus,omitempty"` // cpuset mems CpusetMems string `json:"CpusetMems,omitempty"` // device cgroup rules DeviceCgroupRules []string `json:"DeviceCgroupRules"` // device requests DeviceRequests []*DeviceRequest `json:"DeviceRequests"` // devices Devices []*DeviceMapping `json:"Devices"` // i o maximum bandwidth IOMaximumBandwidth uint64 `json:"IOMaximumBandwidth,omitempty"` // i o maximum i ops IOMaximumIOps uint64 `json:"IOMaximumIOps,omitempty"` // kernel memory KernelMemory int64 `json:"KernelMemory,omitempty"` // kernel memory TCP KernelMemoryTCP int64 `json:"KernelMemoryTCP,omitempty"` // memory Memory int64 `json:"Memory,omitempty"` // memory reservation MemoryReservation int64 `json:"MemoryReservation,omitempty"` // memory swap MemorySwap int64 `json:"MemorySwap,omitempty"` // memory swappiness MemorySwappiness int64 `json:"MemorySwappiness,omitempty"` // nano c p us NanoCPUs int64 `json:"NanoCpus,omitempty"` // oom kill disable OomKillDisable bool `json:"OomKillDisable,omitempty"` // pids limit PidsLimit int64 `json:"PidsLimit,omitempty"` // ulimits Ulimits []*Ulimit `json:"Ulimits"` }
Resources Resources contains container's resources (cgroups config, ulimits...)
swagger:model Resources
func (*Resources) ContextValidate ¶
ContextValidate validate this resources based on the context it is used
func (*Resources) MarshalBinary ¶
MarshalBinary interface implementation
func (*Resources) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type RestartPolicy ¶
type RestartPolicy struct { // maximum retry count MaximumRetryCount int64 `json:"MaximumRetryCount,omitempty"` // name Name string `json:"Name,omitempty"` }
RestartPolicy RestartPolicy represents the restart policies of the container.
swagger:model RestartPolicy
func (*RestartPolicy) ContextValidate ¶
ContextValidate validates this restart policy based on context it is used
func (*RestartPolicy) MarshalBinary ¶
func (m *RestartPolicy) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*RestartPolicy) UnmarshalBinary ¶
func (m *RestartPolicy) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type RootFS ¶
type RootFS struct { // layers Layers []Digest `json:"Layers"` // type Type string `json:"Type,omitempty"` }
RootFS RootFS holds the root fs information of an image
swagger:model RootFS
func (*RootFS) ContextValidate ¶
ContextValidate validate this root f s based on the context it is used
func (*RootFS) MarshalBinary ¶
MarshalBinary interface implementation
func (*RootFS) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type Schema2HealthConfig ¶
type Schema2HealthConfig struct { // interval Interval Duration `json:"Interval,omitempty"` // Retries is the number of consecutive failures needed to consider a container as unhealthy. // Zero means inherit. Retries int64 `json:"Retries,omitempty"` // start period StartPeriod Duration `json:"StartPeriod,omitempty"` // Test is the test to perform to check that the container is healthy. // An empty slice means to inherit the default. // The options are: // {} : inherit healthcheck // {"NONE"} : disable healthcheck // {"CMD", args...} : exec arguments directly // {"CMD-SHELL", command} : run command with system's default shell Test []string `json:"Test"` // timeout Timeout Duration `json:"Timeout,omitempty"` }
Schema2HealthConfig Schema2HealthConfig is a HealthConfig, which holds configuration settings for the HEALTHCHECK feature, from docker/docker/api/types/container.
swagger:model Schema2HealthConfig
func (*Schema2HealthConfig) ContextValidate ¶
ContextValidate validate this schema2 health config based on the context it is used
func (*Schema2HealthConfig) MarshalBinary ¶
func (m *Schema2HealthConfig) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*Schema2HealthConfig) UnmarshalBinary ¶
func (m *Schema2HealthConfig) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Schema2List ¶
type Schema2List struct { // manifests Manifests []*Schema2ManifestDescriptor `json:"manifests"` // media type MediaType string `json:"mediaType,omitempty"` // schema version SchemaVersion int64 `json:"schemaVersion,omitempty"` }
Schema2List Schema2List is a list of platform-specific manifests.
swagger:model Schema2List
func (*Schema2List) ContextValidate ¶
ContextValidate validate this schema2 list based on the context it is used
func (*Schema2List) MarshalBinary ¶
func (m *Schema2List) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*Schema2List) UnmarshalBinary ¶
func (m *Schema2List) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Schema2ManifestDescriptor ¶
type Schema2ManifestDescriptor struct { // media type MediaType string `json:"mediaType,omitempty"` // size Size int64 `json:"size,omitempty"` // u r ls URLs []string `json:"urls"` // digest Digest Digest `json:"digest,omitempty"` // platform Platform *Schema2PlatformSpec `json:"platform,omitempty"` }
Schema2ManifestDescriptor Schema2ManifestDescriptor references a platform-specific manifest.
swagger:model Schema2ManifestDescriptor
func (*Schema2ManifestDescriptor) ContextValidate ¶
func (m *Schema2ManifestDescriptor) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validate this schema2 manifest descriptor based on the context it is used
func (*Schema2ManifestDescriptor) MarshalBinary ¶
func (m *Schema2ManifestDescriptor) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*Schema2ManifestDescriptor) UnmarshalBinary ¶
func (m *Schema2ManifestDescriptor) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Schema2PlatformSpec ¶
type Schema2PlatformSpec struct { // architecture Architecture string `json:"architecture,omitempty"` // features Features []string `json:"features"` // o s OS string `json:"os,omitempty"` // o s features OSFeatures []string `json:"os.features"` // o s version OSVersion string `json:"os.version,omitempty"` // variant Variant string `json:"variant,omitempty"` }
Schema2PlatformSpec Schema2PlatformSpec describes the platform which a particular manifest is specialized for.
swagger:model Schema2PlatformSpec
func (*Schema2PlatformSpec) ContextValidate ¶
ContextValidate validates this schema2 platform spec based on context it is used
func (*Schema2PlatformSpec) MarshalBinary ¶
func (m *Schema2PlatformSpec) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*Schema2PlatformSpec) UnmarshalBinary ¶
func (m *Schema2PlatformSpec) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Secret ¶
type Secret struct { // g ID GID uint32 `json:"GID,omitempty"` // mode Mode uint32 `json:"Mode,omitempty"` // source Source string `json:"Source,omitempty"` // target Target string `json:"Target,omitempty"` // UID UID uint32 `json:"UID,omitempty"` }
Secret secret
swagger:model Secret
func (*Secret) ContextValidate ¶
ContextValidate validates this secret based on context it is used
func (*Secret) MarshalBinary ¶
MarshalBinary interface implementation
func (*Secret) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type SecretCreateRequest ¶
type SecretCreateRequest struct { // Base64-url-safe-encoded (RFC 4648) data to store as secret. Data string `json:"Data,omitempty"` // driver Driver *SecretDriverSpec `json:"Driver,omitempty"` // User-defined name of the secret. Name string `json:"Name,omitempty"` }
SecretCreateRequest secret create request
swagger:model SecretCreateRequest
func (*SecretCreateRequest) ContextValidate ¶
ContextValidate validate this secret create request based on the context it is used
func (*SecretCreateRequest) MarshalBinary ¶
func (m *SecretCreateRequest) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*SecretCreateRequest) UnmarshalBinary ¶
func (m *SecretCreateRequest) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type SecretDriverSpec ¶
type SecretDriverSpec struct { // name Name string `json:"Name,omitempty"` // options Options map[string]string `json:"Options,omitempty"` }
SecretDriverSpec secret driver spec
swagger:model SecretDriverSpec
func (*SecretDriverSpec) ContextValidate ¶
ContextValidate validates this secret driver spec based on context it is used
func (*SecretDriverSpec) MarshalBinary ¶
func (m *SecretDriverSpec) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*SecretDriverSpec) UnmarshalBinary ¶
func (m *SecretDriverSpec) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type SecretInfoReport ¶
type SecretInfoReport struct { // created at // Format: date-time CreatedAt strfmt.DateTime `json:"CreatedAt,omitempty"` // ID ID string `json:"ID,omitempty"` // spec Spec *SecretSpec `json:"Spec,omitempty"` // updated at // Format: date-time UpdatedAt strfmt.DateTime `json:"UpdatedAt,omitempty"` }
SecretInfoReport secret info report
swagger:model SecretInfoReport
func (*SecretInfoReport) ContextValidate ¶
ContextValidate validate this secret info report based on the context it is used
func (*SecretInfoReport) MarshalBinary ¶
func (m *SecretInfoReport) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*SecretInfoReport) UnmarshalBinary ¶
func (m *SecretInfoReport) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type SecretInfoReportCompat ¶
type SecretInfoReportCompat struct { // created at // Format: date-time CreatedAt strfmt.DateTime `json:"CreatedAt,omitempty"` // ID ID string `json:"ID,omitempty"` // spec Spec *SecretSpec `json:"Spec,omitempty"` // updated at // Format: date-time UpdatedAt strfmt.DateTime `json:"UpdatedAt,omitempty"` // version Version *SecretVersion `json:"Version,omitempty"` }
SecretInfoReportCompat secret info report compat
swagger:model SecretInfoReportCompat
func (*SecretInfoReportCompat) ContextValidate ¶
func (m *SecretInfoReportCompat) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validate this secret info report compat based on the context it is used
func (*SecretInfoReportCompat) MarshalBinary ¶
func (m *SecretInfoReportCompat) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*SecretInfoReportCompat) UnmarshalBinary ¶
func (m *SecretInfoReportCompat) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type SecretSpec ¶
type SecretSpec struct { // driver Driver *SecretDriverSpec `json:"Driver,omitempty"` // name Name string `json:"Name,omitempty"` }
SecretSpec secret spec
swagger:model SecretSpec
func (*SecretSpec) ContextValidate ¶
ContextValidate validate this secret spec based on the context it is used
func (*SecretSpec) MarshalBinary ¶
func (m *SecretSpec) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*SecretSpec) UnmarshalBinary ¶
func (m *SecretSpec) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type SecretVersion ¶
type SecretVersion struct { // index Index int64 `json:"Index,omitempty"` }
SecretVersion secret version
swagger:model SecretVersion
func (*SecretVersion) ContextValidate ¶
ContextValidate validates this secret version based on context it is used
func (*SecretVersion) MarshalBinary ¶
func (m *SecretVersion) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*SecretVersion) UnmarshalBinary ¶
func (m *SecretVersion) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type SecurityInfo ¶
type SecurityInfo struct { // app armor enabled AppArmorEnabled bool `json:"apparmorEnabled,omitempty"` // default capabilities DefaultCapabilities string `json:"capabilities,omitempty"` // rootless Rootless bool `json:"rootless,omitempty"` // s e c c o m p enabled SECCOMPEnabled bool `json:"seccompEnabled,omitempty"` // s e c c o m p profile path SECCOMPProfilePath string `json:"seccompProfilePath,omitempty"` // s e linux enabled SELinuxEnabled bool `json:"selinuxEnabled,omitempty"` }
SecurityInfo HostInfo describes the libpod host
swagger:model SecurityInfo
func (*SecurityInfo) ContextValidate ¶
ContextValidate validates this security info based on context it is used
func (*SecurityInfo) MarshalBinary ¶
func (m *SecurityInfo) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*SecurityInfo) UnmarshalBinary ¶
func (m *SecurityInfo) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ServiceInfo ¶
type ServiceInfo struct { // local l b index LocalLBIndex int64 `json:"LocalLBIndex,omitempty"` // ports Ports []string `json:"Ports"` // tasks Tasks []*Task `json:"Tasks"` // v IP VIP string `json:"VIP,omitempty"` }
ServiceInfo ServiceInfo represents service parameters with the list of service's tasks
swagger:model ServiceInfo
func (*ServiceInfo) ContextValidate ¶
ContextValidate validate this service info based on the context it is used
func (*ServiceInfo) MarshalBinary ¶
func (m *ServiceInfo) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ServiceInfo) UnmarshalBinary ¶
func (m *ServiceInfo) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ServiceUpdateResponse ¶
type ServiceUpdateResponse struct { // Optional warning messages Warnings []string `json:"Warnings"` }
ServiceUpdateResponse ServiceUpdateResponse service update response
swagger:model ServiceUpdateResponse
func (*ServiceUpdateResponse) ContextValidate ¶
ContextValidate validates this service update response based on context it is used
func (*ServiceUpdateResponse) MarshalBinary ¶
func (m *ServiceUpdateResponse) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ServiceUpdateResponse) UnmarshalBinary ¶
func (m *ServiceUpdateResponse) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Signal ¶
type Signal int64
Signal A Signal is a number describing a process signal.
It implements the os.Signal interface.
swagger:model Signal
func (Signal) ContextValidate ¶
ContextValidate validates this signal based on context it is used
type SlirpInfo ¶
type SlirpInfo struct { // executable Executable string `json:"executable,omitempty"` // package Package string `json:"package,omitempty"` // version Version string `json:"version,omitempty"` }
SlirpInfo SlirpInfo describes the slirp executable that is being being used.
swagger:model SlirpInfo
func (*SlirpInfo) ContextValidate ¶
ContextValidate validates this slirp info based on context it is used
func (*SlirpInfo) MarshalBinary ¶
MarshalBinary interface implementation
func (*SlirpInfo) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type SpecGenerator ¶
type SpecGenerator struct { // Annotations are key-value options passed into the container runtime // that can be used to trigger special behavior. // Optional. Annotations map[string]string `json:"annotations,omitempty"` // ApparmorProfile is the name of the Apparmor profile the container // will use. // Optional. ApparmorProfile string `json:"apparmor_profile,omitempty"` // CNINetworks is a list of CNI networks to join the container to. // If this list is empty, the default CNI network will be joined // instead. If at least one entry is present, we will not join the // default network (unless it is part of this list). // Only available if NetNS is set to bridge. // Optional. // Deprecated: as of podman 4.0 use "Networks" instead. CNINetworks []string `json:"cni_networks"` // CPU period of the cpuset, determined by --cpus CPUPeriod uint64 `json:"cpu_period,omitempty"` // CPU quota of the cpuset, determined by --cpus CPUQuota int64 `json:"cpu_quota,omitempty"` // CapAdd are capabilities which will be added to the container. // Conflicts with Privileged. // Optional. CapAdd []string `json:"cap_add"` // CapDrop are capabilities which will be removed from the container. // Conflicts with Privileged. // Optional. CapDrop []string `json:"cap_drop"` // CgroupConf are key-value options passed into the container runtime // that are used to configure cgroup v2. // Optional. CgroupConf map[string]string `json:"unified,omitempty"` // CgroupParent is the container's Cgroup parent. // If not set, the default for the current cgroup driver will be used. // Optional. CgroupParent string `json:"cgroup_parent,omitempty"` // CgroupsMode sets a policy for how cgroups will be created in the // container, including the ability to disable creation entirely. CgroupsMode string `json:"cgroups_mode,omitempty"` // Command is the container's command. // If not given and Image is specified, this will be populated by the // image's configuration. // Optional. Command []string `json:"command"` // ConmonPidFile is a path at which a PID file for Conmon will be // placed. // If not given, a default location will be used. // Optional. ConmonPidFile string `json:"conmon_pid_file,omitempty"` // ContainerCreateCommand is the command that was used to create this // container. // This will be shown in the output of Inspect() on the container, and // may also be used by some tools that wish to recreate the container // (e.g. `podman generate systemd --new`). // Optional. ContainerCreateCommand []string `json:"containerCreateCommand"` // Create the working directory if it doesn't exist. // If unset, it doesn't create it. // Optional. CreateWorkingDir bool `json:"create_working_dir,omitempty"` // DNSOptions is a set of DNS options that will be used in the // container's resolv.conf, replacing the host's DNS options which are // used by default. // Conflicts with UseImageResolvConf. // Optional. DNSOptions []string `json:"dns_option"` // DNSSearch is a set of DNS search domains that will be used in the // container's resolv.conf, replacing the host's DNS search domains // which are used by default. // Conflicts with UseImageResolvConf. // Optional. DNSSearch []string `json:"dns_search"` // DNSServers is a set of DNS servers that will be used in the // container's resolv.conf, replacing the host's DNS Servers which are // used by default. // Conflicts with UseImageResolvConf. // Optional. DNSServers []IP `json:"dns_server"` // DependencyContainers is an array of containers this container // depends on. Dependency containers must be started before this // container. Dependencies can be specified by name or full/partial ID. // Optional. DependencyContainers []string `json:"dependencyContainers"` // DeviceCgroupRule are device cgroup rules that allow containers // to use additional types of devices. DeviceCgroupRule []*LinuxDeviceCgroup `json:"device_cgroup_rule"` // Devices are devices that will be added to the container. // Optional. Devices []*LinuxDevice `json:"devices"` // DevicesFrom is a way to ensure your container inherits device specific information from another container DevicesFrom []string `json:"devices_from"` // Entrypoint is the container's entrypoint. // If not given and Image is specified, this will be populated by the // image's configuration. // Optional. Entrypoint []string `json:"entrypoint"` // Env is a set of environment variables that will be set in the // container. // Optional. Env map[string]string `json:"env,omitempty"` // EnvHost indicates that the host environment should be added to container // Optional. EnvHost bool `json:"env_host,omitempty"` // EnvSecrets are secrets that will be set as environment variables // Optional. EnvSecrets map[string]string `json:"secret_env,omitempty"` // Expose is a number of ports that will be forwarded to the container // if PublishExposedPorts is set. // Expose is a map of uint16 (port number) to a string representing // protocol i.e map[uint16]string. Allowed protocols are "tcp", "udp", and "sctp", or some // combination of the three separated by commas. // If protocol is set to "" we will assume TCP. // Only available if NetNS is set to Bridge or Slirp, and // PublishExposedPorts is set. // Optional. Expose interface{} `json:"expose,omitempty"` // Groups are a list of supplemental groups the container's user will // be granted access to. // Optional. Groups []string `json:"groups"` // EnvHTTPProxy indicates that the http host proxy environment variables // should be added to container // Optional. HTTPProxy bool `json:"httpproxy,omitempty"` // HostAdd is a set of hosts which will be added to the container's // etc/hosts file. // Conflicts with UseImageHosts. // Optional. HostAdd []string `json:"hostadd"` // HostDeviceList is used to recreate the mounted device on inherited containers HostDeviceList []*LinuxDevice `json:"host_device_list"` // HostUses is a list of host usernames or UIDs to add to the container // etc/passwd file HostUsers []string `json:"hostusers"` // Hostname is the container's hostname. If not set, the hostname will // not be modified (if UtsNS is not private) or will be set to the // container ID (if UtsNS is private). // Conflicts with UtsNS if UtsNS is not set to private. // Optional. Hostname string `json:"hostname,omitempty"` // Image is the image the container will be based on. The image will be // used as the container's root filesystem, and its environment vars, // volumes, and other configuration will be applied to the container. // Conflicts with Rootfs. // At least one of Image or Rootfs must be specified. Image string `json:"image,omitempty"` // ImageVolumeMode indicates how image volumes will be created. // Supported modes are "ignore" (do not create), "tmpfs" (create as // tmpfs), and "anonymous" (create as anonymous volumes). // The default if unset is anonymous. // Optional. ImageVolumeMode string `json:"image_volume_mode,omitempty"` // Image volumes bind-mount a container-image mount into the container. // Optional. ImageVolumes []*ImageVolume `json:"image_volumes"` // Init specifies that an init binary will be mounted into the // container, and will be used as PID1. Init bool `json:"init,omitempty"` // InitContainerType describes if this container is an init container // and if so, what type: always or once InitContainerType string `json:"init_container_type,omitempty"` // InitPath specifies the path to the init binary that will be added if // Init is specified above. If not specified, the default set in the // Libpod config will be used. Ignored if Init above is not set. // Optional. InitPath string `json:"init_path,omitempty"` // Labels are key-value pairs that are used to add metadata to // containers. // Optional. Labels map[string]string `json:"labels,omitempty"` // Mask is the path we want to mask in the container. This masks the paths // given in addition to the default list. // Optional Mask []string `json:"mask"` // Mounts are mounts that will be added to the container. // These will supersede Image Volumes and VolumesFrom volumes where // there are conflicts. // Optional. Mounts []*Mount `json:"mounts"` // Name is the name the container will be given. // If no name is provided, one will be randomly generated. // Optional. Name string `json:"name,omitempty"` // Namespace is the libpod namespace the container will be placed in. // Optional. Namespace string `json:"namespace,omitempty"` // NetworkOptions are additional options for each network // Optional. NetworkOptions map[string][]string `json:"network_options,omitempty"` // Map of networks names or ids that the container should join. // You can request additional settings for each network, you can // set network aliases, static ips, static mac address and the // network interface name for this container on the specific network. // If the map is empty and the bridge network mode is set the container // will be joined to the default network. Networks map[string]PerNetworkOptions `json:"Networks,omitempty"` // NoNewPrivileges is whether the container will set the no new // privileges flag on create, which disables gaining additional // privileges (e.g. via setuid) in the container. NoNewPrivileges bool `json:"no_new_privileges,omitempty"` // OCIRuntime is the name of the OCI runtime that will be used to create // the container. // If not specified, the default will be used. // Optional. OCIRuntime string `json:"oci_runtime,omitempty"` // OOMScoreAdj adjusts the score used by the OOM killer to determine // processes to kill for the container's process. // Optional. OOMScoreAdj int64 `json:"oom_score_adj,omitempty"` // Overlay volumes are named volumes that will be added to the container. // Optional. OverlayVolumes []*OverlayVolume `json:"overlay_volumes"` // Passwd is a container run option that determines if we are validating users/groups before running the container Passwd bool `json:"manage_password,omitempty"` // Pod is the ID of the pod the container will join. // Optional. Pod string `json:"pod,omitempty"` // PortBindings is a set of ports to map into the container. // Only available if NetNS is set to bridge or slirp. // Optional. PortMappings []*PortMapping `json:"portmappings"` // Privileged is whether the container is privileged. // Privileged does the following: // Adds all devices on the system to the container. // Adds all capabilities to the container. // Disables Seccomp, SELinux, and Apparmor confinement. // (Though SELinux can be manually re-enabled). // TODO: this conflicts with things. // TODO: this does more. Privileged bool `json:"privileged,omitempty"` // ProcOpts are the options used for the proc mount. ProcOpts []string `json:"procfs_opts"` // PublishExposedPorts will publish ports specified in the image to // random unused ports (guaranteed to be above 1024) on the host. // This is based on ports set in Expose below, and any ports specified // by the Image (if one is given). // Only available if NetNS is set to Bridge or Slirp. PublishExposedPorts bool `json:"publish_image_ports,omitempty"` // RawImageName is the user-specified and unprocessed input referring // to a local or a remote image. RawImageName string `json:"raw_image_name,omitempty"` // ReadOnlyFilesystem indicates that everything will be mounted // as read-only ReadOnlyFilesystem bool `json:"read_only_filesystem,omitempty"` // Remove indicates if the container should be removed once it has been started // and exits Remove bool `json:"remove,omitempty"` // RestartPolicy is the container's restart policy - an action which // will be taken when the container exits. // If not given, the default policy, which does nothing, will be used. // Optional. RestartPolicy string `json:"restart_policy,omitempty"` // RestartRetries is the number of attempts that will be made to restart // the container. // Only available when RestartPolicy is set to "on-failure". // Optional. RestartRetries uint64 `json:"restart_tries,omitempty"` // Rlimits are POSIX rlimits to apply to the container. // Optional. Rlimits []*POSIXRlimit `json:"r_limits"` // Rootfs is the path to a directory that will be used as the // container's root filesystem. No modification will be made to the // directory, it will be directly mounted into the container as root. // Conflicts with Image. // At least one of Image or Rootfs must be specified. Rootfs string `json:"rootfs,omitempty"` // RootfsOverlay tells if rootfs is actually an overlay on top of base path RootfsOverlay bool `json:"rootfs_overlay,omitempty"` // RootfsPropagation is the rootfs propagation mode for the container. // If not set, the default of rslave will be used. // Optional. RootfsPropagation string `json:"rootfs_propagation,omitempty"` // Determine how to handle the NOTIFY_SOCKET - do we participate or pass it through // "container" - let the OCI runtime deal with it, advertise conmon's MAINPID // "conmon-only" - advertise conmon's MAINPID, send READY when started, don't pass to OCI // "ignore" - unset NOTIFY_SOCKET SdNotifyMode string `json:"sdnotifyMode,omitempty"` // SeccompPolicy determines which seccomp profile gets applied // the container. valid values: empty,default,image SeccompPolicy string `json:"seccomp_policy,omitempty"` // SeccompProfilePath is the path to a JSON file containing the // container's Seccomp profile. // If not specified, no Seccomp profile will be used. // Optional. SeccompProfilePath string `json:"seccomp_profile_path,omitempty"` // Secrets are the secrets that will be added to the container // Optional. Secrets []*Secret `json:"secrets"` // SelinuxProcessLabel is the process label the container will use. // If SELinux is enabled and this is not specified, a label will be // automatically generated if not specified. // Optional. SelinuxOpts []string `json:"selinux_opts"` // ShmSize is the size of the tmpfs to mount in at /dev/shm, in bytes. // Conflicts with ShmSize if IpcNS is not private. // Optional. ShmSize int64 `json:"shm_size,omitempty"` // Stdin is whether the container will keep its STDIN open. Stdin bool `json:"stdin,omitempty"` // StopTimeout is a timeout between the container's stop signal being // sent and SIGKILL being sent. // If not provided, the default will be used. // If 0 is used, stop signal will not be sent, and SIGKILL will be sent // instead. // Optional. StopTimeout uint64 `json:"stop_timeout,omitempty"` // StorageOpts is the container's storage options // Optional. StorageOpts map[string]string `json:"storage_opts,omitempty"` // Sysctl sets kernel parameters for the container Sysctl map[string]string `json:"sysctl,omitempty"` // Systemd is whether the container will be started in systemd mode. // Valid options are "true", "false", and "always". // "true" enables this mode only if the binary run in the container is // sbin/init or systemd. "always" unconditionally enables systemd mode. // "false" unconditionally disables systemd mode. // If enabled, mounts and stop signal will be modified. // If set to "always" or set to "true" and conditionally triggered, // conflicts with StopSignal. // If not specified, "false" will be assumed. // Optional. Systemd string `json:"systemd,omitempty"` // Terminal is whether the container will create a PTY. // Optional. Terminal bool `json:"terminal,omitempty"` // IO read rate limit per cgroup per device, bytes per second ThrottleReadBpsDevice map[string]LinuxThrottleDevice `json:"throttleReadBpsDevice,omitempty"` // IO read rate limit per cgroup per device, IO per second ThrottleReadIOPSDevice map[string]LinuxThrottleDevice `json:"throttleReadIOPSDevice,omitempty"` // IO write rate limit per cgroup per device, bytes per second ThrottleWriteBpsDevice map[string]LinuxThrottleDevice `json:"throttleWriteBpsDevice,omitempty"` // IO write rate limit per cgroup per device, IO per second ThrottleWriteIOPSDevice map[string]LinuxThrottleDevice `json:"throttleWriteIOPSDevice,omitempty"` // Timeout is a maximum time in seconds the container will run before // main process is sent SIGKILL. // If 0 is used, signal will not be sent. Container can run indefinitely // Optional. Timeout uint64 `json:"timeout,omitempty"` // Timezone is the timezone inside the container. // Local means it has the same timezone as the host machine // Optional. Timezone string `json:"timezone,omitempty"` // Umask is the umask the init process of the container will be run with. Umask string `json:"umask,omitempty"` // Unmask is the path we want to unmask in the container. To override // all the default paths that are masked, set unmask=ALL. Unmask []string `json:"unmask"` // UnsetEnv unsets the specified default environment variables from the image or from buildin or containers.conf // Optional. UnsetEnv []string `json:"unsetenv"` // UnsetEnvAll unsetall default environment variables from the image or from buildin or containers.conf // UnsetEnvAll unsets all default environment variables from the image or from buildin // Optional. UnsetEnvAll bool `json:"unsetenvall,omitempty"` // UseImageHosts indicates that /etc/hosts should not be managed by // Podman, and instead sourced from the image. // Conflicts with HostAdd. UseImageHosts bool `json:"use_image_hosts,omitempty"` // UseImageResolvConf indicates that resolv.conf should not be managed // by Podman, but instead sourced from the image. // Conflicts with DNSServer, DNSSearch, DNSOption. UseImageResolvConf bool `json:"use_image_resolve_conf,omitempty"` // User is the user the container will be run as. // Can be given as a UID or a username; if a username, it will be // resolved within the container, using the container's /etc/passwd. // If unset, the container will be run as root. // Optional. User string `json:"user,omitempty"` // Volatile specifies whether the container storage can be optimized // at the cost of not syncing all the dirty files in memory. Volatile bool `json:"volatile,omitempty"` // Volumes are named volumes that will be added to the container. // These will supersede Image Volumes and VolumesFrom volumes where // there are conflicts. // Optional. Volumes []*NamedVolume `json:"volumes"` // VolumesFrom is a set of containers whose volumes will be added to // this container. The name or ID of the container must be provided, and // may optionally be followed by a : and then one or more // comma-separated options. Valid options are 'ro', 'rw', and 'z'. // Options will be used for all volumes sourced from the container. VolumesFrom []string `json:"volumes_from"` // Weight per cgroup per device, can override BlkioWeight WeightDevice map[string]LinuxWeightDevice `json:"weightDevice,omitempty"` // WorkDir is the container's working directory. // If unset, the default, /, will be used. // Optional. WorkDir string `json:"work_dir,omitempty"` // cgroupns Cgroupns *Namespace `json:"cgroupns,omitempty"` // healthconfig Healthconfig *Schema2HealthConfig `json:"healthconfig,omitempty"` // idmappings Idmappings *IDMappingOptions `json:"idmappings,omitempty"` // ipcns Ipcns *Namespace `json:"ipcns,omitempty"` // log configuration LogConfiguration *LogConfig `json:"log_configuration,omitempty"` // netns Netns *Namespace `json:"netns,omitempty"` // personality Personality *LinuxPersonality `json:"personality,omitempty"` // pidns Pidns *Namespace `json:"pidns,omitempty"` // resource limits ResourceLimits *LinuxResources `json:"resource_limits,omitempty"` // stop signal StopSignal Signal `json:"stop_signal,omitempty"` // userns Userns *Namespace `json:"userns,omitempty"` // utsns Utsns *Namespace `json:"utsns,omitempty"` }
SpecGenerator SpecGenerator creates an OCI spec and Libpod configuration options to create a container based on the given configuration.
swagger:model SpecGenerator
func (*SpecGenerator) ContextValidate ¶
ContextValidate validate this spec generator based on the context it is used
func (*SpecGenerator) MarshalBinary ¶
func (m *SpecGenerator) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*SpecGenerator) UnmarshalBinary ¶
func (m *SpecGenerator) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type StoreInfo ¶
type StoreInfo struct { // config file ConfigFile string `json:"configFile,omitempty"` // graph driver name GraphDriverName string `json:"graphDriverName,omitempty"` // graph options GraphOptions map[string]interface{} `json:"graphOptions,omitempty"` // graph root GraphRoot string `json:"graphRoot,omitempty"` // graph status GraphStatus map[string]string `json:"graphStatus,omitempty"` // image copy tmp dir ImageCopyTmpDir string `json:"imageCopyTmpDir,omitempty"` // run root RunRoot string `json:"runRoot,omitempty"` // volume path VolumePath string `json:"volumePath,omitempty"` // container store ContainerStore *ContainerStore `json:"containerStore,omitempty"` // image store ImageStore *ImageStore `json:"imageStore,omitempty"` }
StoreInfo StoreInfo describes the container storage and its attributes
swagger:model StoreInfo
func (*StoreInfo) ContextValidate ¶
ContextValidate validate this store info based on the context it is used
func (*StoreInfo) MarshalBinary ¶
MarshalBinary interface implementation
func (*StoreInfo) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type StrSlice ¶
type StrSlice []string
StrSlice StrSlice represents a string or an array of strings.
We need to override the json decoder to accept both options.
swagger:model StrSlice
func (StrSlice) ContextValidate ¶
ContextValidate validates this str slice based on context it is used
type Subnet ¶
type Subnet struct { // Gateway IP for this Network. Gateway string `json:"gateway,omitempty"` // Subnet for this Network in CIDR form. Subnet string `json:"subnet,omitempty"` // lease range LeaseRange *LeaseRange `json:"lease_range,omitempty"` }
Subnet subnet
swagger:model Subnet
func (*Subnet) ContextValidate ¶
ContextValidate validate this subnet based on the context it is used
func (*Subnet) MarshalBinary ¶
MarshalBinary interface implementation
func (*Subnet) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type SwagCompatNetworkConnectRequest ¶
type SwagCompatNetworkConnectRequest struct { // container Container string `json:"Container,omitempty"` // endpoint config EndpointConfig *EndpointSettings `json:"EndpointConfig,omitempty"` }
SwagCompatNetworkConnectRequest Network disconnect
swagger:model swagCompatNetworkConnectRequest
func (*SwagCompatNetworkConnectRequest) ContextValidate ¶
func (m *SwagCompatNetworkConnectRequest) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validate this swag compat network connect request based on the context it is used
func (*SwagCompatNetworkConnectRequest) MarshalBinary ¶
func (m *SwagCompatNetworkConnectRequest) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*SwagCompatNetworkConnectRequest) UnmarshalBinary ¶
func (m *SwagCompatNetworkConnectRequest) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type SwagCompatNetworkDisconnectRequest ¶
type SwagCompatNetworkDisconnectRequest struct { // container Container string `json:"Container,omitempty"` // force Force bool `json:"Force,omitempty"` }
SwagCompatNetworkDisconnectRequest Network disconnect
swagger:model swagCompatNetworkDisconnectRequest
func (*SwagCompatNetworkDisconnectRequest) ContextValidate ¶
func (m *SwagCompatNetworkDisconnectRequest) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validates this swag compat network disconnect request based on context it is used
func (*SwagCompatNetworkDisconnectRequest) MarshalBinary ¶
func (m *SwagCompatNetworkDisconnectRequest) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*SwagCompatNetworkDisconnectRequest) UnmarshalBinary ¶
func (m *SwagCompatNetworkDisconnectRequest) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type SwagNetworkConnectRequest ¶
type SwagNetworkConnectRequest struct { // Aliases contains a list of names which the dns server should resolve // to this container. Should only be set when DNSEnabled is true on the Network. // If aliases are set but there is no dns support for this network the // network interface implementation should ignore this and NOT error. // Optional. Aliases []string `json:"aliases"` // container Container string `json:"container,omitempty"` // InterfaceName for this container. Required in the backend. // Optional in the frontend. Will be filled with ethX (where X is a integer) when empty. InterfaceName string `json:"interface_name,omitempty"` // StaticIPs for this container. Optional. StaticIPs []IP `json:"static_ips"` // static mac StaticMac MacAddress `json:"static_mac,omitempty"` }
SwagNetworkConnectRequest Network connect
swagger:model swagNetworkConnectRequest
func (*SwagNetworkConnectRequest) ContextValidate ¶
func (m *SwagNetworkConnectRequest) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validate this swag network connect request based on the context it is used
func (*SwagNetworkConnectRequest) MarshalBinary ¶
func (m *SwagNetworkConnectRequest) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*SwagNetworkConnectRequest) UnmarshalBinary ¶
func (m *SwagNetworkConnectRequest) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type SwagNetworkCreateLibpod ¶
type SwagNetworkCreateLibpod struct { // Created contains the timestamp when this network was created. // Format: date-time Created strfmt.DateTime `json:"created,omitempty"` // DNSEnabled is whether name resolution is active for container on // this Network. DNSEnabled bool `json:"dns_enabled,omitempty"` // Driver for this Network, e.g. bridge, macvlan... Driver string `json:"driver,omitempty"` // ID of the Network. ID string `json:"id,omitempty"` // IPAMOptions contains options used for the ip assignment. IPAMOptions map[string]string `json:"ipam_options,omitempty"` // IPv6Enabled if set to true an ipv6 subnet should be created for this net. IPV6Enabled bool `json:"ipv6_enabled,omitempty"` // Internal is whether the Network should not have external routes // to public or other Networks. Internal bool `json:"internal,omitempty"` // Labels is a set of key-value labels that have been applied to the // Network. Labels map[string]string `json:"labels,omitempty"` // Name of the Network. Name string `json:"name,omitempty"` // NetworkInterface is the network interface name on the host. NetworkInterface string `json:"network_interface,omitempty"` // Options is a set of key-value options that have been applied to // the Network. Options map[string]string `json:"options,omitempty"` // Subnets to use for this network. Subnets []*Subnet `json:"subnets"` }
SwagNetworkCreateLibpod Network create
swagger:model swagNetworkCreateLibpod
func (*SwagNetworkCreateLibpod) ContextValidate ¶
func (m *SwagNetworkCreateLibpod) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validate this swag network create libpod based on the context it is used
func (*SwagNetworkCreateLibpod) MarshalBinary ¶
func (m *SwagNetworkCreateLibpod) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*SwagNetworkCreateLibpod) UnmarshalBinary ¶
func (m *SwagNetworkCreateLibpod) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type SystemDfContainerReport ¶
type SystemDfContainerReport struct { // command Command []string `json:"Command"` // container ID ContainerID string `json:"ContainerID,omitempty"` // created // Format: date-time Created strfmt.DateTime `json:"Created,omitempty"` // image Image string `json:"Image,omitempty"` // local volumes LocalVolumes int64 `json:"LocalVolumes,omitempty"` // names Names string `json:"Names,omitempty"` // r w size RWSize int64 `json:"RWSize,omitempty"` // size Size int64 `json:"Size,omitempty"` // status Status string `json:"Status,omitempty"` }
SystemDfContainerReport SystemDfContainerReport describes a container for use with df
swagger:model SystemDfContainerReport
func (*SystemDfContainerReport) ContextValidate ¶
func (m *SystemDfContainerReport) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validates this system df container report based on context it is used
func (*SystemDfContainerReport) MarshalBinary ¶
func (m *SystemDfContainerReport) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*SystemDfContainerReport) UnmarshalBinary ¶
func (m *SystemDfContainerReport) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type SystemDfImageReport ¶
type SystemDfImageReport struct { // containers Containers int64 `json:"Containers,omitempty"` // created // Format: date-time Created strfmt.DateTime `json:"Created,omitempty"` // image ID ImageID string `json:"ImageID,omitempty"` // repository Repository string `json:"Repository,omitempty"` SharedSize int64 `json:"SharedSize,omitempty"` // size Size int64 `json:"Size,omitempty"` // tag Tag string `json:"Tag,omitempty"` // unique size UniqueSize int64 `json:"UniqueSize,omitempty"` }
SystemDfImageReport SystemDfImageReport describes an image for use with df
swagger:model SystemDfImageReport
func (*SystemDfImageReport) ContextValidate ¶
ContextValidate validates this system df image report based on context it is used
func (*SystemDfImageReport) MarshalBinary ¶
func (m *SystemDfImageReport) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*SystemDfImageReport) UnmarshalBinary ¶
func (m *SystemDfImageReport) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type SystemDfVolumeReport ¶
type SystemDfVolumeReport struct { // links Links int64 `json:"Links,omitempty"` // reclaimable size ReclaimableSize int64 `json:"ReclaimableSize,omitempty"` // size Size int64 `json:"Size,omitempty"` // volume name VolumeName string `json:"VolumeName,omitempty"` }
SystemDfVolumeReport SystemDfVolumeReport describes a volume and its size
swagger:model SystemDfVolumeReport
func (*SystemDfVolumeReport) ContextValidate ¶
ContextValidate validates this system df volume report based on context it is used
func (*SystemDfVolumeReport) MarshalBinary ¶
func (m *SystemDfVolumeReport) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*SystemDfVolumeReport) UnmarshalBinary ¶
func (m *SystemDfVolumeReport) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Task ¶
type Task struct { // endpoint ID EndpointID string `json:"EndpointID,omitempty"` // endpoint IP EndpointIP string `json:"EndpointIP,omitempty"` // info Info map[string]string `json:"Info,omitempty"` // name Name string `json:"Name,omitempty"` }
Task Task carries the information about one backend task
swagger:model Task
func (*Task) ContextValidate ¶
ContextValidate validates this task based on context it is used
func (*Task) MarshalBinary ¶
MarshalBinary interface implementation
func (*Task) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type ThrottleDevice ¶
type ThrottleDevice struct { // path Path string `json:"Path,omitempty"` // rate Rate uint64 `json:"Rate,omitempty"` }
ThrottleDevice ThrottleDevice is a structure that holds device:rate_per_second pair
swagger:model ThrottleDevice
func (*ThrottleDevice) ContextValidate ¶
ContextValidate validates this throttle device based on context it is used
func (*ThrottleDevice) MarshalBinary ¶
func (m *ThrottleDevice) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ThrottleDevice) UnmarshalBinary ¶
func (m *ThrottleDevice) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type TmpfsOptions ¶
type TmpfsOptions struct { // mode Mode FileMode `json:"Mode,omitempty"` // Size sets the size of the tmpfs, in bytes. // // This will be converted to an operating system specific value // depending on the host. For example, on linux, it will be converted to // use a 'k', 'm' or 'g' syntax. BSD, though not widely supported with // docker, uses a straight byte value. // // Percentages are not supported. SizeBytes int64 `json:"SizeBytes,omitempty"` }
TmpfsOptions TmpfsOptions defines options specific to mounts of type "tmpfs".
swagger:model TmpfsOptions
func (*TmpfsOptions) ContextValidate ¶
ContextValidate validate this tmpfs options based on the context it is used
func (*TmpfsOptions) MarshalBinary ¶
func (m *TmpfsOptions) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*TmpfsOptions) UnmarshalBinary ¶
func (m *TmpfsOptions) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Type ¶
type Type string
Type Type represents the type of a mount.
swagger:model Type
func (Type) ContextValidate ¶
ContextValidate validates this type based on context it is used
type UTSMode ¶
type UTSMode string
UTSMode UTSMode represents the UTS namespace of the container.
swagger:model UTSMode
func (UTSMode) ContextValidate ¶
ContextValidate validates this u t s mode based on context it is used
type Ulimit ¶
type Ulimit struct { // hard Hard int64 `json:"Hard,omitempty"` // name Name string `json:"Name,omitempty"` // soft Soft int64 `json:"Soft,omitempty"` }
Ulimit Ulimit is a human friendly version of Rlimit.
swagger:model Ulimit
func (*Ulimit) ContextValidate ¶
ContextValidate validates this ulimit based on context it is used
func (*Ulimit) MarshalBinary ¶
MarshalBinary interface implementation
func (*Ulimit) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type UsernsMode ¶
type UsernsMode string
UsernsMode UsernsMode represents userns mode in the container.
swagger:model UsernsMode
func (UsernsMode) ContextValidate ¶
ContextValidate validates this userns mode based on context it is used
type Version ¶
type Version struct { // API version APIVersion string `json:"APIVersion,omitempty"` // built Built int64 `json:"Built,omitempty"` // built time BuiltTime string `json:"BuiltTime,omitempty"` // git commit GitCommit string `json:"GitCommit,omitempty"` // go version GoVersion string `json:"GoVersion,omitempty"` // os arch OsArch string `json:"OsArch,omitempty"` // version Version string `json:"Version,omitempty"` }
Version Version is an output struct for API
swagger:model Version
func (*Version) ContextValidate ¶
ContextValidate validates this version based on context it is used
func (*Version) MarshalBinary ¶
MarshalBinary interface implementation
func (*Version) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type Volume ¶
type Volume struct { // Date/Time the volume was created. CreatedAt string `json:"CreatedAt,omitempty"` // Name of the volume driver used by the volume. // Required: true Driver *string `json:"Driver"` // User-defined key/value metadata. // Required: true Labels map[string]string `json:"Labels"` // Mount path of the volume on the host. // Required: true Mountpoint *string `json:"Mountpoint"` // Name of the volume. // Required: true Name *string `json:"Name"` // The driver specific options used when creating the volume. // Required: true Options map[string]string `json:"Options"` // The level at which the volume exists. Either `global` for cluster-wide, // or `local` for machine level. // Required: true Scope *string `json:"Scope"` // Low-level details about the volume, provided by the volume driver. // Details are returned as a map with key/value pairs: // `{"key":"value","key2":"value2"}`. // // The `Status` field is optional, and is omitted if the volume driver // does not support this feature. Status map[string]interface{} `json:"Status,omitempty"` // usage data UsageData *VolumeUsageData `json:"UsageData,omitempty"` }
Volume Volume volume
swagger:model volume
func (*Volume) ContextValidate ¶
ContextValidate validate this volume based on the context it is used
func (*Volume) MarshalBinary ¶
MarshalBinary interface implementation
func (*Volume) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type VolumeConfigResponse ¶
type VolumeConfigResponse struct { // Anonymous indicates that the volume was created as an anonymous // volume for a specific container, and will be be removed when any // container using it is removed. Anonymous bool `json:"Anonymous,omitempty"` // CreatedAt is the date and time the volume was created at. This is not // stored for older Libpod volumes; if so, it will be omitted. // Format: date-time CreatedAt strfmt.DateTime `json:"CreatedAt,omitempty"` // Driver is the driver used to create the volume. // If set to "local" or "", the Local driver (Podman built-in code) is // used to service the volume; otherwise, a volume plugin with the given // name is used to mount and manage the volume. Driver string `json:"Driver,omitempty"` // GID is the GID that the volume was created with. GID int64 `json:"GID,omitempty"` // Labels includes the volume's configured labels, key:value pairs that // can be passed during volume creation to provide information for third // party tools. Labels map[string]string `json:"Labels,omitempty"` // MountCount is the number of times this volume has been mounted. MountCount uint64 `json:"MountCount,omitempty"` // Mountpoint is the path on the host where the volume is mounted. Mountpoint string `json:"Mountpoint,omitempty"` // Name is the name of the volume. Name string `json:"Name,omitempty"` // NeedsChown indicates that the next time the volume is mounted into // a container, the container will chown the volume to the container process // UID/GID. NeedsChown bool `json:"NeedsChown,omitempty"` // NeedsCopyUp indicates that the next time the volume is mounted into NeedsCopyUp bool `json:"NeedsCopyUp,omitempty"` // Options is a set of options that were used when creating the volume. // For the Local driver, these are mount options that will be used to // determine how a local filesystem is mounted; they are handled as // parameters to Mount in a manner described in the volume create // manpage. // For non-local drivers, these are passed as-is to the volume plugin. Options map[string]string `json:"Options,omitempty"` // Scope is unused and provided solely for Docker compatibility. It is // unconditionally set to "local". Scope string `json:"Scope,omitempty"` // Status is used to return information on the volume's current state, // if the volume was created using a volume plugin (uses a Driver that // is not the local driver). // Status is provided to us by an external program, so no guarantees are // made about its format or contents. Further, it is an optional field, // so it may not be set even in cases where a volume plugin is in use. Status map[string]interface{} `json:"Status,omitempty"` // UID is the UID that the volume was created with. UID int64 `json:"UID,omitempty"` }
VolumeConfigResponse volume config response
swagger:model VolumeConfigResponse
func (*VolumeConfigResponse) ContextValidate ¶
ContextValidate validates this volume config response based on context it is used
func (*VolumeConfigResponse) MarshalBinary ¶
func (m *VolumeConfigResponse) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*VolumeConfigResponse) UnmarshalBinary ¶
func (m *VolumeConfigResponse) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type VolumeCreateBody ¶
type VolumeCreateBody struct { // Name of the volume driver to use. // Required: true Driver *string `json:"Driver"` // A mapping of driver options and values. These options are // passed directly to the driver and are driver specific. // Required: true DriverOpts map[string]string `json:"DriverOpts"` // User-defined key/value metadata. // Required: true Labels map[string]string `json:"Labels"` // The new volume's name. If not specified, Docker generates a name. // Required: true Name *string `json:"Name"` }
VolumeCreateBody VolumeCreateBody Volume configuration
swagger:model VolumeCreateBody
func (*VolumeCreateBody) ContextValidate ¶
ContextValidate validates this volume create body based on context it is used
func (*VolumeCreateBody) MarshalBinary ¶
func (m *VolumeCreateBody) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*VolumeCreateBody) UnmarshalBinary ¶
func (m *VolumeCreateBody) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type VolumeCreateOptions ¶
type VolumeCreateOptions struct { // Volume driver to use Driver string `json:"Driver,omitempty"` // User-defined key/value metadata. Provided for compatibility Label map[string]string `json:"Label,omitempty"` // User-defined key/value metadata. Preferred field, will override Label Labels map[string]string `json:"Labels,omitempty"` // New volume's name. Can be left blank Name string `json:"Name,omitempty"` // Mapping of driver options and values. Options map[string]string `json:"Options,omitempty"` }
VolumeCreateOptions volume create options
swagger:model VolumeCreateOptions
func (*VolumeCreateOptions) ContextValidate ¶
ContextValidate validates this volume create options based on context it is used
func (*VolumeCreateOptions) MarshalBinary ¶
func (m *VolumeCreateOptions) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*VolumeCreateOptions) UnmarshalBinary ¶
func (m *VolumeCreateOptions) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type VolumeListBody ¶
type VolumeListBody struct { // volumes Volumes []*VolumeListOKBody `json:"Volumes"` }
VolumeListBody VolumeListBody Volume list response
swagger:model VolumeListBody
func (*VolumeListBody) ContextValidate ¶
ContextValidate validate this volume list body based on the context it is used
func (*VolumeListBody) MarshalBinary ¶
func (m *VolumeListBody) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*VolumeListBody) UnmarshalBinary ¶
func (m *VolumeListBody) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type VolumeListOKBody ¶
type VolumeListOKBody struct { // List of volumes // Required: true Volumes []*Volume `json:"Volumes"` // Warnings that occurred when fetching the list of volumes. // Required: true Warnings []string `json:"Warnings"` }
VolumeListOKBody VolumeListOKBody Volume list response
swagger:model VolumeListOKBody
func (*VolumeListOKBody) ContextValidate ¶
ContextValidate validate this volume list o k body based on the context it is used
func (*VolumeListOKBody) MarshalBinary ¶
func (m *VolumeListOKBody) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*VolumeListOKBody) UnmarshalBinary ¶
func (m *VolumeListOKBody) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type VolumeOptions ¶
type VolumeOptions struct { // driver config DriverConfig *Driver `json:"DriverConfig,omitempty"` // labels Labels map[string]string `json:"Labels,omitempty"` // no copy NoCopy bool `json:"NoCopy,omitempty"` }
VolumeOptions VolumeOptions represents the options for a mount of type volume.
swagger:model VolumeOptions
func (*VolumeOptions) ContextValidate ¶
ContextValidate validate this volume options based on the context it is used
func (*VolumeOptions) MarshalBinary ¶
func (m *VolumeOptions) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*VolumeOptions) UnmarshalBinary ¶
func (m *VolumeOptions) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type VolumeUsageData ¶
type VolumeUsageData struct { // The number of containers referencing this volume. This field // is set to `-1` if the reference-count is not available. // Required: true RefCount *int64 `json:"RefCount"` // Amount of disk space used by the volume (in bytes). This information // is only available for volumes created with the `"local"` volume // driver. For volumes created with other volume drivers, this field // is set to `-1` ("not available") // Required: true Size *int64 `json:"Size"` }
VolumeUsageData VolumeUsageData Usage details about the volume. This information is used by the `GET /system/df` endpoint, and omitted in other endpoints.
swagger:model VolumeUsageData
func (*VolumeUsageData) ContextValidate ¶
ContextValidate validates this volume usage data based on context it is used
func (*VolumeUsageData) MarshalBinary ¶
func (m *VolumeUsageData) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*VolumeUsageData) UnmarshalBinary ¶
func (m *VolumeUsageData) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type WeightDevice ¶
type WeightDevice struct { // path Path string `json:"Path,omitempty"` // weight Weight uint16 `json:"Weight,omitempty"` }
WeightDevice WeightDevice is a structure that holds device:weight pair
swagger:model WeightDevice
func (*WeightDevice) ContextValidate ¶
ContextValidate validates this weight device based on context it is used
func (*WeightDevice) MarshalBinary ¶
func (m *WeightDevice) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*WeightDevice) UnmarshalBinary ¶
func (m *WeightDevice) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
Source Files ¶
- address.go
- auth_config.go
- authenticate_o_k_body.go
- auto_user_ns_options.go
- bind_options.go
- cgroup_spec.go
- cgroupns_mode.go
- component_version.go
- config.go
- config_reference.go
- conmon_info.go
- consistency.go
- container_basic_config.go
- container_cgroup_config.go
- container_change_response_item.go
- container_create_created_body.go
- container_health_check_config.go
- container_network_config.go
- container_node.go
- container_resource_config.go
- container_security_config.go
- container_size.go
- container_state.go
- container_storage_config.go
- container_store.go
- container_top_o_k_body.go
- container_update_o_k_body.go
- container_wait_o_k_body.go
- container_wait_o_k_body_error.go
- containers_prune_report.go
- create_container_config.go
- device_mapping.go
- device_request.go
- digest.go
- distribution_info.go
- docker_volume_create.go
- driver.go
- driver_data.go
- duration.go
- endpoint_ip_a_m_config.go
- endpoint_resource.go
- endpoint_settings.go
- error_response.go
- file_mode.go
- graph_driver_data.go
- hardware_addr.go
- health.go
- health_check_log.go
- health_check_results.go
- health_config.go
- healthcheck_result.go
- history.go
- history_response_item.go
- host_config.go
- host_info.go
- id_map.go
- id_mapping_options.go
- id_mappings.go
- id_response.go
- image_config.go
- image_delete_response_item.go
- image_import_report.go
- image_load_report.go
- image_metadata.go
- image_store.go
- image_summary.go
- image_volume.go
- info.go
- inspect_additional_network.go
- inspect_blkio_throttle_device.go
- inspect_blkio_weight_device.go
- inspect_container_config.go
- inspect_container_host_config.go
- inspect_container_state.go
- inspect_device.go
- inspect_host_port.go
- inspect_id_mappings.go
- inspect_log_config.go
- inspect_mount.go
- inspect_network_settings.go
- inspect_pod_container_info.go
- inspect_pod_infra_config.go
- inspect_restart_policy.go
- inspect_secret.go
- inspect_ulimit.go
- ip.go
- ip_a_m.go
- ip_a_m_config.go
- ip_mask.go
- ip_net.go
- ipc_mode.go
- isolation.go
- lease_range.go
- libpod_containers_prune_report.go
- libpod_containers_rm_report.go
- libpod_image_summary.go
- libpod_images_pull_report.go
- libpod_images_remove_report.go
- linux_block_i_o.go
- linux_block_i_o_device.go
- linux_cpu.go
- linux_device.go
- linux_device_cgroup.go
- linux_hugepage_limit.go
- linux_interface_priority.go
- linux_memory.go
- linux_network.go
- linux_personality.go
- linux_personality_domain.go
- linux_personality_flag.go
- linux_pids.go
- linux_rdma.go
- linux_resources.go
- linux_throttle_device.go
- linux_weight_device.go
- list_container.go
- list_container_namespaces.go
- list_pod_container.go
- list_pods_report.go
- log_config.go
- mac_address.go
- manifest_add_options.go
- manifest_annotate_options.go
- manifest_modify_options.go
- manifest_modify_report.go
- manifest_remove_options.go
- mount.go
- mount_point.go
- named_volume.go
- namespace.go
- namespace_mode.go
- net_options.go
- network.go
- network_connect.go
- network_connect_options.go
- network_create.go
- network_create_request.go
- network_disconnect.go
- network_mode.go
- network_prune_report.go
- network_resource.go
- network_rm_report.go
- network_settings.go
- networking_config.go
- o_c_i_runtime_info.go
- overlay_volume.go
- p_o_s_i_x_rlimit.go
- peer_info.go
- per_network_options.go
- pid_mode.go
- play_kube_pod.go
- play_kube_report.go
- play_kube_volume.go
- plugin.go
- plugin_config.go
- plugin_config_args.go
- plugin_config_interface.go
- plugin_config_linux_swagger.go
- plugin_config_network.go
- plugin_config_rootfs.go
- plugin_config_user.go
- plugin_device.go
- plugin_env.go
- plugin_interface_type.go
- plugin_mount.go
- plugin_settings.go
- plugins.go
- pod_basic_config.go
- pod_cgroup_config.go
- pod_create_config.go
- pod_create_options.go
- pod_kill_report.go
- pod_network_config.go
- pod_pause_report.go
- pod_prune_report.go
- pod_resource_config.go
- pod_restart_report.go
- pod_rm_report.go
- pod_security_config.go
- pod_spec_generator.go
- pod_start_report.go
- pod_stop_report.go
- pod_storage_config.go
- pod_unpause_report.go
- port.go
- port_binding.go
- port_map.go
- port_mapping.go
- port_set.go
- propagation.go
- prune_report.go
- remote_socket.go
- resources.go
- restart_policy.go
- root_f_s.go
- schema2_health_config.go
- schema2_list.go
- schema2_manifest_descriptor.go
- schema2_platform_spec.go
- secret.go
- secret_create_request.go
- secret_driver_spec.go
- secret_info_report.go
- secret_info_report_compat.go
- secret_spec.go
- secret_version.go
- security_info.go
- service_info.go
- service_update_response.go
- signal.go
- slirp_info.go
- spec_generator.go
- store_info.go
- str_slice.go
- subnet.go
- swag_compat_network_connect_request.go
- swag_compat_network_disconnect_request.go
- swag_network_connect_request.go
- swag_network_create_libpod.go
- system_df_container_report.go
- system_df_image_report.go
- system_df_volume_report.go
- task.go
- throttle_device.go
- tmpfs_options.go
- type.go
- u_t_s_mode.go
- ulimit.go
- userns_mode.go
- version.go
- volume.go
- volume_config_response.go
- volume_create_body.go
- volume_create_options.go
- volume_list_body.go
- volume_list_o_k_body.go
- volume_options.go
- volume_usage_data.go
- weight_device.go