Available on crate feature
v5 only.Structs§
- Access
Mode - AccessMode defines the access mode of a volume.
- Address
- Address represents an IP address.
- Auth
Config - AuthConfig contains authorization information for connecting to a Registry
- Auth
Report - AuthReport describes the response for authentication check
- Authenticate
OkBody - AuthenticateOKBody authenticate o k body
- Auto
User NsOptions - AutoUserNsOptions defines how to automatically create a user namespace.
- Bind
Options - BindOptions defines options specific to mounts of type “bind”.
- Capacity
Range - CapacityRange describes the minimum and maximum capacity a volume should be created with
- Cluster
Volume - ClusterVolume contains options and information specific to, and only present on, Swarm CSI cluster volumes.
- Cluster
Volume Spec - ClusterVolumeSpec contains the spec used to create this volume.
- Component
Version - ComponentVersion describes the version information for a specific component.
- 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
omitemptyto keep getting predictable hashes from the oldv1Compatibilityconfiguration. - Config
Reference - ConfigReference specifies the source which provides a network’s configuration
- Conmon
Info - ConmonInfo describes the conmon executable being used
- Container
- Container
Basic Config - ContainerBasicConfig contains the basic parts of a container.
- Container
Cgroup Config - ContainerCgroupConfig contains configuration information about a container’s cgroups.
- Container
Create Response - ContainerCreateResponse is the response struct for creating a container
- Container
Exec201 - Container
Exec Body - Container
Exec Libpod201 - Container
Exec Libpod Body - Container
Health Check Config - ContainerHealthCheckConfig describes a container healthcheck with attributes like command, retries, interval, start period, and timeout.
- Container
Json - ContainerJSON is newly used struct along with MountPoint
- Container
Network Config - ContainerNetworkConfig contains information on a container’s network configuration.
- Container
Network Stats - Statistics for an individual container network interface
- Container
Node - ContainerNode stores information about the node that a container is running on. It’s only used by the Docker Swarm standalone API
- Container
Resource Config - ContainerResourceConfig contains information on container resource limits.
- Container
Security Config - ContainerSecurityConfig is a container’s security features, including SELinux, Apparmor, and Seccomp.
- Container
Size - ContainerSize holds the size of the container’s root filesystem and top read-write layer.
- Container
State - ContainerState stores container’s running state it’s part of ContainerJSONBase and will return by “inspect” command
- Container
Stats - ContainerStats contains the statistics information for a running container
- Container
Storage Config - ContainerStorageConfig contains information on the storage configuration of a container.
- Container
Store - ContainerStore describes the quantity of containers in the store by status
- Container
TopOk Body - ContainerTopOKBody OK response to ContainerTop operation
- Container
Update OkBody - ContainerUpdateOKBody OK response to ContainerUpdate operation
- Container
Wait Response - Container
Wait Response Error - Containers
Prune Report - Containers
Prune Report Libpod - CpuUsage
- Create
Container Config - CreateContainerConfig used when compatible endpoint creates a container
- Create
Options - CreateOptions VolumeConfig Volume configuration
- Create
Response - CreateResponse ContainerCreateResponse OK response to ContainerCreate operation
- Delete
Response - DeleteResponse delete response
- Device
Mapping - DeviceMapping represents the device mapping between the host and the container.
- Device
Request - DeviceRequest represents a request for devices from a device driver. Used by GPU device drivers.
- Distribution
Info - DistributionInfo describes the host distribution for libpod
- DnsNetwork
Info - NetworkInfo contains the DNS information.
- Driver
- Driver represents a volume driver.
- Driver
Data - DriverData handles the data for a storage driver
- Endpoint
Ipam Config - EndpointIPAMConfig represents IPAM configurations for the endpoint
- Endpoint
Resource - EndpointResource contains network resources allocated and used for a container in a network
- Endpoint
Settings - EndpointSettings stores the network endpoint details
- Error
Model - ErrorModel is used in remote connections with podman
- Error
Response - ErrorResponse Represents an error.
- Exec
Start Body - Exec
Start Libpod Body - Filesystem
Change - FilesystemChange Change in the container’s filesystem.
- Graph
Driver Data - GraphDriverData Information about the storage driver used to store the container’s and image’s filesystem.
- Health
- Health stores information about the container’s healthcheck results
- Health
Check Log - HealthCheckLog describes the results of a single healthcheck
- Health
Check Results - HealthCheckResults describes the results/logs from a healthcheck
- Healthcheck
Config - HealthcheckConfig holds configuration settings for the HEALTHCHECK feature.
- Healthcheck
Result - HealthcheckResult stores information about a single run of a healthcheck probe
- History
- History describes the history of a layer.
- History
Response - HistoryResponse provides details on image layers
- History
Response Item - HistoryResponseItem individual image layer information in response to ImageHistory operation
- Host
Config - 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.
- Host
Info - HostInfo describes the libpod host
- 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.
- IdMapping
Options - IDMappingOptions are used for specifying how ID mapping should be set up for a layer or container.
- IdMappings
- IDMappings describe the GID and UID mappings
- IdResponse
- IDResponse Response to an API call that returns just an Id
- Image
Build200 - Image
Build Libpod200 - Image
Config - ImageConfig defines the execution parameters which should be used as a base when running a container using an image.
- Image
Data - ImageData holds the inspect information of an image.
- Image
Delete Response Items - Image
Import Report - Image
Inspect - Image
Load Report - Image
Store - ImageStore describes the image store. Right now only the number of images present
- Image
Tree Report - Image
Volume - 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.
- Info
- Info contains information about the Volume as a whole as provided by the CSI storage plugin.
- Inspect
Additional Network - InspectAdditionalNetwork holds information about non-default networks the container has been connected to. As with InspectNetworkSettings, many fields are unused and maintained only for compatibility with Docker.
- Inspect
Blkio Throttle Device - 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.
- Inspect
Blkio Weight Device - 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.
- Inspect
Container Config - InspectContainerConfig holds further data about how a container was initially configured.
- Inspect
Container Data - InspectContainerData provides a detailed record of a container’s configuration
and state as viewed by Libpod.
Large portions of this structure are defined such that the output is
compatible with
docker inspectJSON, but additional fields have been added as required to share information not in the original output. - Inspect
Container Host Config - 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). nolint:revive,stylecheck // Field names are fixed for compatibility and cannot be changed.
- Inspect
Container State - 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).
- Inspect
Device - InspectDevice is a single device that will be mounted into the container.
- Inspect
Exec Process - InspectExecProcess contains information about the process in a given exec session.
- Inspect
Exec Session - InspectExecSession contains information about a given exec session.
- Inspect
Host Port - InspectHostPort provides information on a port on the host that a container’s port is bound to.
- Inspect
IdMappings - Inspect
LogConfig - InspectLogConfig holds information about a container’s configured log driver
- Inspect
Mount - 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.
- Inspect
Network Settings - InspectNetworkSettings holds information about the network settings of the
container.
Many fields are maintained only for compatibility with
docker inspectand are unused within Libpod. - Inspect
PodContainer Info - InspectPodContainerInfo contains information on a container in a pod.
- Inspect
PodData - InspectPodData contains detailed information on a pod’s configuration and state. It is used as the output of Inspect on pods.
- Inspect
PodInfra Config - InspectPodInfraConfig contains the configuration of the pod’s infra container.
- Inspect
Restart Policy - InspectRestartPolicy holds information about the container’s restart policy.
- Inspect
Secret - InspectSecret contains information on secrets mounted inside the container
- Inspect
Ulimit - InspectUlimit is a ulimit that will be applied to the container.
- IpNet
- An IPNet represents an IP network.
- Ipam
- IPAM represents IP Address Management
- Ipam
Config - IPAMConfig represents IPAM configurations
- Lease
Range - LeaseRange contains the range where IP are leased.
- Libpod
Containers RmReport - Libpod
Image Summary - Libpod
Images Pull Report - Libpod
Images Remove Report - LibpodImagesRemoveReport is the return type for image removal via the rest api.
- Libpod
Info - Info is the overall struct that describes the host system running libpod/podman
- Linux
Block Io - LinuxBlockIO for Linux cgroup ‘blkio’ resource management
- Linux
Block IoDevice - LinuxBlockIODevice holds major:minor format supported in blkio cgroup
- Linux
Cpu - LinuxCPU for Linux cgroup ‘cpu’ resource management
- Linux
Device - LinuxDevice represents the mknod information for a Linux special device file
- Linux
Device Cgroup - LinuxDeviceCgroup represents a device rule for the devices specified to the device controller
- Linux
Hugepage Limit - LinuxHugepageLimit structure corresponds to limiting kernel hugepages. Default to reservation limits if supported. Otherwise fallback to page fault limits.
- Linux
IdMapping - LinuxIDMapping specifies UID/GID mappings
- Linux
Intel Rdt - LinuxIntelRdt has container runtime resource constraints for Intel RDT CAT and MBA features and flags enabling Intel RDT CMT and MBM features. Intel RDT features are available in Linux 4.14 and newer kernel versions.
- Linux
Interface Priority - LinuxInterfacePriority for network interfaces
- Linux
Memory - LinuxMemory for Linux cgroup ‘memory’ resource management
- Linux
Network - LinuxNetwork identification and priority configuration
- Linux
Personality - LinuxPersonality represents the Linux personality syscall input
- Linux
Pids - LinuxPids for Linux cgroup ‘pids’ resource management (Linux 4.3)
- Linux
Rdma - LinuxRdma for Linux cgroup ‘rdma’ resource management (Linux 4.11)
- Linux
Resources - LinuxResources has container runtime resource constraints
- Linux
Throttle Device - LinuxThrottleDevice struct holds a
major:minor rate_per_secondpair - Linux
Weight Device - LinuxWeightDevice struct holds a
major:minor weightpair for weightDevice - List
Container - ListContainer describes a container suitable for listing
- List
Container Namespaces - ListContainerNamespaces contains the identifiers of the container’s Linux namespaces
- List
PodContainer - List
Pods Report - List
Response - ListResponse VolumeListResponse Volume list response
- LogConfig
- LogConfig represents the logging configuration of the container.
- LogConfig
Libpod - LogConfig describes the logging characteristics for a container
- Manifest
AddArtifact Options - ManifestAddArtifactOptions provides the model for creating artifact manifests for files and adding those manifests to a manifest list
- Manifest
AddOptions - ManifestAddOptions provides model for adding digests to manifest list
- Manifest
Annotate Options - ManifestAnnotateOptions provides model for annotating manifest list
- Manifest
Modify Options - ManifestModifyOptions provides the model for mutating a manifest swagger 2.0 does not support oneOf for schema validation.
- Manifest
Modify Report - Manifest
Push Report - Manifest
Remove Report - Meta
- Meta is a base object inherited by most of the other once.
- Metadata
- Metadata contains engine-local data about the image.
- Mount
- Mount represents a mount (volume).
- Mount
Point - MountPoint represents a mount point configuration inside the container. This is used for reporting the mountpoints in use by a container.
- Named
Volume - NamedVolume holds information about a named volume that will be mounted into the container.
- Namespace
- Namespace describes the namespace
- NetAddress
- NetAddress contains the ip address, subnet and gateway.
- NetInterface
- NetInterface contains the settings for a given network interface.
- NetOptions
- NetOptions reflect the shared network options between pods and containers
- Network
- Network describes the Network attributes.
- Network
Connect - NetworkConnect represents the data to be used to connect a container to the network
- Network
Connect Options - NetworkConnectOptions describes options for connecting a container to a network
- Network
Container Info - Network
Create - NetworkCreate is the expected body of the “create network” http request message
- Network
Create201 - Network
Create Libpod - Network create
- Network
Create Request - NetworkCreateRequest is the request message sent to the server for network create call.
- Network
Disconnect - NetworkDisconnect represents the data to be used to disconnect a container from the network
- Network
Info - NetworkInfo contains the network information.
- Network
Inspect Report - Network
Prune200 - Network
Prune Report - NetworkPruneReport containers the name of network and an error associated in its pruning (removal)
- Network
Resource - NetworkResource is the body of the “get network” http response message
- Network
RmReport - NetworkRmReport describes the results of network removal
- Network
Settings - NetworkSettings exposes the network settings in the api
- Network
Update Options - NetworkUpdateOptions describes options to update a network
- Networking
Config - NetworkingConfig represents the container’s networking configuration for each of its interfaces
Carries the networking configs specified in the
docker runanddocker network connectcommands - NoSuch
Secret - OciRuntime
Info - OCIRuntimeInfo describes the runtime (crun or runc) being used with podman
- Overlay
Volume - OverlayVolume holds information about an overlay volume that will be mounted into the container.
- Pasta
Info - PastaInfo describes the pasta executable that is being used
- Peer
Info - PeerInfo represents one peer of an overlay network
- PerNetwork
Options - PerNetworkOptions are options which should be set on a per network basis.
- Platform
- Platform describes the platform which the image in the manifest runs on.
- Play
Kube Pod - Play
Kube Report - Play
Kube Volume - Play
Secret - Plugin
- Plugin A plugin for the Engine API
- Plugin
Config - PluginConfig The config of a plugin.
- Plugin
Config Args - PluginConfigArgs plugin config args
- Plugin
Config Interface - PluginConfigInterface The interface between Docker and the plugin
- Plugin
Config Linux - PluginConfigLinux plugin config linux
- Plugin
Config Network - PluginConfigNetwork plugin config network
- Plugin
Config Rootfs - PluginConfigRootfs plugin config rootfs
- Plugin
Config User - PluginConfigUser plugin config user
- Plugin
Device - PluginDevice plugin device
- Plugin
Env - PluginEnv plugin env
- Plugin
Interface Type - PluginInterfaceType plugin interface type
- Plugin
Mount - PluginMount plugin mount
- Plugin
Settings - PluginSettings Settings that can be modified by users.
- Plugins
- PodBasic
Config - PodBasicConfig contains basic configuration options for pods.
- PodCgroup
Config - PodCgroupConfig contains configuration options about a pod’s cgroups. This will be expanded in future updates to pods.
- PodCreate
Options - 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.
- PodKill
Report - PodNetwork
Config - PodNetworkConfig contains networking configuration for a pod.
- PodPause
Report - PodPrune
Report - PodResource
Config - PodRestart
Report - PodRm
Report - PodSecurity
Config - PodSpec
Generator - PodSpecGenerator describes options to create a pod
- PodStart
Report - PodStats
Report - PodStatsReport includes pod-resource statistics data.
- PodStop
Report - PodStorage
Config - PodStorageConfig contains all of the storage related options for the pod and its infra container.
- PodTop
OkBody - PodUnpause
Report - Port
- Port An open port on a container
- Port
Binding - PortBinding represents a binding between a Host IP address and a Host Port
- Port
Mapping - PortMapping is one or more ports that will be mapped into the container.
- Posix
Rlimit - POSIXRlimit type and restrictions
- Prune
Report - Publish
Status - PublishStatus represents the status of the volume as published to an individual node
- Registry
Search Response - Remote
Socket - RemoteSocket describes information about the API socket
- Resources
- Resources contains container’s resources (cgroups config, ulimits…)
- Restart
Policy - RestartPolicy represents the restart policies of the container.
- RootFs
- RootFS holds the root fs information of an image.
- Route
- Schema2
Health Config - Schema2HealthConfig is a HealthConfig, which holds configuration settings for the HEALTHCHECK feature, from docker/docker/api/types/container.
- Schema2
List Public - Schema2ListPublic is a list of platform-specific manifests. This is publicly visible as c/image/manifest.Schema2List. Internal users should usually use Schema2List instead.
- Schema2
Manifest Descriptor - Schema2ManifestDescriptor references a platform-specific manifest. This is publicly visible as c/image/manifest.Schema2ManifestDescriptor.
- Schema2
Platform Spec - Schema2PlatformSpec describes the platform which a particular manifest is specialized for. This is publicly visible as c/image/manifest.Schema2PlatformSpec.
- ScpReport
- Secret
- Secret represents a Swarm Secret value that must be passed to the CSI storage plugin when operating on this Volume. It represents one key-value pair of possibly many.
- Secret
Create - Secret
Create Report - Secret
Create Response - Secret
Driver Spec - Secret
InUse - Secret
Info Report - Secret
Info Report Compat - Secret
RmReport - Secret
Spec - Secret
Version - Security
Info - SecurityInfo describes the libpod host
- Service
Create Response - ServiceCreateResponse contains the information returned to a client on the creation of a new service.
- Service
Info - ServiceInfo represents service parameters with the list of service’s tasks
- Service
Update Response - ServiceUpdateResponse service update response
- Slirp
Info - SlirpInfo describes the slirp executable that is being used
- Spec
Generator - SpecGenerator creates an OCI spec and Libpod configuration options to create a container based on the given configuration.
- Startup
Health Check - StartupHealthCheck is the configuration of a startup healthcheck.
- Store
Info - StoreInfo describes the container storage and its attributes
- Subnet
- Summary
- Summary summary
- Summary
Network Settings - SummaryNetworkSettings provides a summary of container’s networks in /containers/json
- System
Component Version - SystemComponentVersion is the type used by pkg/domain/entities
- System
Component Version Platform - System
DfContainer Report - SystemDfContainerReport describes a container for use with df
- System
DfImage Report - SystemDfImageReport describes an image for use with df
- System
DfReport - SystemDfReport describes the response for df information
- System
DfVolume Report - SystemDfVolumeReport describes a volume and its size
- System
Prune Report - SystemPruneReport provides report after system prune is executed.
- Task
- Task carries the information about one backend task
- Throttle
Device - ThrottleDevice is a structure that holds device:rate_per_second pair
- Tmpfs
Options - TmpfsOptions defines options specific to mounts of type “tmpfs”.
- Topology
- Topology is a map of topological domains to topological segments. This description is taken verbatim from the CSI Spec:
- Topology
Requirement - TopologyRequirement expresses the user’s requirements for a volume’s accessible topology.
- Type
Mount - TypeMount contains options for using a volume as a Mount-type volume.
- Ulimit
- Ulimit is a human friendly version of Rlimit.
- Update
Config - UpdateConfig holds the mutable attributes of a Container. Those attributes can be updated at runtime.
- Update
Entities - UpdateEntities used to wrap the oci resource spec in a swagger model
- Usage
Data - UsageData Usage details about the volume. This information is used by the
GET /system/dfendpoint, and omitted in other endpoints. - Version
- Version represents the internal object version.
- Volume
- Volume volume
- Volume
Config Response - Volume
Create - Details for creating a volume
- Volume
Create Options - Volume
Options - VolumeOptions represents the options for a mount of type volume.
- Volume
RmReport - Volumes
Prune Report - VolumesPruneReport contains the response for Engine API: POST “/volumes/prune”
- Wait
Exit Error - WaitExitError container waiting error, if any
- Wait
Response - WaitResponse ContainerWaitResponse OK response to ContainerWait operation
- Weight
Device - WeightDevice is a structure that holds device:weight pair