Workloads Models

V1ControllerRevision

ControllerRevision implements an immutable snapshot of state data. Clients are responsible for serializing and deserializing the objects that contain their internal state. Once a ControllerRevision has been successfully created, it can not be updated. The API Server will fail validation of all requests that attempt to mutate the Data field. ControllerRevisions may, however, be deleted. Note that, due to its use by both the DaemonSet and StatefulSet controllers for update and rollback, this object is beta. However, it may be subject to name and representation changes in future releases, and clients should not depend on its stability. It is primarily for internal use by controllers.

Property	Type	Description
`apiVersion`	`string`	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:...
`data`	`any`	Data is the serialized representation of the state.
`kind`	`string`	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:...
`revision`	`number`	Revision indicates the revision of the state represented by Data.
`metadata`	V1ObjectMeta

Example

import * as k8s from '@kubernetes/client-node';

const kc = new k8s.KubeConfig();
kc.loadFromDefault();
const api = kc.makeApiClient(k8s.AppsV1Api);

const body: k8s.V1ControllerRevision = {
    metadata: { name: 'example' },
};
const res = await api.createNamespacedControllerRevision({ namespace: 'default', body });
console.log(res.metadata?.name);

Used by: AppsV1Api.createNamespacedControllerRevision · AppsV1Api.patchNamespacedControllerRevision · AppsV1Api.readNamespacedControllerRevision

V1ControllerRevisionList

ControllerRevisionList is a resource containing a list of ControllerRevision objects.

Source

Property	Type	Description
`apiVersion`	`string`	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:...
`items`	V1ControllerRevision[]	Items is the list of ControllerRevisions
`kind`	`string`	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:...
`metadata`	V1ListMeta

Example

import * as k8s from '@kubernetes/client-node';

const kc = new k8s.KubeConfig();
kc.loadFromDefault();
const api = kc.makeApiClient(k8s.AppsV1Api);

const res: k8s.V1ControllerRevisionList = await api.listNamespacedControllerRevision({ namespace: 'default' });
for (const item of res.items) {
    console.log(item.metadata?.name);
}

Used by: AppsV1Api.listControllerRevisionForAllNamespaces · AppsV1Api.listNamespacedControllerRevision

V1CronJob

CronJob represents the configuration of a single cron job.

Source

Property	Type	Description
`apiVersion`	`string`	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:...
`kind`	`string`	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:...
`metadata`	V1ObjectMeta
`spec`	V1CronJobSpec
`status`	V1CronJobStatus

Example

import * as k8s from '@kubernetes/client-node';

const kc = new k8s.KubeConfig();
kc.loadFromDefault();
const api = kc.makeApiClient(k8s.BatchV1Api);

const body: k8s.V1CronJob = {
    metadata: { name: 'example' },
    spec: { /* ... */ },
};
const res = await api.createNamespacedCronJob({ namespace: 'default', body });
console.log(res.metadata?.name);

Used by: BatchV1Api.createNamespacedCronJob · BatchV1Api.readNamespacedCronJob · BatchV1Api.readNamespacedCronJobStatus

V1CronJobList

CronJobList is a collection of cron jobs.

Source

Property	Type	Description
`apiVersion`	`string`	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:...
`items`	V1CronJob[]	items is the list of CronJobs.
`kind`	`string`	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:...
`metadata`	V1ListMeta

Example

import * as k8s from '@kubernetes/client-node';

const kc = new k8s.KubeConfig();
kc.loadFromDefault();
const api = kc.makeApiClient(k8s.BatchV1Api);

const res: k8s.V1CronJobList = await api.listNamespacedCronJob({ namespace: 'default' });
for (const item of res.items) {
    console.log(item.metadata?.name);
}

Used by: BatchV1Api.listCronJobForAllNamespaces · BatchV1Api.listNamespacedCronJob

V1CronJobSpec

CronJobSpec describes how the job execution will look like and when it will actually run.

Source

Property	Type	Description
`concurrencyPolicy`	`string`	Specifies how to treat concurrent executions of a Job. Valid values are: - "Allow" (default): allows CronJobs to run concurrently; - "Forbid": forbids concurrent runs, skipping next run if...
`failedJobsHistoryLimit`	`number`	The number of failed finished jobs to retain. Value must be non-negative integer. Defaults to 1.
`schedule`	`string`	The schedule in Cron format, see https://en.wikipedia.org/wiki/Cron.
`startingDeadlineSeconds`	`number`	Optional deadline in seconds for starting the job if it misses scheduled time for any reason. Missed jobs executions will be counted as failed ones.
`successfulJobsHistoryLimit`	`number`	The number of successful finished jobs to retain. Value must be non-negative integer. Defaults to 3.
`suspend`	`boolean`	This flag tells the controller to suspend subsequent executions, it does not apply to already started executions. Defaults to false.
`timeZone`	`string`	The time zone name for the given schedule, see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones. If not specified, this will default to the time zone of the kube-controller-manager...
`jobTemplate`	V1JobTemplateSpec

V1CronJobStatus

CronJobStatus represents the current state of a cron job.

Source

Property	Type	Description
`active`	V1ObjectReference[]	A list of pointers to currently running jobs.
`lastScheduleTime`	`Date`	Information when was the last time the job was successfully scheduled.
`lastSuccessfulTime`	`Date`	Information when was the last time the job successfully completed.

V1DaemonSet

DaemonSet represents the configuration of a daemon set.

Source

Property	Type	Description
`apiVersion`	`string`	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:...
`kind`	`string`	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:...
`metadata`	V1ObjectMeta
`spec`	V1DaemonSetSpec
`status`	V1DaemonSetStatus

Example

import * as k8s from '@kubernetes/client-node';

const kc = new k8s.KubeConfig();
kc.loadFromDefault();
const api = kc.makeApiClient(k8s.AppsV1Api);

const body: k8s.V1DaemonSet = {
    metadata: { name: 'example' },
    spec: { /* ... */ },
};
const res = await api.createNamespacedDaemonSet({ namespace: 'default', body });
console.log(res.metadata?.name);

Used by: AppsV1Api.createNamespacedDaemonSet · AppsV1Api.readNamespacedDaemonSet · AppsV1Api.readNamespacedDaemonSetStatus

V1DaemonSetCondition

DaemonSetCondition describes the state of a DaemonSet at a certain point.

Source

Property	Type	Description
`lastTransitionTime`	`Date`	Last time the condition transitioned from one status to another.
`message`	`string`	A human readable message indicating details about the transition.
`reason`	`string`	The reason for the condition's last transition.
`status`	`string`	Status of the condition, one of True, False, Unknown.
`type`	`string`	Type of DaemonSet condition.

V1DaemonSetList

DaemonSetList is a collection of daemon sets.

Source

Property	Type	Description
`apiVersion`	`string`	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:...
`items`	V1DaemonSet[]	A list of daemon sets.
`kind`	`string`	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:...
`metadata`	V1ListMeta

Example

import * as k8s from '@kubernetes/client-node';

const kc = new k8s.KubeConfig();
kc.loadFromDefault();
const api = kc.makeApiClient(k8s.AppsV1Api);

const res: k8s.V1DaemonSetList = await api.listNamespacedDaemonSet({ namespace: 'default' });
for (const item of res.items) {
    console.log(item.metadata?.name);
}

Used by: AppsV1Api.listDaemonSetForAllNamespaces · AppsV1Api.listNamespacedDaemonSet

V1DaemonSetSpec

DaemonSetSpec is the specification of a daemon set.

Source

Property	Type	Description
`minReadySeconds`	`number`	The minimum number of seconds for which a newly created DaemonSet pod should be ready without any of its container crashing, for it to be considered available. Defaults to 0 (pod will be considered...
`revisionHistoryLimit`	`number`	The number of old history to retain to allow rollback. This is a pointer to distinguish between explicit zero and not specified. Defaults to 10.
`selector`	V1LabelSelector
`template`	V1PodTemplateSpec
`updateStrategy`	V1DaemonSetUpdateStrategy

V1DaemonSetStatus

DaemonSetStatus represents the current status of a daemon set.

Source

Property	Type	Description
`collisionCount`	`number`	Count of hash collisions for the DaemonSet. The DaemonSet controller uses this field as a collision avoidance mechanism when it needs to create the name for the newest ControllerRevision.
`conditions`	V1DaemonSetCondition[]	Represents the latest available observations of a DaemonSet's current state.
`currentNumberScheduled`	`number`	The number of nodes that are running at least 1 daemon pod and are supposed to run the daemon pod. More info: https://kubernetes.io/docs/concepts/workloads/controllers/daemonset/
`desiredNumberScheduled`	`number`	The total number of nodes that should be running the daemon pod (including nodes correctly running the daemon pod). More info: https://kubernetes.io/docs/concepts/workloads/controllers/daemonset/
`numberAvailable`	`number`	The number of nodes that should be running the daemon pod and have one or more of the daemon pod running and available (ready for at least spec.minReadySeconds)
`numberMisscheduled`	`number`	The number of nodes that are running the daemon pod, but are not supposed to run the daemon pod. More info: https://kubernetes.io/docs/concepts/workloads/controllers/daemonset/
`numberReady`	`number`	numberReady is the number of nodes that should be running the daemon pod and have one or more of the daemon pod running with a Ready Condition.
`numberUnavailable`	`number`	The number of nodes that should be running the daemon pod and have none of the daemon pod running and available (ready for at least spec.minReadySeconds)
`observedGeneration`	`number`	The most recent generation observed by the daemon set controller.
`updatedNumberScheduled`	`number`	The total number of nodes that are running updated daemon pod

V1DaemonSetUpdateStrategy

DaemonSetUpdateStrategy is a struct used to control the update strategy for a DaemonSet.

Source

Property	Type	Description
`type`	`string`	Type of daemon set update. Can be "RollingUpdate" or "OnDelete". Default is RollingUpdate.
`rollingUpdate`	V1RollingUpdateDaemonSet

V1Deployment

Deployment enables declarative updates for Pods and ReplicaSets.

Source

Property	Type	Description
`apiVersion`	`string`	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:...
`kind`	`string`	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:...
`metadata`	V1ObjectMeta
`spec`	V1DeploymentSpec
`status`	V1DeploymentStatus

Example

import * as k8s from '@kubernetes/client-node';

const kc = new k8s.KubeConfig();
kc.loadFromDefault();
const api = kc.makeApiClient(k8s.AppsV1Api);

const body: k8s.V1Deployment = {
    metadata: { name: 'example' },
    spec: { /* ... */ },
};
const res = await api.createNamespacedDeployment({ namespace: 'default', body });
console.log(res.metadata?.name);

Used by: AppsV1Api.createNamespacedDeployment · AppsV1Api.readNamespacedDeployment · AppsV1Api.readNamespacedDeploymentStatus

V1DeploymentCondition

DeploymentCondition describes the state of a deployment at a certain point.

Source

Property	Type	Description
`lastTransitionTime`	`Date`	Last time the condition transitioned from one status to another.
`lastUpdateTime`	`Date`	The last time this condition was updated.
`message`	`string`	A human readable message indicating details about the transition.
`reason`	`string`	The reason for the condition's last transition.
`status`	`string`	Status of the condition, one of True, False, Unknown.
`type`	`string`	Type of deployment condition.

V1DeploymentList

DeploymentList is a list of Deployments.

Source

Property	Type	Description
`apiVersion`	`string`	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:...
`items`	V1Deployment[]	Items is the list of Deployments.
`kind`	`string`	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:...
`metadata`	V1ListMeta

Example

import * as k8s from '@kubernetes/client-node';

const kc = new k8s.KubeConfig();
kc.loadFromDefault();
const api = kc.makeApiClient(k8s.AppsV1Api);

const res: k8s.V1DeploymentList = await api.listNamespacedDeployment({ namespace: 'default' });
for (const item of res.items) {
    console.log(item.metadata?.name);
}

Used by: AppsV1Api.listDeploymentForAllNamespaces · AppsV1Api.listNamespacedDeployment

V1DeploymentSpec

DeploymentSpec is the specification of the desired behavior of the Deployment.

Source

Property	Type	Description
`minReadySeconds`	`number`	Minimum number of seconds for which a newly created pod should be ready without any of its container crashing, for it to be considered available. Defaults to 0 (pod will be considered available as...
`paused`	`boolean`	Indicates that the deployment is paused.
`progressDeadlineSeconds`	`number`	The maximum time in seconds for a deployment to make progress before it is considered to be failed. The deployment controller will continue to process failed deployments and a condition with a...
`replicas`	`number`	Number of desired pods. This is a pointer to distinguish between explicit zero and not specified. Defaults to 1.
`revisionHistoryLimit`	`number`	The number of old ReplicaSets to retain to allow rollback. This is a pointer to distinguish between explicit zero and not specified. Defaults to 10.
`selector`	V1LabelSelector
`strategy`	V1DeploymentStrategy
`template`	V1PodTemplateSpec

V1DeploymentStatus

DeploymentStatus is the most recently observed status of the Deployment.

Source

Property	Type	Description
`availableReplicas`	`number`	Total number of available non-terminating pods (ready for at least minReadySeconds) targeted by this deployment.
`collisionCount`	`number`	Count of hash collisions for the Deployment. The Deployment controller uses this field as a collision avoidance mechanism when it needs to create the name for the newest ReplicaSet.
`conditions`	V1DeploymentCondition[]	Represents the latest available observations of a deployment's current state.
`observedGeneration`	`number`	The generation observed by the deployment controller.
`readyReplicas`	`number`	Total number of non-terminating pods targeted by this Deployment with a Ready Condition.
`replicas`	`number`	Total number of non-terminating pods targeted by this deployment (their labels match the selector).
`terminatingReplicas`	`number`	Total number of terminating pods targeted by this deployment. Terminating pods have a non-null .metadata.deletionTimestamp and have not yet reached the Failed or Succeeded .status.phase. This is a...
`unavailableReplicas`	`number`	Total number of unavailable pods targeted by this deployment. This is the total number of pods that are still required for the deployment to have 100% available capacity. They may either be pods that...
`updatedReplicas`	`number`	Total number of non-terminating pods targeted by this deployment that have the desired template spec.

V1DeploymentStrategy

DeploymentStrategy describes how to replace existing pods with new ones.

Source

Property	Type	Description
`type`	`string`	Type of deployment. Can be "Recreate" or "RollingUpdate". Default is RollingUpdate.
`rollingUpdate`	V1RollingUpdateDeployment

V1HorizontalPodAutoscaler

configuration of a horizontal pod autoscaler.

Source

Property	Type	Description
`apiVersion`	`string`	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:...
`kind`	`string`	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:...
`metadata`	V1ObjectMeta
`spec`	V1HorizontalPodAutoscalerSpec
`status`	V1HorizontalPodAutoscalerStatus

Example

import * as k8s from '@kubernetes/client-node';

const kc = new k8s.KubeConfig();
kc.loadFromDefault();
const api = kc.makeApiClient(k8s.AutoscalingV1Api);

const body: k8s.V1HorizontalPodAutoscaler = {
    metadata: { name: 'example' },
    spec: { /* ... */ },
};
const res = await api.createNamespacedHorizontalPodAutoscaler({ namespace: 'default', body });
console.log(res.metadata?.name);

Used by: AutoscalingV1Api.createNamespacedHorizontalPodAutoscaler · AutoscalingV1Api.readNamespacedHorizontalPodAutoscaler · AutoscalingV1Api.readNamespacedHorizontalPodAutoscalerStatus

V1HorizontalPodAutoscalerList

list of horizontal pod autoscaler objects.

Source

Property	Type	Description
`apiVersion`	`string`	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:...
`items`	V1HorizontalPodAutoscaler[]	items is the list of horizontal pod autoscaler objects.
`kind`	`string`	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:...
`metadata`	V1ListMeta

Example

import * as k8s from '@kubernetes/client-node';

const kc = new k8s.KubeConfig();
kc.loadFromDefault();
const api = kc.makeApiClient(k8s.AutoscalingV1Api);

const res: k8s.V1HorizontalPodAutoscalerList = await api.listNamespacedHorizontalPodAutoscaler({ namespace: 'default' });
for (const item of res.items) {
    console.log(item.metadata?.name);
}

Used by: AutoscalingV1Api.listHorizontalPodAutoscalerForAllNamespaces · AutoscalingV1Api.listNamespacedHorizontalPodAutoscaler

V1HorizontalPodAutoscalerSpec

specification of a horizontal pod autoscaler.

Source

Property	Type	Description
`maxReplicas`	`number`	maxReplicas is the upper limit for the number of pods that can be set by the autoscaler; cannot be smaller than MinReplicas.
`minReplicas`	`number`	minReplicas is the lower limit for the number of replicas to which the autoscaler can scale down. It defaults to 1 pod. minReplicas is allowed to be 0 if the alpha feature gate HPAScaleToZero is...
`targetCPUUtilizationPercentage`	`number`	targetCPUUtilizationPercentage is the target average CPU utilization (represented as a percentage of requested CPU) over all the pods; if not specified the default autoscaling policy will be used.
`scaleTargetRef`	V1CrossVersionObjectReference

V1HorizontalPodAutoscalerStatus

current status of a horizontal pod autoscaler

Source

Property	Type	Description
`currentCPUUtilizationPercentage`	`number`	currentCPUUtilizationPercentage is the current average CPU utilization over all pods, represented as a percentage of requested CPU, e.g. 70 means that an average pod is using now 70% of its requested...
`currentReplicas`	`number`	currentReplicas is the current number of replicas of pods managed by this autoscaler.
`desiredReplicas`	`number`	desiredReplicas is the desired number of replicas of pods managed by this autoscaler.
`lastScaleTime`	`Date`	lastScaleTime is the last time the HorizontalPodAutoscaler scaled the number of pods; used by the autoscaler to control how often the number of pods is changed.
`observedGeneration`	`number`	observedGeneration is the most recent generation observed by this autoscaler.

V1Job

Job represents the configuration of a single job.

Source

Property	Type	Description
`apiVersion`	`string`	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:...
`kind`	`string`	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:...
`metadata`	V1ObjectMeta
`spec`	V1JobSpec
`status`	V1JobStatus

Example

import * as k8s from '@kubernetes/client-node';

const kc = new k8s.KubeConfig();
kc.loadFromDefault();
const api = kc.makeApiClient(k8s.BatchV1Api);

const body: k8s.V1Job = {
    metadata: { name: 'example' },
    spec: { /* ... */ },
};
const res = await api.createNamespacedJob({ namespace: 'default', body });
console.log(res.metadata?.name);

Used by: BatchV1Api.createNamespacedJob · BatchV1Api.readNamespacedJob · BatchV1Api.readNamespacedJobStatus

V1JobCondition

JobCondition describes current state of a job.

Source

Property	Type	Description
`lastProbeTime`	`Date`	Last time the condition was checked.
`lastTransitionTime`	`Date`	Last time the condition transit from one status to another.
`message`	`string`	Human readable message indicating details about last transition.
`reason`	`string`	(brief) reason for the condition's last transition.
`status`	`string`	Status of the condition, one of True, False, Unknown.
`type`	`string`	Type of job condition, Complete or Failed.

V1JobList

JobList is a collection of jobs.

Source

Property	Type	Description
`apiVersion`	`string`	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:...
`items`	V1Job[]	items is the list of Jobs.
`kind`	`string`	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:...
`metadata`	V1ListMeta

Example

import * as k8s from '@kubernetes/client-node';

const kc = new k8s.KubeConfig();
kc.loadFromDefault();
const api = kc.makeApiClient(k8s.BatchV1Api);

const res: k8s.V1JobList = await api.listNamespacedJob({ namespace: 'default' });
for (const item of res.items) {
    console.log(item.metadata?.name);
}

Used by: BatchV1Api.listJobForAllNamespaces · BatchV1Api.listNamespacedJob

V1JobSpec

JobSpec describes how the job execution will look like.

Source

Property	Type	Description
`activeDeadlineSeconds`	`number`	Specifies the duration in seconds relative to the startTime that the job may be continuously active before the system tries to terminate it; value must be positive integer. If a Job is suspended (at...
`backoffLimit`	`number`	Specifies the number of retries before marking this job failed. Defaults to 6, unless backoffLimitPerIndex (only Indexed Job) is specified. When backoffLimitPerIndex is specified, backoffLimit...
`backoffLimitPerIndex`	`number`	Specifies the limit for the number of retries within an index before marking this index as failed. When enabled the number of failures per index is kept in the pod's...
`completionMode`	`string`	completionMode specifies how Pod completions are tracked. It can be `NonIndexed` (default) or `Indexed`. `NonIndexed` means that the Job is considered complete when there have been .spec.completions...
`completions`	`number`	Specifies the desired number of successfully finished pods the job should be run with. Setting to null means that the success of any pod signals the success of all pods, and allows parallelism to...
`managedBy`	`string`	ManagedBy field indicates the controller that manages a Job. The k8s Job controller reconciles jobs which don't have this field at all or the field value is the reserved string...
`manualSelector`	`boolean`	manualSelector controls generation of pod labels and pod selectors. Leave `manualSelector` unset unless you are certain what you are doing. When false or unset, the system pick labels unique to this...
`maxFailedIndexes`	`number`	Specifies the maximal number of failed indexes before marking the Job as failed, when backoffLimitPerIndex is set. Once the number of failed indexes exceeds this number the entire Job is marked as...
`parallelism`	`number`	Specifies the maximum desired number of pods the job should run at any given time. The actual number of pods running in steady state will be less than this number when ((.spec.completions -...
`podReplacementPolicy`	`string`	podReplacementPolicy specifies when to create replacement Pods. Possible values are: - TerminatingOrFailed means that we recreate pods when they are terminating (has a metadata.deletionTimestamp)...
`suspend`	`boolean`	suspend specifies whether the Job controller should create Pods or not. If a Job is created with suspend set to true, no Pods are created by the Job controller. If a Job is suspended after creation...
`ttlSecondsAfterFinished`	`number`	ttlSecondsAfterFinished limits the lifetime of a Job that has finished execution (either Complete or Failed). If this field is set, ttlSecondsAfterFinished after the Job finishes, it is eligible to...
`podFailurePolicy`	V1PodFailurePolicy
`selector`	V1LabelSelector
`successPolicy`	V1SuccessPolicy
`template`	V1PodTemplateSpec

V1JobStatus

JobStatus represents the current state of a Job.

Source

Property	Type	Description
`active`	`number`	The number of pending and running pods which are not terminating (without a deletionTimestamp). The value is zero for finished jobs.
`completedIndexes`	`string`	completedIndexes holds the completed indexes when .spec.completionMode = "Indexed" in a text format. The indexes are represented as decimal integers separated by commas. The numbers are listed in...
`completionTime`	`Date`	Represents time when the job was completed. It is not guaranteed to be set in happens-before order across separate operations. It is represented in RFC3339 form and is in UTC. The completion time is...
`conditions`	V1JobCondition[]	The latest available observations of an object's current state. When a Job fails, one of the conditions will have type "Failed" and status true. When a Job is suspended, one of the conditions will...
`failed`	`number`	The number of pods which reached phase Failed. The value increases monotonically.
`failedIndexes`	`string`	FailedIndexes holds the failed indexes when spec.backoffLimitPerIndex is set. The indexes are represented in the text format analogous as for the `completedIndexes` field, ie. they are kept as...
`ready`	`number`	The number of active pods which have a Ready condition and are not terminating (without a deletionTimestamp).
`startTime`	`Date`	Represents time when the job controller started processing a job. When a Job is created in the suspended state, this field is not set until the first time it is resumed. This field is reset every...
`succeeded`	`number`	The number of pods which reached phase Succeeded. The value increases monotonically for a given spec. However, it may decrease in reaction to scale down of elastic indexed jobs.
`terminating`	`number`	The number of pods which are terminating (in phase Pending or Running and have a deletionTimestamp). This field is beta-level. The job controller populates the field when the feature gate...
`uncountedTerminatedPods`	V1UncountedTerminatedPods

V1JobTemplateSpec

JobTemplateSpec describes the data a Job should have when created from a template

Source

Property	Type	Description
`metadata`	V1ObjectMeta
`spec`	V1JobSpec

V1ReplicaSet

ReplicaSet ensures that a specified number of pod replicas are running at any given time.

Source

Property	Type	Description
`apiVersion`	`string`	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:...
`kind`	`string`	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:...
`metadata`	V1ObjectMeta
`spec`	V1ReplicaSetSpec
`status`	V1ReplicaSetStatus

Example

import * as k8s from '@kubernetes/client-node';

const kc = new k8s.KubeConfig();
kc.loadFromDefault();
const api = kc.makeApiClient(k8s.AppsV1Api);

const body: k8s.V1ReplicaSet = {
    metadata: { name: 'example' },
    spec: { /* ... */ },
};
const res = await api.createNamespacedReplicaSet({ namespace: 'default', body });
console.log(res.metadata?.name);

Used by: AppsV1Api.createNamespacedReplicaSet · AppsV1Api.readNamespacedReplicaSet · AppsV1Api.readNamespacedReplicaSetStatus

V1ReplicaSetCondition

ReplicaSetCondition describes the state of a replica set at a certain point.

Source

Property	Type	Description
`lastTransitionTime`	`Date`	The last time the condition transitioned from one status to another.
`message`	`string`	A human readable message indicating details about the transition.
`reason`	`string`	The reason for the condition's last transition.
`status`	`string`	Status of the condition, one of True, False, Unknown.
`type`	`string`	Type of replica set condition.

V1ReplicaSetList

ReplicaSetList is a collection of ReplicaSets.

Source

Property	Type	Description
`apiVersion`	`string`	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:...
`items`	V1ReplicaSet[]	List of ReplicaSets. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicaset
`kind`	`string`	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:...
`metadata`	V1ListMeta

Example

import * as k8s from '@kubernetes/client-node';

const kc = new k8s.KubeConfig();
kc.loadFromDefault();
const api = kc.makeApiClient(k8s.AppsV1Api);

const res: k8s.V1ReplicaSetList = await api.listNamespacedReplicaSet({ namespace: 'default' });
for (const item of res.items) {
    console.log(item.metadata?.name);
}

Used by: AppsV1Api.listNamespacedReplicaSet · AppsV1Api.listReplicaSetForAllNamespaces

V1ReplicaSetSpec

ReplicaSetSpec is the specification of a ReplicaSet.

Source

Property	Type	Description
`minReadySeconds`	`number`	Minimum number of seconds for which a newly created pod should be ready without any of its container crashing, for it to be considered available. Defaults to 0 (pod will be considered available as...
`replicas`	`number`	Replicas is the number of desired pods. This is a pointer to distinguish between explicit zero and unspecified. Defaults to 1. More info:...
`selector`	V1LabelSelector
`template`	V1PodTemplateSpec

V1ReplicaSetStatus

ReplicaSetStatus represents the current status of a ReplicaSet.

Source

Property	Type	Description
`availableReplicas`	`number`	The number of available non-terminating pods (ready for at least minReadySeconds) for this replica set.
`conditions`	V1ReplicaSetCondition[]	Represents the latest available observations of a replica set's current state.
`fullyLabeledReplicas`	`number`	The number of non-terminating pods that have labels matching the labels of the pod template of the replicaset.
`observedGeneration`	`number`	ObservedGeneration reflects the generation of the most recently observed ReplicaSet.
`readyReplicas`	`number`	The number of non-terminating pods targeted by this ReplicaSet with a Ready Condition.
`replicas`	`number`	Replicas is the most recently observed number of non-terminating pods. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicaset
`terminatingReplicas`	`number`	The number of terminating pods for this replica set. Terminating pods have a non-null .metadata.deletionTimestamp and have not yet reached the Failed or Succeeded .status.phase. This is a beta field...

V1Scale

Scale represents a scaling request for a resource.

Source

Property	Type	Description
`apiVersion`	`string`	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:...
`kind`	`string`	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:...
`metadata`	V1ObjectMeta
`spec`	V1ScaleSpec
`status`	V1ScaleStatus

Example

import * as k8s from '@kubernetes/client-node';

const kc = new k8s.KubeConfig();
kc.loadFromDefault();
const api = kc.makeApiClient(k8s.CoreV1Api);

const body: k8s.V1Scale = {
    metadata: { name: 'example' },
    spec: { /* ... */ },
};
const res = await api.patchNamespacedReplicationControllerScale({ namespace: 'default', body });
console.log(res.metadata?.name);

Used by: AppsV1Api.patchNamespacedDeploymentScale · AppsV1Api.readNamespacedDeploymentScale · AppsV1Api.replaceNamespacedDeploymentScale · CoreV1Api.patchNamespacedReplicationControllerScale · CoreV1Api.readNamespacedReplicationControllerScale · CoreV1Api.replaceNamespacedReplicationControllerScale

V1ScaleIOPersistentVolumeSource

ScaleIOPersistentVolumeSource represents a persistent ScaleIO volume

Source

Property	Type	Description
`fsType`	`string`	fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Default is "xfs"
`gateway`	`string`	gateway is the host address of the ScaleIO API Gateway.
`protectionDomain`	`string`	protectionDomain is the name of the ScaleIO Protection Domain for the configured storage.
`readOnly`	`boolean`	readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
`sslEnabled`	`boolean`	sslEnabled is the flag to enable/disable SSL communication with Gateway, default false
`storageMode`	`string`	storageMode indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned. Default is ThinProvisioned.
`storagePool`	`string`	storagePool is the ScaleIO Storage Pool associated with the protection domain.
`system`	`string`	system is the name of the storage system as configured in ScaleIO.
`volumeName`	`string`	volumeName is the name of a volume already created in the ScaleIO system that is associated with this volume source.
`secretRef`	V1SecretReference

V1ScaleIOVolumeSource

ScaleIOVolumeSource represents a persistent ScaleIO volume

Source

Property	Type	Description
`fsType`	`string`	fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Default is "xfs".
`gateway`	`string`	gateway is the host address of the ScaleIO API Gateway.
`protectionDomain`	`string`	protectionDomain is the name of the ScaleIO Protection Domain for the configured storage.
`readOnly`	`boolean`	readOnly Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
`sslEnabled`	`boolean`	sslEnabled Flag enable/disable SSL communication with Gateway, default false
`storageMode`	`string`	storageMode indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned. Default is ThinProvisioned.
`storagePool`	`string`	storagePool is the ScaleIO Storage Pool associated with the protection domain.
`system`	`string`	system is the name of the storage system as configured in ScaleIO.
`volumeName`	`string`	volumeName is the name of a volume already created in the ScaleIO system that is associated with this volume source.
`secretRef`	V1LocalObjectReference

V1ScaleSpec

ScaleSpec describes the attributes of a scale subresource.

Source

Property	Type	Description
`replicas`	`number`	replicas is the desired number of instances for the scaled object.

V1ScaleStatus

ScaleStatus represents the current status of a scale subresource.

Source

Property	Type	Description
`replicas`	`number`	replicas is the actual number of observed instances of the scaled object.
`selector`	`string`	selector is the label query over pods that should match the replicas count. This is same as the label selector but in the string format to avoid introspection by clients. The string will be in the...

V1StatefulSet

StatefulSet represents a set of pods with consistent identities. Identities are defined as: - Network: A single stable DNS and hostname. - Storage: As many VolumeClaims as requested. The StatefulSet guarantees that a given network identity will always map to the same storage identity.

Source

Property	Type	Description
`apiVersion`	`string`	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:...
`kind`	`string`	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:...
`metadata`	V1ObjectMeta
`spec`	V1StatefulSetSpec
`status`	V1StatefulSetStatus

Example

import * as k8s from '@kubernetes/client-node';

const kc = new k8s.KubeConfig();
kc.loadFromDefault();
const api = kc.makeApiClient(k8s.AppsV1Api);

const body: k8s.V1StatefulSet = {
    metadata: { name: 'example' },
    spec: { /* ... */ },
};
const res = await api.createNamespacedStatefulSet({ namespace: 'default', body });
console.log(res.metadata?.name);

Used by: AppsV1Api.createNamespacedStatefulSet · AppsV1Api.readNamespacedStatefulSet · AppsV1Api.readNamespacedStatefulSetStatus

V1StatefulSetCondition

StatefulSetCondition describes the state of a statefulset at a certain point.

Source

Property	Type	Description
`lastTransitionTime`	`Date`	Last time the condition transitioned from one status to another.
`message`	`string`	A human readable message indicating details about the transition.
`reason`	`string`	The reason for the condition's last transition.
`status`	`string`	Status of the condition, one of True, False, Unknown.
`type`	`string`	Type of statefulset condition.

V1StatefulSetList

StatefulSetList is a collection of StatefulSets.

Source

Property	Type	Description
`apiVersion`	`string`	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:...
`items`	V1StatefulSet[]	Items is the list of stateful sets.
`kind`	`string`	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:...
`metadata`	V1ListMeta

Example

import * as k8s from '@kubernetes/client-node';

const kc = new k8s.KubeConfig();
kc.loadFromDefault();
const api = kc.makeApiClient(k8s.AppsV1Api);

const res: k8s.V1StatefulSetList = await api.listNamespacedStatefulSet({ namespace: 'default' });
for (const item of res.items) {
    console.log(item.metadata?.name);
}

Used by: AppsV1Api.listNamespacedStatefulSet · AppsV1Api.listStatefulSetForAllNamespaces

V1StatefulSetOrdinals

StatefulSetOrdinals describes the policy used for replica ordinal assignment in this StatefulSet.

Source

Property	Type	Description
`start`	`number`	start is the number representing the first replica's index. It may be used to number replicas from an alternate index (eg: 1-indexed) over the default 0-indexed names, or to orchestrate progressive...

V1StatefulSetPersistentVolumeClaimRetentionPolicy

StatefulSetPersistentVolumeClaimRetentionPolicy describes the policy used for PVCs created from the StatefulSet VolumeClaimTemplates.

Source

Property	Type	Description
`whenDeleted`	`string`	WhenDeleted specifies what happens to PVCs created from StatefulSet VolumeClaimTemplates when the StatefulSet is deleted. The default policy of `Retain` causes PVCs to not be affected by StatefulSet...
`whenScaled`	`string`	WhenScaled specifies what happens to PVCs created from StatefulSet VolumeClaimTemplates when the StatefulSet is scaled down. The default policy of `Retain` causes PVCs to not be affected by a...

V1StatefulSetSpec

A StatefulSetSpec is the specification of a StatefulSet.

Source

Property	Type	Description
`minReadySeconds`	`number`	Minimum number of seconds for which a newly created pod should be ready without any of its container crashing for it to be considered available. Defaults to 0 (pod will be considered available as...
`podManagementPolicy`	`string`	podManagementPolicy controls how pods are created during initial scale up, when replacing pods on nodes, or when scaling down. The default policy is `OrderedReady`, where pods are created in...
`replicas`	`number`	replicas is the desired number of replicas of the given Template. These are replicas in the sense that they are instantiations of the same Template, but individual replicas also have a consistent...
`revisionHistoryLimit`	`number`	revisionHistoryLimit is the maximum number of revisions that will be maintained in the StatefulSet's revision history. The revision history consists of all revisions not represented by a currently...
`serviceName`	`string`	serviceName is the name of the service that governs this StatefulSet. This service must exist before the StatefulSet, and is responsible for the network identity of the set. Pods get DNS/hostnames...
`volumeClaimTemplates`	V1PersistentVolumeClaim[]	volumeClaimTemplates is a list of claims that pods are allowed to reference. The StatefulSet controller is responsible for mapping network identities to claims in a way that maintains the identity of...
`ordinals`	V1StatefulSetOrdinals
`persistentVolumeClaimRetentionPolicy`	V1StatefulSetPersistentVolumeClaimRetentionPolicy
`selector`	V1LabelSelector
`template`	V1PodTemplateSpec
`updateStrategy`	V1StatefulSetUpdateStrategy

V1StatefulSetStatus

StatefulSetStatus represents the current state of a StatefulSet.

Source

Property	Type	Description
`availableReplicas`	`number`	Total number of available pods (ready for at least minReadySeconds) targeted by this statefulset.
`collisionCount`	`number`	collisionCount is the count of hash collisions for the StatefulSet. The StatefulSet controller uses this field as a collision avoidance mechanism when it needs to create the name for the newest...
`conditions`	V1StatefulSetCondition[]	Represents the latest available observations of a statefulset's current state.
`currentReplicas`	`number`	currentReplicas is the number of Pods created by the StatefulSet controller from the StatefulSet version indicated by currentRevision.
`currentRevision`	`string`	currentRevision, if not empty, indicates the version of the StatefulSet used to generate Pods in the sequence [0,currentReplicas).
`observedGeneration`	`number`	observedGeneration is the most recent generation observed for this StatefulSet. It corresponds to the StatefulSet's generation, which is updated on mutation by the API Server.
`readyReplicas`	`number`	readyReplicas is the number of pods created for this StatefulSet with a Ready Condition.
`replicas`	`number`	replicas is the number of Pods created by the StatefulSet controller.
`updateRevision`	`string`	updateRevision, if not empty, indicates the version of the StatefulSet used to generate Pods in the sequence [replicas-updatedReplicas,replicas)
`updatedReplicas`	`number`	updatedReplicas is the number of Pods created by the StatefulSet controller from the StatefulSet version indicated by updateRevision.

V1StatefulSetUpdateStrategy

StatefulSetUpdateStrategy indicates the strategy that the StatefulSet controller will use to perform updates. It includes any additional parameters necessary to perform the update for the indicated strategy.

Source

Property	Type	Description
`type`	`string`	Type indicates the type of the StatefulSetUpdateStrategy. Default is RollingUpdate.
`rollingUpdate`	V1RollingUpdateStatefulSetStrategy

V1ControllerRevision​

V1ControllerRevisionList​

V1CronJob​

V1CronJobList​

V1CronJobSpec​

V1CronJobStatus​

V1DaemonSet​

V1DaemonSetCondition​

V1DaemonSetList​

V1DaemonSetSpec​

V1DaemonSetStatus​

V1DaemonSetUpdateStrategy​

V1Deployment​

V1DeploymentCondition​

V1DeploymentList​

V1DeploymentSpec​

V1DeploymentStatus​

V1DeploymentStrategy​

V1HorizontalPodAutoscaler​

V1HorizontalPodAutoscalerList​

V1HorizontalPodAutoscalerSpec​

V1HorizontalPodAutoscalerStatus​

V1Job​

V1JobCondition​

V1JobList​

V1JobSpec​

V1JobStatus​

V1JobTemplateSpec​

V1ReplicaSet​

V1ReplicaSetCondition​

V1ReplicaSetList​

V1ReplicaSetSpec​

V1ReplicaSetStatus​

V1Scale​

V1ScaleIOPersistentVolumeSource​

V1ScaleIOVolumeSource​

V1ScaleSpec​

V1ScaleStatus​

V1StatefulSet​

V1StatefulSetCondition​

V1StatefulSetList​

V1StatefulSetOrdinals​

V1StatefulSetPersistentVolumeClaimRetentionPolicy​

V1StatefulSetSpec​

V1StatefulSetStatus​

V1StatefulSetUpdateStrategy​

V1ControllerRevision

V1ControllerRevisionList

V1CronJob

V1CronJobList

V1CronJobSpec

V1CronJobStatus

V1DaemonSet

V1DaemonSetCondition

V1DaemonSetList

V1DaemonSetSpec

V1DaemonSetStatus

V1DaemonSetUpdateStrategy

V1Deployment

V1DeploymentCondition

V1DeploymentList

V1DeploymentSpec

V1DeploymentStatus

V1DeploymentStrategy

V1HorizontalPodAutoscaler

V1HorizontalPodAutoscalerList

V1HorizontalPodAutoscalerSpec

V1HorizontalPodAutoscalerStatus

V1Job

V1JobCondition

V1JobList

V1JobSpec

V1JobStatus

V1JobTemplateSpec

V1ReplicaSet

V1ReplicaSetCondition

V1ReplicaSetList

V1ReplicaSetSpec

V1ReplicaSetStatus

V1Scale

V1ScaleIOPersistentVolumeSource

V1ScaleIOVolumeSource

V1ScaleSpec

V1ScaleStatus

V1StatefulSet

V1StatefulSetCondition

V1StatefulSetList

V1StatefulSetOrdinals

V1StatefulSetPersistentVolumeClaimRetentionPolicy

V1StatefulSetSpec

V1StatefulSetStatus

V1StatefulSetUpdateStrategy