[][src]Module k8s_cri::v1alpha2

Modules

image_service_client

Generated client implementations.

image_service_server

Generated server implementations.

runtime_service_client

Generated client implementations.

runtime_service_server

Generated server implementations.

Structs

AttachRequest
AttachResponse
AuthConfig

AuthConfig contains authorization information for connecting to a registry.

Capability

Capability contains the container capabilities to add or drop

Container

Container provides the runtime information for a container, such as ID, hash, state of the container.

ContainerAttributes

ContainerAttributes provides basic information of the container.

ContainerConfig

ContainerConfig holds all the required and optional fields for creating a container.

ContainerFilter

ContainerFilter is used to filter containers. All those fields are combined with 'AND'

ContainerMetadata

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.

ContainerStateValue

ContainerStateValue is the wrapper of ContainerState.

ContainerStats

ContainerStats provides the resource usage statistics for a container.

ContainerStatsFilter

ContainerStatsFilter is used to filter containers. All those fields are combined with 'AND'

ContainerStatsRequest
ContainerStatsResponse
ContainerStatus

ContainerStatus represents the status of a container.

ContainerStatusRequest
ContainerStatusResponse
CpuUsage

CpuUsage provides the CPU usage information.

CreateContainerRequest
CreateContainerResponse
Device

Device specifies a host device to mount into a container.

DnsConfig

DNSConfig specifies the DNS servers and search domains of a sandbox.

ExecRequest
ExecResponse
ExecSyncRequest
ExecSyncResponse
FilesystemIdentifier

FilesystemIdentifier uniquely identify the filesystem.

FilesystemUsage

FilesystemUsage provides the filesystem usage information.

HugepageLimit

HugepageLimit corresponds to the filehugetlb.<hugepagesize>.limit_in_byte in container level cgroup. For example, PageSize=1GB, Limit=1073741824 means setting 1073741824 bytes to hugetlb.1GB.limit_in_bytes.

Image

Basic information about a container image.

ImageFilter
ImageFsInfoRequest
ImageFsInfoResponse
ImageSpec

ImageSpec is an internal representation of an image. Currently, it wraps the value of a Container's Image field (e.g. imageID or imageDigest), but in the future it will include more detailed information about the different image types.

ImageStatusRequest
ImageStatusResponse
Int64Value

Int64Value is the wrapper of int64.

KeyValue
LinuxContainerConfig

LinuxContainerConfig contains platform-specific configuration for Linux-based containers.

LinuxContainerResources

LinuxContainerResources specifies Linux specific configuration for resources. TODO: Consider using Resources from opencontainers/runtime-spec/specs-go directly.

LinuxContainerSecurityContext

LinuxContainerSecurityContext holds linux security configuration that will be applied to a container.

LinuxPodSandboxConfig

LinuxPodSandboxConfig holds platform-specific configurations for Linux host platforms and Linux-based containers.

LinuxPodSandboxStatus

LinuxSandboxStatus contains status specific to Linux sandboxes.

LinuxSandboxSecurityContext

LinuxSandboxSecurityContext holds linux security configuration that will be applied to a sandbox. Note that:

ListContainerStatsRequest
ListContainerStatsResponse
ListContainersRequest
ListContainersResponse
ListImagesRequest
ListImagesResponse
ListPodSandboxRequest
ListPodSandboxResponse
MemoryUsage

MemoryUsage provides the memory usage information.

Mount

Mount specifies a host volume to mount into a container.

Namespace

Namespace contains paths to the namespaces.

NamespaceOption

NamespaceOption provides options for Linux namespaces.

NetworkConfig
PodIp

PodIP represents an ip of a Pod

PodSandbox

PodSandbox contains minimal information about a sandbox.

PodSandboxConfig

PodSandboxConfig holds all the required and optional fields for creating a sandbox.

PodSandboxFilter

PodSandboxFilter is used to filter a list of PodSandboxes. All those fields are combined with 'AND'

PodSandboxMetadata

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

PodSandboxNetworkStatus is the status of the network for a PodSandbox.

PodSandboxStateValue

PodSandboxStateValue is the wrapper of PodSandboxState.

PodSandboxStatus

PodSandboxStatus contains the status of the PodSandbox.

PodSandboxStatusRequest
PodSandboxStatusResponse
PortForwardRequest
PortForwardResponse
PortMapping

PortMapping specifies the port mapping configurations of a sandbox.

PullImageRequest
PullImageResponse
RemoveContainerRequest
RemoveContainerResponse
RemoveImageRequest
RemoveImageResponse
RemovePodSandboxRequest
RemovePodSandboxResponse
ReopenContainerLogRequest
ReopenContainerLogResponse
RunPodSandboxRequest
RunPodSandboxResponse
RuntimeCondition

RuntimeCondition contains condition information for the runtime. There are 2 kinds of runtime conditions:

RuntimeConfig
RuntimeStatus

RuntimeStatus is information about the current status of the runtime.

SeLinuxOption

SELinuxOption are the labels to be applied to the container.

StartContainerRequest
StartContainerResponse
StatusRequest
StatusResponse
StopContainerRequest
StopContainerResponse
StopPodSandboxRequest
StopPodSandboxResponse
UInt64Value

UInt64Value is the wrapper of uint64.

UpdateContainerResourcesRequest
UpdateContainerResourcesResponse
UpdateRuntimeConfigRequest
UpdateRuntimeConfigResponse
VersionRequest
VersionResponse
WindowsContainerConfig

WindowsContainerConfig contains platform-specific configuration for Windows-based containers.

WindowsContainerResources

WindowsContainerResources specifies Windows specific configuration for resources.

WindowsContainerSecurityContext

WindowsContainerSecurityContext holds windows security configuration that will be applied to a container.

Enums

ContainerState
MountPropagation
NamespaceMode

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.

PodSandboxState
Protocol