Expand description
API version v1, original Protocol Buffers file.
Modules§
- Generated client implementations.
- Generated server implementations.
- Generated client implementations.
- Generated server implementations.
- Nested message and enum types in
SecurityProfile
.
Structs§
- AuthConfig contains authorization information for connecting to a registry.
- Capability contains the container capabilities to add or drop Dropping a capability will drop it from all sets. If a capability is added to only the add_capabilities list then it gets added to permitted, inheritable, effective and bounding sets, i.e. all sets except the ambient set. If a capability is added to only the add_ambient_capabilities list then it gets added to all sets, i.e permitted inheritable, effective, bounding and ambient sets. If a capability is added to add_capabilities and add_ambient_capabilities lists then it gets added to all sets, i.e. permitted, inheritable, effective, bounding and ambient sets.
- Container provides the runtime information for a container, such as ID, hash, state of the container.
- ContainerAttributes provides basic information of the container.
- ContainerConfig holds all the required and optional fields for creating a container.
- ContainerFilter is used to filter containers. All those fields are combined with ‘AND’
- ContainerMetadata holds all necessary information for building the container name. The container runtime is encouraged to expose the metadata in its user interface for better user experience. E.g., runtime can construct a unique container name based on the metadata. Note that (name, attempt) is unique within a sandbox for the entire lifetime of the sandbox.
- ContainerResources holds resource limits configuration for a container.
- ContainerStateValue is the wrapper of ContainerState.
- ContainerStats provides the resource usage statistics for a container.
- ContainerStatsFilter is used to filter containers. All those fields are combined with ‘AND’
- ContainerStatus represents the status of a container.
- CpuUsage provides the CPU usage information.
- Device specifies a host device to mount into a container.
- DNSConfig specifies the DNS servers and search domains of a sandbox.
- FilesystemIdentifier uniquely identify the filesystem.
- FilesystemUsage provides the filesystem usage information.
- HugepageLimit corresponds to the file
hugetlb.<hugepagesize>.limit_in_byte
in container level cgroup. For example,PageSize=1GB
,Limit=1073741824
means setting1073741824
bytes to hugetlb.1GB.limit_in_bytes. - IDMapping describes host to container ID mappings for a pod sandbox.
- Basic information about a container image.
- ImageSpec is an internal representation of an image.
- Int64Value is the wrapper of int64.
- LinuxContainerConfig contains platform-specific configuration for Linux-based containers.
- LinuxContainerResources specifies Linux specific configuration for resources.
- LinuxContainerSecurityContext holds linux security configuration that will be applied to a container.
- LinuxPodSandboxConfig holds platform-specific configurations for Linux host platforms and Linux-based containers.
- LinuxPodSandboxStats provides the resource usage statistics for a pod sandbox on linux.
- LinuxSandboxStatus contains status specific to Linux sandboxes.
- LinuxSandboxSecurityContext holds linux security configuration that will be applied to a sandbox. Note that:
- MemoryUsage provides the memory usage information.
- Mount specifies a host volume to mount into a container.
- Namespace contains paths to the namespaces.
- NamespaceOption provides options for Linux namespaces.
- NetworkInterfaceUsage contains resource value data about a network interface.
- NetworkUsage contains data about network resources.
- PodIP represents an ip of a Pod
- PodSandbox contains minimal information about a sandbox.
- PodSandboxAttributes provides basic information of the pod sandbox.
- PodSandboxConfig holds all the required and optional fields for creating a sandbox.
- PodSandboxFilter is used to filter a list of PodSandboxes. All those fields are combined with ‘AND’
- PodSandboxMetadata holds all necessary information for building the sandbox name. The container runtime is encouraged to expose the metadata associated with the PodSandbox in its user interface for better user experience. For example, the runtime can construct a unique PodSandboxName based on the metadata.
- PodSandboxNetworkStatus is the status of the network for a PodSandbox. Currently ignored for pods sharing the host networking namespace.
- PodSandboxStateValue is the wrapper of PodSandboxState.
- PodSandboxStats provides the resource usage statistics for a pod. The linux or windows field will be populated depending on the platform.
- PodSandboxStatsFilter is used to filter the list of pod sandboxes to retrieve stats for. All those fields are combined with ‘AND’.
- PodSandboxStatus contains the status of the PodSandbox.
- PortMapping specifies the port mapping configurations of a sandbox.
- ProcessUsage are stats pertaining to processes.
- RuntimeCondition contains condition information for the runtime. There are 2 kinds of runtime conditions:
- RuntimeStatus is information about the current status of the runtime.
- SELinuxOption are the labels to be applied to the container.
- A security profile which can be used for sandboxes and containers.
- UInt64Value is the wrapper of uint64.
- UserNamespace describes the intended user namespace configuration for a pod sandbox.
- WindowsContainerConfig contains platform-specific configuration for Windows-based containers.
- WindowsContainerResources specifies Windows specific configuration for resources.
- WindowsContainerSecurityContext holds windows security configuration that will be applied to a container.
- WindowsPodSandboxConfig holds platform-specific configurations for Windows host platforms and Windows-based containers.
- WindowsPodSandboxStats provides the resource usage statistics for a pod sandbox on windows
- WindowsSandboxSecurityContext holds platform-specific configurations that will be applied to a sandbox. These settings will only apply to the sandbox container.
Enums§
- A NamespaceMode describes the intended namespace configuration for each of the namespaces (Network, PID, IPC) in NamespaceOption. Runtimes should map these modes as appropriate for the technology underlying the runtime.