Skip to content

K
k3s
Commit cc7f3906 authored by Jonathan Boulle's avatar Jonathan Boulle
Browse files
Options

CRI: various spelling and typo fixes

Also clarify whether some properties belong to containers or sandboxes.
parent 448ceb38
Hide whitespace changes
Inline Side-by-side
Showing with 31 additions and 31 deletions
pkg/kubelet/api/v1alpha1/runtime/api.pb.go
View file @ cc7f3906
...@@ -281,7 +281,7 @@ func (m *VersionResponse) GetRuntimeApiVersion() string { ...@@ -281,7 +281,7 @@ func (m *VersionResponse) GetRuntimeApiVersion() string {
return "" return ""
} }
// DNSConfig specifies the DNS servers and search domains. // DNSConfig specifies the DNS servers and search domains of a sandbox.
type DNSConfig struct { type DNSConfig struct {
// List of DNS servers of the cluster. // List of DNS servers of the cluster.
Servers []string `protobuf:"bytes,1,rep,name=servers" json:"servers,omitempty"` Servers []string `protobuf:"bytes,1,rep,name=servers" json:"servers,omitempty"`
...@@ -319,7 +319,7 @@ func (m *DNSConfig) GetOptions() []string { ...@@ -319,7 +319,7 @@ func (m *DNSConfig) GetOptions() []string {
return nil return nil
} }
// PortMapping specifies the port mapping configurations of sandbox // PortMapping specifies the port mapping configurations of a sandbox.
type PortMapping struct { type PortMapping struct {
// The name of the port mapping // The name of the port mapping
Name *string `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"` Name *string `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"`
...@@ -374,7 +374,7 @@ func (m *PortMapping) GetHostIp() string { ...@@ -374,7 +374,7 @@ func (m *PortMapping) GetHostIp() string {
return "" return ""
} }
// Mount specifies the volume mount for the sandbox // Mount specifies a host volume to mount into a container.
type Mount struct { type Mount struct {
// The name of the volume mount. // The name of the volume mount.
Name *string `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"` Name *string `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"`
...@@ -433,9 +433,9 @@ func (m *Mount) GetSelinuxRelabel() bool { ...@@ -433,9 +433,9 @@ func (m *Mount) GetSelinuxRelabel() bool {
type NamespaceOption struct { type NamespaceOption struct {
// If set, use the host's network namespace. // If set, use the host's network namespace.
HostNetwork *bool `protobuf:"varint,1,opt,name=host_network,json=hostNetwork" json:"host_network,omitempty"` HostNetwork *bool `protobuf:"varint,1,opt,name=host_network,json=hostNetwork" json:"host_network,omitempty"`
// If set, use the host's pid namesapce. // If set, use the host's PID namespace.
HostPid *bool `protobuf:"varint,2,opt,name=host_pid,json=hostPid" json:"host_pid,omitempty"` HostPid *bool `protobuf:"varint,2,opt,name=host_pid,json=hostPid" json:"host_pid,omitempty"`
// If set, use the host's ipc namespace. // If set, use the host's IPC namespace.
HostIpc *bool `protobuf:"varint,3,opt,name=host_ipc,json=hostIpc" json:"host_ipc,omitempty"` HostIpc *bool `protobuf:"varint,3,opt,name=host_ipc,json=hostIpc" json:"host_ipc,omitempty"`
XXX_unrecognized []byte `json:"-"` XXX_unrecognized []byte `json:"-"`
} }
...@@ -466,12 +466,12 @@ func (m *NamespaceOption) GetHostIpc() bool { ...@@ -466,12 +466,12 @@ func (m *NamespaceOption) GetHostIpc() bool {
return false return false
} }
// LinuxPodSandboxConfig holds platform-specific configuraions for Linux // LinuxPodSandboxConfig holds platform-specific configurations for Linux
// host platforms and Linux-based containers. // host platforms and Linux-based containers.
type LinuxPodSandboxConfig struct { type LinuxPodSandboxConfig struct {
// The parent cgroup of the pod sandbox. // The parent cgroup of the pod sandbox.
// 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 semantices if needed. // convert it to systemd semantics if needed.
CgroupParent *string `protobuf:"bytes,1,opt,name=cgroup_parent,json=cgroupParent" json:"cgroup_parent,omitempty"` CgroupParent *string `protobuf:"bytes,1,opt,name=cgroup_parent,json=cgroupParent" json:"cgroup_parent,omitempty"`
// The configurations for the sandbox's namespaces. // The 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.
...@@ -500,12 +500,12 @@ func (m *LinuxPodSandboxConfig) GetNamespaceOptions() *NamespaceOption { ...@@ -500,12 +500,12 @@ func (m *LinuxPodSandboxConfig) GetNamespaceOptions() *NamespaceOption {
// PodSandboxMetadata holds all necessary information for building the sandbox name. // PodSandboxMetadata holds all necessary information for building the sandbox name.
// The container runtime is encouraged to expose the metadata associated with the // The container runtime is encouraged to expose the metadata associated with the
// PodSandbox in its user interface for better user experience. E.g., runtime can // PodSandbox in its user interface for better user experience. For example,
// construct a unique PodSandboxName based on the metadata. // the runtime can construct a unique PodSandboxName based on the metadata.
type PodSandboxMetadata struct { type PodSandboxMetadata struct {
// The pod name of the sandbox. Same as the pod name in the PodSpec. // The pod name of the sandbox. Same as the pod name in the PodSpec.
Name *string `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"` Name *string `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"`
// The pod uid of the sandbox. Same as the pod UID in the PodSpec. // The pod UID of the sandbox. Same as the pod UID in the PodSpec.
Uid *string `protobuf:"bytes,2,opt,name=uid" json:"uid,omitempty"` Uid *string `protobuf:"bytes,2,opt,name=uid" json:"uid,omitempty"`
// The pod namespace of the sandbox. Same as the pod namespace in the PodSpec. // The pod namespace of the sandbox. Same as the pod namespace in the PodSpec.
Namespace *string `protobuf:"bytes,3,opt,name=namespace" json:"namespace,omitempty"` Namespace *string `protobuf:"bytes,3,opt,name=namespace" json:"namespace,omitempty"`
...@@ -649,7 +649,7 @@ func (m *PodSandboxConfig) GetLinux() *LinuxPodSandboxConfig { ...@@ -649,7 +649,7 @@ func (m *PodSandboxConfig) GetLinux() *LinuxPodSandboxConfig {
} }
type RunPodSandboxRequest struct { type RunPodSandboxRequest struct {
// The configuration for creating a PodSandBox. // The configuration for creating a PodSandbox.
Config *PodSandboxConfig `protobuf:"bytes,1,opt,name=config" json:"config,omitempty"` Config *PodSandboxConfig `protobuf:"bytes,1,opt,name=config" json:"config,omitempty"`
XXX_unrecognized []byte `json:"-"` XXX_unrecognized []byte `json:"-"`
} }
...@@ -667,7 +667,7 @@ func (m *RunPodSandboxRequest) GetConfig() *PodSandboxConfig { ...@@ -667,7 +667,7 @@ func (m *RunPodSandboxRequest) GetConfig() *PodSandboxConfig {
} }
type RunPodSandboxResponse struct { type RunPodSandboxResponse struct {
// The id of the PodSandBox // The id of the PodSandbox
PodSandboxId *string `protobuf:"bytes,1,opt,name=pod_sandbox_id,json=podSandboxId" json:"pod_sandbox_id,omitempty"` PodSandboxId *string `protobuf:"bytes,1,opt,name=pod_sandbox_id,json=podSandboxId" json:"pod_sandbox_id,omitempty"`
XXX_unrecognized []byte `json:"-"` XXX_unrecognized []byte `json:"-"`
} }
...@@ -685,7 +685,7 @@ func (m *RunPodSandboxResponse) GetPodSandboxId() string { ...@@ -685,7 +685,7 @@ func (m *RunPodSandboxResponse) GetPodSandboxId() string {
} }
type StopPodSandboxRequest struct { type StopPodSandboxRequest struct {
// The id of the PodSandBox // The id of the PodSandbox
PodSandboxId *string `protobuf:"bytes,1,opt,name=pod_sandbox_id,json=podSandboxId" json:"pod_sandbox_id,omitempty"` PodSandboxId *string `protobuf:"bytes,1,opt,name=pod_sandbox_id,json=podSandboxId" json:"pod_sandbox_id,omitempty"`
XXX_unrecognized []byte `json:"-"` XXX_unrecognized []byte `json:"-"`
} }
...@@ -712,7 +712,7 @@ func (*StopPodSandboxResponse) ProtoMessage() {} ...@@ -712,7 +712,7 @@ func (*StopPodSandboxResponse) ProtoMessage() {}
func (*StopPodSandboxResponse) Descriptor() ([]byte, []int) { return fileDescriptorApi, []int{12} } func (*StopPodSandboxResponse) Descriptor() ([]byte, []int) { return fileDescriptorApi, []int{12} }
type RemovePodSandboxRequest struct { type RemovePodSandboxRequest struct {
// The id of the PodSandBox // The id of the PodSandbox
PodSandboxId *string `protobuf:"bytes,1,opt,name=pod_sandbox_id,json=podSandboxId" json:"pod_sandbox_id,omitempty"` PodSandboxId *string `protobuf:"bytes,1,opt,name=pod_sandbox_id,json=podSandboxId" json:"pod_sandbox_id,omitempty"`
XXX_unrecognized []byte `json:"-"` XXX_unrecognized []byte `json:"-"`
} }
...@@ -739,7 +739,7 @@ func (*RemovePodSandboxResponse) ProtoMessage() {} ...@@ -739,7 +739,7 @@ func (*RemovePodSandboxResponse) ProtoMessage() {}
func (*RemovePodSandboxResponse) Descriptor() ([]byte, []int) { return fileDescriptorApi, []int{14} } func (*RemovePodSandboxResponse) Descriptor() ([]byte, []int) { return fileDescriptorApi, []int{14} }
type PodSandboxStatusRequest struct { type PodSandboxStatusRequest struct {
// The id of the PodSandBox // The id of the PodSandbox
PodSandboxId *string `protobuf:"bytes,1,opt,name=pod_sandbox_id,json=podSandboxId" json:"pod_sandbox_id,omitempty"` PodSandboxId *string `protobuf:"bytes,1,opt,name=pod_sandbox_id,json=podSandboxId" json:"pod_sandbox_id,omitempty"`
XXX_unrecognized []byte `json:"-"` XXX_unrecognized []byte `json:"-"`
} }
......
pkg/kubelet/api/v1alpha1/runtime/api.proto
View file @ cc7f3906
...@@ -73,7 +73,7 @@ message VersionResponse { ...@@ -73,7 +73,7 @@ message VersionResponse {
optional string runtime_api_version = 4; optional string runtime_api_version = 4;
} }
// DNSConfig specifies the DNS servers and search domains. // DNSConfig specifies the DNS servers and search domains of a sandbox.
message DNSConfig { message DNSConfig {
// List of DNS servers of the cluster. // List of DNS servers of the cluster.
repeated string servers = 1; repeated string servers = 1;
...@@ -89,7 +89,7 @@ enum Protocol { ...@@ -89,7 +89,7 @@ enum Protocol {
UDP = 1; UDP = 1;
} }
// PortMapping specifies the port mapping configurations of sandbox // PortMapping specifies the port mapping configurations of a sandbox.
message PortMapping { message PortMapping {
// The name of the port mapping // The name of the port mapping
optional string name = 1; optional string name = 1;
...@@ -103,7 +103,7 @@ message PortMapping { ...@@ -103,7 +103,7 @@ message PortMapping {
optional string host_ip = 5; optional string host_ip = 5;
} }
// Mount specifies the volume mount for the sandbox // Mount specifies a host volume to mount into a container.
message Mount { message Mount {
// The name of the volume mount. // The name of the volume mount.
optional string name = 1; optional string name = 1;
...@@ -121,18 +121,18 @@ message Mount { ...@@ -121,18 +121,18 @@ message Mount {
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; optional bool host_network = 1;
// If set, use the host's pid namesapce. // If set, use the host's PID namespace.
optional bool host_pid = 2; optional 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; optional bool host_ipc = 3;
} }
// LinuxPodSandboxConfig holds platform-specific configuraions for Linux // LinuxPodSandboxConfig holds platform-specific configurations for Linux
// host platforms and Linux-based containers. // host platforms and Linux-based containers.
message LinuxPodSandboxConfig { message LinuxPodSandboxConfig {
// The parent cgroup of the pod sandbox. // The parent cgroup of the pod sandbox.
// 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 semantices if needed. // convert it to systemd semantics if needed.
optional string cgroup_parent = 1; optional string cgroup_parent = 1;
// The configurations for the sandbox's namespaces. // The 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.
...@@ -141,12 +141,12 @@ message LinuxPodSandboxConfig { ...@@ -141,12 +141,12 @@ message LinuxPodSandboxConfig {
// PodSandboxMetadata holds all necessary information for building the sandbox name. // PodSandboxMetadata holds all necessary information for building the sandbox name.
// The container runtime is encouraged to expose the metadata associated with the // The container runtime is encouraged to expose the metadata associated with the
// PodSandbox in its user interface for better user experience. E.g., runtime can // PodSandbox in its user interface for better user experience. For example,
// construct a unique PodSandboxName based on the metadata. // the runtime can construct a unique PodSandboxName based on the metadata.
message PodSandboxMetadata { message PodSandboxMetadata {
// The pod name of the sandbox. Same as the pod name in the PodSpec. // The pod name of the sandbox. Same as the pod name in the PodSpec.
optional string name = 1; optional string name = 1;
// The pod uid of the sandbox. Same as the pod UID in the PodSpec. // The pod UID of the sandbox. Same as the pod UID in the PodSpec.
optional string uid = 2; optional string uid = 2;
// The pod namespace of the sandbox. Same as the pod namespace in the PodSpec. // The pod namespace of the sandbox. Same as the pod namespace in the PodSpec.
optional string namespace = 3; optional string namespace = 3;
...@@ -194,31 +194,31 @@ message PodSandboxConfig { ...@@ -194,31 +194,31 @@ message PodSandboxConfig {
} }
message RunPodSandboxRequest { message RunPodSandboxRequest {
// The configuration for creating a PodSandBox. // The configuration for creating a PodSandbox.
optional PodSandboxConfig config = 1; optional PodSandboxConfig config = 1;
} }
message RunPodSandboxResponse { message RunPodSandboxResponse {
// The id of the PodSandBox // The id of the PodSandbox
optional string pod_sandbox_id = 1; optional string pod_sandbox_id = 1;
} }
message StopPodSandboxRequest { message StopPodSandboxRequest {
// The id of the PodSandBox // The id of the PodSandbox
optional string pod_sandbox_id = 1; optional string pod_sandbox_id = 1;
} }
message StopPodSandboxResponse {} message StopPodSandboxResponse {}
message RemovePodSandboxRequest { message RemovePodSandboxRequest {
// The id of the PodSandBox // The id of the PodSandbox
optional string pod_sandbox_id = 1; optional string pod_sandbox_id = 1;
} }
message RemovePodSandboxResponse {} message RemovePodSandboxResponse {}
message PodSandboxStatusRequest { message PodSandboxStatusRequest {
// The id of the PodSandBox // The id of the PodSandbox
optional string pod_sandbox_id = 1; optional string pod_sandbox_id = 1;
} }
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment