Merge pull request #33516 from yifan-gu/immutable_sandbox_config

Automatic merge from submit-queue

CRI: Add more docs abount pod sandbox config in CreateContainerRequest.

Makes it clear that the config will not change during the pod lifecycle.
The field is only for convenience.
pull/6/head
Kubernetes Submit Queue 2016-09-28 16:47:08 -07:00 committed by GitHub
commit f70ac7da2d
2 changed files with 8 additions and 2 deletions

View File

@ -1523,7 +1523,10 @@ type CreateContainerRequest struct {
PodSandboxId *string `protobuf:"bytes,1,opt,name=pod_sandbox_id,json=podSandboxId" json:"pod_sandbox_id,omitempty"`
// The config of the container
Config *ContainerConfig `protobuf:"bytes,2,opt,name=config" json:"config,omitempty"`
// The config of the PodSandbox
// The config of the PodSandbox. This is the same config that was passed
// to RunPodSandboxRequest to create the PodSandbox. It is passed again
// here just for easy reference. The PodSandboxConfig is immutable and
// remains the same throughout the lifetime of the pod.
SandboxConfig *PodSandboxConfig `protobuf:"bytes,3,opt,name=sandbox_config,json=sandboxConfig" json:"sandbox_config,omitempty"`
XXX_unrecognized []byte `json:"-"`
}

View File

@ -456,7 +456,10 @@ message CreateContainerRequest {
optional string pod_sandbox_id = 1;
// The config of the container
optional ContainerConfig config = 2;
// The config of the PodSandbox
// The config of the PodSandbox. This is the same config that was passed
// to RunPodSandboxRequest to create the PodSandbox. It is passed again
// here just for easy reference. The PodSandboxConfig is immutable and
// remains the same throughout the lifetime of the pod.
optional PodSandboxConfig sandbox_config = 3;
}