Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[eng] Fix links to PodOverhead Feature Design (static/docs) #34989

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -8196,7 +8196,7 @@ <H3 id="podspec-v1-core">PodSpec v1 core</H3>
<TR><TD><CODE>initContainers</CODE><BR /><I><a href="#container-v1-core">Container</a> array</I><BR /><B>patch strategy</B>: <I>merge</I><BR /><B>patch merge key</B>: <I>name</I></TD><TD>List of initialization containers belonging to the pod. Init containers are executed in order prior to containers being started. If any init container fails, the pod is considered to have failed and is handled according to its restartPolicy. The name for an init container or normal container must be unique among all containers. Init containers may not have Lifecycle actions, Readiness probes, Liveness probes, or Startup probes. The resourceRequirements of an init container are taken into account during scheduling by finding the highest request/limit for each resource type, and then using the max of of that value or the sum of the normal containers. Limits are applied to init containers in a similar fashion. Init containers cannot currently be added or removed. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/</TD></TR>
<TR><TD><CODE>nodeName</CODE><BR /><I>string</I></TD><TD>NodeName is a request to schedule this pod onto a specific node. If it is non-empty, the scheduler simply schedules this pod onto that node, assuming that it fits resource requirements.</TD></TR>
<TR><TD><CODE>nodeSelector</CODE><BR /><I>object</I></TD><TD>NodeSelector is a selector which must be true for the pod to fit on a node. Selector which must match a node&#39;s labels for the pod to be scheduled on that node. More info: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/</TD></TR>
<TR><TD><CODE>overhead</CODE><BR /><I>object</I></TD><TD>Overhead represents the resource overhead associated with running a pod for a given RuntimeClass. This field will be autopopulated at admission time by the RuntimeClass admission controller. If the RuntimeClass admission controller is enabled, overhead must not be set in Pod create requests. The RuntimeClass admission controller will reject Pod create requests which have the overhead already set. If RuntimeClass is configured and selected in the PodSpec, Overhead will be set to the value defined in the corresponding RuntimeClass, otherwise it will remain unset and treated as zero. More info: https://git.k8s.io/enhancements/keps/sig-node/20190226-pod-overhead.md This field is alpha-level as of Kubernetes v1.16, and is only honored by servers that enable the PodOverhead feature.</TD></TR>
<TR><TD><CODE>overhead</CODE><BR /><I>object</I></TD><TD>Overhead represents the resource overhead associated with running a pod for a given RuntimeClass. This field will be autopopulated at admission time by the RuntimeClass admission controller. If the RuntimeClass admission controller is enabled, overhead must not be set in Pod create requests. The RuntimeClass admission controller will reject Pod create requests which have the overhead already set. If RuntimeClass is configured and selected in the PodSpec, Overhead will be set to the value defined in the corresponding RuntimeClass, otherwise it will remain unset and treated as zero. More info: https://git.k8s.io/enhancements/keps/sig-node/688-pod-overhead This field is alpha-level as of Kubernetes v1.16, and is only honored by servers that enable the PodOverhead feature.</TD></TR>
<TR><TD><CODE>preemptionPolicy</CODE><BR /><I>string</I></TD><TD>PreemptionPolicy is the Policy for preempting pods with lower priority. One of Never, PreemptLowerPriority. Defaults to PreemptLowerPriority if unset. This field is beta-level, gated by the NonPreemptingPriority feature-gate.</TD></TR>
<TR><TD><CODE>priority</CODE><BR /><I>integer</I></TD><TD>The priority value. Various system components use this field to find the priority of the pod. When Priority Admission Controller is enabled, it prevents users from setting this field. The admission controller populates this field from PriorityClassName. The higher the value, the higher the priority.</TD></TR>
<TR><TD><CODE>priorityClassName</CODE><BR /><I>string</I></TD><TD>If specified, indicates the pod&#39;s priority. &#34;system-node-critical&#34; and &#34;system-cluster-critical&#34; are two special keywords which indicate the highest priorities with the former being the highest priority. Any other name must be defined by creating a PriorityClass object with that name. If not specified, the pod priority will be default or zero if there is no default.</TD></TR>
Expand Down Expand Up @@ -28067,7 +28067,7 @@ <H1 id="runtimeclass-v1beta1-node-k8s-io">RuntimeClass v1beta1 node.k8s.io</H1>
<TR><TD><CODE>handler</CODE><BR /><I>string</I></TD><TD>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 &amp; 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 &#34;runc&#34; might specify that the runc OCI runtime (using native Linux containers) will be used to run the containers in a pod. The Handler must conform to the DNS Label (RFC 1123) requirements, and is immutable.</TD></TR>
<TR><TD><CODE>kind</CODE><BR /><I>string</I></TD><TD>Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds</TD></TR>
<TR><TD><CODE>metadata</CODE><BR /><I><a href="#objectmeta-v1-meta">ObjectMeta</a></I></TD><TD>More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata</TD></TR>
<TR><TD><CODE>overhead</CODE><BR /><I><a href="#overhead-v1beta1-node-k8s-io">Overhead</a></I></TD><TD>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/20190226-pod-overhead.md This field is alpha-level as of Kubernetes v1.15, and is only honored by servers that enable the PodOverhead feature.</TD></TR>
<TR><TD><CODE>overhead</CODE><BR /><I><a href="#overhead-v1beta1-node-k8s-io">Overhead</a></I></TD><TD>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 This field is alpha-level as of Kubernetes v1.15, and is only honored by servers that enable the PodOverhead feature.</TD></TR>
<TR><TD><CODE>scheduling</CODE><BR /><I><a href="#scheduling-v1beta1-node-k8s-io">Scheduling</a></I></TD><TD>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.</TD></TR>
</TBODY>
</TABLE>
Expand Down Expand Up @@ -47498,7 +47498,7 @@ <H3 id="runtimeclassspec-v1alpha1-node-k8s-io">RuntimeClassSpec v1alpha1 node</H
<TABLE>
<THEAD><TR><TH>Field</TH><TH>Description</TH></TR></THEAD>
<TBODY>
<TR><TD><CODE>overhead</CODE><BR /><I><a href="#overhead-v1alpha1-node-k8s-io">Overhead</a></I></TD><TD>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/20190226-pod-overhead.md This field is alpha-level as of Kubernetes v1.15, and is only honored by servers that enable the PodOverhead feature.</TD></TR>
<TR><TD><CODE>overhead</CODE><BR /><I><a href="#overhead-v1alpha1-node-k8s-io">Overhead</a></I></TD><TD>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 This field is alpha-level as of Kubernetes v1.15, and is only honored by servers that enable the PodOverhead feature.</TD></TR>
<TR><TD><CODE>runtimeHandler</CODE><BR /><I>string</I></TD><TD>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 &amp; 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 &#34;runc&#34; might specify that the runc OCI runtime (using native Linux containers) will be used to run the containers in a pod. The RuntimeHandler must conform to the DNS Label (RFC 1123) requirements and is immutable.</TD></TR>
<TR><TD><CODE>scheduling</CODE><BR /><I><a href="#scheduling-v1alpha1-node-k8s-io">Scheduling</a></I></TD><TD>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.</TD></TR>
</TBODY>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8368,7 +8368,7 @@ <H3 id="podspec-v1-core">PodSpec v1 core</H3>
<TR><TD><CODE>initContainers</CODE><BR /><I><a href="#container-v1-core">Container</a> array</I><BR /><B>patch strategy</B>: <I>merge</I><BR /><B>patch merge key</B>: <I>name</I></TD><TD>List of initialization containers belonging to the pod. Init containers are executed in order prior to containers being started. If any init container fails, the pod is considered to have failed and is handled according to its restartPolicy. The name for an init container or normal container must be unique among all containers. Init containers may not have Lifecycle actions, Readiness probes, Liveness probes, or Startup probes. The resourceRequirements of an init container are taken into account during scheduling by finding the highest request/limit for each resource type, and then using the max of of that value or the sum of the normal containers. Limits are applied to init containers in a similar fashion. Init containers cannot currently be added or removed. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/</TD></TR>
<TR><TD><CODE>nodeName</CODE><BR /><I>string</I></TD><TD>NodeName is a request to schedule this pod onto a specific node. If it is non-empty, the scheduler simply schedules this pod onto that node, assuming that it fits resource requirements.</TD></TR>
<TR><TD><CODE>nodeSelector</CODE><BR /><I>object</I></TD><TD>NodeSelector is a selector which must be true for the pod to fit on a node. Selector which must match a node&#39;s labels for the pod to be scheduled on that node. More info: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/</TD></TR>
<TR><TD><CODE>overhead</CODE><BR /><I>object</I></TD><TD>Overhead represents the resource overhead associated with running a pod for a given RuntimeClass. This field will be autopopulated at admission time by the RuntimeClass admission controller. If the RuntimeClass admission controller is enabled, overhead must not be set in Pod create requests. The RuntimeClass admission controller will reject Pod create requests which have the overhead already set. If RuntimeClass is configured and selected in the PodSpec, Overhead will be set to the value defined in the corresponding RuntimeClass, otherwise it will remain unset and treated as zero. More info: https://git.k8s.io/enhancements/keps/sig-node/20190226-pod-overhead.md This field is alpha-level as of Kubernetes v1.16, and is only honored by servers that enable the PodOverhead feature.</TD></TR>
<TR><TD><CODE>overhead</CODE><BR /><I>object</I></TD><TD>Overhead represents the resource overhead associated with running a pod for a given RuntimeClass. This field will be autopopulated at admission time by the RuntimeClass admission controller. If the RuntimeClass admission controller is enabled, overhead must not be set in Pod create requests. The RuntimeClass admission controller will reject Pod create requests which have the overhead already set. If RuntimeClass is configured and selected in the PodSpec, Overhead will be set to the value defined in the corresponding RuntimeClass, otherwise it will remain unset and treated as zero. More info: https://git.k8s.io/enhancements/keps/sig-node/688-pod-overhead This field is alpha-level as of Kubernetes v1.16, and is only honored by servers that enable the PodOverhead feature.</TD></TR>
<TR><TD><CODE>preemptionPolicy</CODE><BR /><I>string</I></TD><TD>PreemptionPolicy is the Policy for preempting pods with lower priority. One of Never, PreemptLowerPriority. Defaults to PreemptLowerPriority if unset. This field is beta-level, gated by the NonPreemptingPriority feature-gate.</TD></TR>
<TR><TD><CODE>priority</CODE><BR /><I>integer</I></TD><TD>The priority value. Various system components use this field to find the priority of the pod. When Priority Admission Controller is enabled, it prevents users from setting this field. The admission controller populates this field from PriorityClassName. The higher the value, the higher the priority.</TD></TR>
<TR><TD><CODE>priorityClassName</CODE><BR /><I>string</I></TD><TD>If specified, indicates the pod&#39;s priority. &#34;system-node-critical&#34; and &#34;system-cluster-critical&#34; are two special keywords which indicate the highest priorities with the former being the highest priority. Any other name must be defined by creating a PriorityClass object with that name. If not specified, the pod priority will be default or zero if there is no default.</TD></TR>
Expand Down Expand Up @@ -49107,7 +49107,7 @@ <H1 id="runtimeclass-v1beta1-node-k8s-io">RuntimeClass v1beta1 node.k8s.io</H1>
<TR><TD><CODE>handler</CODE><BR /><I>string</I></TD><TD>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 &amp; 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 &#34;runc&#34; 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.</TD></TR>
<TR><TD><CODE>kind</CODE><BR /><I>string</I></TD><TD>Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds</TD></TR>
<TR><TD><CODE>metadata</CODE><BR /><I><a href="#objectmeta-v1-meta">ObjectMeta</a></I></TD><TD>More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata</TD></TR>
<TR><TD><CODE>overhead</CODE><BR /><I><a href="#overhead-v1beta1-node-k8s-io">Overhead</a></I></TD><TD>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/20190226-pod-overhead.md This field is alpha-level as of Kubernetes v1.15, and is only honored by servers that enable the PodOverhead feature.</TD></TR>
<TR><TD><CODE>overhead</CODE><BR /><I><a href="#overhead-v1beta1-node-k8s-io">Overhead</a></I></TD><TD>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 This field is alpha-level as of Kubernetes v1.15, and is only honored by servers that enable the PodOverhead feature.</TD></TR>
<TR><TD><CODE>scheduling</CODE><BR /><I><a href="#scheduling-v1beta1-node-k8s-io">Scheduling</a></I></TD><TD>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.</TD></TR>
</TBODY>
</TABLE>
Expand Down Expand Up @@ -49444,7 +49444,7 @@ <H3 id="runtimeclassspec-v1alpha1-node-k8s-io">RuntimeClassSpec v1alpha1 node</H
<TABLE>
<THEAD><TR><TH>Field</TH><TH>Description</TH></TR></THEAD>
<TBODY>
<TR><TD><CODE>overhead</CODE><BR /><I><a href="#overhead-v1alpha1-node-k8s-io">Overhead</a></I></TD><TD>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/20190226-pod-overhead.md This field is alpha-level as of Kubernetes v1.15, and is only honored by servers that enable the PodOverhead feature.</TD></TR>
<TR><TD><CODE>overhead</CODE><BR /><I><a href="#overhead-v1alpha1-node-k8s-io">Overhead</a></I></TD><TD>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 This field is alpha-level as of Kubernetes v1.15, and is only honored by servers that enable the PodOverhead feature.</TD></TR>
<TR><TD><CODE>runtimeHandler</CODE><BR /><I>string</I></TD><TD>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 &amp; 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 &#34;runc&#34; 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) requirements, and is immutable.</TD></TR>
<TR><TD><CODE>scheduling</CODE><BR /><I><a href="#scheduling-v1alpha1-node-k8s-io">Scheduling</a></I></TD><TD>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.</TD></TR>
</TBODY>
Expand Down
Loading