Workload v1alpha1
apiVersion: scheduling.k8s.io/v1alpha1
import "k8s.io/api/scheduling/v1alpha1"
Workload
Workload allows for expressing scheduling constraints that should be used when managing lifecycle of workloads from scheduling perspective, including scheduling, preemption, eviction and other phases.
apiVersion: scheduling.k8s.io/v1alpha1
kind: Workload
metadata (ObjectMeta)
Standard object's metadata. Name must be a DNS subdomain.
spec (WorkloadSpec), required
Spec defines the desired behavior of a Workload.
WorkloadSpec
WorkloadSpec defines the desired state of a Workload.
podGroups ([]PodGroup), required
Map: unique values on key name will be kept during a merge
PodGroups is the list of pod groups that make up the Workload. The maximum number of pod groups is 8. This field is immutable.
PodGroup represents a set of pods with a common scheduling policy.
podGroups.name (string), required
Name is a unique identifier for the PodGroup within the Workload. It must be a DNS label. This field is immutable.
podGroups.policy (PodGroupPolicy), required
Policy defines the scheduling policy for this PodGroup.
PodGroupPolicy defines the scheduling configuration for a PodGroup.
podGroups.policy.basic (BasicSchedulingPolicy)
Basic specifies that the pods in this group should be scheduled using standard Kubernetes scheduling behavior.
BasicSchedulingPolicy indicates that standard Kubernetes scheduling behavior should be used.
podGroups.policy.gang (GangSchedulingPolicy)
Gang specifies that the pods in this group should be scheduled using all-or-nothing semantics.
GangSchedulingPolicy defines the parameters for gang scheduling.
podGroups.policy.gang.minCount (int32), required
MinCount is the minimum number of pods that must be schedulable or scheduled at the same time for the scheduler to admit the entire group. It must be a positive integer.
controllerRef (TypedLocalObjectReference)
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. When set, it cannot be changed.
TypedLocalObjectReference allows to reference typed object inside the same namespace.
controllerRef.kind (string), required
Kind is the type of resource being referenced. It must be a path segment name.
controllerRef.name (string), required
Name is the name of resource being referenced. It must be a path segment name.
controllerRef.apiGroup (string)
APIGroup is the group for the resource being referenced. If APIGroup is empty, the specified Kind must be in the core API group. For any other third-party types, setting APIGroup is required. It must be a DNS subdomain.
WorkloadList
WorkloadList contains a list of Workload resources.
apiVersion: scheduling.k8s.io/v1alpha1
kind: WorkloadList
metadata (ListMeta)
Standard list metadata.
items ([]Workload), required
Items is the list of Workloads.
Operations
get read the specified Workload
HTTP Request
GET /apis/scheduling.k8s.io/v1alpha1/namespaces/{namespace}/workloads/{name}
Parameters
name (in path): string, required
name of the Workload
namespace (in path): string, required
pretty (in query): string
Response
200 (Workload): OK
401: Unauthorized
list list or watch objects of kind Workload
HTTP Request
GET /apis/scheduling.k8s.io/v1alpha1/namespaces/{namespace}/workloads
Parameters
namespace (in path): string, required
allowWatchBookmarks (in query): boolean
continue (in query): string
fieldSelector (in query): string
labelSelector (in query): string
limit (in query): integer
pretty (in query): string
resourceVersion (in query): string
resourceVersionMatch (in query): string
sendInitialEvents (in query): boolean
timeoutSeconds (in query): integer
watch (in query): boolean
Response
200 (WorkloadList): OK
401: Unauthorized
list list or watch objects of kind Workload
HTTP Request
GET /apis/scheduling.k8s.io/v1alpha1/workloads
Parameters
allowWatchBookmarks (in query): boolean
continue (in query): string
fieldSelector (in query): string
labelSelector (in query): string
limit (in query): integer
pretty (in query): string
resourceVersion (in query): string
resourceVersionMatch (in query): string
sendInitialEvents (in query): boolean
timeoutSeconds (in query): integer
watch (in query): boolean
Response
200 (WorkloadList): OK
401: Unauthorized
create create a Workload
HTTP Request
POST /apis/scheduling.k8s.io/v1alpha1/namespaces/{namespace}/workloads
Parameters
namespace (in path): string, required
body: Workload, required
dryRun (in query): string
fieldManager (in query): string
fieldValidation (in query): string
pretty (in query): string
Response
200 (Workload): OK
201 (Workload): Created
202 (Workload): Accepted
401: Unauthorized
update replace the specified Workload
HTTP Request
PUT /apis/scheduling.k8s.io/v1alpha1/namespaces/{namespace}/workloads/{name}
Parameters
name (in path): string, required
name of the Workload
namespace (in path): string, required
body: Workload, required
dryRun (in query): string
fieldManager (in query): string
fieldValidation (in query): string
pretty (in query): string
Response
200 (Workload): OK
201 (Workload): Created
401: Unauthorized
patch partially update the specified Workload
HTTP Request
PATCH /apis/scheduling.k8s.io/v1alpha1/namespaces/{namespace}/workloads/{name}
Parameters
name (in path): string, required
name of the Workload
namespace (in path): string, required
body: Patch, required
dryRun (in query): string
fieldManager (in query): string
fieldValidation (in query): string
force (in query): boolean
pretty (in query): string
Response
200 (Workload): OK
201 (Workload): Created
401: Unauthorized
delete delete a Workload
HTTP Request
DELETE /apis/scheduling.k8s.io/v1alpha1/namespaces/{namespace}/workloads/{name}
Parameters
name (in path): string, required
name of the Workload
namespace (in path): string, required
body: DeleteOptions
dryRun (in query): string
gracePeriodSeconds (in query): integer
ignoreStoreReadErrorWithClusterBreakingPotential (in query): boolean
pretty (in query): string
propagationPolicy (in query): string
Response
200 (Status): OK
202 (Status): Accepted
401: Unauthorized
deletecollection delete collection of Workload
HTTP Request
DELETE /apis/scheduling.k8s.io/v1alpha1/namespaces/{namespace}/workloads
Parameters
namespace (in path): string, required
body: DeleteOptions
continue (in query): string
dryRun (in query): string
fieldSelector (in query): string
gracePeriodSeconds (in query): integer
ignoreStoreReadErrorWithClusterBreakingPotential (in query): boolean
labelSelector (in query): string
limit (in query): integer
pretty (in query): string
propagationPolicy (in query): string
resourceVersion (in query): string
resourceVersionMatch (in query): string
sendInitialEvents (in query): boolean
timeoutSeconds (in query): integer
Response
200 (Status): OK
401: Unauthorized
This page is automatically generated.
If you plan to report an issue with this page, mention that the page is auto-generated in your issue description. The fix may need to happen elsewhere in the Kubernetes project.