package runtime.v1alpha1

Get desktop application:
View/edit binary Protocol Buffers messages

Runtime service defines the public APIs for talk between RuntimeHookServer and RuntimeManager

• rpc PreRunPodSandboxHook (PodSandboxHookRequest, PodSandboxHookResponse)

  api.proto:152

  PreRunPodSandboxHook calls RuntimeHookServer before pod creating, and would merge RunPodSandboxHookResponse and Original RunPodSandboxRequest generating a new RunPodSandboxRequest to transfer to backend runtime engine. RuntimeHookServer should ensure the correct operations basing on RunPodSandboxHookRequest.

• rpc PostStopPodSandboxHook (PodSandboxHookRequest, PodSandboxHookResponse)

  api.proto:155

  PostStopPodSandboxHook calls RuntimeHookServer after pod deleted. RuntimeHookServer could do resource setting garbage collection sanity check after PodSandBox stopped.

• rpc PreCreateContainerHook (ContainerResourceHookRequest, ContainerResourceHookResponse)

  api.proto:158

  PreCreateContainerHook calls RuntimeHookServer before container creating. RuntimeHookServer could do some resource setting before container launching.

• rpc PreStartContainerHook (ContainerResourceHookRequest, ContainerResourceHookResponse)

  api.proto:161

  PreStartContainerHook calls RuntimeHookServer before container starting, RuntimeHookServer could do some resource adjustments before container launching.

• rpc PostStartContainerHook (ContainerResourceHookRequest, ContainerResourceHookResponse)

  api.proto:164

  PostStartContainerHook calls RuntimeHookServer after container starting. RuntimeHookServer could do resource set checking after container launch.

• rpc PostStopContainerHook (ContainerResourceHookRequest, ContainerResourceHookResponse)

  api.proto:167

  PostStopContainerHook calls RuntimeHookServer after container stop. RuntimeHookServer could do resource setting garbage collection.

• rpc PreUpdateContainerResourcesHook (ContainerResourceHookRequest, ContainerResourceHookResponse)

  api.proto:170

  PreUpdateContainerResourcesHook calls RuntimeHookServer before container resource update to keep resource policy consistent

Used in: ContainerResourceHookRequest

• string name = 1

  Name of the container. Same as the container name in the PodSpec.

• uint32 attempt = 2

  Attempt number of creating the container. Default: 0.

• string id = 3

  Id of the container.

ContainerResourceHookRequest is sent to RuntimeHookServer before/after container related operations including pre-container-start, post-container-create, pre-container-resource-update, post-container-stop.

Used as request type in: RuntimeHookService.PostStartContainerHook, RuntimeHookService.PostStopContainerHook, RuntimeHookService.PreCreateContainerHook, RuntimeHookService.PreStartContainerHook, RuntimeHookService.PreUpdateContainerResourcesHook

• optional PodSandboxMetadata pod_meta = 1

• optional ContainerMetadata container_meta = 2

• map<string, string> container_annotations = 3

  container related annotations

• optional LinuxContainerResources container_resources = 4

• optional LinuxContainerResources pod_resources = 5

• map<string, string> pod_annotations = 6

  pod related annotations and labels

• map<string, string> pod_labels = 7

• string pod_cgroup_parent = 8

• map<string, string> container_envs = 9

  TODO: add the error info from containerd/dockerd

ContainerResourceHookResponse is RuntimeHookServer's response to ContainerResourceHookRequest. RuntimeManager will merge ContainerResourceHookResponse and Pre hookType Request to generate a RunPodSandboxRequest to containerd(dockerd).

Used as response type in: RuntimeHookService.PostStartContainerHook, RuntimeHookService.PostStopContainerHook, RuntimeHookService.PreCreateContainerHook, RuntimeHookService.PreStartContainerHook, RuntimeHookService.PreUpdateContainerResourcesHook

• map<string, string> container_annotations = 1

• optional LinuxContainerResources container_resources = 2

• string pod_cgroup_parent = 3

• map<string, string> container_envs = 4

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

Used in: LinuxContainerResources

• string page_size = 1

  The value of PageSize has the format <size><unit-prefix>B (2MB, 1GB), and must match the <hugepagesize> of the corresponding control file found in `hugetlb.<hugepagesize>.limit_in_bytes`. The values of <unit-prefix> are intended to be parsed using base 1024("1KB" = 1024, "1MB" = 1048576, etc).

• uint64 limit = 2

  limit in bytes of hugepagesize HugeTLB usage.

LinuxContainerResources specifies Linux specific configuration for resources.

Used in: ContainerResourceHookRequest, ContainerResourceHookResponse, PodSandboxHookRequest, PodSandboxHookResponse

• int64 cpu_period = 1

  CPU CFS (Completely Fair Scheduler) period. Default: 0 (not specified).

• int64 cpu_quota = 2

  CPU CFS (Completely Fair Scheduler) quota. Default: 0 (not specified).

• int64 cpu_shares = 3

  CPU shares (relative weight vs. other containers). Default: 0 (not specified).

• int64 memory_limit_in_bytes = 4

  Memory limit in bytes. Default: 0 (not specified).

• int64 oom_score_adj = 5

  OOMScoreAdj adjusts the oom-killer score. Default: 0 (not specified).

• string cpuset_cpus = 6

  CpusetCpus constrains the allowed set of logical CPUs. Default: "" (not specified).

• string cpuset_mems = 7

  CpusetMems constrains the allowed set of memory nodes. Default: "" (not specified).

• repeated HugepageLimit hugepage_limits = 8

  List of HugepageLimits to limit the HugeTLB usage of container per page size. Default: nil (not specified).

• map<string, string> unified = 9

  Unified resources for cgroup v2. Default: nil (not specified). Each key/value in the map refers to the cgroup v2. e.g. "memory.max": "6937202688" or "io.weight": "default 100".

• int64 memory_swap_limit_in_bytes = 10

  Memory swap limit in bytes. Default 0 (not specified).

RunPodSandboxHookRequest is sent to RuntimeHookServer before pod creating request transferred to backend containerd or dockerd. This Request is generated basing on CRI's RunPodSandboxRequest, including pod Meta, Resources, Annotations .e.g and RuntimeHookServer should ensure correct operations basing on this request.

Used as request type in: RuntimeHookService.PostStopPodSandboxHook, RuntimeHookService.PreRunPodSandboxHook

• optional PodSandboxMetadata pod_meta = 1

  Metadata of the sandbox. This information will uniquely identify the sandbox.

• string runtime_handler = 2

  Named runtime to use for podSandbox.

• map<string, string> labels = 3

  Labels/Annotations are key-value pairs that may be used.

• map<string, string> annotations = 4

• string cgroup_parent = 5

  Parent cgroup of the pod sandbox.

• optional LinuxContainerResources overhead = 6

  Optional overhead represents the overheads associated with this sandbox, same as LinuxPodSandboxConfig.overhead under CRI scenario

• optional LinuxContainerResources resources = 7

  Optional resources represents the sum of container resources for this sandbox same as LinuxPodSandboxConfig.resources under CRI scenario

RunPodSandboxHookResponse is RuntimeHookServer's response to RunPodSandboxHookRequest. RuntimeManager will merge RunPodSandboxHookResponse and RunPodSandboxRequest to generate a RunPodSandboxRequest to containerd(dockerd).

Used as response type in: RuntimeHookService.PostStopPodSandboxHook, RuntimeHookService.PreRunPodSandboxHook

• map<string, string> labels = 1

  RuntimeHookServer may inject additional labels/annotations to PodSandboxRequest to be send to backend contaienrd/dockerd

• map<string, string> annotations = 2

• string cgroup_parent = 3

  RuntimeHookSever may modify cgroup_parent to construct customized cgroup topology.

• optional LinuxContainerResources resources = 4

  RuntimeHookServer may modify the linux resource config. Optional resources represents the sum of container resources for this sandbox

PodSandboxMetadata holds all necessary information for sandbox.

Used in: ContainerResourceHookRequest, PodSandboxHookRequest

• string name = 1

  Pod name of the sandbox. Same as the pod name in the Pod ObjectMeta.

• string uid = 2

  Pod UID of the sandbox. Same as the pod UID in the Pod ObjectMeta.

• string namespace = 3

  Pod namespace of the sandbox. Same as the pod namespace in the Pod ObjectMeta.

• uint32 attempt = 4

  Attempt number of creating the sandbox. Default: 0.