diff --git a/pkg/kubelet/api/services.go b/pkg/kubelet/api/services.go index 715c53e4f4a..4fb6aefb4f1 100644 --- a/pkg/kubelet/api/services.go +++ b/pkg/kubelet/api/services.go @@ -33,9 +33,9 @@ type RuntimeService interface { // StopPodSandbox stops the sandbox. If there are any running containers in the // sandbox, they should be force terminated. StopPodSandbox(podSandboxID string) error - // DeletePodSandbox deletes the sandbox. If there are running containers in the - // sandbox, they should be forcibly deleted. - DeletePodSandbox(podSandboxID string) error + // RemovePodSandbox removes the sandbox. If there are running containers in the + // sandbox, they should be forcibly removed. + RemovePodSandbox(podSandboxID string) error // PodSandboxStatus returns the Status of the PodSandbox. PodSandboxStatus(podSandboxID string) (*runtimeApi.PodSandboxStatus, error) // ListPodSandbox returns a list of Sandbox. diff --git a/pkg/kubelet/api/testing/fake_runtime_service.go b/pkg/kubelet/api/testing/fake_runtime_service.go index a8074a6aaca..21c2922058e 100644 --- a/pkg/kubelet/api/testing/fake_runtime_service.go +++ b/pkg/kubelet/api/testing/fake_runtime_service.go @@ -144,11 +144,11 @@ func (r *FakeRuntimeService) StopPodSandbox(podSandboxID string) error { return nil } -func (r *FakeRuntimeService) DeletePodSandbox(podSandboxID string) error { +func (r *FakeRuntimeService) RemovePodSandbox(podSandboxID string) error { r.Lock() defer r.Unlock() - r.Called = append(r.Called, "DeletePodSandbox") + r.Called = append(r.Called, "RemovePodSandbox") // Remove the pod sandbox delete(r.Sandboxes, podSandboxID) diff --git a/pkg/kubelet/api/v1alpha1/runtime/api.pb.go b/pkg/kubelet/api/v1alpha1/runtime/api.pb.go index 09540859d5b..4a844f5b17e 100644 --- a/pkg/kubelet/api/v1alpha1/runtime/api.pb.go +++ b/pkg/kubelet/api/v1alpha1/runtime/api.pb.go @@ -39,8 +39,8 @@ It has these top-level messages: CreatePodSandboxResponse StopPodSandboxRequest StopPodSandboxResponse - DeletePodSandboxRequest - DeletePodSandboxResponse + RemovePodSandboxRequest + RemovePodSandboxResponse PodSandboxStatusRequest PodSandboxNetworkStatus Namespace @@ -700,30 +700,30 @@ func (m *StopPodSandboxResponse) Reset() { *m = StopPodSandboxResponse{} func (m *StopPodSandboxResponse) String() string { return proto.CompactTextString(m) } func (*StopPodSandboxResponse) ProtoMessage() {} -type DeletePodSandboxRequest struct { +type RemovePodSandboxRequest struct { // The id of the PodSandBox PodSandboxId *string `protobuf:"bytes,1,opt,name=pod_sandbox_id" json:"pod_sandbox_id,omitempty"` XXX_unrecognized []byte `json:"-"` } -func (m *DeletePodSandboxRequest) Reset() { *m = DeletePodSandboxRequest{} } -func (m *DeletePodSandboxRequest) String() string { return proto.CompactTextString(m) } -func (*DeletePodSandboxRequest) ProtoMessage() {} +func (m *RemovePodSandboxRequest) Reset() { *m = RemovePodSandboxRequest{} } +func (m *RemovePodSandboxRequest) String() string { return proto.CompactTextString(m) } +func (*RemovePodSandboxRequest) ProtoMessage() {} -func (m *DeletePodSandboxRequest) GetPodSandboxId() string { +func (m *RemovePodSandboxRequest) GetPodSandboxId() string { if m != nil && m.PodSandboxId != nil { return *m.PodSandboxId } return "" } -type DeletePodSandboxResponse struct { +type RemovePodSandboxResponse struct { XXX_unrecognized []byte `json:"-"` } -func (m *DeletePodSandboxResponse) Reset() { *m = DeletePodSandboxResponse{} } -func (m *DeletePodSandboxResponse) String() string { return proto.CompactTextString(m) } -func (*DeletePodSandboxResponse) ProtoMessage() {} +func (m *RemovePodSandboxResponse) Reset() { *m = RemovePodSandboxResponse{} } +func (m *RemovePodSandboxResponse) String() string { return proto.CompactTextString(m) } +func (*RemovePodSandboxResponse) ProtoMessage() {} type PodSandboxStatusRequest struct { // The id of the PodSandBox @@ -2255,8 +2255,8 @@ func init() { proto.RegisterType((*CreatePodSandboxResponse)(nil), "runtime.CreatePodSandboxResponse") proto.RegisterType((*StopPodSandboxRequest)(nil), "runtime.StopPodSandboxRequest") proto.RegisterType((*StopPodSandboxResponse)(nil), "runtime.StopPodSandboxResponse") - proto.RegisterType((*DeletePodSandboxRequest)(nil), "runtime.DeletePodSandboxRequest") - proto.RegisterType((*DeletePodSandboxResponse)(nil), "runtime.DeletePodSandboxResponse") + proto.RegisterType((*RemovePodSandboxRequest)(nil), "runtime.RemovePodSandboxRequest") + proto.RegisterType((*RemovePodSandboxResponse)(nil), "runtime.RemovePodSandboxResponse") proto.RegisterType((*PodSandboxStatusRequest)(nil), "runtime.PodSandboxStatusRequest") proto.RegisterType((*PodSandboxNetworkStatus)(nil), "runtime.PodSandboxNetworkStatus") proto.RegisterType((*Namespace)(nil), "runtime.Namespace") @@ -2320,14 +2320,14 @@ type RuntimeServiceClient interface { // CreatePodSandbox creates a pod-level sandbox. // The definition of PodSandbox is at https://github.com/kubernetes/kubernetes/pull/25899 CreatePodSandbox(ctx context.Context, in *CreatePodSandboxRequest, opts ...grpc.CallOption) (*CreatePodSandboxResponse, error) - // StopPodSandbox stops the sandbox. If there are any running containers in the - // sandbox, they should be force terminated. + // StopPodSandbox stops the running sandbox. If there are any running + // containers in the sandbox, they should be forcibly terminated. StopPodSandbox(ctx context.Context, in *StopPodSandboxRequest, opts ...grpc.CallOption) (*StopPodSandboxResponse, error) - // DeletePodSandbox deletes the sandbox. If there are any running containers in the - // sandbox, they should be force deleted. - // It should return success if the sandbox has already been deleted. - DeletePodSandbox(ctx context.Context, in *DeletePodSandboxRequest, opts ...grpc.CallOption) (*DeletePodSandboxResponse, error) - // PodSandboxStatus returns the Status of the PodSandbox. + // RemovePodSandbox removes the sandbox. If there are any running containers in the + // sandbox, they should be forcibly removed. + // It should return success if the sandbox has already been removed. + RemovePodSandbox(ctx context.Context, in *RemovePodSandboxRequest, opts ...grpc.CallOption) (*RemovePodSandboxResponse, error) + // PodSandboxStatus returns the status of the PodSandbox. PodSandboxStatus(ctx context.Context, in *PodSandboxStatusRequest, opts ...grpc.CallOption) (*PodSandboxStatusResponse, error) // ListPodSandbox returns a list of SandBox. ListPodSandbox(ctx context.Context, in *ListPodSandboxRequest, opts ...grpc.CallOption) (*ListPodSandboxResponse, error) @@ -2337,8 +2337,8 @@ type RuntimeServiceClient interface { StartContainer(ctx context.Context, in *StartContainerRequest, opts ...grpc.CallOption) (*StartContainerResponse, error) // StopContainer stops a running container with a grace period (i.e., timeout). StopContainer(ctx context.Context, in *StopContainerRequest, opts ...grpc.CallOption) (*StopContainerResponse, error) - // RemoveContainer removes the container. If the container is running, the container - // should be force removed. + // RemoveContainer removes the container. If the container is running, the + // container should be forcibly removed. // It should return success if the container has already been removed. RemoveContainer(ctx context.Context, in *RemoveContainerRequest, opts ...grpc.CallOption) (*RemoveContainerResponse, error) // ListContainers lists all containers by filters. @@ -2384,9 +2384,9 @@ func (c *runtimeServiceClient) StopPodSandbox(ctx context.Context, in *StopPodSa return out, nil } -func (c *runtimeServiceClient) DeletePodSandbox(ctx context.Context, in *DeletePodSandboxRequest, opts ...grpc.CallOption) (*DeletePodSandboxResponse, error) { - out := new(DeletePodSandboxResponse) - err := grpc.Invoke(ctx, "/runtime.RuntimeService/DeletePodSandbox", in, out, c.cc, opts...) +func (c *runtimeServiceClient) RemovePodSandbox(ctx context.Context, in *RemovePodSandboxRequest, opts ...grpc.CallOption) (*RemovePodSandboxResponse, error) { + out := new(RemovePodSandboxResponse) + err := grpc.Invoke(ctx, "/runtime.RuntimeService/RemovePodSandbox", in, out, c.cc, opts...) if err != nil { return nil, err } @@ -2504,14 +2504,14 @@ type RuntimeServiceServer interface { // CreatePodSandbox creates a pod-level sandbox. // The definition of PodSandbox is at https://github.com/kubernetes/kubernetes/pull/25899 CreatePodSandbox(context.Context, *CreatePodSandboxRequest) (*CreatePodSandboxResponse, error) - // StopPodSandbox stops the sandbox. If there are any running containers in the - // sandbox, they should be force terminated. + // StopPodSandbox stops the running sandbox. If there are any running + // containers in the sandbox, they should be forcibly terminated. StopPodSandbox(context.Context, *StopPodSandboxRequest) (*StopPodSandboxResponse, error) - // DeletePodSandbox deletes the sandbox. If there are any running containers in the - // sandbox, they should be force deleted. - // It should return success if the sandbox has already been deleted. - DeletePodSandbox(context.Context, *DeletePodSandboxRequest) (*DeletePodSandboxResponse, error) - // PodSandboxStatus returns the Status of the PodSandbox. + // RemovePodSandbox removes the sandbox. If there are any running containers in the + // sandbox, they should be forcibly removed. + // It should return success if the sandbox has already been removed. + RemovePodSandbox(context.Context, *RemovePodSandboxRequest) (*RemovePodSandboxResponse, error) + // PodSandboxStatus returns the status of the PodSandbox. PodSandboxStatus(context.Context, *PodSandboxStatusRequest) (*PodSandboxStatusResponse, error) // ListPodSandbox returns a list of SandBox. ListPodSandbox(context.Context, *ListPodSandboxRequest) (*ListPodSandboxResponse, error) @@ -2521,8 +2521,8 @@ type RuntimeServiceServer interface { StartContainer(context.Context, *StartContainerRequest) (*StartContainerResponse, error) // StopContainer stops a running container with a grace period (i.e., timeout). StopContainer(context.Context, *StopContainerRequest) (*StopContainerResponse, error) - // RemoveContainer removes the container. If the container is running, the container - // should be force removed. + // RemoveContainer removes the container. If the container is running, the + // container should be forcibly removed. // It should return success if the container has already been removed. RemoveContainer(context.Context, *RemoveContainerRequest) (*RemoveContainerResponse, error) // ListContainers lists all containers by filters. @@ -2573,12 +2573,12 @@ func _RuntimeService_StopPodSandbox_Handler(srv interface{}, ctx context.Context return out, nil } -func _RuntimeService_DeletePodSandbox_Handler(srv interface{}, ctx context.Context, dec func(interface{}) error) (interface{}, error) { - in := new(DeletePodSandboxRequest) +func _RuntimeService_RemovePodSandbox_Handler(srv interface{}, ctx context.Context, dec func(interface{}) error) (interface{}, error) { + in := new(RemovePodSandboxRequest) if err := dec(in); err != nil { return nil, err } - out, err := srv.(RuntimeServiceServer).DeletePodSandbox(ctx, in) + out, err := srv.(RuntimeServiceServer).RemovePodSandbox(ctx, in) if err != nil { return nil, err } @@ -2724,8 +2724,8 @@ var _RuntimeService_serviceDesc = grpc.ServiceDesc{ Handler: _RuntimeService_StopPodSandbox_Handler, }, { - MethodName: "DeletePodSandbox", - Handler: _RuntimeService_DeletePodSandbox_Handler, + MethodName: "RemovePodSandbox", + Handler: _RuntimeService_RemovePodSandbox_Handler, }, { MethodName: "PodSandboxStatus", diff --git a/pkg/kubelet/api/v1alpha1/runtime/api.proto b/pkg/kubelet/api/v1alpha1/runtime/api.proto index 27907e477b5..9fe3b7ca79f 100644 --- a/pkg/kubelet/api/v1alpha1/runtime/api.proto +++ b/pkg/kubelet/api/v1alpha1/runtime/api.proto @@ -1,4 +1,4 @@ -// api.pb.go could be generate by hack/update-generate-runtime.sh +// To regenerate api.pb.go run hack/update-generated-runtime.sh syntax = 'proto2'; package runtime; @@ -11,14 +11,14 @@ service RuntimeService { // CreatePodSandbox creates a pod-level sandbox. // The definition of PodSandbox is at https://github.com/kubernetes/kubernetes/pull/25899 rpc CreatePodSandbox(CreatePodSandboxRequest) returns (CreatePodSandboxResponse) {} - // StopPodSandbox stops the sandbox. If there are any running containers in the - // sandbox, they should be force terminated. + // StopPodSandbox stops the running sandbox. If there are any running + // containers in the sandbox, they should be forcibly terminated. rpc StopPodSandbox(StopPodSandboxRequest) returns (StopPodSandboxResponse) {} - // DeletePodSandbox deletes the sandbox. If there are any running containers in the - // sandbox, they should be force deleted. - // It should return success if the sandbox has already been deleted. - rpc DeletePodSandbox(DeletePodSandboxRequest) returns (DeletePodSandboxResponse) {} - // PodSandboxStatus returns the Status of the PodSandbox. + // RemovePodSandbox removes the sandbox. If there are any running containers in the + // sandbox, they should be forcibly removed. + // It should return success if the sandbox has already been removed. + rpc RemovePodSandbox(RemovePodSandboxRequest) returns (RemovePodSandboxResponse) {} + // PodSandboxStatus returns the status of the PodSandbox. rpc PodSandboxStatus(PodSandboxStatusRequest) returns (PodSandboxStatusResponse) {} // ListPodSandbox returns a list of SandBox. rpc ListPodSandbox(ListPodSandboxRequest) returns (ListPodSandboxResponse) {} @@ -29,8 +29,8 @@ service RuntimeService { rpc StartContainer(StartContainerRequest) returns (StartContainerResponse) {} // StopContainer stops a running container with a grace period (i.e., timeout). rpc StopContainer(StopContainerRequest) returns (StopContainerResponse) {} - // RemoveContainer removes the container. If the container is running, the container - // should be force removed. + // RemoveContainer removes the container. If the container is running, the + // container should be forcibly removed. // It should return success if the container has already been removed. rpc RemoveContainer(RemoveContainerRequest) returns (RemoveContainerResponse) {} // ListContainers lists all containers by filters. @@ -214,12 +214,12 @@ message StopPodSandboxRequest { message StopPodSandboxResponse {} -message DeletePodSandboxRequest { +message RemovePodSandboxRequest { // The id of the PodSandBox optional string pod_sandbox_id = 1; } -message DeletePodSandboxResponse {} +message RemovePodSandboxResponse {} message PodSandboxStatusRequest { // The id of the PodSandBox @@ -318,8 +318,8 @@ message ListPodSandboxResponse { } // ImageSpec is an internal representation of an image. Currently, it wraps the -// value of a Container's Image field (e.g. imageName, imageName:tag, or -// imageName:digest), but in the future it will include more detailed +// value of a Container's Image field (e.g. imageName, imageName:tag, or +// imageName:digest), but in the future it will include more detailed // information about the different image types. message ImageSpec { optional string image = 1; diff --git a/pkg/kubelet/dockershim/docker_sandbox.go b/pkg/kubelet/dockershim/docker_sandbox.go index 0c75be26ba5..e53cf12ab1a 100644 --- a/pkg/kubelet/dockershim/docker_sandbox.go +++ b/pkg/kubelet/dockershim/docker_sandbox.go @@ -72,9 +72,9 @@ func (ds *dockerService) StopPodSandbox(podSandboxID string) error { // TODO: Stop all running containers in the sandbox. } -// DeletePodSandbox deletes the sandbox. If there are running containers in the -// sandbox, they should be forcibly deleted. -func (ds *dockerService) DeletePodSandbox(podSandboxID string) error { +// RemovePodSandbox removes the sandbox. If there are running containers in the +// sandbox, they should be forcibly removed. +func (ds *dockerService) RemovePodSandbox(podSandboxID string) error { return ds.client.RemoveContainer(podSandboxID, dockertypes.ContainerRemoveOptions{RemoveVolumes: true}) // TODO: remove all containers in the sandbox. } diff --git a/pkg/kubelet/remote/remote_runtime.go b/pkg/kubelet/remote/remote_runtime.go index 9e2ae073649..b6a0c9fb30e 100644 --- a/pkg/kubelet/remote/remote_runtime.go +++ b/pkg/kubelet/remote/remote_runtime.go @@ -97,17 +97,17 @@ func (r *RemoteRuntimeService) StopPodSandbox(podSandBoxID string) error { return nil } -// DeletePodSandbox deletes the sandbox. If there are any containers in the -// sandbox, they should be forced to deletion. -func (r *RemoteRuntimeService) DeletePodSandbox(podSandBoxID string) error { +// RemovePodSandbox removes the sandbox. If there are any containers in the +// sandbox, they should be forcibly removed. +func (r *RemoteRuntimeService) RemovePodSandbox(podSandBoxID string) error { ctx, cancel := getContextWithTimeout(r.timeout) defer cancel() - _, err := r.runtimeClient.DeletePodSandbox(ctx, &runtimeApi.DeletePodSandboxRequest{ + _, err := r.runtimeClient.RemovePodSandbox(ctx, &runtimeApi.RemovePodSandboxRequest{ PodSandboxId: &podSandBoxID, }) if err != nil { - glog.Errorf("DeletePodSandbox %q from runtime service failed: %v", podSandBoxID, err) + glog.Errorf("RemovePodSandbox %q from runtime service failed: %v", podSandBoxID, err) return err }