github/kubernetes
1
0
Fork 0
mirror of https://github.com/k3s-io/kubernetes.git synced 2025-07-29 14:37:00 +00:00
Code Issues Projects Releases Wiki Activity

CRI: update protobuf to v3

Browse Source
This commit is contained in:
Pengfei Ni 2017-01-20 09:54:03 +08:00
parent d357a72161
commit 9cab3b4a07
2 changed files with 728 additions and 1691 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2030
pkg/kubelet/api/v1alpha1/runtime/api.pb.go
View File

File diff suppressed because it is too large Load Diff

389
pkg/kubelet/api/v1alpha1/runtime/api.proto
View File

@ -1,5 +1,5 @@
// To regenerate api.pb.go run hack/update-generated-runtime.sh // To regenerate api.pb.go run hack/update-generated-runtime.sh
syntax = 'proto2'; syntax = 'proto3';
package runtime; package runtime;
@ -84,20 +84,20 @@ service ImageService {
message VersionRequest { message VersionRequest {
// Version of the kubelet runtime API. // Version of the kubelet runtime API.
optional string version = 1; string version = 1;
} }
message VersionResponse { message VersionResponse {
// Version of the kubelet runtime API. // Version of the kubelet runtime API.
optional string version = 1; string version = 1;
// Name of the container runtime. // Name of the container runtime.
optional string runtime_name = 2; string runtime_name = 2;
// Version of the container runtime. The string must be // Version of the container runtime. The string must be
// semver-compatible. // semver-compatible.
optional string runtime_version = 3; string runtime_version = 3;
// API version of the container runtime. The string must be // API version of the container runtime. The string must be
// semver-compatible. // semver-compatible.
optional string runtime_api_version = 4; string runtime_api_version = 4;
} }
// DNSConfig specifies the DNS servers and search domains of a sandbox. // DNSConfig specifies the DNS servers and search domains of a sandbox.
@ -119,35 +119,41 @@ enum Protocol {
// PortMapping specifies the port mapping configurations of a sandbox. // PortMapping specifies the port mapping configurations of a sandbox.
message PortMapping { message PortMapping {
// Protocol of the port mapping. // Protocol of the port mapping.
optional Protocol protocol = 1; Protocol protocol = 1;
// Port number within the container. // Port number within the container. Default: 0 (not specified).
optional int32 container_port = 2; int32 container_port = 2;
// Port number on the host. // Port number on the host. Default: 0 (not specified).
optional int32 host_port = 3; int32 host_port = 3;
// Host IP. // Host IP.
optional string host_ip = 4; string host_ip = 4;
} }
// Mount specifies a host volume to mount into a container. // Mount specifies a host volume to mount into a container.
message Mount { message Mount {
// Path of the mount within the container. // Path of the mount within the container.
optional string container_path = 1; string container_path = 1;
// Path of the mount on the host. // Path of the mount on the host.
optional string host_path = 2; string host_path = 2;
// If set, the mount is read-only. // If set, the mount is read-only.
optional bool readonly = 3; bool readonly = 3;
// If set, the mount needs SELinux relabeling. // If set, the mount needs SELinux relabeling.
optional bool selinux_relabel = 4; bool selinux_relabel = 4;
} }
// NamespaceOption provides options for Linux namespaces. // NamespaceOption provides options for Linux namespaces.
message NamespaceOption { message NamespaceOption {
// If set, use the host's network namespace. // If set, use the host's network namespace.
optional bool host_network = 1; bool host_network = 1;
// If set, use the host's PID namespace. // If set, use the host's PID namespace.
optional bool host_pid = 2; bool host_pid = 2;
// If set, use the host's IPC namespace. // If set, use the host's IPC namespace.
optional bool host_ipc = 3; bool host_ipc = 3;
}
// Int64Value is the wrapper of int64.
message Int64Value {
// The value.
int64 value = 1;
} }
// LinuxSandboxSecurityContext holds linux security configuration that will be // LinuxSandboxSecurityContext holds linux security configuration that will be
@ -158,13 +164,13 @@ message NamespaceOption {
message LinuxSandboxSecurityContext { message LinuxSandboxSecurityContext {
// Configurations for the sandbox's namespaces. // Configurations for the sandbox's namespaces.
// This will be used only if the PodSandbox uses namespace for isolation. // This will be used only if the PodSandbox uses namespace for isolation.
optional NamespaceOption namespace_options = 1; NamespaceOption namespace_options = 1;
// Optional SELinux context to be applied. // Optional SELinux context to be applied.
optional SELinuxOption selinux_options = 2; SELinuxOption selinux_options = 2;
// UID to run sandbox processes as, when applicable. // UID to run sandbox processes as, when applicable.
optional int64 run_as_user = 3; Int64Value run_as_user = 3;
// If set, the root filesystem of the sandbox is read-only. // If set, the root filesystem of the sandbox is read-only.
optional bool readonly_rootfs = 4; bool readonly_rootfs = 4;
// List of groups applied to the first process run in the sandbox, in // List of groups applied to the first process run in the sandbox, in
// addition to the sandbox's primary GID. // addition to the sandbox's primary GID.
repeated int64 supplemental_groups = 5; repeated int64 supplemental_groups = 5;
@ -173,7 +179,7 @@ message LinuxSandboxSecurityContext {
// MUST be true. // MUST be true.
// This allows a sandbox to take additional security precautions if no // This allows a sandbox to take additional security precautions if no
// privileged containers are expected to be run. // privileged containers are expected to be run.
optional bool privileged = 6; bool privileged = 6;
} }
// LinuxPodSandboxConfig holds platform-specific configurations for Linux // LinuxPodSandboxConfig holds platform-specific configurations for Linux
@ -182,9 +188,9 @@ message LinuxPodSandboxConfig {
// Parent cgroup of the PodSandbox. // Parent cgroup of the PodSandbox.
// The cgroupfs style syntax will be used, but the container runtime can // The cgroupfs style syntax will be used, but the container runtime can
// convert it to systemd semantics if needed. // convert it to systemd semantics if needed.
optional string cgroup_parent = 1; string cgroup_parent = 1;
// LinuxSandboxSecurityContext holds sandbox security attributes. // LinuxSandboxSecurityContext holds sandbox security attributes.
optional LinuxSandboxSecurityContext security_context = 2; LinuxSandboxSecurityContext security_context = 2;
} }
// PodSandboxMetadata holds all necessary information for building the sandbox name. // PodSandboxMetadata holds all necessary information for building the sandbox name.
@ -193,13 +199,13 @@ message LinuxPodSandboxConfig {
// the runtime can construct a unique PodSandboxName based on the metadata. // the runtime can construct a unique PodSandboxName based on the metadata.
message PodSandboxMetadata { message PodSandboxMetadata {
// Pod name of the sandbox. Same as the pod name in the PodSpec. // Pod name of the sandbox. Same as the pod name in the PodSpec.
optional string name = 1; string name = 1;
// Pod UID of the sandbox. Same as the pod UID in the PodSpec. // Pod UID of the sandbox. Same as the pod UID in the PodSpec.
optional string uid = 2; string uid = 2;
// Pod namespace of the sandbox. Same as the pod namespace in the PodSpec. // Pod namespace of the sandbox. Same as the pod namespace in the PodSpec.
optional string namespace = 3; string namespace = 3;
// Attempt number of creating the sandbox. // Attempt number of creating the sandbox. Default: 0.
optional uint32 attempt = 4; uint32 attempt = 4;
} }
// PodSandboxConfig holds all the required and optional fields for creating a // PodSandboxConfig holds all the required and optional fields for creating a
@ -209,9 +215,9 @@ message PodSandboxConfig {
// sandbox, and the runtime should leverage this to ensure correct // sandbox, and the runtime should leverage this to ensure correct
// operation. The runtime may also use this information to improve UX, such // operation. The runtime may also use this information to improve UX, such
// as by constructing a readable name. // as by constructing a readable name.
optional PodSandboxMetadata metadata = 1; PodSandboxMetadata metadata = 1;
// Hostname of the sandbox. // Hostname of the sandbox.
optional string hostname = 2; string hostname = 2;
// Path to the directory on the host in which container log files are // Path to the directory on the host in which container log files are
// stored. // stored.
// By default the log of a container going into the LogDirectory will be // By default the log of a container going into the LogDirectory will be
@ -227,9 +233,9 @@ message PodSandboxConfig {
// container logs are under active discussion in // container logs are under active discussion in
// https://issues.k8s.io/24677. There *may* be future change of direction // https://issues.k8s.io/24677. There *may* be future change of direction
// for logging as the discussion carries on. // for logging as the discussion carries on.
optional string log_directory = 3; string log_directory = 3;
// DNS config for the sandbox. // DNS config for the sandbox.
optional DNSConfig dns_config = 4; DNSConfig dns_config = 4;
// Port mappings for the sandbox. // Port mappings for the sandbox.
repeated PortMapping port_mappings = 5; repeated PortMapping port_mappings = 5;
// Key-value pairs that may be used to scope and select individual resources. // Key-value pairs that may be used to scope and select individual resources.
@ -292,77 +298,77 @@ message PodSandboxConfig {
// //
map<string, string> annotations = 7; map<string, string> annotations = 7;
// Optional configurations specific to Linux hosts. // Optional configurations specific to Linux hosts.
optional LinuxPodSandboxConfig linux = 8; LinuxPodSandboxConfig linux = 8;
} }
message RunPodSandboxRequest { message RunPodSandboxRequest {
// Configuration for creating a PodSandbox. // Configuration for creating a PodSandbox.
optional PodSandboxConfig config = 1; PodSandboxConfig config = 1;
} }
message RunPodSandboxResponse { message RunPodSandboxResponse {
// ID of the PodSandbox to run. // ID of the PodSandbox to run.
optional string pod_sandbox_id = 1; string pod_sandbox_id = 1;
} }
message StopPodSandboxRequest { message StopPodSandboxRequest {
// ID of the PodSandbox to stop. // ID of the PodSandbox to stop.
optional string pod_sandbox_id = 1; string pod_sandbox_id = 1;
} }
message StopPodSandboxResponse {} message StopPodSandboxResponse {}
message RemovePodSandboxRequest { message RemovePodSandboxRequest {
// ID of the PodSandbox to remove. // ID of the PodSandbox to remove.
optional string pod_sandbox_id = 1; string pod_sandbox_id = 1;
} }
message RemovePodSandboxResponse {} message RemovePodSandboxResponse {}
message PodSandboxStatusRequest { message PodSandboxStatusRequest {
// ID of the PodSandbox for which to retrieve status. // ID of the PodSandbox for which to retrieve status.
optional string pod_sandbox_id = 1; string pod_sandbox_id = 1;
} }
// PodSandboxNetworkStatus is the status of the network for a PodSandbox. // PodSandboxNetworkStatus is the status of the network for a PodSandbox.
message PodSandboxNetworkStatus { message PodSandboxNetworkStatus {
// IP address of the PodSandbox. // IP address of the PodSandbox.
optional string ip = 1; string ip = 1;
} }
// Namespace contains paths to the namespaces. // Namespace contains paths to the namespaces.
message Namespace { message Namespace {
// Path to the network namespace. // Path to the network namespace.
optional string network = 1; string network = 1;
// Namespace options for Linux namespaces. // Namespace options for Linux namespaces.
optional NamespaceOption options = 2; NamespaceOption options = 2;
} }
// LinuxSandboxStatus contains status specific to Linux sandboxes. // LinuxSandboxStatus contains status specific to Linux sandboxes.
message LinuxPodSandboxStatus { message LinuxPodSandboxStatus {
// Paths to the sandbox's namespaces. // Paths to the sandbox's namespaces.
optional Namespace namespaces = 1; Namespace namespaces = 1;
} }
enum PodSandboxState { enum PodSandboxState {
SANDBOX_READY = 0; SANDBOX_READY = 0;
SANDBOX_NOTREADY = 1; SANDBOX_NOTREADY = 1;
} }
// PodSandboxStatus contains the status of the PodSandbox. // PodSandboxStatus contains the status of the PodSandbox.
message PodSandboxStatus { message PodSandboxStatus {
// ID of the sandbox. // ID of the sandbox.
optional string id = 1; string id = 1;
// Metadata of the sandbox. // Metadata of the sandbox.
optional PodSandboxMetadata metadata = 2; PodSandboxMetadata metadata = 2;
// State of the sandbox. // State of the sandbox.
optional PodSandboxState state = 3; PodSandboxState state = 3;
// Creation timestamp of the sandbox in nanoseconds. // Creation timestamp of the sandbox in nanoseconds. Must be > 0.
optional int64 created_at = 4; int64 created_at = 4;
// Network contains network status if network is handled by the runtime. // Network contains network status if network is handled by the runtime.
optional PodSandboxNetworkStatus network = 5; PodSandboxNetworkStatus network = 5;
// Linux-specific status to a pod sandbox. // Linux-specific status to a pod sandbox.
optional LinuxPodSandboxStatus linux = 6; LinuxPodSandboxStatus linux = 6;
// Labels are key-value pairs that may be used to scope and select individual resources. // Labels are key-value pairs that may be used to scope and select individual resources.
map<string, string> labels = 7; map<string, string> labels = 7;
// Unstructured key-value map holding arbitrary metadata. // Unstructured key-value map holding arbitrary metadata.
@ -374,16 +380,22 @@ message PodSandboxStatus {
message PodSandboxStatusResponse { message PodSandboxStatusResponse {
// Status of the PodSandbox. // Status of the PodSandbox.
optional PodSandboxStatus status = 1; PodSandboxStatus status = 1;
}
// PodSandboxStateValue is the wrapper of PodSandboxState.
message PodSandboxStateValue {
// State of the sandbox.
PodSandboxState state = 1;
} }
// PodSandboxFilter is used to filter a list of PodSandboxes. // PodSandboxFilter is used to filter a list of PodSandboxes.
// All those fields are combined with 'AND' // All those fields are combined with 'AND'
message PodSandboxFilter { message PodSandboxFilter {
// ID of the sandbox. // ID of the sandbox.
optional string id = 1; string id = 1;
// State of the sandbox. // State of the sandbox.
optional PodSandboxState state = 2; PodSandboxStateValue state = 2;
// LabelSelector to select matches. // LabelSelector to select matches.
// Only api.MatchLabels is supported for now and the requirements // Only api.MatchLabels is supported for now and the requirements
// are ANDed. MatchExpressions is not supported yet. // are ANDed. MatchExpressions is not supported yet.
@ -392,20 +404,20 @@ message PodSandboxFilter {
message ListPodSandboxRequest { message ListPodSandboxRequest {
// PodSandboxFilter to filter a list of PodSandboxes. // PodSandboxFilter to filter a list of PodSandboxes.
optional PodSandboxFilter filter = 1; PodSandboxFilter filter = 1;
} }
// PodSandbox contains minimal information about a sandbox. // PodSandbox contains minimal information about a sandbox.
message PodSandbox { message PodSandbox {
// ID of the PodSandbox. // ID of the PodSandbox.
optional string id = 1; string id = 1;
// Metadata of the PodSandbox. // Metadata of the PodSandbox.
optional PodSandboxMetadata metadata = 2; PodSandboxMetadata metadata = 2;
// State of the PodSandbox. // State of the PodSandbox.
optional PodSandboxState state = 3; PodSandboxState state = 3;
// Creation timestamps of the PodSandbox in nanoseconds. // Creation timestamps of the PodSandbox in nanoseconds. Must be > 0.
optional int64 created_at = 4; int64 created_at = 4;
// Labels of the PodSandbox. // Labels of the PodSandbox.
map<string, string> labels = 5; map<string, string> labels = 5;
// Unstructured key-value map holding arbitrary metadata. // Unstructured key-value map holding arbitrary metadata.
@ -424,12 +436,12 @@ message ListPodSandboxResponse {
// value of a Container's Image field (e.g. imageID or imageDigest), but in 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. // future it will include more detailed information about the different image types.
message ImageSpec { message ImageSpec {
optional string image = 1; string image = 1;
} }
message KeyValue { message KeyValue {
optional string key = 1; string key = 1;
optional string value = 2; string value = 2;
} }
// LinuxContainerResources specifies Linux specific configuration for // LinuxContainerResources specifies Linux specific configuration for
@ -437,24 +449,24 @@ message KeyValue {
// TODO: Consider using Resources from opencontainers/runtime-spec/specs-go // TODO: Consider using Resources from opencontainers/runtime-spec/specs-go
// directly. // directly.
message LinuxContainerResources { message LinuxContainerResources {
// CPU CFS (Completely Fair Scheduler) period. // CPU CFS (Completely Fair Scheduler) period. Default: 0 (not specified).
optional int64 cpu_period = 1; int64 cpu_period = 1;
// CPU CFS (Completely Fair Scheduler) quota. // CPU CFS (Completely Fair Scheduler) quota. Default: 0 (not specified).
optional int64 cpu_quota = 2; int64 cpu_quota = 2;
// CPU shares (relative weight vs. other containers). // CPU shares (relative weight vs. other containers). Default: 0 (not specified).
optional int64 cpu_shares = 3; int64 cpu_shares = 3;
// Memory limit in bytes. // Memory limit in bytes. Default: 0 (not specified).
optional int64 memory_limit_in_bytes = 4; int64 memory_limit_in_bytes = 4;
// OOMScoreAdj adjusts the oom-killer score. // OOMScoreAdj adjusts the oom-killer score. Default: 0 (not specified).
optional int64 oom_score_adj = 5; int64 oom_score_adj = 5;
} }
// SELinuxOption are the labels to be applied to the container. // SELinuxOption are the labels to be applied to the container.
message SELinuxOption { message SELinuxOption {
optional string user = 1; string user = 1;
optional string role = 2; string role = 2;
optional string type = 3; string type = 3;
optional string level = 4; string level = 4;
} }
// Capability contains the container capabilities to add or drop // Capability contains the container capabilities to add or drop
@ -468,7 +480,7 @@ message Capability {
// LinuxContainerSecurityContext holds linux security configuration that will be applied to a container. // LinuxContainerSecurityContext holds linux security configuration that will be applied to a container.
message LinuxContainerSecurityContext { message LinuxContainerSecurityContext {
// Capabilities to add or drop. // Capabilities to add or drop.
optional Capability capabilities = 1; Capability capabilities = 1;
// If set, run container in privileged mode. // If set, run container in privileged mode.
// Privileged mode is incompatible with the following options. If // Privileged mode is incompatible with the following options. If
// privileged is set, the following features MAY have no effect: // privileged is set, the following features MAY have no effect:
@ -486,21 +498,21 @@ message LinuxContainerSecurityContext {
// 6. The device cgroup does not restrict access to any devices. // 6. The device cgroup does not restrict access to any devices.
// 7. All devices from the host's /dev are available within the container. // 7. All devices from the host's /dev are available within the container.
// 8. SELinux restrictions are not applied (e.g. label=disabled). // 8. SELinux restrictions are not applied (e.g. label=disabled).
optional bool privileged = 2; bool privileged = 2;
// Configurations for the container's namespaces. // Configurations for the container's namespaces.
// Only used if the container uses namespace for isolation. // Only used if the container uses namespace for isolation.
optional NamespaceOption namespace_options = 3; NamespaceOption namespace_options = 3;
// SELinux context to be optionally applied. // SELinux context to be optionally applied.
optional SELinuxOption selinux_options = 4; SELinuxOption selinux_options = 4;
// UID to run the container process as. Only one of run_as_user and // UID to run the container process as. Only one of run_as_user and
// run_as_username can be specified at a time. // run_as_username can be specified at a time.
optional int64 run_as_user = 5; Int64Value run_as_user = 5;
// User name to run the container process as. If specified, the user MUST // User name to run the container process as. If specified, the user MUST
// exist in the container image (i.e. in the /etc/passwd inside the image), // exist in the container image (i.e. in the /etc/passwd inside the image),
// and be resolved there by the runtime; otherwise, the runtime MUST error. // and be resolved there by the runtime; otherwise, the runtime MUST error.
optional string run_as_username = 6; string run_as_username = 6;
// If set, the root filesystem of the container is read-only. // If set, the root filesystem of the container is read-only.
optional bool readonly_rootfs = 7; bool readonly_rootfs = 7;
// List of groups applied to the first process run in the container, in // List of groups applied to the first process run in the container, in
// addition to the container's primary GID. // addition to the container's primary GID.
repeated int64 supplemental_groups = 8; repeated int64 supplemental_groups = 8;
@ -510,9 +522,9 @@ message LinuxContainerSecurityContext {
// Linux-based containers. // Linux-based containers.
message LinuxContainerConfig { message LinuxContainerConfig {
// Resources specification for the container. // Resources specification for the container.
optional LinuxContainerResources resources = 1; LinuxContainerResources resources = 1;
// LinuxContainerSecurityContext configuration for the container. // LinuxContainerSecurityContext configuration for the container.
optional LinuxContainerSecurityContext security_context = 2; LinuxContainerSecurityContext security_context = 2;
} }
// ContainerMetadata holds all necessary information for building the container // ContainerMetadata holds all necessary information for building the container
@ -522,22 +534,22 @@ message LinuxContainerConfig {
// within a sandbox for the entire lifetime of the sandbox. // within a sandbox for the entire lifetime of the sandbox.
message ContainerMetadata { message ContainerMetadata {
// Name of the container. Same as the container name in the PodSpec. // Name of the container. Same as the container name in the PodSpec.
optional string name = 1; string name = 1;
// Attempt number of creating the container. // Attempt number of creating the container. Default: 0.
optional uint32 attempt = 2; uint32 attempt = 2;
} }
// Device specifies a host device to mount into a container. // Device specifies a host device to mount into a container.
message Device { message Device {
// Path of the device within the container. // Path of the device within the container.
optional string container_path = 1; string container_path = 1;
// Path of the device on the host. // Path of the device on the host.
optional string host_path = 2; string host_path = 2;
// Cgroups permissions of the device, candidates are one or more of // Cgroups permissions of the device, candidates are one or more of
// * r - allows container to read from the specified device. // * r - allows container to read from the specified device.
// * w - allows container to write to the specified device. // * w - allows container to write to the specified device.
// * m - allows container to create device files that do not yet exist. // * m - allows container to create device files that do not yet exist.
optional string permissions = 3; string permissions = 3;
} }
// ContainerConfig holds all the required and optional fields for creating a // ContainerConfig holds all the required and optional fields for creating a
@ -547,15 +559,15 @@ message ContainerConfig {
// container, and the runtime should leverage this to ensure correct // container, and the runtime should leverage this to ensure correct
// operation. The runtime may also use this information to improve UX, such // operation. The runtime may also use this information to improve UX, such
// as by constructing a readable name. // as by constructing a readable name.
optional ContainerMetadata metadata = 1 ; ContainerMetadata metadata = 1 ;
// Image to use. // Image to use.
optional ImageSpec image = 2; ImageSpec image = 2;
// Command to execute (i.e., entrypoint for docker) // Command to execute (i.e., entrypoint for docker)
repeated string command = 3; repeated string command = 3;
// Args for the Command (i.e., command for docker) // Args for the Command (i.e., command for docker)
repeated string args = 4; repeated string args = 4;
// Current working directory of the command. // Current working directory of the command.
optional string working_dir = 5; string working_dir = 5;
// List of environment variable to set in the container. // List of environment variable to set in the container.
repeated KeyValue envs = 6; repeated KeyValue envs = 6;
// Mounts for the container. // Mounts for the container.
@ -590,56 +602,57 @@ message ContainerConfig {
// container logs are under active discussion in // container logs are under active discussion in
// https://issues.k8s.io/24677. There *may* be future change of direction // https://issues.k8s.io/24677. There *may* be future change of direction
// for logging as the discussion carries on. // for logging as the discussion carries on.
optional string log_path = 11; string log_path = 11;
// Variables for interactive containers, these have very specialized // Variables for interactive containers, these have very specialized
// use-cases (e.g. debugging). // use-cases (e.g. debugging).
// TODO: Determine if we need to continue supporting these fields that are // TODO: Determine if we need to continue supporting these fields that are
// part of Kubernetes's Container Spec. // part of Kubernetes's Container Spec.
optional bool stdin = 12; bool stdin = 12;
optional bool stdin_once = 13; bool stdin_once = 13;
optional bool tty = 14; bool tty = 14;
// Configuration specific to Linux containers. // Configuration specific to Linux containers.
optional LinuxContainerConfig linux = 15; LinuxContainerConfig linux = 15;
} }
message CreateContainerRequest { message CreateContainerRequest {
// ID of the PodSandbox in which the container should be created. // ID of the PodSandbox in which the container should be created.
optional string pod_sandbox_id = 1; string pod_sandbox_id = 1;
// Config of the container. // Config of the container.
optional ContainerConfig config = 2; ContainerConfig config = 2;
// Config of the PodSandbox. This is the same config that was passed // Config of the PodSandbox. This is the same config that was passed
// to RunPodSandboxRequest to create the PodSandbox. It is passed again // to RunPodSandboxRequest to create the PodSandbox. It is passed again
// here just for easy reference. The PodSandboxConfig is immutable and // here just for easy reference. The PodSandboxConfig is immutable and
// remains the same throughout the lifetime of the pod. // remains the same throughout the lifetime of the pod.
optional PodSandboxConfig sandbox_config = 3; PodSandboxConfig sandbox_config = 3;
} }
message CreateContainerResponse { message CreateContainerResponse {
// ID of the created container. // ID of the created container.
optional string container_id = 1; string container_id = 1;
} }
message StartContainerRequest { message StartContainerRequest {
// ID of the container to start. // ID of the container to start.
optional string container_id = 1; string container_id = 1;
} }
message StartContainerResponse {} message StartContainerResponse {}
message StopContainerRequest { message StopContainerRequest {
// ID of the container to stop. // ID of the container to stop.
optional string container_id = 1; string container_id = 1;
// Timeout, in seconds, to stop the container. // Timeout in seconds to wait for the container to stop before forcibly
optional int64 timeout = 2; // terminating it. Default: 0 (forcibly terminate the container immediately)
int64 timeout = 2;
} }
message StopContainerResponse {} message StopContainerResponse {}
message RemoveContainerRequest { message RemoveContainerRequest {
// ID of the container to remove. // ID of the container to remove.
optional string container_id = 1; string container_id = 1;
} }
message RemoveContainerResponse {} message RemoveContainerResponse {}
@ -651,15 +664,21 @@ enum ContainerState {
CONTAINER_UNKNOWN = 3; CONTAINER_UNKNOWN = 3;
} }
// ContainerStateValue is the wrapper of ContainerState.
message ContainerStateValue {
// State of the container.
ContainerState state = 1;
}
// ContainerFilter is used to filter containers. // ContainerFilter is used to filter containers.
// All those fields are combined with 'AND' // All those fields are combined with 'AND'
message ContainerFilter { message ContainerFilter {
// ID of the container. // ID of the container.
optional string id = 1; string id = 1;
// State of the container. // State of the container.
optional ContainerState state = 2; ContainerStateValue state = 2;
// ID of the PodSandbox. // ID of the PodSandbox.
optional string pod_sandbox_id = 3; string pod_sandbox_id = 3;
// LabelSelector to select matches. // LabelSelector to select matches.
// Only api.MatchLabels is supported for now and the requirements // Only api.MatchLabels is supported for now and the requirements
// are ANDed. MatchExpressions is not supported yet. // are ANDed. MatchExpressions is not supported yet.
@ -667,7 +686,7 @@ message ContainerFilter {
} }
message ListContainersRequest { message ListContainersRequest {
optional ContainerFilter filter = 1; ContainerFilter filter = 1;
} }
// Container provides the runtime information for a container, such as ID, hash, // Container provides the runtime information for a container, such as ID, hash,
@ -675,20 +694,20 @@ message ListContainersRequest {
message Container { message Container {
// ID of the container, used by the container runtime to identify // ID of the container, used by the container runtime to identify
// a container. // a container.
optional string id = 1; string id = 1;
// ID of the sandbox to which this container belongs. // ID of the sandbox to which this container belongs.
optional string pod_sandbox_id = 2; string pod_sandbox_id = 2;
// Metadata of the container. // Metadata of the container.
optional ContainerMetadata metadata = 3; ContainerMetadata metadata = 3;
// Spec of the image. // Spec of the image.
optional ImageSpec image = 4; ImageSpec image = 4;
// Reference to the image in use. For most runtimes, this should be an // Reference to the image in use. For most runtimes, this should be an
// image ID. // image ID.
optional string image_ref = 5; string image_ref = 5;
// State of the container. // State of the container.
optional ContainerState state = 6; ContainerState state = 6;
// Creation time of the container in nanoseconds. // Creation time of the container in nanoseconds.
optional int64 created_at = 7; int64 created_at = 7;
// Key-value pairs that may be used to scope and select individual resources. // Key-value pairs that may be used to scope and select individual resources.
map<string, string> labels = 8; map<string, string> labels = 8;
// Unstructured key-value map holding arbitrary metadata. // Unstructured key-value map holding arbitrary metadata.
@ -705,35 +724,35 @@ message ListContainersResponse {
message ContainerStatusRequest { message ContainerStatusRequest {
// ID of the container for which to retrieve status. // ID of the container for which to retrieve status.
optional string container_id = 1; string container_id = 1;
} }
// ContainerStatus represents the status of a container. // ContainerStatus represents the status of a container.
message ContainerStatus { message ContainerStatus {
// ID of the container. // ID of the container.
optional string id = 1; string id = 1;
// Metadata of the container. // Metadata of the container.
optional ContainerMetadata metadata = 2; ContainerMetadata metadata = 2;
// Status of the container. // Status of the container.
optional ContainerState state = 3; ContainerState state = 3;
// Creation time of the container in nanoseconds. // Creation time of the container in nanoseconds.
optional int64 created_at = 4; int64 created_at = 4;
// Start time of the container in nanoseconds. // Start time of the container in nanoseconds. Default: 0 (not specified).
optional int64 started_at = 5; int64 started_at = 5;
// Finish time of the container in nanoseconds. // Finish time of the container in nanoseconds. Default: 0 (not specified).
optional int64 finished_at = 6; int64 finished_at = 6;
// Exit code of the container. // Exit code of the container. Only required when finished_at != 0. Default: 0.
optional int32 exit_code = 7; int32 exit_code = 7;
// Spec of the image. // Spec of the image.
optional ImageSpec image = 8; ImageSpec image = 8;
// Reference to the image in use. For most runtimes, this should be an // Reference to the image in use. For most runtimes, this should be an
// image ID // image ID
optional string image_ref = 9; string image_ref = 9;
// Brief CamelCase string explaining why container is in its current state. // Brief CamelCase string explaining why container is in its current state.
optional string reason = 10; string reason = 10;
// Human-readable message indicating details about why container is in its // Human-readable message indicating details about why container is in its
// current state. // current state.
optional string message = 11; string message = 11;
// Key-value pairs that may be used to scope and select individual resources. // Key-value pairs that may be used to scope and select individual resources.
map<string,string> labels = 12; map<string,string> labels = 12;
// Unstructured key-value map holding arbitrary metadata. // Unstructured key-value map holding arbitrary metadata.
@ -747,97 +766,97 @@ message ContainerStatus {
message ContainerStatusResponse { message ContainerStatusResponse {
// Status of the container. // Status of the container.
optional ContainerStatus status = 1; ContainerStatus status = 1;
} }
message ExecSyncRequest { message ExecSyncRequest {
// ID of the container. // ID of the container.
optional string container_id = 1; string container_id = 1;
// Command to execute. // Command to execute.
repeated string cmd = 2; repeated string cmd = 2;
// Timeout in seconds to stop the command. Default: run forever. // Timeout in seconds to stop the command. Default: 0 (run forever).
optional int64 timeout = 3; int64 timeout = 3;
} }
message ExecSyncResponse { message ExecSyncResponse {
// Captured command stdout output. // Captured command stdout output.
optional bytes stdout = 1; bytes stdout = 1;
// Captured command stderr output. // Captured command stderr output.
optional bytes stderr = 2; bytes stderr = 2;
// Exit code the command finished with. // Exit code the command finished with. Default: 0 (success).
optional int32 exit_code = 3; int32 exit_code = 3;
} }
message ExecRequest { message ExecRequest {
// ID of the container in which to execute the command. // ID of the container in which to execute the command.
optional string container_id = 1; string container_id = 1;
// Command to execute. // Command to execute.
repeated string cmd = 2; repeated string cmd = 2;
// Whether to exec the command in a TTY. // Whether to exec the command in a TTY.
optional bool tty = 3; bool tty = 3;
// Whether to stream stdin. // Whether to stream stdin.
optional bool stdin = 4; bool stdin = 4;
} }
message ExecResponse { message ExecResponse {
// Fully qualified URL of the exec streaming server. // Fully qualified URL of the exec streaming server.
optional string url = 1; string url = 1;
} }
message AttachRequest { message AttachRequest {
// ID of the container to which to attach. // ID of the container to which to attach.
optional string container_id = 1; string container_id = 1;
// Whether to stream stdin. // Whether to stream stdin.
optional bool stdin = 2; bool stdin = 2;
// Whether the process being attached is running in a TTY. // Whether the process being attached is running in a TTY.
// This must match the TTY setting in the ContainerConfig. // This must match the TTY setting in the ContainerConfig.
optional bool tty = 3; bool tty = 3;
} }
message AttachResponse { message AttachResponse {
// Fully qualified URL of the attach streaming server. // Fully qualified URL of the attach streaming server.
optional string url = 1; string url = 1;
} }
message PortForwardRequest { message PortForwardRequest {
// ID of the container to which to forward the port. // ID of the container to which to forward the port.
optional string pod_sandbox_id = 1; string pod_sandbox_id = 1;
// Port to forward. // Port to forward.
repeated int32 port = 2; repeated int32 port = 2;
} }
message PortForwardResponse { message PortForwardResponse {
// Fully qualified URL of the port-forward streaming server. // Fully qualified URL of the port-forward streaming server.
optional string url = 1; string url = 1;
} }
message ImageFilter { message ImageFilter {
// Spec of the image. // Spec of the image.
optional ImageSpec image = 1; ImageSpec image = 1;
} }
message ListImagesRequest { message ListImagesRequest {
// Filter to list images. // Filter to list images.
optional ImageFilter filter = 1; ImageFilter filter = 1;
} }
// Basic information about a container image. // Basic information about a container image.
message Image { message Image {
// ID of the image. // ID of the image.
optional string id = 1; string id = 1;
// Other names by which this image is known. // Other names by which this image is known.
repeated string repo_tags = 2; repeated string repo_tags = 2;
// Digests by which this image is known. // Digests by which this image is known.
repeated string repo_digests = 3; repeated string repo_digests = 3;
// Size of the image in bytes. // Size of the image in bytes. Must be > 0.
optional uint64 size = 4; uint64 size = 4;
// UID that will run the command(s). This is used as a default if no user is // UID that will run the command(s). This is used as a default if no user is
// specified when creating the container. UID and the following user name // specified when creating the container. UID and the following user name
// are mutually exclusive. // are mutually exclusive.
optional int64 uid = 5; Int64Value uid = 5;
// User name that will run the command(s). This is used if UID is not set // User name that will run the command(s). This is used if UID is not set
// and no user is specified when creating container. // and no user is specified when creating container.
optional string username = 6; string username = 6;
} }
message ListImagesResponse { message ListImagesResponse {
@ -847,67 +866,67 @@ message ListImagesResponse {
message ImageStatusRequest { message ImageStatusRequest {
// Spec of the image. // Spec of the image.
optional ImageSpec image = 1; ImageSpec image = 1;
} }
message ImageStatusResponse { message ImageStatusResponse {
// Status of the image. // Status of the image.
optional Image image = 1; Image image = 1;
} }
// AuthConfig contains authorization information for connecting to a registry. // AuthConfig contains authorization information for connecting to a registry.
message AuthConfig { message AuthConfig {
optional string username = 1; string username = 1;
optional string password = 2; string password = 2;
optional string auth = 3; string auth = 3;
optional string server_address = 4; string server_address = 4;
// IdentityToken is used to authenticate the user and get // IdentityToken is used to authenticate the user and get
// an access token for the registry. // an access token for the registry.
optional string identity_token = 5; string identity_token = 5;
// RegistryToken is a bearer token to be sent to a registry // RegistryToken is a bearer token to be sent to a registry
optional string registry_token = 6; string registry_token = 6;
} }
message PullImageRequest { message PullImageRequest {
// Spec of the image. // Spec of the image.
optional ImageSpec image = 1; ImageSpec image = 1;
// Authentication configuration for pulling the image. // Authentication configuration for pulling the image.
optional AuthConfig auth = 2; AuthConfig auth = 2;
// Config of the PodSandbox, which is used to pull image in PodSandbox context. // Config of the PodSandbox, which is used to pull image in PodSandbox context.
optional PodSandboxConfig sandbox_config = 3; PodSandboxConfig sandbox_config = 3;
} }
message PullImageResponse { message PullImageResponse {
// Reference to the image in use. For most runtimes, this should be an // Reference to the image in use. For most runtimes, this should be an
// image ID or digest. // image ID or digest.
optional string image_ref = 1; string image_ref = 1;
} }
message RemoveImageRequest { message RemoveImageRequest {
// Spec of the image to remove. // Spec of the image to remove.
optional ImageSpec image = 1; ImageSpec image = 1;
} }
message RemoveImageResponse {} message RemoveImageResponse {}
message NetworkConfig { message NetworkConfig {
// CIDR to use for pod IP addresses. // CIDR to use for pod IP addresses.
optional string pod_cidr = 1; string pod_cidr = 1;
} }
message RuntimeConfig { message RuntimeConfig {
optional NetworkConfig network_config = 1; NetworkConfig network_config = 1;
} }
message UpdateRuntimeConfigRequest { message UpdateRuntimeConfigRequest {
optional RuntimeConfig runtime_config = 1; RuntimeConfig runtime_config = 1;
} }
message UpdateRuntimeConfigResponse {} message UpdateRuntimeConfigResponse {}
// RuntimeCondition contains condition information for the runtime. // RuntimeCondition contains condition information for the runtime.
// There are 2 kinds of runtime conditions: // There are 2 kinds of runtime conditions:
// 1. Required condtitions: Conditions are required for kubelet to work // 1. Required conditions: Conditions are required for kubelet to work
// properly. If any required condition is unmet, the node will be not ready. // properly. If any required condition is unmet, the node will be not ready.
// The required conditions include: // The required conditions include:
// * RuntimeReady: RuntimeReady means the runtime is up and ready to accept // * RuntimeReady: RuntimeReady means the runtime is up and ready to accept
@ -920,13 +939,13 @@ message UpdateRuntimeConfigResponse {}
// them understand the status of the system. // them understand the status of the system.
message RuntimeCondition { message RuntimeCondition {
// Type of runtime condition. // Type of runtime condition.
optional string type = 1; string type = 1;
// Status of the condition, one of true/false. // Status of the condition, one of true/false. Default: false.
optional bool status = 2; bool status = 2;
// Brief CamelCase string containing reason for the condition's last transition. // Brief CamelCase string containing reason for the condition's last transition.
optional string reason = 3; string reason = 3;
// Human-readable message indicating details about last transition. // Human-readable message indicating details about last transition.
optional string message = 4; string message = 4;
} }
// RuntimeStatus is information about the current status of the runtime. // RuntimeStatus is information about the current status of the runtime.
@ -939,5 +958,5 @@ message StatusRequest {}
message StatusResponse { message StatusResponse {
// Status of the Runtime. // Status of the Runtime.
optional RuntimeStatus status = 1; RuntimeStatus status = 1;
} }