AuthConfig : AuthConfig contains authorization information for connecting to a Registry
AuthReport : AuthReport describes the response for authentication check
AuthenticateOkBody : AuthenticateOKBody authenticate o k body
CapacityRange : CapacityRange describes the minimum and maximum capacity a volume should be created with
ClusterVolume : ClusterVolume contains options and information specific to, and only present on, Swarm CSI cluster volumes.
Config : 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.
ConfigReference : ConfigReference specifies the source which provides a network’s configuration
ConmonInfo : ConmonInfo describes the conmon executable being used
ContainerCgroupConfig : ContainerCgroupConfig contains configuration information about a container’s cgroups.
ContainerCreateResponse : ContainerCreateResponse is the response struct for creating a container
ContainerHealthCheckConfig : ContainerHealthCheckConfig describes a container healthcheck with attributes like command, retries, interval, start period, and timeout.
ContainerJson : ContainerJSON is newly used struct along with MountPoint
ContainerNetworkConfig : ContainerNetworkConfig contains information on a container’s network configuration.
ContainerNetworkStats : Statistics for an individual container network interface
ContainerNode : ContainerNode stores information about the node that a container is running on. It’s only used by the Docker Swarm standalone API
ContainerSecurityConfig : ContainerSecurityConfig is a container’s security features, including SELinux, Apparmor, and Seccomp.
ContainerSize : ContainerSize holds the size of the container’s root filesystem and top read-write layer.
ContainerState : ContainerState stores container’s running state it’s part of ContainerJSONBase and will return by "inspect" command
ContainerStats : ContainerStats contains the statistics information for a running container
ContainerStorageConfig : ContainerStorageConfig contains information on the storage configuration of a container.
ContainerStore : ContainerStore describes the quantity of containers in the store by status
ContainerTopOkBody : ContainerTopOKBody OK response to ContainerTop operation
ContainerUpdateOkBody : ContainerUpdateOKBody OK response to ContainerUpdate operation
CreateContainerConfig : CreateContainerConfig used when compatible endpoint creates a container
CreateOptions : Volume configuration
CreateResponse : OK response to ContainerCreate operation
DeleteResponse : DeleteResponse delete response
DeviceRequest : Used by GPU device drivers.
DistributionInfo : DistributionInfo describes the host distribution for libpod
DriverData : DriverData handles the data for a storage driver
EndpointIpamConfig : EndpointIPAMConfig represents IPAM configurations for the endpoint
EndpointResource : EndpointResource contains network resources allocated and used for a container in a network
EndpointSettings : EndpointSettings stores the network endpoint details
ErrorModel : ErrorModel is used in remote connections with podman
GraphDriverData : 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
HealthCheckLog : HealthCheckLog describes the results of a single healthcheck
HealthCheckResults : HealthCheckResults describes the results/logs from a healthcheck
HealthcheckResult : HealthcheckResult stores information about a single run of a healthcheck probe
HistoryResponse : HistoryResponse provides details on image layers
HistoryResponseItem : HistoryResponseItem individual image layer information in response to ImageHistory operation
HostConfig : Here, "non-portable" means "dependent of the host we are running on". Portable information should appear in Config.
HostInfo : 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.
IdMappingOptions : 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
ImageStore : ImageStore describes the image store. Right now only the number of images present
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.
Info : Info contains information about the Volume as a whole as provided by the CSI storage plugin.
InspectAdditionalNetwork : 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.
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.
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.
InspectContainerConfig : InspectContainerConfig holds further data about how a container was initially configured.
InspectContainerData : 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 inspect JSON, but additional fields have been added as required to share information not in the original output.
InspectContainerHostConfig : nolint:revive,stylecheck // Field names are fixed for compatibility and cannot be changed.
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).
InspectExecProcess : InspectExecProcess contains information about the process in a given exec session.
InspectHostPort : InspectHostPort provides information on a port on the host that a container’s port is bound to.
InspectLogConfig : InspectLogConfig holds information about a container’s configured log driver
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.
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.
InspectPodData : InspectPodData contains detailed information on a pod’s configuration and state. It is used as the output of Inspect on pods.
InspectPodInfraConfig : InspectPodInfraConfig contains the configuration of the pod’s infra container.
InspectSecret : InspectSecret contains information on secrets mounted inside the container
Ipam : IPAM represents IP Address Management
IpamConfig : IPAMConfig represents IPAM configurations
LibpodImagesRemoveReport : LibpodImagesRemoveReport is the return type for image removal via the rest api.
LibpodInfo : Info is the overall struct that describes the host system running libpod/podman
LinuxBlockIo : LinuxBlockIO for Linux cgroup ‘blkio’ resource management
LinuxBlockIoDevice : LinuxBlockIODevice holds major:minor format supported in blkio cgroup
LinuxCpu : LinuxCPU for Linux cgroup ‘cpu’ resource management
LinuxDevice : LinuxDevice represents the mknod information for a Linux special device file
LinuxDeviceCgroup : LinuxDeviceCgroup represents a device rule for the devices specified to the device controller
LinuxHugepageLimit : Default to reservation limits if supported. Otherwise fallback to page fault limits.
LinuxIdMapping : LinuxIDMapping specifies UID/GID mappings
LinuxIntelRdt : 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.
LinuxInterfacePriority : LinuxInterfacePriority for network interfaces
LinuxMemory : LinuxMemory for Linux cgroup ‘memory’ resource management
LinuxNetwork : LinuxNetwork identification and priority configuration
LinuxPersonality : LinuxPersonality represents the Linux personality syscall input
LinuxPids : LinuxPids for Linux cgroup ‘pids’ resource management (Linux 4.3)
LinuxRdma : LinuxRdma for Linux cgroup ‘rdma’ resource management (Linux 4.11)
LinuxResources : LinuxResources has container runtime resource constraints
LinuxThrottleDevice : LinuxThrottleDevice struct holds a major:minor rate_per_second pair
LinuxWeightDevice : LinuxWeightDevice struct holds a major:minor weight pair for weightDevice
ListContainer : ListContainer describes a container suitable for listing
ListContainerNamespaces : ListContainerNamespaces contains the identifiers of the container’s Linux namespaces
ListResponse : Volume list response
LogConfigLibpod : LogConfig describes the logging characteristics for a container
ManifestAddArtifactOptions : ManifestAddArtifactOptions provides the model for creating artifact manifests for files and adding those manifests to a manifest list
ManifestAddOptions : ManifestAddOptions provides model for adding digests to manifest list
ManifestAnnotateOptions : ManifestAnnotateOptions provides model for annotating manifest list
ManifestModifyOptions : 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
MountPoint : This is used for reporting the mountpoints in use by a container.
NamedVolume : NamedVolume holds information about a named volume that will be mounted into the container.
Namespace : Namespace describes the namespace
NetOptions : NetOptions reflect the shared network options between pods and containers
NetworkConnect : NetworkConnect represents the data to be used to connect a container to the network
NetworkConnectOptions : NetworkConnectOptions describes options for connecting a container to a network
NetworkCreateLibpod : Network create
NetworkDisconnect : NetworkDisconnect represents the data to be used to disconnect a container from the network
NetworkPruneReport : NetworkPruneReport containers the name of network and an error associated in its pruning (removal)
NetworkResource : NetworkResource is the body of the "get network" http response message
NetworkRmReport : NetworkRmReport describes the results of network removal
NetworkSettings : NetworkSettings exposes the network settings in the api
NetworkUpdateOptions : NetworkUpdateOptions describes options to update a network
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
OciRuntimeInfo : OCIRuntimeInfo describes the runtime (crun or runc) being used with podman
OverlayVolume : OverlayVolume holds information about an overlay volume that will be mounted into the container.
PastaInfo : PastaInfo describes the pasta executable that is being used
PeerInfo : PeerInfo represents one peer of an overlay network
Plugin : Plugin A plugin for the Engine API
PluginConfigArgs : PluginConfigArgs plugin config args
PluginConfigInterface : PluginConfigInterface The interface between Docker and the plugin
PluginConfigLinux : PluginConfigLinux plugin config linux
PluginConfigNetwork : PluginConfigNetwork plugin config network
PluginConfigRootfs : PluginConfigRootfs plugin config rootfs
PluginConfigUser : PluginConfigUser plugin config user
PluginDevice : PluginDevice plugin device
PluginEnv : PluginEnv plugin env
PluginInterfaceType : PluginInterfaceType plugin interface type
PluginMount : PluginMount plugin mount
PodCgroupConfig : This will be expanded in future updates to pods.
PodCreateOptions : The JSON tags below are made to match the respective field in ContainerCreateOptions for the purpose of mapping.
PodSpecGenerator : PodSpecGenerator describes options to create a pod
Port : Port An open port on a container
PortBinding : PortBinding represents a binding between a Host IP address and a Host Port
PosixRlimit : POSIXRlimit type and restrictions
PublishStatus : PublishStatus represents the status of the volume as published to an individual node
RemoteSocket : RemoteSocket describes information about the API socket
Resources : Resources contains container’s resources (cgroups config, ulimits…)
Schema2HealthConfig : Schema2HealthConfig is a HealthConfig, which holds configuration settings for the HEALTHCHECK feature, from docker/docker/api/types/container.
Schema2ListPublic : This is publicly visible as c/image/manifest.Schema2List. Internal users should usually use Schema2List instead.
Schema2ManifestDescriptor : This is publicly visible as c/image/manifest.Schema2ManifestDescriptor.
Schema2PlatformSpec : Schema2PlatformSpec describes the platform which a particular manifest is specialized for. This is publicly visible as c/image/manifest.Schema2PlatformSpec.
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.
SecurityInfo : SecurityInfo describes the libpod host
ServiceCreateResponse : ServiceCreateResponse contains the information returned to a client on the creation of a new service.
ServiceInfo : ServiceInfo represents service parameters with the list of service’s tasks
ServiceUpdateResponse : ServiceUpdateResponse service update response
SlirpInfo : SlirpInfo describes the slirp executable that is being used
SpecGenerator : SpecGenerator creates an OCI spec and Libpod configuration options to create a container based on the given configuration.
StoreInfo : StoreInfo describes the container storage and its attributes
Summary : Summary summary
SummaryNetworkSettings : SummaryNetworkSettings provides a summary of container’s networks in /containers/json
SystemComponentVersion : SystemComponentVersion is the type used by pkg/domain/entities
SystemDfContainerReport : SystemDfContainerReport describes a container for use with df
SystemDfImageReport : SystemDfImageReport describes an image for use with df
SystemDfReport : SystemDfReport describes the response for df information
SystemDfVolumeReport : SystemDfVolumeReport describes a volume and its size
Task : Task carries the information about one backend task
ThrottleDevice : ThrottleDevice is a structure that holds device:rate_per_second pair
Topology : This description is taken verbatim from the CSI Spec: A topological domain is a sub-division of a cluster, like "region", "zone", "rack", etc. A topological segment is a specific instance of a topological domain, like "zone3", "rack3", etc. For example {"com.company/zone": "Z1", "com.company/rack": "R3"} Valid keys have two segments: an OPTIONAL prefix and name, separated by a slash (/), for example: "com.company.example/zone". The key name segment is REQUIRED. The prefix is OPTIONAL. The key name MUST be 63 characters or less, begin and end with an alphanumeric character ([a-z0-9A-Z]), and contain only dashes (-), underscores (), dots (.), or alphanumerics in between, for example "zone". The key prefix MUST be 63 characters or less, begin and end with a lower-case alphanumeric character ([a-z0-9]), contain only dashes (-), dots (.), or lower-case alphanumerics in between, and follow domain name notation format (https://tools.ietf.org/html/rfc1035#section-2.3.1). The key prefix SHOULD include the plugin’s host company name and/or the plugin name, to minimize the possibility of collisions with keys from other plugins. If a key prefix is specified, it MUST be identical across all topology keys returned by the SP (across all RPCs). Keys MUST be case-insensitive. Meaning the keys "Zone" and "zone" MUST not both exist. Each value (topological segment) MUST contain 1 or more strings. Each string MUST be 63 characters or less and begin and end with an alphanumeric character with ‘-’, ‘’, ‘.’, or alphanumerics in between.
TopologyRequirement : TopologyRequirement expresses the user’s requirements for a volume’s accessible topology.
TypeMount : TypeMount contains options for using a volume as a Mount-type volume.
UpdateConfig : Those attributes can be updated at runtime.
UpdateEntities : UpdateEntities used to wrap the oci resource spec in a swagger model
UsageData : UsageData Usage details about the volume. This information is used by the GET /system/df endpoint, and omitted in other endpoints.
Volume : Volume volume
VolumeCreate : Details for creating a volume
VolumesPruneReport : POST "/volumes/prune"
WaitExitError : WaitExitError container waiting error, if any
WaitResponse : OK response to ContainerWait operation
WeightDevice : WeightDevice is a structure that holds device:weight pair