github/kubernetes
1
0
Fork 0
mirror of https://github.com/k3s-io/kubernetes.git synced 2025-07-23 19:56:01 +00:00
Code Issues Projects Releases Wiki Activity

fix doc of types.go of node

Browse Source 
Signed-off-by: Ruquan Zhao <ruquan.zhao@arm.com>
This commit is contained in:
RuquanZhao 2022-11-22 16:59:25 +08:00
parent 57eb5d631c
commit 568fedea41
4 changed files with 31 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
pkg/apis/node/types.go
View File

@ -32,10 +32,11 @@ import (
// https://git.k8s.io/enhancements/keps/sig-node/585-runtime-class/README.md
type RuntimeClass struct {
metav1.TypeMeta
// +optional
metav1.ObjectMeta
// Handler specifies the underlying runtime and configuration that the CRI
// handler specifies the underlying runtime and configuration that the CRI
// implementation will use to handle pods of this class. The possible values
// are specific to the node & CRI configuration. It is assumed that all
// handlers are available on every node, and handlers of the same name are
@ -47,13 +48,13 @@ type RuntimeClass struct {
// immutable.
Handler string
// Overhead represents the resource overhead associated with running a pod for a
// overhead represents the resource overhead associated with running a pod for a
// given RuntimeClass. For more details, see
// https://git.k8s.io/enhancements/keps/sig-network/580-pod-readiness-gates
// +optional
Overhead *Overhead
// Scheduling holds the scheduling constraints to ensure that pods running
// scheduling holds the scheduling constraints to ensure that pods running
// with this RuntimeClass are scheduled to nodes that support it.
// If scheduling is nil, this RuntimeClass is assumed to be supported by all
// nodes.
@ -63,7 +64,7 @@ type RuntimeClass struct {
// Overhead structure represents the resource overhead associated with running a pod.
type Overhead struct {
// PodFixed represents the fixed resource overhead associated with running a pod.
// podFixed represents the fixed resource overhead associated with running a pod.
// +optional
PodFixed core.ResourceList
}
@ -91,9 +92,10 @@ type Scheduling struct {
// RuntimeClassList is a list of RuntimeClass objects.
type RuntimeClassList struct {
metav1.TypeMeta
// +optional
metav1.ListMeta
// Items is a list of schema objects.
// items is a list of schema objects.
Items []RuntimeClass
}

12
staging/src/k8s.io/api/node/v1/types.go
View File

@ -34,11 +34,12 @@ import (
// https://kubernetes.io/docs/concepts/containers/runtime-class/
type RuntimeClass struct {
metav1.TypeMeta `json:",inline"`
// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
// +optional
metav1.ObjectMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"`
// Handler specifies the underlying runtime and configuration that the CRI
// handler specifies the underlying runtime and configuration that the CRI
// implementation will use to handle pods of this class. The possible values
// are specific to the node & CRI configuration. It is assumed that all
// handlers are available on every node, and handlers of the same name are
@ -50,13 +51,13 @@ type RuntimeClass struct {
// and is immutable.
Handler string `json:"handler" protobuf:"bytes,2,opt,name=handler"`
// Overhead represents the resource overhead associated with running a pod for a
// overhead represents the resource overhead associated with running a pod for a
// given RuntimeClass. For more details, see
// https://kubernetes.io/docs/concepts/scheduling-eviction/pod-overhead/
// +optional
Overhead *Overhead `json:"overhead,omitempty" protobuf:"bytes,3,opt,name=overhead"`
// Scheduling holds the scheduling constraints to ensure that pods running
// scheduling holds the scheduling constraints to ensure that pods running
// with this RuntimeClass are scheduled to nodes that support it.
// If scheduling is nil, this RuntimeClass is assumed to be supported by all
// nodes.
@ -66,7 +67,7 @@ type RuntimeClass struct {
// Overhead structure represents the resource overhead associated with running a pod.
type Overhead struct {
// PodFixed represents the fixed resource overhead associated with running a pod.
// podFixed represents the fixed resource overhead associated with running a pod.
// +optional
PodFixed corev1.ResourceList `json:"podFixed,omitempty" protobuf:"bytes,1,opt,name=podFixed,casttype=k8s.io/api/core/v1.ResourceList,castkey=k8s.io/api/core/v1.ResourceName,castvalue=k8s.io/apimachinery/pkg/api/resource.Quantity"`
}
@ -96,11 +97,12 @@ type Scheduling struct {
// RuntimeClassList is a list of RuntimeClass objects.
type RuntimeClassList struct {
metav1.TypeMeta `json:",inline"`
// Standard list metadata.
// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
// +optional
metav1.ListMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"`
// Items is a list of schema objects.
// items is a list of schema objects.
Items []RuntimeClass `json:"items" protobuf:"bytes,2,rep,name=items"`
}

16
staging/src/k8s.io/api/node/v1alpha1/types.go
View File

@ -34,11 +34,12 @@ import (
// https://git.k8s.io/enhancements/keps/sig-node/585-runtime-class
type RuntimeClass struct {
metav1.TypeMeta `json:",inline"`
// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
// +optional
metav1.ObjectMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"`
// Specification of the RuntimeClass
// spec represents specification of the RuntimeClass
// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
Spec RuntimeClassSpec `json:"spec" protobuf:"bytes,2,name=spec"`
}
@ -48,7 +49,7 @@ type RuntimeClass struct {
// Interface (CRI) implementation, as well as any other components that need to
// understand how the pod will be run. The RuntimeClassSpec is immutable.
type RuntimeClassSpec struct {
// RuntimeHandler specifies the underlying runtime and configuration that the
// runtimeHandler specifies the underlying runtime and configuration that the
// CRI implementation will use to handle pods of this class. The possible
// values are specific to the node & CRI configuration. It is assumed that
// all handlers are available on every node, and handlers of the same name are
@ -56,17 +57,17 @@ type RuntimeClassSpec struct {
// For example, a handler called "runc" might specify that the runc OCI
// runtime (using native Linux containers) will be used to run the containers
// in a pod.
// The RuntimeHandler must be lowercase, conform to the DNS Label (RFC 1123)
// The runtimeHandler must be lowercase, conform to the DNS Label (RFC 1123)
// requirements, and is immutable.
RuntimeHandler string `json:"runtimeHandler" protobuf:"bytes,1,opt,name=runtimeHandler"`
// Overhead represents the resource overhead associated with running a pod for a
// overhead represents the resource overhead associated with running a pod for a
// given RuntimeClass. For more details, see
// https://git.k8s.io/enhancements/keps/sig-node/688-pod-overhead/README.md
// +optional
Overhead *Overhead `json:"overhead,omitempty" protobuf:"bytes,2,opt,name=overhead"`
// Scheduling holds the scheduling constraints to ensure that pods running
// scheduling holds the scheduling constraints to ensure that pods running
// with this RuntimeClass are scheduled to nodes that support it.
// If scheduling is nil, this RuntimeClass is assumed to be supported by all
// nodes.
@ -76,7 +77,7 @@ type RuntimeClassSpec struct {
// Overhead structure represents the resource overhead associated with running a pod.
type Overhead struct {
// PodFixed represents the fixed resource overhead associated with running a pod.
// podFixed represents the fixed resource overhead associated with running a pod.
// +optional
PodFixed corev1.ResourceList `json:"podFixed,omitempty" protobuf:"bytes,1,opt,name=podFixed,casttype=k8s.io/api/core/v1.ResourceList,castkey=k8s.io/api/core/v1.ResourceName,castvalue=k8s.io/apimachinery/pkg/api/resource.Quantity"`
}
@ -106,11 +107,12 @@ type Scheduling struct {
// RuntimeClassList is a list of RuntimeClass objects.
type RuntimeClassList struct {
metav1.TypeMeta `json:",inline"`
// Standard list metadata.
// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
// +optional
metav1.ListMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"`
// Items is a list of schema objects.
// items is a list of schema objects.
Items []RuntimeClass `json:"items" protobuf:"bytes,2,rep,name=items"`
}

14
staging/src/k8s.io/api/node/v1beta1/types.go
View File

@ -36,11 +36,12 @@ import (
// https://git.k8s.io/enhancements/keps/sig-node/585-runtime-class
type RuntimeClass struct {
metav1.TypeMeta `json:",inline"`
// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
// +optional
metav1.ObjectMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"`
// Handler specifies the underlying runtime and configuration that the CRI
// handler specifies the underlying runtime and configuration that the CRI
// implementation will use to handle pods of this class. The possible values
// are specific to the node & CRI configuration. It is assumed that all
// handlers are available on every node, and handlers of the same name are
@ -48,17 +49,17 @@ type RuntimeClass struct {
// For example, a handler called "runc" might specify that the runc OCI
// runtime (using native Linux containers) will be used to run the containers
// in a pod.
// The Handler must be lowercase, conform to the DNS Label (RFC 1123) requirements,
// The handler must be lowercase, conform to the DNS Label (RFC 1123) requirements,
// and is immutable.
Handler string `json:"handler" protobuf:"bytes,2,opt,name=handler"`
// Overhead represents the resource overhead associated with running a pod for a
// overhead represents the resource overhead associated with running a pod for a
// given RuntimeClass. For more details, see
// https://git.k8s.io/enhancements/keps/sig-node/688-pod-overhead/README.md
// +optional
Overhead *Overhead `json:"overhead,omitempty" protobuf:"bytes,3,opt,name=overhead"`
// Scheduling holds the scheduling constraints to ensure that pods running
// scheduling holds the scheduling constraints to ensure that pods running
// with this RuntimeClass are scheduled to nodes that support it.
// If scheduling is nil, this RuntimeClass is assumed to be supported by all
// nodes.
@ -68,7 +69,7 @@ type RuntimeClass struct {
// Overhead structure represents the resource overhead associated with running a pod.
type Overhead struct {
// PodFixed represents the fixed resource overhead associated with running a pod.
// podFixed represents the fixed resource overhead associated with running a pod.
// +optional
PodFixed corev1.ResourceList `json:"podFixed,omitempty" protobuf:"bytes,1,opt,name=podFixed,casttype=k8s.io/api/core/v1.ResourceList,castkey=k8s.io/api/core/v1.ResourceName,castvalue=k8s.io/apimachinery/pkg/api/resource.Quantity"`
}
@ -100,11 +101,12 @@ type Scheduling struct {
// RuntimeClassList is a list of RuntimeClass objects.
type RuntimeClassList struct {
metav1.TypeMeta `json:",inline"`
// Standard list metadata.
// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
// +optional
metav1.ListMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"`
// Items is a list of schema objects.
// items is a list of schema objects.
Items []RuntimeClass `json:"items" protobuf:"bytes,2,rep,name=items"`
}