⎈ k8s knowledge compiler

Workload [page]deterministic

Workload allows for expressing scheduling constraints that should be used when managing the lifecycle of workloads from the scheduling perspective, including scheduling, preemption, eviction and other phases. Workload API enablement is toggled by the GenericWorkload feature gate.

reference

`apiVersion: scheduling.k8s.io/v1alpha2`

`import "k8s.io/api/scheduling/v1alpha2"`

## Workload {#Workload}

Workload allows for expressing scheduling constraints that should be used when managing the lifecycle of workloads from the scheduling perspective, including scheduling, preemption, eviction and other phases. Workload API enablement is toggled by the GenericWorkload feature gate.

<hr>

<table> <thead><tr><th>Field</th><th>Description</th></tr></thead> <tbody> <tr> <td><code>apiVersion</code><br/><em>string</em></td> <td>APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources</td> </tr> <tr> <td><code>kind</code><br/><em>string</em></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/><em><a href="">ObjectMeta</a></em></td> <td>Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata</td> </tr> <tr> <td><code>spec</code>&nbsp;<strong>*</strong><br/><em><a href="">WorkloadSpec</a></em></td> <td>Spec defines the desired behavior of a Workload.</td> </tr> </tbody> </table>

## WorkloadSpec {#WorkloadSpec}

WorkloadSpec defines the desired state of a Workload.

<hr>

<table> <thead><tr><th>Field</th><th>Description</th></tr></thead> <tbody> <tr> <td><code>controllerRef</code><br/><em><a href="">TypedLocalObjectReference</a></em></td> <td>ControllerRef is an optional reference to the controlling object, such as a Deployment or Job. This field is intended for use by tools like CLIs to provide a link back to the original workload definition. This field is immutable.</td> </tr> <tr> <td><code>podGroupTemplates</code>&nbsp;<strong>*</strong><br/><em><a href="">PodGroupTemplate array</a></em></td> <td>PodGroupTemplates is the list of templates that make up the Workload. The maximum number of templates is 8. This field is immutable.</td> </tr> </tbody> </table>

## WorkloadList {#WorkloadList}

WorkloadList contains a list of Workload resources.

<hr>

<table> <thead><tr><th>Field</th><th>Description</th></tr></thead> <tbody> <tr> <td><code>apiVersion</code><br/><em>string</em></td> <td>APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources</td> </tr> <tr> <td><code>items</code>&nbsp;<strong>*</strong><br/><em><a href="">Workload array</a></em></td> <td>Items is the list of Workloads.</td> </tr> <tr> <td><code>kind</code><br/><em>string</em></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/><em><a href="">ListMeta</a></em></td> <td>Standard list metadata.</td> </tr> </tbody> </table>

## PodGroupTemplate {#PodGroupTemplate}

PodGroupTemplate represents a template for a set of pods with a scheduling policy.

<hr>

<table> <thead><tr><th>Field</th><th>Description</th></tr></thead> <tbody> <tr> …(trimmed)

Sources

reference/kubernetes-api/scheduling/workload-v1alpha2.md · docWorkload

Related (17)

part_of Workload {#Workload}describes conf=1
part_of WorkloadSpec {#WorkloadSpec}describes conf=1
part_of WorkloadList {#WorkloadList}describes conf=1
part_of PodGroupTemplate {#PodGroupTemplate}describes conf=1
part_of Operations {#Operations}describes conf=1
part_of `post` Createdescribes conf=1
part_of `patch` Patchdescribes conf=1
part_of `put` Replacedescribes conf=1
part_of `delete` Deletedescribes conf=1
part_of `delete` Delete Collectiondescribes conf=1
part_of `get` Readdescribes conf=1
part_of `get` Listdescribes conf=1
part_of `get` List All Namespacesdescribes conf=1
part_of `get` Watchdescribes conf=1
part_of `get` Watch Listdescribes conf=1
part_of `get` Watch List All Namespacesdescribes conf=1
api_for Workloaddocuments API object conf=1

← all Docs