Merge pull request #114065 from ruquanzhao/fixNodeTypesDoc

fix doc of types.go of node
This commit is contained in:
Kubernetes Prow Robot
2023-01-10 10:39:25 -08:00
committed by GitHub
13 changed files with 91 additions and 83 deletions

View File

@@ -12158,7 +12158,7 @@
"additionalProperties": {
"$ref": "#/definitions/io.k8s.apimachinery.pkg.api.resource.Quantity"
},
"description": "PodFixed represents the fixed resource overhead associated with running a pod.",
"description": "podFixed represents the fixed resource overhead associated with running a pod.",
"type": "object"
}
},
@@ -12172,7 +12172,7 @@
"type": "string"
},
"handler": {
"description": "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 equivalent on every node. 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, and is immutable.",
"description": "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 equivalent on every node. 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, and is immutable.",
"type": "string"
},
"kind": {
@@ -12185,11 +12185,11 @@
},
"overhead": {
"$ref": "#/definitions/io.k8s.api.node.v1.Overhead",
"description": "Overhead represents the resource overhead associated with running a pod for a given RuntimeClass. For more details, see\n https://kubernetes.io/docs/concepts/scheduling-eviction/pod-overhead/"
"description": "overhead represents the resource overhead associated with running a pod for a given RuntimeClass. For more details, see\n https://kubernetes.io/docs/concepts/scheduling-eviction/pod-overhead/"
},
"scheduling": {
"$ref": "#/definitions/io.k8s.api.node.v1.Scheduling",
"description": "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."
"description": "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."
}
},
"required": [
@@ -12212,7 +12212,7 @@
"type": "string"
},
"items": {
"description": "Items is a list of schema objects.",
"description": "items is a list of schema objects.",
"items": {
"$ref": "#/definitions/io.k8s.api.node.v1.RuntimeClass"
},

View File

@@ -40,7 +40,7 @@
],
"default": {}
},
"description": "PodFixed represents the fixed resource overhead associated with running a pod.",
"description": "podFixed represents the fixed resource overhead associated with running a pod.",
"type": "object"
}
},
@@ -55,7 +55,7 @@
},
"handler": {
"default": "",
"description": "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 equivalent on every node. 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, and is immutable.",
"description": "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 equivalent on every node. 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, and is immutable.",
"type": "string"
},
"kind": {
@@ -77,7 +77,7 @@
"$ref": "#/components/schemas/io.k8s.api.node.v1.Overhead"
}
],
"description": "Overhead represents the resource overhead associated with running a pod for a given RuntimeClass. For more details, see\n https://kubernetes.io/docs/concepts/scheduling-eviction/pod-overhead/"
"description": "overhead represents the resource overhead associated with running a pod for a given RuntimeClass. For more details, see\n https://kubernetes.io/docs/concepts/scheduling-eviction/pod-overhead/"
},
"scheduling": {
"allOf": [
@@ -85,7 +85,7 @@
"$ref": "#/components/schemas/io.k8s.api.node.v1.Scheduling"
}
],
"description": "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."
"description": "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."
}
},
"required": [
@@ -108,7 +108,7 @@
"type": "string"
},
"items": {
"description": "Items is a list of schema objects.",
"description": "items is a list of schema objects.",
"items": {
"allOf": [
{