Core Models

V1APIResource

• APIResource specifies the name of a resource and whether it is namespaced.

Source

Property	Type	Description
categories	string[]	categories is a list of the grouped resources this resource belongs to (e.g. 'all')
group	string	group is the preferred group of the resource. Empty implies the group of the containing resource list. For subresources, this may have a different value, for example: Scale".
kind	string	kind is the kind for the resource (e.g. 'Foo' is the kind for a resource 'foo')
name	string	name is the plural name of the resource.
namespaced	boolean	namespaced indicates if a resource is namespaced or not.
shortNames	string[]	shortNames is a list of suggested short names of the resource.
singularName	string	singularName is the singular name of the resource. This allows clients to handle plural and singular opaquely. The singularName is more correct for reporting status on a single item and both...
storageVersionHash	string	The hash value of the storage version, the version this resource is converted to when written to the data store. Value must be treated as opaque by clients. Only equality comparison on the value is...
verbs	string[]	verbs is a list of supported kube verbs (this includes get, list, watch, create, update, patch, delete, deletecollection, and proxy)
version	string	version is the preferred version of the resource. Empty implies the version of the containing resource list For subresources, this may have a different value, for example: v1 (while inside a v1beta1...

V1APIResourceList

• APIResourceList is a list of APIResource, it is used to expose the name of the resources supported in a specific group and version, and if the resource is namespaced.

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:...
groupVersion	string	groupVersion is the group and version this APIResourceList is for.
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:...
resources	V1APIResource[]	resources contains the name of the resources and if they are namespaced.

Example

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

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

const res: k8s.V1APIResourceList = await api.getAPIResources(/* ... */);
console.log(res.groupVersion);

Used by: AdmissionregistrationV1alpha1Api.getAPIResources · AdmissionregistrationV1Api.getAPIResources · AdmissionregistrationV1beta1Api.getAPIResources · ApiextensionsV1Api.getAPIResources · ApiregistrationV1Api.getAPIResources · AppsV1Api.getAPIResources · AuthenticationV1Api.getAPIResources · AuthorizationV1Api.getAPIResources · AutoscalingV1Api.getAPIResources · AutoscalingV2Api.getAPIResources · BatchV1Api.getAPIResources · CertificatesV1alpha1Api.getAPIResources · CertificatesV1Api.getAPIResources · CertificatesV1beta1Api.getAPIResources · CoordinationV1alpha2Api.getAPIResources · CoordinationV1Api.getAPIResources · CoordinationV1beta1Api.getAPIResources · CoreV1Api.getAPIResources · CustomObjectsApi.getAPIResources · DiscoveryV1Api.getAPIResources

and 17 more…

EventsV1Api.getAPIResources · FlowcontrolApiserverV1Api.getAPIResources · InternalApiserverV1alpha1Api.getAPIResources · NetworkingV1Api.getAPIResources · NetworkingV1beta1Api.getAPIResources · NodeV1Api.getAPIResources · PolicyV1Api.getAPIResources · RbacAuthorizationV1Api.getAPIResources · ResourceV1alpha3Api.getAPIResources · ResourceV1Api.getAPIResources · ResourceV1beta1Api.getAPIResources · ResourceV1beta2Api.getAPIResources · SchedulingV1alpha1Api.getAPIResources · SchedulingV1Api.getAPIResources · StoragemigrationV1beta1Api.getAPIResources · StorageV1Api.getAPIResources · StorageV1beta1Api.getAPIResources

V1APIService

• APIService represents a server for a particular GroupVersion. Name must be "version.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	V1APIServiceSpec
status	V1APIServiceStatus

Example

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

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

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

Used by: ApiregistrationV1Api.createAPIService · ApiregistrationV1Api.readAPIService · ApiregistrationV1Api.readAPIServiceStatus

V1APIServiceCondition

• APIServiceCondition describes the state of an APIService at a particular point

Source

Property	Type	Description
lastTransitionTime	Date	Last time the condition transitioned from one status to another.
message	string	Human-readable message indicating details about last transition.
reason	string	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.

V1APIServiceList

• APIServiceList is a list of APIService 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	V1APIService[]	Items is the list of APIService
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.ApiregistrationV1Api);

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

Used by: ApiregistrationV1Api.listAPIService

V1APIServiceSpec

• APIServiceSpec contains information for locating and communicating with a server. Only https is supported, though you are able to disable certificate verification.

Source

Property	Type	Description
caBundle	string	CABundle is a PEM encoded CA bundle which will be used to validate an API server's serving certificate. If unspecified, system trust roots on the apiserver are used.
group	string	Group is the API group name this server hosts
groupPriorityMinimum	number	GroupPriorityMinimum is the priority this group should have at least. Higher priority means that the group is preferred by clients over lower priority ones. Note that other versions of this group...
insecureSkipTLSVerify	boolean	InsecureSkipTLSVerify disables TLS certificate verification when communicating with this server. This is strongly discouraged. You should use the CABundle instead.
version	string	Version is the API version this server hosts. For example, "v1"
versionPriority	number	VersionPriority controls the ordering of this API version inside of its group. Must be greater than zero. The primary sort is based on VersionPriority, ordered highest to lowest (20 before 10)....
service	ApiregistrationV1ServiceReference

V1APIServiceStatus

• APIServiceStatus contains derived information about an API server

Source

Property	Type	Description
conditions	V1APIServiceCondition[]	Current service state of apiService.

V1Binding

• Binding ties one object to another; for example, a pod is bound to a node by a scheduler.

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
target	V1ObjectReference

Example

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

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

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

Used by: CoreV1Api.createNamespacedBinding · CoreV1Api.createNamespacedPodBinding

V1ComponentCondition

• Information about the condition of a component.

Source

Property	Type	Description
error	string	Condition error code for a component. For example, a health check error code.
message	string	Message about the condition for a component. For example, information about a health check.
status	string	Status of the condition for a component. Valid values for "Healthy": "True", "False", or "Unknown".
type	string	Type of condition for a component. Valid value: "Healthy"

V1ComponentStatus

• ComponentStatus (and ComponentStatusList) holds the cluster validation info. Deprecated: This API is deprecated in v1.19+

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:...
conditions	V1ComponentCondition[]	List of component conditions observed
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

Example

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

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

const res: k8s.V1ComponentStatus = await api.readComponentStatus(/* ... */);
console.log(res.conditions);

Used by: CoreV1Api.readComponentStatus

V1ComponentStatusList

• Status of all the conditions for the component as a list of ComponentStatus objects. Deprecated: This API is deprecated in v1.19+

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	V1ComponentStatus[]	List of ComponentStatus 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.CoreV1Api);

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

Used by: CoreV1Api.listComponentStatus

V1ConfigMap

• ConfigMap holds configuration data for pods to consume.

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:...
binaryData	{ [key: string]: string	BinaryData contains the binary data. Each key must consist of alphanumeric characters, '-', '_' or '.'. BinaryData can contain byte sequences that are not in the UTF-8 range. The keys stored in...
data	{ [key: string]: string	Data contains the configuration data. Each key must consist of alphanumeric characters, '-', '_' or '.'. Values with non-UTF-8 byte sequences must use the BinaryData field. The keys stored in...
immutable	boolean	Immutable, if set to true, ensures that data stored in the ConfigMap cannot be updated (only object metadata can be modified). If not set to true, the field can be modified at any time. Defaulted to...
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

Example

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

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

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

Used by: CoreV1Api.createNamespacedConfigMap · CoreV1Api.patchNamespacedConfigMap · CoreV1Api.readNamespacedConfigMap

V1ConfigMapEnvSource

• ConfigMapEnvSource selects a ConfigMap to populate the environment variables with. The contents of the target ConfigMap's Data field will represent the key-value pairs as environment variables.

Source

Property	Type	Description
name	string	Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More...
optional	boolean	Specify whether the ConfigMap must be defined

V1ConfigMapKeySelector

• Selects a key from a ConfigMap.

Source

Property	Type	Description
key	string	The key to select.
name	string	Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More...
optional	boolean	Specify whether the ConfigMap or its key must be defined

V1ConfigMapList

• ConfigMapList is a resource containing a list of ConfigMap 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	V1ConfigMap[]	Items is the list of ConfigMaps.
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.CoreV1Api);

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

Used by: CoreV1Api.listConfigMapForAllNamespaces · CoreV1Api.listNamespacedConfigMap

V1ConfigMapNodeConfigSource

• ConfigMapNodeConfigSource contains the information to reference a ConfigMap as a config source for the Node. This API is deprecated since 1.22: https://git.k8s.io/enhancements/keps/sig-node/281-dynamic-kubelet-configuration

Source

Property	Type	Description
kubeletConfigKey	string	KubeletConfigKey declares which key of the referenced ConfigMap corresponds to the KubeletConfiguration structure This field is required in all cases.
name	string	Name is the metadata.name of the referenced ConfigMap. This field is required in all cases.
namespace	string	Namespace is the metadata.namespace of the referenced ConfigMap. This field is required in all cases.
resourceVersion	string	ResourceVersion is the metadata.ResourceVersion of the referenced ConfigMap. This field is forbidden in Node.Spec, and required in Node.Status.
uid	string	UID is the metadata.UID of the referenced ConfigMap. This field is forbidden in Node.Spec, and required in Node.Status.

V1ConfigMapProjection

• Adapts a ConfigMap into a projected volume. The contents of the target ConfigMap's Data field will be presented in a projected volume as files using the keys in the Data field as the file names, unless the items element is populated with specific mappings of keys to paths. Note that this is identical to a configmap volume source without the default mode.

Source

Property	Type	Description
items	V1KeyToPath[]	items if unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the...
name	string	Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More...
optional	boolean	optional specify whether the ConfigMap or its keys must be defined

V1ConfigMapVolumeSource

• Adapts a ConfigMap into a volume. The contents of the target ConfigMap's Data field will be presented in a volume as files using the keys in the Data field as the file names, unless the items element is populated with specific mappings of keys to paths. ConfigMap volumes support ownership management and SELinux relabeling.

Source

Property	Type	Description
defaultMode	number	defaultMode is optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and...
items	V1KeyToPath[]	items if unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value. If specified, the...
name	string	Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More...
optional	boolean	optional specify whether the ConfigMap or its keys must be defined

V1Endpoint

• Endpoint represents a single logical "backend" implementing a service.

Source

Property	Type	Description
addresses	string[]	addresses of this endpoint. For EndpointSlices of addressType "IPv4" or "IPv6", the values are IP addresses in canonical form. The syntax and semantics of other addressType values are not...
deprecatedTopology	{ [key: string]: string	deprecatedTopology contains topology information part of the v1beta1 API. This field is deprecated, and will be removed when the v1beta1 API is removed (no sooner than kubernetes v1.24). While this...
hostname	string	hostname of this endpoint. This field may be used by consumers of endpoints to distinguish endpoints from each other (e.g. in DNS names). Multiple endpoints which use the same hostname should be...
nodeName	string	nodeName represents the name of the Node hosting this endpoint. This can be used to determine endpoints local to a Node.
zone	string	zone is the name of the Zone this endpoint exists in.
conditions	V1EndpointConditions
hints	V1EndpointHints
targetRef	V1ObjectReference

V1EndpointAddress

• EndpointAddress is a tuple that describes single IP address. Deprecated: This API is deprecated in v1.33+.

Source

Property	Type	Description
hostname	string	The Hostname of this endpoint
ip	string	The IP of this endpoint. May not be loopback (127.0.0.0/8 or ::1), link-local (169.254.0.0/16 or fe80::/10), or link-local multicast (224.0.0.0/24 or ff02::/16).
nodeName	string	Optional: Node hosting this endpoint. This can be used to determine endpoints local to a node.
targetRef	V1ObjectReference

V1EndpointConditions

• EndpointConditions represents the current condition of an endpoint.

Source

Property	Type	Description
ready	boolean	ready indicates that this endpoint is ready to receive traffic, according to whatever system is managing the endpoint. A nil value should be interpreted as "true". In general, an endpoint should be...
serving	boolean	serving indicates that this endpoint is able to receive traffic, according to whatever system is managing the endpoint. For endpoints backed by pods, the EndpointSlice controller will mark the...
terminating	boolean	terminating indicates that this endpoint is terminating. A nil value should be interpreted as "false".

V1EndpointHints

• EndpointHints provides hints describing how an endpoint should be consumed.

Source

Property	Type	Description
forNodes	V1ForNode[]	forNodes indicates the node(s) this endpoint should be consumed by when using topology aware routing. May contain a maximum of 8 entries.
forZones	V1ForZone[]	forZones indicates the zone(s) this endpoint should be consumed by when using topology aware routing. May contain a maximum of 8 entries.

V1EndpointSlice

• EndpointSlice represents a set of service endpoints. Most EndpointSlices are created by the EndpointSlice controller to represent the Pods selected by Service objects. For a given service there may be multiple EndpointSlice objects which must be joined to produce the full set of endpoints; you can find all of the slices for a given service by listing EndpointSlices in the service's namespace whose kubernetes.io/service-name label contains the service's name.

Source

Property	Type	Description
addressType	string	addressType specifies the type of address carried by this EndpointSlice. All addresses in this slice must be the same type. This field is immutable after creation. The following address types are...
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:...
endpoints	V1Endpoint[]	endpoints is a list of unique endpoints in this slice. Each slice may include a maximum of 1000 endpoints.
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:...
ports	DiscoveryV1EndpointPort[]	ports specifies the list of network ports exposed by each endpoint in this slice. Each port must have a unique name. Each slice may include a maximum of 100 ports. Services always have at least 1...
metadata	V1ObjectMeta

Example

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

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

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

Used by: DiscoveryV1Api.createNamespacedEndpointSlice · DiscoveryV1Api.patchNamespacedEndpointSlice · DiscoveryV1Api.readNamespacedEndpointSlice

V1EndpointSliceList

• EndpointSliceList represents a list of endpoint slices

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	V1EndpointSlice[]	items is the list of endpoint slices
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.DiscoveryV1Api);

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

Used by: DiscoveryV1Api.listEndpointSliceForAllNamespaces · DiscoveryV1Api.listNamespacedEndpointSlice

V1EndpointSubset

• EndpointSubset is a group of addresses with a common set of ports. The expanded set of endpoints is the Cartesian product of Addresses x Ports. For example, given: { Addresses: [{"ip": "10.10.1.1"}, {"ip": "10.10.2.2"}], Ports: [{"name": "a", "port": 8675}, {"name": "b", "port": 309}] } The resulting set of endpoints can be viewed as: a: [ 10.10.1.1:8675, 10.10.2.2:8675 ], b: [ 10.10.1.1:309, 10.10.2.2:309 ] Deprecated: This API is deprecated in v1.33+.

Source

Property	Type	Description
addresses	V1EndpointAddress[]	IP addresses which offer the related ports that are marked as ready. These endpoints should be considered safe for load balancers and clients to utilize.
notReadyAddresses	V1EndpointAddress[]	IP addresses which offer the related ports but are not currently marked as ready because they have not yet finished starting, have recently failed a readiness check, or have recently failed a...
ports	CoreV1EndpointPort[]	Port numbers available on the related IP addresses.

V1Endpoints

• Endpoints is a collection of endpoints that implement the actual service. Example: Name: "mysvc", Subsets: [ { Addresses: [{"ip": "10.10.1.1"}, {"ip": "10.10.2.2"}], Ports: [{"name": "a", "port": 8675}, {"name": "b", "port": 309}] }, { Addresses: [{"ip": "10.10.3.3"}], Ports: [{"name": "a", "port": 93}, {"name": "b", "port": 76}] }, ] Endpoints is a legacy API and does not contain information about all Service features. Use discoveryv1.EndpointSlice for complete information about Service endpoints. Deprecated: This API is deprecated in v1.33+. Use discoveryv1.EndpointSlice.

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:...
subsets	V1EndpointSubset[]	The set of all endpoints is the union of all subsets. Addresses are placed into subsets according to the IPs they share. A single address with multiple ports, some of which are ready and some of...
metadata	V1ObjectMeta

Example

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

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

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

Used by: CoreV1Api.createNamespacedEndpoints · CoreV1Api.patchNamespacedEndpoints · CoreV1Api.readNamespacedEndpoints

V1EndpointsList

• EndpointsList is a list of endpoints. Deprecated: This API is deprecated in v1.33+.

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	V1Endpoints[]	List of endpoints.
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.CoreV1Api);

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

Used by: CoreV1Api.listEndpointsForAllNamespaces · CoreV1Api.listNamespacedEndpoints

V1LimitRange

• LimitRange sets resource usage limits for each kind of resource in a Namespace.

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	V1LimitRangeSpec

Example

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

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

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

Used by: CoreV1Api.createNamespacedLimitRange · CoreV1Api.patchNamespacedLimitRange · CoreV1Api.readNamespacedLimitRange

V1LimitRangeItem

• LimitRangeItem defines a min/max usage limit for any resource that matches on kind.

Source

Property	Type	Description
_default	{ [key: string]: string	Default resource requirement limit value by resource name if resource limit is omitted.
defaultRequest	{ [key: string]: string	DefaultRequest is the default resource requirement request value by resource name if resource request is omitted.
max	{ [key: string]: string	Max usage constraints on this kind by resource name.
maxLimitRequestRatio	{ [key: string]: string	MaxLimitRequestRatio if specified, the named resource must have a request and limit that are both non-zero where limit divided by request is less than or equal to the enumerated value; this...
min	{ [key: string]: string	Min usage constraints on this kind by resource name.
type	string	Type of resource that this limit applies to.

V1LimitRangeList

• LimitRangeList is a list of LimitRange items.

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	V1LimitRange[]	Items is a list of LimitRange objects. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
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.CoreV1Api);

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

Used by: CoreV1Api.listLimitRangeForAllNamespaces · CoreV1Api.listNamespacedLimitRange

V1LimitRangeSpec

• LimitRangeSpec defines a min/max usage limit for resources that match on kind.

Source

Property	Type	Description
limits	V1LimitRangeItem[]	Limits is the list of LimitRangeItem objects that are enforced.

V1Namespace

• Namespace provides a scope for Names. Use of multiple namespaces is optional.

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	V1NamespaceSpec
status	V1NamespaceStatus

Example

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

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

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

Used by: CoreV1Api.createNamespace · CoreV1Api.readNamespace · CoreV1Api.readNamespaceStatus

V1NamespaceCondition

• NamespaceCondition contains details about state of namespace.

Source

Property	Type	Description
lastTransitionTime	Date	Last time the condition transitioned from one status to another.
message	string	Human-readable message indicating details about last transition.
reason	string	Unique, one-word, CamelCase reason for the condition's last transition.
status	string	Status of the condition, one of True, False, Unknown.
type	string	Type of namespace controller condition.

V1NamespaceList

• NamespaceList is a list of Namespaces.

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	V1Namespace[]	Items is the list of Namespace objects in the list. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/
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.CoreV1Api);

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

Used by: CoreV1Api.listNamespace

V1NamespaceSpec

• NamespaceSpec describes the attributes on a Namespace.

Source

Property	Type	Description
finalizers	string[]	Finalizers is an opaque list of values that must be empty to permanently remove object from storage. More info: https://kubernetes.io/docs/tasks/administer-cluster/namespaces/

V1NamespaceStatus

• NamespaceStatus is information about the current status of a Namespace.

Source

Property	Type	Description
conditions	V1NamespaceCondition[]	Represents the latest available observations of a namespace's current state.
phase	string	Phase is the current lifecycle phase of the namespace. More info: https://kubernetes.io/docs/tasks/administer-cluster/namespaces/

V1Node

• Node is a worker node in Kubernetes. Each node will have a unique identifier in the cache (i.e. in etcd).

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	V1NodeSpec
status	V1NodeStatus

Example

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

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

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

Used by: CoreV1Api.createNode · CoreV1Api.readNode · CoreV1Api.readNodeStatus

V1NodeAddress

• NodeAddress contains information for the node's address.

Source

Property	Type	Description
address	string	The node address.
type	string	Node address type, one of Hostname, ExternalIP or InternalIP.

V1NodeAffinity

• Node affinity is a group of node affinity scheduling rules.

Source

Property	Type	Description
preferredDuringSchedulingIgnoredDuringExecution	V1PreferredSchedulingTerm[]	The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that...
requiredDuringSchedulingIgnoredDuringExecution	V1NodeSelector

V1NodeCondition

• NodeCondition contains condition information for a node.

Source

Property	Type	Description
lastHeartbeatTime	Date	Last time we got an update on a given condition.
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 node condition.

V1NodeConfigSource

• NodeConfigSource specifies a source of node configuration. Exactly one subfield (excluding metadata) must be non-nil. This API is deprecated since 1.22

Source

Property	Type	Description
configMap	V1ConfigMapNodeConfigSource

V1NodeConfigStatus

• NodeConfigStatus describes the status of the config assigned by Node.Spec.ConfigSource.

Source

Property	Type	Description
error	string	Error describes any problems reconciling the Spec.ConfigSource to the Active config. Errors may occur, for example, attempting to checkpoint Spec.ConfigSource to the local Assigned record, attempting...
active	V1NodeConfigSource
assigned	V1NodeConfigSource
lastKnownGood	V1NodeConfigSource

V1NodeDaemonEndpoints

• NodeDaemonEndpoints lists ports opened by daemons running on the Node.

Source

Property	Type	Description
kubeletEndpoint	V1DaemonEndpoint

V1NodeFeatures

• NodeFeatures describes the set of features implemented by the CRI implementation. The features contained in the NodeFeatures should depend only on the cri implementation independent of runtime handlers.

Source

Property	Type	Description
supplementalGroupsPolicy	boolean	SupplementalGroupsPolicy is set to true if the runtime supports SupplementalGroupsPolicy and ContainerUser.

V1NodeList

• NodeList is the whole list of all Nodes which have been registered with master.

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	V1Node[]	List of nodes
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.CoreV1Api);

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

Used by: CoreV1Api.listNode

V1NodeRuntimeHandler

• NodeRuntimeHandler is a set of runtime handler information.

Source

Property	Type	Description
name	string	Runtime handler name. Empty for the default runtime handler.
features	V1NodeRuntimeHandlerFeatures

V1NodeRuntimeHandlerFeatures

• NodeRuntimeHandlerFeatures is a set of features implemented by the runtime handler.

Source

Property	Type	Description
recursiveReadOnlyMounts	boolean	RecursiveReadOnlyMounts is set to true if the runtime handler supports RecursiveReadOnlyMounts.
userNamespaces	boolean	UserNamespaces is set to true if the runtime handler supports UserNamespaces, including for volumes.

V1NodeSelector

• A node selector represents the union of the results of one or more label queries over a set of nodes; that is, it represents the OR of the selectors represented by the node selector terms.

Source

Property	Type	Description
nodeSelectorTerms	V1NodeSelectorTerm[]	Required. A list of node selector terms. The terms are ORed.

V1NodeSelectorRequirement

• A node selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

Source

Property	Type	Description
key	string	The label key that the selector applies to.
operator	string	Represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.
values	string[]	An array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. If the operator is Gt or Lt,...

V1NodeSelectorTerm

• A null or empty node selector term matches no objects. The requirements of them are ANDed. The TopologySelectorTerm type implements a subset of the NodeSelectorTerm.

Source

Property	Type	Description
matchExpressions	V1NodeSelectorRequirement[]	A list of node selector requirements by node's labels.
matchFields	V1NodeSelectorRequirement[]	A list of node selector requirements by node's fields.

V1NodeSpec

• NodeSpec describes the attributes that a node is created with.

Source

Property	Type	Description
externalID	string	Deprecated. Not all kubelets will set this field. Remove field after 1.13. see: https://issues.k8s.io/61966
podCIDR	string	PodCIDR represents the pod IP range assigned to the node.
podCIDRs	string[]	podCIDRs represents the IP ranges assigned to the node for usage by Pods on that node. If this field is specified, the 0th entry must match the podCIDR field. It may contain at most 1 value for each...
providerID	string	ID of the node assigned by the cloud provider in the format: ://
taints	V1Taint[]	If specified, the node's taints.
unschedulable	boolean	Unschedulable controls node schedulability of new pods. By default, node is schedulable. More info: https://kubernetes.io/docs/concepts/nodes/node/#manual-node-administration
configSource	V1NodeConfigSource

V1NodeStatus

• NodeStatus is information about the current status of a node.

Source

Property	Type	Description
addresses	V1NodeAddress[]	List of addresses reachable to the node. Queried from cloud provider, if available. More info: https://kubernetes.io/docs/reference/node/node-status/#addresses Note: This field is declared as...
allocatable	{ [key: string]: string	Allocatable represents the resources of a node that are available for scheduling. Defaults to Capacity.
capacity	{ [key: string]: string	Capacity represents the total resources of a node. More info: https://kubernetes.io/docs/reference/node/node-status/#capacity
conditions	V1NodeCondition[]	Conditions is an array of current observed node conditions. More info: https://kubernetes.io/docs/reference/node/node-status/#condition
declaredFeatures	string[]	DeclaredFeatures represents the features related to feature gates that are declared by the node.
images	V1ContainerImage[]	List of container images on this node
phase	string	NodePhase is the recently observed lifecycle phase of the node. More info: https://kubernetes.io/docs/concepts/nodes/node/#phase The field is never populated, and now is deprecated.
runtimeHandlers	V1NodeRuntimeHandler[]	The available runtime handlers.
volumesAttached	V1AttachedVolume[]	List of volumes that are attached to the node.
volumesInUse	string[]	List of attachable volumes in use (mounted) by the node.
config	V1NodeConfigStatus
daemonEndpoints	V1NodeDaemonEndpoints
features	V1NodeFeatures
nodeInfo	V1NodeSystemInfo

V1NodeSwapStatus

• NodeSwapStatus represents swap memory information.

Source

Property	Type	Description
capacity	number	Total amount of swap memory in bytes.

V1NodeSystemInfo

• NodeSystemInfo is a set of ids/uuids to uniquely identify the node.

Source

Property	Type	Description
architecture	string	The Architecture reported by the node
bootID	string	Boot ID reported by the node.
containerRuntimeVersion	string	ContainerRuntime Version reported by the node through runtime remote API (e.g. containerd://1.4.2).
kernelVersion	string	Kernel Version reported by the node from 'uname -r' (e.g. 3.16.0-0.bpo.4-amd64).
kubeProxyVersion	string	Deprecated: KubeProxy Version reported by the node.
kubeletVersion	string	Kubelet Version reported by the node.
machineID	string	MachineID reported by the node. For unique machine identification in the cluster this field is preferred. Learn more from man(5) machine-id: http://man7.org/linux/man-pages/man5/machine-id.5.html
operatingSystem	string	The Operating System reported by the node
osImage	string	OS Image reported by the node from /etc/os-release (e.g. Debian GNU/Linux 7 (wheezy)).
systemUUID	string	SystemUUID reported by the node. For unique machine identification MachineID is preferred. This field is specific to Red Hat hosts...
swap	V1NodeSwapStatus

V1PersistentVolume

• PersistentVolume (PV) is a storage resource provisioned by an administrator. It is analogous to a node. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes

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	V1PersistentVolumeSpec
status	V1PersistentVolumeStatus

Example

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

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

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

Used by: CoreV1Api.createPersistentVolume · CoreV1Api.readPersistentVolume · CoreV1Api.readPersistentVolumeStatus

V1PersistentVolumeClaim

• PersistentVolumeClaim is a user's request for and claim to a persistent volume

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	V1PersistentVolumeClaimSpec
status	V1PersistentVolumeClaimStatus

Example

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

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

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

Used by: CoreV1Api.createNamespacedPersistentVolumeClaim · CoreV1Api.readNamespacedPersistentVolumeClaim · CoreV1Api.readNamespacedPersistentVolumeClaimStatus

V1PersistentVolumeClaimCondition

• PersistentVolumeClaimCondition contains details about state of pvc

Source

Property	Type	Description
lastProbeTime	Date	lastProbeTime is the time we probed the condition.
lastTransitionTime	Date	lastTransitionTime is the time the condition transitioned from one status to another.
message	string	message is the human-readable message indicating details about last transition.
reason	string	reason is a unique, this should be a short, machine understandable string that gives the reason for condition's last transition. If it reports "Resizing" that means the underlying persistent...
status	string	Status is the status of the condition. Can be True, False, Unknown. More info:...
type	string	Type is the type of the condition. More info:...

V1PersistentVolumeClaimList

• PersistentVolumeClaimList is a list of PersistentVolumeClaim items.

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	V1PersistentVolumeClaim[]	items is a list of persistent volume claims. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims
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.CoreV1Api);

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

Used by: CoreV1Api.listNamespacedPersistentVolumeClaim · CoreV1Api.listPersistentVolumeClaimForAllNamespaces

V1PersistentVolumeClaimSpec

• PersistentVolumeClaimSpec describes the common attributes of storage devices and allows a Source for provider-specific attributes

Source

Property	Type	Description
accessModes	string[]	accessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1
storageClassName	string	storageClassName is the name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1
volumeAttributesClassName	string	volumeAttributesClassName may be used to set the VolumeAttributesClass used by this claim. If specified, the CSI driver will create or update the volume with the attributes defined in the...
volumeMode	string	volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec.
volumeName	string	volumeName is the binding reference to the PersistentVolume backing this claim.
dataSource	V1TypedLocalObjectReference
dataSourceRef	V1TypedObjectReference
resources	V1VolumeResourceRequirements
selector	V1LabelSelector

V1PersistentVolumeClaimStatus

• PersistentVolumeClaimStatus is the current status of a persistent volume claim.

Source

Property	Type	Description
accessModes	string[]	accessModes contains the actual access modes the volume backing the PVC has. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1
allocatedResourceStatuses	{ [key: string]: string	allocatedResourceStatuses stores status of resource being resized for the given PVC. Key names follow standard Kubernetes label syntax. Valid values are either: * Un-prefixed keys: - storage - the...
allocatedResources	{ [key: string]: string	allocatedResources tracks the resources allocated to a PVC including its capacity. Key names follow standard Kubernetes label syntax. Valid values are either: * Un-prefixed keys: - storage - the...
capacity	{ [key: string]: string	capacity represents the actual resources of the underlying volume.
conditions	V1PersistentVolumeClaimCondition[]	conditions is the current Condition of persistent volume claim. If underlying persistent volume is being resized then the Condition will be set to 'Resizing'.
currentVolumeAttributesClassName	string	currentVolumeAttributesClassName is the current name of the VolumeAttributesClass the PVC is using. When unset, there is no VolumeAttributeClass applied to this PersistentVolumeClaim
phase	string	phase represents the current phase of PersistentVolumeClaim.
modifyVolumeStatus	V1ModifyVolumeStatus

V1PersistentVolumeClaimTemplate

• PersistentVolumeClaimTemplate is used to produce PersistentVolumeClaim objects as part of an EphemeralVolumeSource.

Source

Property	Type	Description
metadata	V1ObjectMeta
spec	V1PersistentVolumeClaimSpec

V1PersistentVolumeClaimVolumeSource

• PersistentVolumeClaimVolumeSource references the user's PVC in the same namespace. This volume finds the bound PV and mounts that volume for the pod. A PersistentVolumeClaimVolumeSource is, essentially, a wrapper around another type of volume that is owned by someone else (the system).

Source

Property	Type	Description
claimName	string	claimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims
readOnly	boolean	readOnly Will force the ReadOnly setting in VolumeMounts. Default false.

V1PersistentVolumeList

• PersistentVolumeList is a list of PersistentVolume items.

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	V1PersistentVolume[]	items is a list of persistent volumes. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes
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.CoreV1Api);

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

Used by: CoreV1Api.listPersistentVolume

V1PersistentVolumeSpec

• PersistentVolumeSpec is the specification of a persistent volume.

Source

Property	Type	Description
accessModes	string[]	accessModes contains all ways the volume can be mounted. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes
capacity	{ [key: string]: string	capacity is the description of the persistent volume's resources and capacity. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#capacity
mountOptions	string[]	mountOptions is the list of mount options, e.g. ["ro", "soft"]. Not validated - mount will simply fail if one is invalid. More info:...
persistentVolumeReclaimPolicy	string	persistentVolumeReclaimPolicy defines what happens to a persistent volume when released from its claim. Valid options are Retain (default for manually created PersistentVolumes), Delete (default for...
storageClassName	string	storageClassName is the name of StorageClass to which this persistent volume belongs. Empty value means that this volume does not belong to any StorageClass.
volumeAttributesClassName	string	Name of VolumeAttributesClass to which this persistent volume belongs. Empty value is not allowed. When this field is not set, it indicates that this volume does not belong to any...
volumeMode	string	volumeMode defines if a volume is intended to be used with a formatted filesystem or to remain in raw block state. Value of Filesystem is implied when not included in spec.
awsElasticBlockStore	V1AWSElasticBlockStoreVolumeSource
azureDisk	V1AzureDiskVolumeSource
azureFile	V1AzureFilePersistentVolumeSource
cephfs	V1CephFSPersistentVolumeSource
cinder	V1CinderPersistentVolumeSource
claimRef	V1ObjectReference
csi	V1CSIPersistentVolumeSource
fc	V1FCVolumeSource
flexVolume	V1FlexPersistentVolumeSource
flocker	V1FlockerVolumeSource
gcePersistentDisk	V1GCEPersistentDiskVolumeSource
glusterfs	V1GlusterfsPersistentVolumeSource
hostPath	V1HostPathVolumeSource
iscsi	V1ISCSIPersistentVolumeSource
local	V1LocalVolumeSource
nfs	V1NFSVolumeSource
nodeAffinity	V1VolumeNodeAffinity
photonPersistentDisk	V1PhotonPersistentDiskVolumeSource
portworxVolume	V1PortworxVolumeSource
quobyte	V1QuobyteVolumeSource
rbd	V1RBDPersistentVolumeSource
scaleIO	V1ScaleIOPersistentVolumeSource
storageos	V1StorageOSPersistentVolumeSource
vsphereVolume	V1VsphereVirtualDiskVolumeSource

V1PersistentVolumeStatus

• PersistentVolumeStatus is the current status of a persistent volume.

Source

Property	Type	Description
lastPhaseTransitionTime	Date	lastPhaseTransitionTime is the time the phase transitioned from one to another and automatically resets to current time everytime a volume phase transitions.
message	string	message is a human-readable message indicating details about why the volume is in this state.
phase	string	phase indicates if a volume is available, bound to a claim, or released by a claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#phase
reason	string	reason is a brief CamelCase string that describes any failure and is meant for machine parsing and tidy display in the CLI.

V1Pod

• Pod is a collection of containers that can run on a host. This resource is created by clients and scheduled onto hosts.

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	V1PodSpec
status	V1PodStatus

Example

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

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

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

Used by: CoreV1Api.createNamespacedPod · CoreV1Api.readNamespacedPod · CoreV1Api.readNamespacedPodEphemeralcontainers

V1PodAffinity

• Pod affinity is a group of inter pod affinity scheduling rules.

Source

Property	Type	Description
preferredDuringSchedulingIgnoredDuringExecution	V1WeightedPodAffinityTerm[]	The scheduler will prefer to schedule pods to nodes that satisfy the affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node that...
requiredDuringSchedulingIgnoredDuringExecution	V1PodAffinityTerm[]	If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met...

V1PodAffinityTerm

• Defines a set of pods (namely those matching the labelSelector relative to the given namespace(s)) that this pod should be co-located (affinity) or not co-located (anti-affinity) with, where co-located is defined as running on a node whose value of the label with key matches that of any node on which a pod of the set of pods is running

Source

Property	Type	Description
matchLabelKeys	string[]	MatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged...
mismatchLabelKeys	string[]	MismatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the incoming pod labels, those key-value labels are merged...
namespaces	string[]	namespaces specifies a static list of namespace names that the term applies to. The term is applied to the union of the namespaces listed in this field and the ones selected by namespaceSelector....
topologyKey	string	This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose...
labelSelector	V1LabelSelector
namespaceSelector	V1LabelSelector

V1PodAntiAffinity

• Pod anti affinity is a group of inter pod anti affinity scheduling rules.

Source

Property	Type	Description
preferredDuringSchedulingIgnoredDuringExecution	V1WeightedPodAffinityTerm[]	The scheduler will prefer to schedule pods to nodes that satisfy the anti-affinity expressions specified by this field, but it may choose a node that violates one or more of the expressions. The node...
requiredDuringSchedulingIgnoredDuringExecution	V1PodAffinityTerm[]	If the anti-affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the anti-affinity requirements specified by this field cease...

V1PodCertificateProjection

• PodCertificateProjection provides a private key and X.509 certificate in the pod filesystem.

Source

Property	Type	Description
certificateChainPath	string	Write the certificate chain at this path in the projected volume. Most applications should use credentialBundlePath. When using keyPath and certificateChainPath, your application needs to check...
credentialBundlePath	string	Write the credential bundle at this path in the projected volume. The credential bundle is a single file that contains multiple PEM blocks. The first PEM block is a PRIVATE KEY block, containing a...
keyPath	string	Write the key at this path in the projected volume. Most applications should use credentialBundlePath. When using keyPath and certificateChainPath, your application needs to check that the key and...
keyType	string	The type of keypair Kubelet will generate for the pod. Valid values are "RSA3072", "RSA4096", "ECDSAP256", "ECDSAP384", "ECDSAP521", and "ED25519".
maxExpirationSeconds	number	maxExpirationSeconds is the maximum lifetime permitted for the certificate. Kubelet copies this value verbatim into the PodCertificateRequests it generates for this projection. If omitted,...
signerName	string	Kubelet's generated CSRs will be addressed to this signer.
userAnnotations	{ [key: string]: string	userAnnotations allow pod authors to pass additional information to the signer implementation. Kubernetes does not restrict or validate this metadata in any way. These values are copied verbatim...

V1PodCondition

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

Source

Property	Type	Description
lastProbeTime	Date	Last time we probed the condition.
lastTransitionTime	Date	Last time the condition transitioned from one status to another.
message	string	Human-readable message indicating details about last transition.
observedGeneration	number	If set, this represents the .metadata.generation that the pod condition was set based upon. The PodObservedGenerationTracking feature gate must be enabled to use this field.
reason	string	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. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-conditions
type	string	Type is the type of the condition. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-conditions

V1PodDNSConfig

• PodDNSConfig defines the DNS parameters of a pod in addition to those generated from DNSPolicy.

Source

Property	Type	Description
nameservers	string[]	A list of DNS name server IP addresses. This will be appended to the base nameservers generated from DNSPolicy. Duplicated nameservers will be removed.
options	V1PodDNSConfigOption[]	A list of DNS resolver options. This will be merged with the base options generated from DNSPolicy. Duplicated entries will be removed. Resolution options given in Options will override those that...
searches	string[]	A list of DNS search domains for host-name lookup. This will be appended to the base search paths generated from DNSPolicy. Duplicated search paths will be removed.

V1PodDNSConfigOption

• PodDNSConfigOption defines DNS resolver options of a pod.

Source

Property	Type	Description
name	string	Name is this DNS resolver option's name. Required.
value	string	Value is this DNS resolver option's value.

V1PodDisruptionBudget

• PodDisruptionBudget is an object to define the max disruption that can be caused to a collection of pods

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	V1PodDisruptionBudgetSpec
status	V1PodDisruptionBudgetStatus

Example

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

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

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

Used by: PolicyV1Api.createNamespacedPodDisruptionBudget · PolicyV1Api.readNamespacedPodDisruptionBudget · PolicyV1Api.readNamespacedPodDisruptionBudgetStatus

V1PodDisruptionBudgetList

• PodDisruptionBudgetList is a collection of PodDisruptionBudgets.

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	V1PodDisruptionBudget[]	Items is a list of PodDisruptionBudgets
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.PolicyV1Api);

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

Used by: PolicyV1Api.listNamespacedPodDisruptionBudget · PolicyV1Api.listPodDisruptionBudgetForAllNamespaces

V1PodDisruptionBudgetSpec

• PodDisruptionBudgetSpec is a description of a PodDisruptionBudget.

Source

Property	Type	Description
maxUnavailable	IntOrString	IntOrString is a type that can hold an int32 or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This allows you to have, for example, a...
minAvailable	IntOrString	IntOrString is a type that can hold an int32 or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This allows you to have, for example, a...
unhealthyPodEvictionPolicy	string	UnhealthyPodEvictionPolicy defines the criteria for when unhealthy pods should be considered for eviction. Current implementation considers healthy pods, as pods that have status.conditions item with...
selector	V1LabelSelector

V1PodDisruptionBudgetStatus

• PodDisruptionBudgetStatus represents information about the status of a PodDisruptionBudget. Status may trail the actual state of a system.

Source

Property	Type	Description
conditions	V1Condition[]	Conditions contain conditions for PDB. The disruption controller sets the DisruptionAllowed condition. The following are known values for the reason field (additional reasons could be added in the...
currentHealthy	number	current number of healthy pods
desiredHealthy	number	minimum desired number of healthy pods
disruptedPods	{ [key: string]: Date	DisruptedPods contains information about pods whose eviction was processed by the API server eviction subresource handler but has not yet been observed by the PodDisruptionBudget controller. A pod...
disruptionsAllowed	number	Number of pod disruptions that are currently allowed.
expectedPods	number	total number of pods counted by this disruption budget
observedGeneration	number	Most recent generation observed when updating this PDB status. DisruptionsAllowed and other status information is valid only if observedGeneration equals to PDB's object generation.

V1PodExtendedResourceClaimStatus

• PodExtendedResourceClaimStatus is stored in the PodStatus for the extended resource requests backed by DRA. It stores the generated name for the corresponding special ResourceClaim created by the scheduler.

Source

Property	Type	Description
requestMappings	V1ContainerExtendedResourceRequest[]	RequestMappings identifies the mapping of <container, extended resource backed by DRA> to device request in the generated ResourceClaim.
resourceClaimName	string	ResourceClaimName is the name of the ResourceClaim that was generated for the Pod in the namespace of the Pod.

V1PodFailurePolicy

• PodFailurePolicy describes how failed pods influence the backoffLimit.

Source

Property	Type	Description
rules	V1PodFailurePolicyRule[]	A list of pod failure policy rules. The rules are evaluated in order. Once a rule matches a Pod failure, the remaining of the rules are ignored. When no rule matches the Pod failure, the default...

V1PodFailurePolicyOnExitCodesRequirement

• PodFailurePolicyOnExitCodesRequirement describes the requirement for handling a failed pod based on its container exit codes. In particular, it lookups the .state.terminated.exitCode for each app container and init container status, represented by the .status.containerStatuses and .status.initContainerStatuses fields in the Pod status, respectively. Containers completed with success (exit code 0) are excluded from the requirement check.

Source

Property	Type	Description
containerName	string	Restricts the check for exit codes to the container with the specified name. When null, the rule applies to all containers. When specified, it should match one the container or initContainer names in...
operator	string	Represents the relationship between the container exit code(s) and the specified values. Containers completed with success (exit code 0) are excluded from the requirement check. Possible values are: ...
values	number[]	Specifies the set of values. Each returned container exit code (might be multiple in case of multiple containers) is checked against this set of values with respect to the operator. The list of...

V1PodFailurePolicyOnPodConditionsPattern

• PodFailurePolicyOnPodConditionsPattern describes a pattern for matching an actual pod condition type.

Source

Property	Type	Description
status	string	Specifies the required Pod condition status. To match a pod condition it is required that the specified status equals the pod condition status. Defaults to True.
type	string	Specifies the required Pod condition type. To match a pod condition it is required that specified type equals the pod condition type.

V1PodFailurePolicyRule

• PodFailurePolicyRule describes how a pod failure is handled when the requirements are met. One of onExitCodes and onPodConditions, but not both, can be used in each rule.

Source

Property	Type	Description
action	string	Specifies the action taken on a pod failure when the requirements are satisfied. Possible values are: - FailJob: indicates that the pod's job is marked as Failed and all running pods are...
onPodConditions	V1PodFailurePolicyOnPodConditionsPattern[]	Represents the requirement on the pod conditions. The requirement is represented as a list of pod condition patterns. The requirement is satisfied if at least one pattern matches an actual pod...
onExitCodes	V1PodFailurePolicyOnExitCodesRequirement

V1PodIP

• PodIP represents a single IP address allocated to the pod.

Source

Property	Type	Description
ip	string	IP is the IP address assigned to the pod

V1PodList

• PodList is a list of Pods.

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	V1Pod[]	List of pods. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md
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.CoreV1Api);

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

Used by: CoreV1Api.listNamespacedPod · CoreV1Api.listPodForAllNamespaces

V1PodOS

• PodOS defines the OS parameters of a pod.

Source

Property	Type	Description
name	string	Name is the name of the operating system. The currently supported values are linux and windows. Additional value may be defined in future and can be one of:...

V1PodReadinessGate

• PodReadinessGate contains the reference to a pod condition

Source

Property	Type	Description
conditionType	string	ConditionType refers to a condition in the pod's condition list with matching type.

V1PodResourceClaim

• PodResourceClaim references exactly one ResourceClaim, either directly or by naming a ResourceClaimTemplate which is then turned into a ResourceClaim for the pod. It adds a name to it that uniquely identifies the ResourceClaim inside the Pod. Containers that need access to the ResourceClaim reference it with this name.

Source

Property	Type	Description
name	string	Name uniquely identifies this resource claim inside the pod. This must be a DNS_LABEL.
resourceClaimName	string	ResourceClaimName is the name of a ResourceClaim object in the same namespace as this pod. Exactly one of ResourceClaimName and ResourceClaimTemplateName must be set.
resourceClaimTemplateName	string	ResourceClaimTemplateName is the name of a ResourceClaimTemplate object in the same namespace as this pod. The template will be used to create a new ResourceClaim, which will be bound to this pod....

V1PodResourceClaimStatus

• PodResourceClaimStatus is stored in the PodStatus for each PodResourceClaim which references a ResourceClaimTemplate. It stores the generated name for the corresponding ResourceClaim.

Source

Property	Type	Description
name	string	Name uniquely identifies this resource claim inside the pod. This must match the name of an entry in pod.spec.resourceClaims, which implies that the string must be a DNS_LABEL.
resourceClaimName	string	ResourceClaimName is the name of the ResourceClaim that was generated for the Pod in the namespace of the Pod. If this is unset, then generating a ResourceClaim was not necessary. The...

V1PodSchedulingGate

• PodSchedulingGate is associated to a Pod to guard its scheduling.

Source

Property	Type	Description
name	string	Name of the scheduling gate. Each scheduling gate must have a unique name field.

V1PodSecurityContext

• PodSecurityContext holds pod-level security attributes and common container settings. Some fields are also present in container.securityContext. Field values of container.securityContext take precedence over field values of PodSecurityContext.

Source

Property	Type	Description
fsGroup	number	A special supplemental group that applies to all containers in a pod. Some volume types allow the Kubelet to change the ownership of that volume to be owned by the pod: 1. The owning GID will be the...
fsGroupChangePolicy	string	fsGroupChangePolicy defines behavior of changing ownership and permission of the volume before being exposed inside Pod. This field will only apply to volume types which support fsGroup based...
runAsGroup	number	The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, the value specified...
runAsNonRoot	boolean	Indicates that the container must run as a non-root user. If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it...
runAsUser	number	The UID to run the entrypoint of the container process. Defaults to user specified in image metadata if unspecified. May also be set in SecurityContext. If set in both SecurityContext and...
seLinuxChangePolicy	string	seLinuxChangePolicy defines how the container's SELinux label is applied to all volumes used by the Pod. It has no effect on nodes that do not support SELinux or to volumes does not support SELinux....
supplementalGroups	number[]	A list of groups applied to the first process run in each container, in addition to the container's primary GID and fsGroup (if specified). If the SupplementalGroupsPolicy feature is enabled, the...
supplementalGroupsPolicy	string	Defines how supplemental groups of the first container processes are calculated. Valid values are "Merge" and "Strict". If not specified, "Merge" is used. (Alpha) Using the field requires the...
sysctls	V1Sysctl[]	Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported sysctls (by the container runtime) might fail to launch. Note that this field cannot be set when spec.os.name is...
appArmorProfile	V1AppArmorProfile
seLinuxOptions	V1SELinuxOptions
seccompProfile	V1SeccompProfile
windowsOptions	V1WindowsSecurityContextOptions

V1PodSpec

• PodSpec is a description of a pod.

Source

Property	Type	Description
activeDeadlineSeconds	number	Optional duration in seconds the pod may be active on the node relative to StartTime before the system will actively try to mark it failed and kill associated containers. Value must be a positive...
automountServiceAccountToken	boolean	AutomountServiceAccountToken indicates whether a service account token should be automatically mounted.
containers	V1Container[]	List of containers belonging to the pod. Containers cannot currently be added or removed. There must be at least one container in a Pod. Cannot be updated.
dnsPolicy	string	Set DNS policy for the pod. Defaults to "ClusterFirst". Valid values are 'ClusterFirstWithHostNet', 'ClusterFirst', 'Default' or 'None'. DNS parameters given in DNSConfig will be merged...
enableServiceLinks	boolean	EnableServiceLinks indicates whether information about services should be injected into pod's environment variables, matching the syntax of Docker links. Optional: Defaults to true.
ephemeralContainers	V1EphemeralContainer[]	List of ephemeral containers run in this pod. Ephemeral containers may be run in an existing pod to perform user-initiated actions such as debugging. This list cannot be specified when creating a...
hostAliases	V1HostAlias[]	HostAliases is an optional list of hosts and IPs that will be injected into the pod's hosts file if specified.
hostIPC	boolean	Use the host's ipc namespace. Optional: Default to false.
hostNetwork	boolean	Host networking requested for this pod. Use the host's network namespace. When using HostNetwork you should specify ports so the scheduler is aware. When hostNetwork is true, specified hostPort...
hostPID	boolean	Use the host's pid namespace. Optional: Default to false.
hostUsers	boolean	Use the host's user namespace. Optional: Default to true. If set to true or not present, the pod will be run in the host user namespace, useful for when the pod needs a feature only available to the...
hostname	string	Specifies the hostname of the Pod If not specified, the pod's hostname will be set to a system-defined value.
hostnameOverride	string	HostnameOverride specifies an explicit override for the pod's hostname as perceived by the pod. This field only specifies the pod's hostname and does not affect its DNS records. When this field is...
imagePullSecrets	V1LocalObjectReference[]	ImagePullSecrets is an optional list of references to secrets in the same namespace to use for pulling any of the images used by this PodSpec. If specified, these secrets will be passed to individual...
initContainers	V1Container[]	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...
nodeName	string	NodeName indicates in which node this pod is scheduled. If empty, this pod is a candidate for scheduling by the scheduler defined in schedulerName. Once this field is set, the kubelet for this node...
nodeSelector	{ [key: string]: string	NodeSelector is a selector which must be true for the pod to fit on a node. Selector which must match a node's labels for the pod to be scheduled on that node. More info:...
overhead	{ [key: string]: string	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...
preemptionPolicy	string	PreemptionPolicy is the Policy for preempting pods with lower priority. One of Never, PreemptLowerPriority. Defaults to PreemptLowerPriority if unset.
priority	number	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...
priorityClassName	string	If specified, indicates the pod's priority. "system-node-critical" and "system-cluster-critical" are two special keywords which indicate the highest priorities with the former being the highest...
readinessGates	V1PodReadinessGate[]	If specified, all readiness gates will be evaluated for pod readiness. A pod is ready when all its containers are ready AND all conditions specified in the readiness gates have status equal to...
resourceClaims	V1PodResourceClaim[]	ResourceClaims defines which ResourceClaims must be allocated and reserved before the Pod is allowed to start. The resources will be made available to those containers which consume them by name. ...
restartPolicy	string	Restart policy for all containers within the pod. One of Always, OnFailure, Never. In some contexts, only a subset of those values may be permitted. Default to Always. More info:...
runtimeClassName	string	RuntimeClassName refers to a RuntimeClass object in the node.k8s.io group, which should be used to run this pod. If no RuntimeClass resource matches the named class, the pod will not be run. If...
schedulerName	string	If specified, the pod will be dispatched by specified scheduler. If not specified, the pod will be dispatched by default scheduler.
schedulingGates	V1PodSchedulingGate[]	SchedulingGates is an opaque list of values that if specified will block scheduling the pod. If schedulingGates is not empty, the pod will stay in the SchedulingGated state and the scheduler will not...
serviceAccount	string	DeprecatedServiceAccount is a deprecated alias for ServiceAccountName. Deprecated: Use serviceAccountName instead.
serviceAccountName	string	ServiceAccountName is the name of the ServiceAccount to use to run this pod. More info: https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/
setHostnameAsFQDN	boolean	If true the pod's hostname will be configured as the pod's FQDN, rather than the leaf name (the default). In Linux containers, this means setting the FQDN in the hostname field of the kernel (the...
shareProcessNamespace	boolean	Share a single process namespace between all of the containers in a pod. When this is set containers will be able to view and signal processes from other containers in the same pod, and the first...
subdomain	string	If specified, the fully qualified Pod hostname will be "...svc.". If not specified, the pod will not have a domainname at all.
terminationGracePeriodSeconds	number	Optional duration in seconds the pod needs to terminate gracefully. May be decreased in delete request. Value must be non-negative integer. The value zero indicates stop immediately via the kill...
tolerations	V1Toleration[]	If specified, the pod's tolerations.
topologySpreadConstraints	V1TopologySpreadConstraint[]	TopologySpreadConstraints describes how a group of pods ought to spread across topology domains. Scheduler will schedule pods in a way which abides by the constraints. All topologySpreadConstraints...
volumes	V1Volume[]	List of volumes that can be mounted by containers belonging to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes
affinity	V1Affinity
dnsConfig	V1PodDNSConfig
os	V1PodOS
resources	V1ResourceRequirements
securityContext	V1PodSecurityContext
workloadRef	V1WorkloadReference

V1PodStatus

• PodStatus represents information about the status of a pod. Status may trail the actual state of a system, especially if the node that hosts the pod cannot contact the control plane.

Source

Property	Type	Description
allocatedResources	{ [key: string]: string	AllocatedResources is the total requests allocated for this pod by the node. If pod-level requests are not set, this will be the total requests aggregated across containers in the pod.
conditions	V1PodCondition[]	Current service state of pod. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-conditions
containerStatuses	V1ContainerStatus[]	Statuses of containers in this pod. Each container in the pod should have at most one status in this list, and all statuses should be for containers in the pod. However this is not enforced. If a...
ephemeralContainerStatuses	V1ContainerStatus[]	Statuses for any ephemeral containers that have run in this pod. Each ephemeral container in the pod should have at most one status in this list, and all statuses should be for containers in the pod....
hostIP	string	hostIP holds the IP address of the host to which the pod is assigned. Empty if the pod has not started yet. A pod can be assigned to a node that has a problem in kubelet which in turns mean that...
hostIPs	V1HostIP[]	hostIPs holds the IP addresses allocated to the host. If this field is specified, the first entry must match the hostIP field. This list is empty if the pod has not started yet. A pod can be assigned...
initContainerStatuses	V1ContainerStatus[]	Statuses of init containers in this pod. The most recent successful non-restartable init container will have ready = true, the most recently started container will have startTime set. Each init...
message	string	A human readable message indicating details about why the pod is in this condition.
nominatedNodeName	string	nominatedNodeName is set only when this pod preempts other pods on the node, but it cannot be scheduled right away as preemption victims receive their graceful termination periods. This field does...
observedGeneration	number	If set, this represents the .metadata.generation that the pod status was set based upon. The PodObservedGenerationTracking feature gate must be enabled to use this field.
phase	string	The phase of a Pod is a simple, high-level summary of where the Pod is in its lifecycle. The conditions array, the reason and message fields, and the individual container status arrays contain more...
podIP	string	podIP address allocated to the pod. Routable at least within the cluster. Empty if not yet allocated.
podIPs	V1PodIP[]	podIPs holds the IP addresses allocated to the pod. If this field is specified, the 0th entry must match the podIP field. Pods may be allocated at most 1 value for each of IPv4 and IPv6. This list is...
qosClass	string	The Quality of Service (QOS) classification assigned to the pod based on resource requirements See PodQOSClass type for available QOS classes More info:...
reason	string	A brief CamelCase message indicating details about why the pod is in this state. e.g. 'Evicted'
resize	string	Status of resources resize desired for pod's containers. It is empty if no resources resize is pending. Any changes to container resources will automatically set this to "Proposed" Deprecated:...
resourceClaimStatuses	V1PodResourceClaimStatus[]	Status of resource claims.
startTime	Date	RFC 3339 date and time at which the object was acknowledged by the Kubelet. This is before the Kubelet pulled the container image(s) for the pod.
extendedResourceClaimStatus	V1PodExtendedResourceClaimStatus
resources	V1ResourceRequirements

V1PodTemplate

• PodTemplate describes a template for creating copies of a predefined pod.

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
template	V1PodTemplateSpec

Example

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

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

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

Used by: CoreV1Api.createNamespacedPodTemplate · CoreV1Api.patchNamespacedPodTemplate · CoreV1Api.readNamespacedPodTemplate

V1PodTemplateList

• PodTemplateList is a list of PodTemplates.

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	V1PodTemplate[]	List of pod templates
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.CoreV1Api);

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

Used by: CoreV1Api.listNamespacedPodTemplate · CoreV1Api.listPodTemplateForAllNamespaces

V1PodTemplateSpec

• PodTemplateSpec describes the data a pod should have when created from a template

Source

Property	Type	Description
metadata	V1ObjectMeta
spec	V1PodSpec

V1ReplicationController

• ReplicationController represents the configuration of a replication controller.

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	V1ReplicationControllerSpec
status	V1ReplicationControllerStatus

Example

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

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

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

Used by: CoreV1Api.createNamespacedReplicationController · CoreV1Api.readNamespacedReplicationController · CoreV1Api.readNamespacedReplicationControllerStatus

V1ReplicationControllerCondition

• ReplicationControllerCondition describes the state of a replication controller 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 replication controller condition.

V1ReplicationControllerList

• ReplicationControllerList is a collection of replication controllers.

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	V1ReplicationController[]	List of replication controllers. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller
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.CoreV1Api);

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

Used by: CoreV1Api.listNamespacedReplicationController · CoreV1Api.listReplicationControllerForAllNamespaces

V1ReplicationControllerSpec

• ReplicationControllerSpec is the specification of a replication controller.

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 replicas. This is a pointer to distinguish between explicit zero and unspecified. Defaults to 1. More info:...
selector	{ [key: string]: string	Selector is a label query over pods that should match the Replicas count. If Selector is empty, it is defaulted to the labels present on the Pod template. Label keys and values that must match in...
template	V1PodTemplateSpec

V1ReplicationControllerStatus

• ReplicationControllerStatus represents the current status of a replication controller.

Source

Property	Type	Description
availableReplicas	number	The number of available replicas (ready for at least minReadySeconds) for this replication controller.
conditions	V1ReplicationControllerCondition[]	Represents the latest available observations of a replication controller's current state.
fullyLabeledReplicas	number	The number of pods that have labels matching the labels of the pod template of the replication controller.
observedGeneration	number	ObservedGeneration reflects the generation of the most recently observed replication controller.
readyReplicas	number	The number of ready replicas for this replication controller.
replicas	number	Replicas is the most recently observed number of replicas. More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller#what-is-a-replicationcontroller

V1ResourceQuota

• ResourceQuota sets aggregate quota restrictions enforced per namespace

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	V1ResourceQuotaSpec
status	V1ResourceQuotaStatus

Example

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

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

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

Used by: CoreV1Api.createNamespacedResourceQuota · CoreV1Api.readNamespacedResourceQuota · CoreV1Api.readNamespacedResourceQuotaStatus

V1ResourceQuotaList

• ResourceQuotaList is a list of ResourceQuota items.

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	V1ResourceQuota[]	Items is a list of ResourceQuota objects. More info: https://kubernetes.io/docs/concepts/policy/resource-quotas/
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.CoreV1Api);

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

Used by: CoreV1Api.listNamespacedResourceQuota · CoreV1Api.listResourceQuotaForAllNamespaces

V1ResourceQuotaSpec

• ResourceQuotaSpec defines the desired hard limits to enforce for Quota.

Source

Property	Type	Description
hard	{ [key: string]: string	hard is the set of desired hard limits for each named resource. More info: https://kubernetes.io/docs/concepts/policy/resource-quotas/
scopes	string[]	A collection of filters that must match each object tracked by a quota. If not specified, the quota matches all objects.
scopeSelector	V1ScopeSelector

V1ResourceQuotaStatus

• ResourceQuotaStatus defines the enforced hard limits and observed use.

Source

Property	Type	Description
hard	{ [key: string]: string	Hard is the set of enforced hard limits for each named resource. More info: https://kubernetes.io/docs/concepts/policy/resource-quotas/
used	{ [key: string]: string	Used is the current observed total usage of the resource in the namespace.

V1Secret

• Secret holds secret data of a certain type. The total bytes of the values in the Data field must be less than MaxSecretSize bytes.

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:...
data	{ [key: string]: string	Data contains the secret data. Each key must consist of alphanumeric characters, '-', '_' or '.'. The serialized form of the secret data is a base64 encoded string, representing the arbitrary...
immutable	boolean	Immutable, if set to true, ensures that data stored in the Secret cannot be updated (only object metadata can be modified). If not set to true, the field can be modified at any time. Defaulted to nil.
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:...
stringData	{ [key: string]: string	stringData allows specifying non-binary secret data in string form. It is provided as a write-only input field for convenience. All keys and values are merged into the data field on write,...
type	string	Used to facilitate programmatic handling of secret data. More info: https://kubernetes.io/docs/concepts/configuration/secret/#secret-types
metadata	V1ObjectMeta

Example

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

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

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

Used by: CoreV1Api.createNamespacedSecret · CoreV1Api.patchNamespacedSecret · CoreV1Api.readNamespacedSecret

V1SecretEnvSource

• SecretEnvSource selects a Secret to populate the environment variables with. The contents of the target Secret's Data field will represent the key-value pairs as environment variables.

Source

Property	Type	Description
name	string	Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More...
optional	boolean	Specify whether the Secret must be defined

V1SecretKeySelector

• SecretKeySelector selects a key of a Secret.

Source

Property	Type	Description
key	string	The key of the secret to select from. Must be a valid secret key.
name	string	Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More...
optional	boolean	Specify whether the Secret or its key must be defined

V1SecretList

• SecretList is a list of Secret.

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	V1Secret[]	Items is a list of secret objects. More info: https://kubernetes.io/docs/concepts/configuration/secret
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.CoreV1Api);

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

Used by: CoreV1Api.listNamespacedSecret · CoreV1Api.listSecretForAllNamespaces

V1SecretProjection

• Adapts a secret into a projected volume. The contents of the target Secret's Data field will be presented in a projected volume as files using the keys in the Data field as the file names. Note that this is identical to a secret volume source without the default mode.

Source

Property	Type	Description
items	V1KeyToPath[]	items if unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the...
name	string	Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More...
optional	boolean	optional field specify whether the Secret or its key must be defined

V1SecretReference

• SecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace

Source

Property	Type	Description
name	string	name is unique within a namespace to reference a secret resource.
namespace	string	namespace defines the space within which the secret name must be unique.

V1SecretVolumeSource

• Adapts a Secret into a volume. The contents of the target Secret's Data field will be presented in a volume as files using the keys in the Data field as the file names. Secret volumes support ownership management and SELinux relabeling.

Source

Property	Type	Description
defaultMode	number	defaultMode is Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and...
items	V1KeyToPath[]	items If unspecified, each key-value pair in the Data field of the referenced Secret will be projected into the volume as a file whose name is the key and content is the value. If specified, the...
optional	boolean	optional field specify whether the Secret or its keys must be defined
secretName	string	secretName is the name of the secret in the pod's namespace to use. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret

V1Service

• Service is a named abstraction of software service (for example, mysql) consisting of local port (for example 3306) that the proxy listens on, and the selector that determines which pods will answer requests sent through the proxy.

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	V1ServiceSpec
status	V1ServiceStatus

Example

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

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

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

Used by: CoreV1Api.createNamespacedService · CoreV1Api.readNamespacedService · CoreV1Api.readNamespacedServiceStatus

V1ServiceAccount

• ServiceAccount binds together: * a name, understood by users, and perhaps by peripheral systems, for an identity * a principal that can be authenticated and authorized * a set of secrets

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:...
automountServiceAccountToken	boolean	AutomountServiceAccountToken indicates whether pods running as this service account should have an API token automatically mounted. Can be overridden at the pod level.
imagePullSecrets	V1LocalObjectReference[]	ImagePullSecrets is a list of references to secrets in the same namespace to use for pulling any images in pods that reference this ServiceAccount. ImagePullSecrets are distinct from Secrets because...
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:...
secrets	V1ObjectReference[]	Secrets is a list of the secrets in the same namespace that pods running using this ServiceAccount are allowed to use. Pods are only limited to this list if this service account has a...
metadata	V1ObjectMeta

Example

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

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

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

Used by: CoreV1Api.createNamespacedServiceAccount · CoreV1Api.patchNamespacedServiceAccount · CoreV1Api.readNamespacedServiceAccount

V1ServiceAccountList

• ServiceAccountList is a list of ServiceAccount 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	V1ServiceAccount[]	List of ServiceAccounts. More info: https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/
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.CoreV1Api);

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

Used by: CoreV1Api.listNamespacedServiceAccount · CoreV1Api.listServiceAccountForAllNamespaces

V1ServiceAccountTokenProjection

• ServiceAccountTokenProjection represents a projected service account token volume. This projection can be used to insert a service account token into the pods runtime filesystem for use against APIs (Kubernetes API Server or otherwise).

Source

Property	Type	Description
audience	string	audience is the intended audience of the token. A recipient of a token must identify itself with an identifier specified in the audience of the token, and otherwise should reject the token. The...
expirationSeconds	number	expirationSeconds is the requested duration of validity of the service account token. As the token approaches expiration, the kubelet volume plugin will proactively rotate the service account token....
path	string	path is the path relative to the mount point of the file to project the token into.

V1ServiceBackendPort

• ServiceBackendPort is the service port being referenced.

Source

Property	Type	Description
name	string	name is the name of the port on the Service. This is a mutually exclusive setting with "Number".
number	number	number is the numerical port number (e.g. 80) on the Service. This is a mutually exclusive setting with "Name".

V1ServiceCIDR

• ServiceCIDR defines a range of IP addresses using CIDR format (e.g. 192.168.0.0/24 or 2001:db2::/64). This range is used to allocate ClusterIPs to Service 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:...
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	V1ServiceCIDRSpec
status	V1ServiceCIDRStatus

Example

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

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

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

Used by: NetworkingV1Api.createServiceCIDR · NetworkingV1Api.readServiceCIDR · NetworkingV1Api.readServiceCIDRStatus

V1ServiceCIDRList

• ServiceCIDRList contains a list of ServiceCIDR 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	V1ServiceCIDR[]	items is the list of ServiceCIDRs.
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.NetworkingV1Api);

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

Used by: NetworkingV1Api.listServiceCIDR

V1ServiceCIDRSpec

• ServiceCIDRSpec define the CIDRs the user wants to use for allocating ClusterIPs for Services.

Source

Property	Type	Description
cidrs	string[]	CIDRs defines the IP blocks in CIDR notation (e.g. "192.168.0.0/24" or "2001:db8::/64") from which to assign service cluster IPs. Max of two CIDRs is allowed, one of each IP family. This field is...

V1ServiceCIDRStatus

• ServiceCIDRStatus describes the current state of the ServiceCIDR.

Source

Property	Type	Description
conditions	V1Condition[]	conditions holds an array of metav1.Condition that describe the state of the ServiceCIDR. Current service state

V1ServiceList

• ServiceList holds a list of services.

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	V1Service[]	List of services
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.CoreV1Api);

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

Used by: CoreV1Api.listNamespacedService · CoreV1Api.listServiceForAllNamespaces

V1ServicePort

• ServicePort contains information on service's port.

Source

Property	Type	Description
appProtocol	string	The application protocol for this port. This is used as a hint for implementations to offer richer behavior for protocols that they understand. This field follows standard Kubernetes label syntax....
name	string	The name of this port within the service. This must be a DNS_LABEL. All ports within a ServiceSpec must have unique names. When considering the endpoints for a Service, this must match the 'name'...
nodePort	number	The port on each node on which this service is exposed when type is NodePort or LoadBalancer. Usually assigned by the system. If a value is specified, in-range, and not in use it will be used,...
port	number	The port that will be exposed by this service.
protocol	string	The IP protocol for this port. Supports "TCP", "UDP", and "SCTP". Default is TCP.
targetPort	IntOrString	IntOrString is a type that can hold an int32 or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This allows you to have, for example, a...

V1ServiceSpec

• ServiceSpec describes the attributes that a user creates on a service.

Source

Property	Type	Description
allocateLoadBalancerNodePorts	boolean	allocateLoadBalancerNodePorts defines if NodePorts will be automatically allocated for services with type LoadBalancer. Default is "true". It may be set to "false" if the cluster load-balancer...
clusterIP	string	clusterIP is the IP address of the service and is usually assigned randomly. If an address is specified manually, is in-range (as per system configuration), and is not in use, it will be allocated to...
clusterIPs	string[]	ClusterIPs is a list of IP addresses assigned to this service, and are usually assigned randomly. If an address is specified manually, is in-range (as per system configuration), and is not in use,...
externalIPs	string[]	externalIPs is a list of IP addresses for which nodes in the cluster will also accept traffic for this service. These IPs are not managed by Kubernetes. The user is responsible for ensuring that...
externalName	string	externalName is the external reference that discovery mechanisms will return as an alias for this service (e.g. a DNS CNAME record). No proxying will be involved. Must be a lowercase RFC-1123...
externalTrafficPolicy	string	externalTrafficPolicy describes how nodes distribute service traffic they receive on one of the Service's "externally-facing" addresses (NodePorts, ExternalIPs, and LoadBalancer IPs). If set to...
healthCheckNodePort	number	healthCheckNodePort specifies the healthcheck nodePort for the service. This only applies when type is set to LoadBalancer and externalTrafficPolicy is set to Local. If a value is specified, is...
internalTrafficPolicy	string	InternalTrafficPolicy describes how nodes distribute service traffic they receive on the ClusterIP. If set to "Local", the proxy will assume that pods only want to talk to endpoints of the service...
ipFamilies	string[]	IPFamilies is a list of IP families (e.g. IPv4, IPv6) assigned to this service. This field is usually assigned automatically based on cluster configuration and the ipFamilyPolicy field. If this field...
ipFamilyPolicy	string	IPFamilyPolicy represents the dual-stack-ness requested or required by this Service. If there is no value provided, then this field will be set to SingleStack. Services can be "SingleStack" (a...
loadBalancerClass	string	loadBalancerClass is the class of the load balancer implementation this Service belongs to. If specified, the value of this field must be a label-style identifier, with an optional prefix, e.g....
loadBalancerIP	string	Only applies to Service Type: LoadBalancer. This feature depends on whether the underlying cloud-provider supports specifying the loadBalancerIP when a load balancer is created. This field will be...
loadBalancerSourceRanges	string[]	If specified and supported by the platform, this will restrict traffic through the cloud-provider load-balancer will be restricted to the specified client IPs. This field will be ignored if the...
ports	V1ServicePort[]	The list of ports that are exposed by this service. More info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies
publishNotReadyAddresses	boolean	publishNotReadyAddresses indicates that any agent which deals with endpoints for this Service should disregard any indications of ready/not-ready. The primary use case for setting this field is for a...
selector	{ [key: string]: string	Route service traffic to pods with label keys and values matching this selector. If empty or not present, the service is assumed to have an external process managing its endpoints, which Kubernetes...
sessionAffinity	string	Supports "ClientIP" and "None". Used to maintain session affinity. Enable client IP based session affinity. Must be ClientIP or None. Defaults to None. More info:...
trafficDistribution	string	TrafficDistribution offers a way to express preferences for how traffic is distributed to Service endpoints. Implementations can use this field as a hint, but are not required to guarantee strict...
type	string	type determines how the Service is exposed. Defaults to ClusterIP. Valid options are ExternalName, ClusterIP, NodePort, and LoadBalancer. "ClusterIP" allocates a cluster-internal IP address for...
sessionAffinityConfig	V1SessionAffinityConfig

V1ServiceStatus

• ServiceStatus represents the current status of a service.

Source

Property	Type	Description
conditions	V1Condition[]	Current service state
loadBalancer	V1LoadBalancerStatus