AccessMode defines the access mode of a volume.
Address represents an IP address.
AuthConfig contains authorization information for connecting to a Registry
AuthReport describes the response for authentication check
AuthenticateOKBody authenticate o k body
AutoUserNsOptions defines how to automatically create a user namespace.
BindOptions defines options specific to mounts of type “bind”.
CapacityRange describes the minimum and maximum capacity a volume should be
created with
ClusterVolume contains options and information specific to, and only present
on, Swarm CSI cluster volumes.
ClusterVolumeSpec contains the spec used to create this volume.
ComponentVersion describes the version information for a specific component.
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.
ConfigReference specifies the source which provides a network’s configuration
ConmonInfo describes the conmon executable being used
ContainerBasicConfig contains the basic parts of a container.
ContainerCgroupConfig contains configuration information about a container’s
cgroups.
ContainerCreateResponse is the response struct for creating a container
ContainerHealthCheckConfig describes a container healthcheck with attributes
like command, retries, interval, start period, and timeout.
ContainerJSON is newly used struct along with MountPoint
ContainerNetworkConfig contains information on a container’s network
configuration.
Statistics for an individual container network interface
ContainerNode stores information about the node that a container
is running on. It’s only used by the Docker Swarm standalone API
ContainerResourceConfig contains information on container resource limits.
ContainerSecurityConfig is a container’s security features, including
SELinux, Apparmor, and Seccomp.
ContainerSize holds the size of the container’s root filesystem and top
read-write layer.
ContainerState stores container’s running state
it’s part of ContainerJSONBase and will return by “inspect” command
ContainerStats contains the statistics information for a running container
ContainerStorageConfig contains information on the storage configuration of a
container.
ContainerStore describes the quantity of containers in the
store by status
ContainerTopOKBody OK response to ContainerTop operation
ContainerUpdateOKBody OK response to ContainerUpdate operation
CreateContainerConfig used when compatible endpoint creates a container
CreateOptions VolumeConfig
Volume configuration
CreateResponse ContainerCreateResponse
OK response to ContainerCreate operation
DeleteResponse delete response
DeviceMapping represents the device mapping between the host and the container.
DeviceRequest represents a request for devices from a device driver.
Used by GPU device drivers.
DistributionInfo describes the host distribution for libpod
NetworkInfo contains the DNS information.
Driver represents a volume driver.
DriverData handles the data for a storage driver
EndpointIPAMConfig represents IPAM configurations for the endpoint
EndpointResource contains network resources allocated and used for a container in a network
EndpointSettings stores the network endpoint details
ErrorModel is used in remote connections with podman
ErrorResponse Represents an error.
FilesystemChange Change in the container’s filesystem.
GraphDriverData Information about the storage driver used to store the container’s and
image’s filesystem.
Health stores information about the container’s healthcheck results
HealthCheckLog describes the results of a single healthcheck
HealthCheckResults describes the results/logs from a healthcheck
HealthcheckConfig holds configuration settings for the HEALTHCHECK feature.
HealthcheckResult stores information about a single run of a healthcheck probe
History describes the history of a layer.
HistoryResponse provides details on image layers
HistoryResponseItem individual image layer information in response to ImageHistory operation
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.
HostInfo describes the libpod host
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 are used for specifying how ID mapping should be set up for
a layer or container.
IDMappings describe the GID and UID mappings
IDResponse Response to an API call that returns just an Id
ImageConfig defines the execution parameters which should be used as a base when running a container using an image.
ImageData holds the inspect information of an image.
ImageStore describes the image store. Right now only the number
of images present
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 contains information about the Volume as a whole as provided by
the CSI storage plugin.
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 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 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 holds further data about how a container was initially
configured.
InspectContainerData provides a detailed record of a container’s configuration
and state as viewed by Libpod.
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 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.
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).
InspectDevice is a single device that will be mounted into the container.
InspectExecProcess contains information about the process in a given exec
session.
InspectExecSession contains information about a given exec session.
InspectHostPort provides information on a port on the host that a container’s
port is bound to.
InspectLogConfig holds information about a container’s configured log driver
InspectMount provides a record of a single mount in a container. 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 holds information about the network settings of the
container.
Many fields are maintained only for compatibility with docker inspect and
are unused within Libpod.
InspectPodContainerInfo contains information on a container in a pod.
InspectPodData contains detailed information on a pod’s configuration and
state. It is used as the output of Inspect on pods.
InspectPodInfraConfig contains the configuration of the pod’s infra
container.
InspectRestartPolicy holds information about the container’s restart policy.
InspectSecret contains information on secrets mounted inside the container
InspectUlimit is a ulimit that will be applied to the container.
An IPNet represents an IP network.
IPAM represents IP Address Management
IPAMConfig represents IPAM configurations
LeaseRange contains the range where IP are leased.
LibpodImagesRemoveReport is the return type for image removal via the rest
api.
Info is the overall struct that describes the host system
running libpod/podman
LinuxBlockIO for Linux cgroup ‘blkio’ resource management
LinuxBlockIODevice holds major:minor format supported in blkio cgroup
LinuxCPU for Linux cgroup ‘cpu’ resource management
LinuxDevice represents the mknod information for a Linux special device file
LinuxDeviceCgroup represents a device rule for the devices specified to
the device controller
LinuxHugepageLimit structure corresponds to limiting kernel hugepages.
Default to reservation limits if supported. Otherwise fallback to page fault limits.
LinuxIDMapping specifies UID/GID mappings
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 for network interfaces
LinuxMemory for Linux cgroup ‘memory’ resource management
LinuxNetwork identification and priority configuration
LinuxPersonality represents the Linux personality syscall input
LinuxPids for Linux cgroup ‘pids’ resource management (Linux 4.3)
LinuxRdma for Linux cgroup ‘rdma’ resource management (Linux 4.11)
LinuxResources has container runtime resource constraints
LinuxThrottleDevice struct holds a major:minor rate_per_second pair
LinuxWeightDevice struct holds a major:minor weight pair for weightDevice
ListContainer describes a container suitable for listing
ListContainerNamespaces contains the identifiers of the container’s Linux namespaces
ListResponse VolumeListResponse
Volume list response
LogConfig represents the logging configuration of the container.
LogConfig describes the logging characteristics for a container
ManifestAddArtifactOptions provides the model for creating artifact manifests
for files and adding those manifests to a manifest list
ManifestAddOptions provides model for adding digests to manifest list
ManifestAnnotateOptions provides model for annotating manifest list
ManifestModifyOptions provides the model for mutating a manifest
swagger 2.0 does not support oneOf for schema validation.
Meta is a base object inherited by most of the other once.
Metadata contains engine-local data about the image.
Mount represents a mount (volume).
MountPoint represents a mount point configuration inside the container.
This is used for reporting the mountpoints in use by a container.
NamedVolume holds information about a named volume that will be mounted into
the container.
Namespace describes the namespace
NetAddress contains the ip address, subnet and gateway.
NetInterface contains the settings for a given network interface.
NetOptions reflect the shared network options between
pods and containers
Network describes the Network attributes.
NetworkConnect represents the data to be used to connect a container to the network
NetworkConnectOptions describes options for connecting
a container to a network
NetworkCreate is the expected body of the “create network” http request message
Network create
NetworkCreateRequest is the request message sent to the server for network create call.
NetworkDisconnect represents the data to be used to disconnect a container from the network
NetworkInfo contains the network information.
NetworkPruneReport containers the name of network and an error
associated in its pruning (removal)
NetworkResource is the body of the “get network” http response message
NetworkRmReport describes the results of network removal
NetworkSettings exposes the network settings in the api
NetworkUpdateOptions describes options to update a network
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 describes the runtime (crun or runc) being
used with podman
OverlayVolume holds information about an overlay volume that will be mounted into
the container.
PastaInfo describes the pasta executable that is being used
PeerInfo represents one peer of an overlay network
PerNetworkOptions are options which should be set on a per network basis.
Platform describes the platform which the image in the manifest runs on.
Plugin A plugin for the Engine API
PluginConfig The config of a plugin.
PluginConfigArgs plugin config args
PluginConfigInterface The interface between Docker and the plugin
PluginConfigLinux plugin config linux
PluginConfigNetwork plugin config network
PluginConfigRootfs plugin config rootfs
PluginConfigUser plugin config user
PluginDevice plugin device
PluginEnv plugin env
PluginInterfaceType plugin interface type
PluginMount plugin mount
PluginSettings Settings that can be modified by users.
PodBasicConfig contains basic configuration options for pods.
PodCgroupConfig contains configuration options about a pod’s cgroups.
This will be expanded in future updates to pods.
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.
PodNetworkConfig contains networking configuration for a pod.
PodSpecGenerator describes options to create a pod
PodStatsReport includes pod-resource statistics data.
PodStorageConfig contains all of the storage related options for the pod and its infra container.
Port An open port on a container
PortBinding represents a binding between a Host IP address and a Host Port
PortMapping is one or more ports that will be mapped into the container.
POSIXRlimit type and restrictions
PublishStatus represents the status of the volume as published to an
individual node
RemoteSocket describes information about the API socket
Resources contains container’s resources (cgroups config, ulimits…)
RestartPolicy represents the restart policies of the container.
RootFS holds the root fs information of an image.
Schema2HealthConfig is a HealthConfig, which holds configuration settings
for the HEALTHCHECK feature, from docker/docker/api/types/container.
Schema2ListPublic is a list of platform-specific manifests.
This is publicly visible as c/image/manifest.Schema2List.
Internal users should usually use Schema2List instead.
Schema2ManifestDescriptor references a platform-specific manifest.
This is publicly visible as c/image/manifest.Schema2ManifestDescriptor.
Schema2PlatformSpec describes the platform which a particular manifest is
specialized for.
This is publicly visible as c/image/manifest.Schema2PlatformSpec.
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 describes the libpod host
ServiceCreateResponse contains the information returned to a client on the
creation of a new service.
ServiceInfo represents service parameters with the list of service’s tasks
ServiceUpdateResponse service update response
SlirpInfo describes the slirp executable that is being used
SpecGenerator creates an OCI spec and Libpod configuration options to create
a container based on the given configuration.
StartupHealthCheck is the configuration of a startup healthcheck.
StoreInfo describes the container storage and its
attributes
Summary summary
SummaryNetworkSettings provides a summary of container’s networks
in /containers/json
SystemComponentVersion is the type used by pkg/domain/entities
SystemDfContainerReport describes a container for use with df
SystemDfImageReport describes an image for use with df
SystemDfReport describes the response for df information
SystemDfVolumeReport describes a volume and its size
SystemPruneReport provides report after system prune is executed.
Task carries the information about one backend task
ThrottleDevice is a structure that holds device:rate_per_second pair
TmpfsOptions defines options specific to mounts of type “tmpfs”.
Topology is a map of topological domains to topological segments.
This description is taken verbatim from the CSI Spec:
TopologyRequirement expresses the user’s requirements for a volume’s
accessible topology.
TypeMount contains options for using a volume as a Mount-type
volume.
Ulimit is a human friendly version of Rlimit.
UpdateConfig holds the mutable attributes of a Container.
Those attributes can be updated at runtime.
UpdateEntities used to wrap the oci resource spec in a swagger model
UsageData Usage details about the volume. This information is used by the
GET /system/df endpoint, and omitted in other endpoints.
Version represents the internal object version.
Volume volume
Details for creating a volume
VolumeOptions represents the options for a mount of type volume.
VolumesPruneReport contains the response for Engine API:
POST “/volumes/prune”
WaitExitError container waiting error, if any
WaitResponse ContainerWaitResponse
OK response to ContainerWait operation
WeightDevice is a structure that holds device:weight pair