Cluster Models

V1CustomResourceDefinition

• CustomResourceDefinition represents a resource that should be exposed on the API server. Its name MUST be in the format <.spec.name>.<.spec.group>.

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	V1CustomResourceDefinitionSpec
status	V1CustomResourceDefinitionStatus

Example

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

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

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

Used by: ApiextensionsV1Api.createCustomResourceDefinition · ApiextensionsV1Api.readCustomResourceDefinition · ApiextensionsV1Api.readCustomResourceDefinitionStatus

V1CustomResourceDefinitionCondition

• CustomResourceDefinitionCondition contains details for the current condition of this pod.

Source

Property	Type	Description
lastTransitionTime	Date	lastTransitionTime last time the condition transitioned from one status to another.
message	string	message is a human-readable message indicating details about last transition.
observedGeneration	number	observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration...
reason	string	reason is a unique, one-word, CamelCase reason for the condition's last transition.
status	string	status is the status of the condition. Can be True, False, Unknown.
type	string	type is the type of the condition. Types include Established, NamesAccepted and Terminating.

V1CustomResourceDefinitionList

• CustomResourceDefinitionList is a list of CustomResourceDefinition 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	V1CustomResourceDefinition[]	items list individual CustomResourceDefinition 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.ApiextensionsV1Api);

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

Used by: ApiextensionsV1Api.listCustomResourceDefinition

V1CustomResourceDefinitionNames

• CustomResourceDefinitionNames indicates the names to serve this CustomResourceDefinition

Source

Property	Type	Description
categories	string[]	categories is a list of grouped resources this custom resource belongs to (e.g. 'all'). This is published in API discovery documents, and used by clients to support invocations like `kubectl get...
kind	string	kind is the serialized kind of the resource. It is normally CamelCase and singular. Custom resource instances will use this value as the kind attribute in API calls.
listKind	string	listKind is the serialized kind of the list for this resource. Defaults to "kindList".
plural	string	plural is the plural name of the resource to serve. The custom resources are served under /apis/<group>/<version>/.../<plural>. Must match the name of the CustomResourceDefinition (in the form...
shortNames	string[]	shortNames are short names for the resource, exposed in API discovery documents, and used by clients to support invocations like kubectl get <shortname>. It must be all lowercase.
singular	string	singular is the singular name of the resource. It must be all lowercase. Defaults to lowercased kind.

V1CustomResourceDefinitionSpec

• CustomResourceDefinitionSpec describes how a user wants their resource to appear

Source

Property	Type	Description
group	string	group is the API group of the defined custom resource. The custom resources are served under /apis/<group>/.... Must match the name of the CustomResourceDefinition (in the form...
preserveUnknownFields	boolean	preserveUnknownFields indicates that object fields which are not specified in the OpenAPI schema should be preserved when persisting to storage. apiVersion, kind, metadata and known fields inside...
scope	string	scope indicates whether the defined custom resource is cluster- or namespace-scoped. Allowed values are Cluster and Namespaced.
versions	V1CustomResourceDefinitionVersion[]	versions is the list of all API versions of the defined custom resource. Version names are used to compute the order in which served versions are listed in API discovery. If the version string is...
conversion	V1CustomResourceConversion
names	V1CustomResourceDefinitionNames

V1CustomResourceDefinitionStatus

• CustomResourceDefinitionStatus indicates the state of the CustomResourceDefinition

Source

Property	Type	Description
conditions	V1CustomResourceDefinitionCondition[]	conditions indicate state for particular aspects of a CustomResourceDefinition
observedGeneration	number	The generation observed by the CRD controller.
storedVersions	string[]	storedVersions lists all versions of CustomResources that were ever persisted. Tracking these versions allows a migration path for stored versions in etcd. The field is mutable so a migration...
acceptedNames	V1CustomResourceDefinitionNames

V1CustomResourceDefinitionVersion

• CustomResourceDefinitionVersion describes a version for CRD.

Source

Property	Type	Description
additionalPrinterColumns	V1CustomResourceColumnDefinition[]	additionalPrinterColumns specifies additional columns returned in Table output. See https://kubernetes.io/docs/reference/using-api/api-concepts/#receiving-resources-as-tables for details. If no...
deprecated	boolean	deprecated indicates this version of the custom resource API is deprecated. When set to true, API requests to this version receive a warning header in the server response. Defaults to false.
deprecationWarning	string	deprecationWarning overrides the default warning returned to API clients. May only be set when deprecated is true. The default warning indicates this version is deprecated and recommends use of the...
name	string	name is the version name, e.g. “v1”, “v2beta1”, etc. The custom resources are served under this version at /apis/<group>/<version>/... if served is true.
selectableFields	V1SelectableField[]	selectableFields specifies paths to fields that may be used as field selectors. A maximum of 8 selectable fields are allowed. See...
served	boolean	served is a flag enabling/disabling this version from being served via REST APIs
storage	boolean	storage indicates this version should be used when persisting custom resources to storage. There must be exactly one version with storage=true.
schema	V1CustomResourceValidation
subresources	V1CustomResourceSubresources

V1MutatingWebhookConfiguration

• MutatingWebhookConfiguration describes the configuration of and admission webhook that accept or reject and may change the object.

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:...
webhooks	V1MutatingWebhook[]	Webhooks is a list of webhooks and the affected resources and operations.
metadata	V1ObjectMeta

Example

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

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

const body: k8s.V1MutatingWebhookConfiguration = {
    metadata: { name: 'example' },
};
const res = await api.createMutatingWebhookConfiguration({ body });
console.log(res.metadata?.name);

Used by: AdmissionregistrationV1Api.createMutatingWebhookConfiguration · AdmissionregistrationV1Api.patchMutatingWebhookConfiguration · AdmissionregistrationV1Api.readMutatingWebhookConfiguration

V1MutatingWebhookConfigurationList

• MutatingWebhookConfigurationList is a list of MutatingWebhookConfiguration.

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	V1MutatingWebhookConfiguration[]	List of MutatingWebhookConfiguration.
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.AdmissionregistrationV1Api);

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

Used by: AdmissionregistrationV1Api.listMutatingWebhookConfiguration

V1PriorityClass

• PriorityClass defines mapping from a priority class name to the priority integer value. The value can be any valid integer.

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:...
description	string	description is an arbitrary string that usually provides guidelines on when this priority class should be used.
globalDefault	boolean	globalDefault specifies whether this PriorityClass should be considered as the default priority for pods that do not have any priority class. Only one PriorityClass can be marked as globalDefault....
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:...
preemptionPolicy	string	preemptionPolicy is the Policy for preempting pods with lower priority. One of Never, PreemptLowerPriority. Defaults to PreemptLowerPriority if unset.
value	number	value represents the integer value of this priority class. This is the actual priority that pods receive when they have the name of this class in their pod spec.
metadata	V1ObjectMeta

Example

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

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

const body: k8s.V1PriorityClass = {
    metadata: { name: 'example' },
};
const res = await api.createPriorityClass({ body });
console.log(res.metadata?.name);

Used by: SchedulingV1Api.createPriorityClass · SchedulingV1Api.patchPriorityClass · SchedulingV1Api.readPriorityClass

V1PriorityClassList

• PriorityClassList is a collection of priority classes.

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	V1PriorityClass[]	items is the list of PriorityClasses
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.SchedulingV1Api);

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

Used by: SchedulingV1Api.listPriorityClass

V1Scheduling

• Scheduling specifies the scheduling constraints for nodes supporting a RuntimeClass.

Source

Property	Type	Description
nodeSelector	{ [key: string]: string	nodeSelector lists labels that must be present on nodes that support this RuntimeClass. Pods using this RuntimeClass can only be scheduled to a node matched by this selector. The RuntimeClass...
tolerations	V1Toleration[]	tolerations are appended (excluding duplicates) to pods running with this RuntimeClass during admission, effectively unioning the set of nodes tolerated by the pod and the RuntimeClass.

V1ValidatingAdmissionPolicy

• ValidatingAdmissionPolicy describes the definition of an admission validation policy that accepts or rejects an object without changing it.

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	V1ValidatingAdmissionPolicySpec
status	V1ValidatingAdmissionPolicyStatus

Example

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

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

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

Used by: AdmissionregistrationV1Api.createValidatingAdmissionPolicy · AdmissionregistrationV1Api.readValidatingAdmissionPolicy · AdmissionregistrationV1Api.readValidatingAdmissionPolicyStatus

V1ValidatingAdmissionPolicyBinding

• ValidatingAdmissionPolicyBinding binds the ValidatingAdmissionPolicy with paramerized resources. ValidatingAdmissionPolicyBinding and parameter CRDs together define how cluster administrators configure policies for clusters. For a given admission request, each binding will cause its policy to be evaluated N times, where N is 1 for policies/bindings that don't use params, otherwise N is the number of parameters selected by the binding. The CEL expressions of a policy must have a computed CEL cost below the maximum CEL budget. Each evaluation of the policy is given an independent CEL cost budget. Adding/removing policies, bindings, or params can not affect whether a given (policy, binding, param) combination is within its own CEL budget.

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	V1ValidatingAdmissionPolicyBindingSpec

Example

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

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

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

Used by: AdmissionregistrationV1Api.createValidatingAdmissionPolicyBinding · AdmissionregistrationV1Api.patchValidatingAdmissionPolicyBinding · AdmissionregistrationV1Api.readValidatingAdmissionPolicyBinding

V1ValidatingAdmissionPolicyBindingList

• ValidatingAdmissionPolicyBindingList is a list of ValidatingAdmissionPolicyBinding.

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	V1ValidatingAdmissionPolicyBinding[]	List of PolicyBinding.
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.AdmissionregistrationV1Api);

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

Used by: AdmissionregistrationV1Api.listValidatingAdmissionPolicyBinding

V1ValidatingAdmissionPolicyBindingSpec

• ValidatingAdmissionPolicyBindingSpec is the specification of the ValidatingAdmissionPolicyBinding.

Source

Property	Type	Description
policyName	string	PolicyName references a ValidatingAdmissionPolicy name which the ValidatingAdmissionPolicyBinding binds to. If the referenced resource does not exist, this binding is considered invalid and will be...
validationActions	string[]	validationActions declares how Validations of the referenced ValidatingAdmissionPolicy are enforced. If a validation evaluates to false it is always enforced according to these actions. Failures...
matchResources	V1MatchResources
paramRef	V1ParamRef

V1ValidatingAdmissionPolicyList

• ValidatingAdmissionPolicyList is a list of ValidatingAdmissionPolicy.

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	V1ValidatingAdmissionPolicy[]	List of ValidatingAdmissionPolicy.
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.AdmissionregistrationV1Api);

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

Used by: AdmissionregistrationV1Api.listValidatingAdmissionPolicy

V1ValidatingAdmissionPolicySpec

• ValidatingAdmissionPolicySpec is the specification of the desired behavior of the AdmissionPolicy.

Source

Property	Type	Description
auditAnnotations	V1AuditAnnotation[]	auditAnnotations contains CEL expressions which are used to produce audit annotations for the audit event of the API request. validations and auditAnnotations may not both be empty; a least one of...
failurePolicy	string	failurePolicy defines how to handle failures for the admission policy. Failures can occur from CEL expression parse errors, type check errors, runtime errors and invalid or mis-configured policy...
matchConditions	V1MatchCondition[]	MatchConditions is a list of conditions that must be met for a request to be validated. Match conditions filter requests that have already been matched by the rules, namespaceSelector, and...
validations	V1Validation[]	Validations contain CEL expressions which is used to apply the validation. Validations and AuditAnnotations may not both be empty; a minimum of one Validations or AuditAnnotations is required.
variables	V1Variable[]	Variables contain definitions of variables that can be used in composition of other expressions. Each variable is defined as a named CEL expression. The variables defined here will be available under...
matchConstraints	V1MatchResources
paramKind	V1ParamKind

V1ValidatingAdmissionPolicyStatus

• ValidatingAdmissionPolicyStatus represents the status of an admission validation policy.

Source

Property	Type	Description
conditions	V1Condition[]	The conditions represent the latest available observations of a policy's current state.
observedGeneration	number	The generation observed by the controller.
typeChecking	V1TypeChecking

V1ValidatingWebhookConfiguration

• ValidatingWebhookConfiguration describes the configuration of and admission webhook that accept or reject and object without changing it.

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:...
webhooks	V1ValidatingWebhook[]	Webhooks is a list of webhooks and the affected resources and operations.
metadata	V1ObjectMeta

Example

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

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

const body: k8s.V1ValidatingWebhookConfiguration = {
    metadata: { name: 'example' },
};
const res = await api.createValidatingWebhookConfiguration({ body });
console.log(res.metadata?.name);

Used by: AdmissionregistrationV1Api.createValidatingWebhookConfiguration · AdmissionregistrationV1Api.patchValidatingWebhookConfiguration · AdmissionregistrationV1Api.readValidatingWebhookConfiguration

V1ValidatingWebhookConfigurationList

• ValidatingWebhookConfigurationList is a list of ValidatingWebhookConfiguration.

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	V1ValidatingWebhookConfiguration[]	List of ValidatingWebhookConfiguration.
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.AdmissionregistrationV1Api);

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

Used by: AdmissionregistrationV1Api.listValidatingWebhookConfiguration