Other Models

V1AWSElasticBlockStoreVolumeSource

Represents a Persistent Disk resource in AWS. An AWS EBS disk must exist before mounting to a container. The disk must also be in the same AWS zone as the kubelet. An AWS EBS disk can only be mounted as read/write once. AWS EBS volumes support ownership management and SELinux relabeling.

Property	Type	Description
`fsType`	`string`	fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly...
`partition`	`number`	partition is the partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the...
`readOnly`	`boolean`	readOnly value true will force the readOnly setting in VolumeMounts. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
`volumeID`	`string`	volumeID is unique ID of the persistent disk resource in AWS (Amazon EBS volume). More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore

V1Affinity

Affinity is a group of affinity scheduling rules.

Source

Property	Type	Description
`nodeAffinity`	V1NodeAffinity
`podAffinity`	V1PodAffinity
`podAntiAffinity`	V1PodAntiAffinity

V1AggregationRule

AggregationRule describes how to locate ClusterRoles to aggregate into the ClusterRole

Source

Property	Type	Description
`clusterRoleSelectors`	V1LabelSelector[]	ClusterRoleSelectors holds a list of selectors which will be used to find ClusterRoles and create the rules. If any of the selectors match, then the ClusterRole's permissions will be added

V1AppArmorProfile

AppArmorProfile defines a pod or container's AppArmor settings.

Source

Property	Type	Description
`localhostProfile`	`string`	localhostProfile indicates a profile loaded on the node that should be used. The profile must be preconfigured on the node to work. Must match the loaded name of the profile. Must be set if and only...
`type`	`string`	type indicates which kind of AppArmor profile will be applied. Valid options are: Localhost - a profile pre-loaded on the node. RuntimeDefault - the container runtime's default profile. ...

V1AttachedVolume

AttachedVolume describes a volume attached to a node

Source

Property	Type	Description
`devicePath`	`string`	DevicePath represents the device path where the volume should be available
`name`	`string`	Name of the attached volume

V1AuditAnnotation

AuditAnnotation describes how to produce an audit annotation for an API request.

Source

Property	Type	Description
`key`	`string`	key specifies the audit annotation key. The audit annotation keys of a ValidatingAdmissionPolicy must be unique. The key must be a qualified name ([A-Za-z0-9][-A-Za-z0-9_.]*) no more than 63 bytes in...
`valueExpression`	`string`	valueExpression represents the expression which is evaluated by CEL to produce an audit annotation value. The expression must evaluate to either a string or null value. If the expression evaluates to...

V1AzureDiskVolumeSource

AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.

Source

Property	Type	Description
`cachingMode`	`string`	cachingMode is the Host Caching mode: None, Read Only, Read Write.
`diskName`	`string`	diskName is the Name of the data disk in the blob storage
`diskURI`	`string`	diskURI is the URI of data disk in the blob storage
`fsType`	`string`	fsType is Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
`kind`	`string`	kind expected values are Shared: multiple blob disks per storage account Dedicated: single blob disk per storage account Managed: azure managed data disk (only in managed availability set)....
`readOnly`	`boolean`	readOnly Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.

V1AzureFilePersistentVolumeSource

AzureFile represents an Azure File Service mount on the host and bind mount to the pod.

Source

Property	Type	Description
`readOnly`	`boolean`	readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
`secretName`	`string`	secretName is the name of secret that contains Azure Storage Account Name and Key
`secretNamespace`	`string`	secretNamespace is the namespace of the secret that contains Azure Storage Account Name and Key default is the same as the Pod
`shareName`	`string`	shareName is the azure Share Name

V1AzureFileVolumeSource

AzureFile represents an Azure File Service mount on the host and bind mount to the pod.

Source

Property	Type	Description
`readOnly`	`boolean`	readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
`secretName`	`string`	secretName is the name of secret that contains Azure Storage Account Name and Key
`shareName`	`string`	shareName is the azure share Name

V1CELDeviceSelector

CELDeviceSelector contains a CEL expression for selecting a device.

Source

Property	Type	Description
`expression`	`string`	Expression is a CEL expression which evaluates a single device. It must evaluate to true when the device under consideration satisfies the desired criteria, and false when it does not. Any other...

V1Capabilities

Adds and removes POSIX capabilities from running containers.

Source

Property	Type	Description
`add`	`string[]`	Added capabilities
`drop`	`string[]`	Removed capabilities

V1CapacityRequestPolicy

CapacityRequestPolicy defines how requests consume device capacity. Must not set more than one ValidRequestValues.

Source

Property	Type	Description
`_default`	`string`	Default specifies how much of this capacity is consumed by a request that does not contain an entry for it in DeviceRequest's Capacity.
`validValues`	`string[]`	ValidValues defines a set of acceptable quantity values in consuming requests. Must not contain more than 10 entries. Must be sorted in ascending order. If this field is set, Default must be...
`validRange`	V1CapacityRequestPolicyRange

V1CapacityRequestPolicyRange

CapacityRequestPolicyRange defines a valid range for consumable capacity values. - If the requested amount is less than Min, it is rounded up to the Min value. - If Step is set and the requested amount is between Min and Max but not aligned with Step, it will be rounded up to the next value equal to Min + (n * Step). - If Step is not set, the requested amount is used as-is if it falls within the range Min to Max (if set). - If the requested or rounded amount exceeds Max (if set), the request does not satisfy the policy, and the device cannot be allocated.

Source

Property	Type	Description
`max`	`string`	Max defines the upper limit for capacity that can be requested. Max must be less than or equal to the capacity value. Min and requestPolicy.default must be less than or equal to the maximum.
`min`	`string`	Min specifies the minimum capacity allowed for a consumption request. Min must be greater than or equal to zero, and less than or equal to the capacity value. requestPolicy.default must be more than...
`step`	`string`	Step defines the step size between valid capacity amounts within the range. Max (if set) and requestPolicy.default must be a multiple of Step. Min + Step must be less than or equal to the capacity...

V1CapacityRequirements

CapacityRequirements defines the capacity requirements for a specific device request.

Source

Property	Type	Description
`requests`	`{ [key: string]: string`	Requests represent individual device resource requests for distinct resources, all of which must be provided by the device. This value is used as an additional filtering condition against the...

V1CephFSPersistentVolumeSource

Represents a Ceph Filesystem mount that lasts the lifetime of a pod Cephfs volumes do not support ownership management or SELinux relabeling.

Source

Property	Type	Description
`monitors`	`string[]`	monitors is Required: Monitors is a collection of Ceph monitors More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
`path`	`string`	path is Optional: Used as the mounted root, rather than the full Ceph tree, default is /
`readOnly`	`boolean`	readOnly is Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
`secretFile`	`string`	secretFile is Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
`user`	`string`	user is Optional: User is the rados user name, default is admin More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
`secretRef`	V1SecretReference

V1CephFSVolumeSource

Represents a Ceph Filesystem mount that lasts the lifetime of a pod Cephfs volumes do not support ownership management or SELinux relabeling.

Source

Property	Type	Description
`monitors`	`string[]`	monitors is Required: Monitors is a collection of Ceph monitors More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
`path`	`string`	path is Optional: Used as the mounted root, rather than the full Ceph tree, default is /
`readOnly`	`boolean`	readOnly is Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
`secretFile`	`string`	secretFile is Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
`user`	`string`	user is optional: User is the rados user name, default is admin More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
`secretRef`	V1LocalObjectReference

V1CinderPersistentVolumeSource

Represents a cinder volume resource in Openstack. A Cinder volume must exist before mounting to a container. The volume must also be in the same region as the kubelet. Cinder volumes support ownership management and SELinux relabeling.

Source

Property	Type	Description
`fsType`	`string`	fsType Filesystem type to mount. Must be a filesystem type supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info:...
`readOnly`	`boolean`	readOnly is Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/mysql-cinder-pd/README.md
`volumeID`	`string`	volumeID used to identify the volume in cinder. More info: https://examples.k8s.io/mysql-cinder-pd/README.md
`secretRef`	V1SecretReference

V1CinderVolumeSource

Represents a cinder volume resource in Openstack. A Cinder volume must exist before mounting to a container. The volume must also be in the same region as the kubelet. Cinder volumes support ownership management and SELinux relabeling.

Source

Property	Type	Description
`fsType`	`string`	fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified....
`readOnly`	`boolean`	readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/mysql-cinder-pd/README.md
`volumeID`	`string`	volumeID used to identify the volume in cinder. More info: https://examples.k8s.io/mysql-cinder-pd/README.md
`secretRef`	V1LocalObjectReference

V1ClientIPConfig

ClientIPConfig represents the configurations of Client IP based session affinity.

Source

Property	Type	Description
`timeoutSeconds`	`number`	timeoutSeconds specifies the seconds of ClientIP type session sticky time. The value must be >0 && <=86400(for 1 day) if ServiceAffinity == "ClientIP". Default value is 10800(for 3 hours).

V1ClusterTrustBundleProjection

ClusterTrustBundleProjection describes how to select a set of ClusterTrustBundle objects and project their contents into the pod filesystem.

Source

Property	Type	Description
`name`	`string`	Select a single ClusterTrustBundle by object name. Mutually-exclusive with signerName and labelSelector.
`optional`	`boolean`	If true, don't block pod startup if the referenced ClusterTrustBundle(s) aren't available. If using name, then the named ClusterTrustBundle is allowed not to exist. If using signerName, then the...
`path`	`string`	Relative path from the volume root to write the bundle.
`signerName`	`string`	Select all ClusterTrustBundles that match this signer name. Mutually-exclusive with name. The contents of all selected ClusterTrustBundles will be unified and deduplicated.
`labelSelector`	V1LabelSelector

V1Condition

Condition contains details for one aspect of the current state of this API Resource.

Source

Property	Type	Description
`lastTransitionTime`	`Date`	lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the...
`message`	`string`	message is a human readable message indicating details about the transition. This may be an empty string.
`observedGeneration`	`number`	observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration...
`reason`	`string`	reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and...
`status`	`string`	status of the condition, one of True, False, Unknown.
`type`	`string`	type of condition in CamelCase or in foo.example.com/CamelCase.

V1Container

A single application container that you want to run within a pod.

Source

Property	Type	Description
`args`	`string[]`	Arguments to the entrypoint. The container image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be...
`command`	`string[]`	Entrypoint array. Not executed within a shell. The container image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a...
`env`	V1EnvVar[]	List of environment variables to set in the container. Cannot be updated.
`envFrom`	V1EnvFromSource[]	List of sources to populate environment variables in the container. The keys defined within a source may consist of any printable ASCII characters except '='. When a key exists in multiple sources,...
`image`	`string`	Container image name. More info: https://kubernetes.io/docs/concepts/containers/images This field is optional to allow higher level config management to default or override container images in...
`imagePullPolicy`	`string`	Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info:...
`name`	`string`	Name of the container specified as a DNS_LABEL. Each container in a pod must have a unique name (DNS_LABEL). Cannot be updated.
`ports`	V1ContainerPort[]	List of ports to expose from the container. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default "0.0.0.0" address inside a container...
`resizePolicy`	V1ContainerResizePolicy[]	Resources resize policy for the container. This field cannot be set on ephemeral containers.
`restartPolicy`	`string`	RestartPolicy defines the restart behavior of individual containers in a pod. This overrides the pod-level restart policy. When this field is not specified, the restart behavior is defined by the...
`restartPolicyRules`	V1ContainerRestartRule[]	Represents a list of rules to be checked to determine if the container should be restarted on exit. The rules are evaluated in order. Once a rule matches a container exit condition, the remaining...
`stdin`	`boolean`	Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false.
`stdinOnce`	`boolean`	Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If...
`terminationMessagePath`	`string`	Optional: Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such...
`terminationMessagePolicy`	`string`	Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure....
`tty`	`boolean`	Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false.
`volumeDevices`	V1VolumeDevice[]	volumeDevices is the list of block devices to be used by the container.
`volumeMounts`	V1VolumeMount[]	Pod volumes to mount into the container's filesystem. Cannot be updated.
`workingDir`	`string`	Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. Cannot be updated.
`lifecycle`	V1Lifecycle
`livenessProbe`	V1Probe
`readinessProbe`	V1Probe
`resources`	V1ResourceRequirements
`securityContext`	V1SecurityContext
`startupProbe`	V1Probe

V1ContainerExtendedResourceRequest

ContainerExtendedResourceRequest has the mapping of container name, extended resource name to the device request name.

Source

Property	Type	Description
`containerName`	`string`	The name of the container requesting resources.
`requestName`	`string`	The name of the request in the special ResourceClaim which corresponds to the extended resource.
`resourceName`	`string`	The name of the extended resource in that container which gets backed by DRA.

V1ContainerImage

Describe a container image

Source

Property	Type	Description
`names`	`string[]`	Names by which this image is known. e.g. ["kubernetes.example/hyperkube:v1.0.7", "cloud-vendor.registry.example/cloud-vendor/hyperkube:v1.0.7"]
`sizeBytes`	`number`	The size of the image in bytes.

V1ContainerPort

ContainerPort represents a network port in a single container.

Source

Property	Type	Description
`containerPort`	`number`	Number of port to expose on the pod's IP address. This must be a valid port number, 0 < x < 65536.
`hostIP`	`string`	What host IP to bind the external port to.
`hostPort`	`number`	Number of port to expose on the host. If specified, this must be a valid port number, 0 < x < 65536. If HostNetwork is specified, this must match ContainerPort. Most containers do not need this.
`name`	`string`	If specified, this must be an IANA_SVC_NAME and unique within the pod. Each named port in a pod must have a unique name. Name for the port that can be referred to by services.
`protocol`	`string`	Protocol for port. Must be UDP, TCP, or SCTP. Defaults to "TCP".

V1ContainerResizePolicy

ContainerResizePolicy represents resource resize policy for the container.

Source

Property	Type	Description
`resourceName`	`string`	Name of the resource to which this resource resize policy applies. Supported values: cpu, memory.
`restartPolicy`	`string`	Restart policy to apply when specified resource is resized. If not specified, it defaults to NotRequired.

V1ContainerRestartRule

ContainerRestartRule describes how a container exit is handled.

Source

Property	Type	Description
`action`	`string`	Specifies the action taken on a container exit if the requirements are satisfied. The only possible value is "Restart" to restart the container.
`exitCodes`	V1ContainerRestartRuleOnExitCodes

V1ContainerRestartRuleOnExitCodes

ContainerRestartRuleOnExitCodes describes the condition for handling an exited container based on its exit codes.

Source

Property	Type	Description
`operator`	`string`	Represents the relationship between the container exit code(s) and the specified values. Possible values are: - In: the requirement is satisfied if the container exit code is in the set of...
`values`	`number[]`	Specifies the set of values to check for container exit codes. At most 255 elements are allowed.

V1ContainerState

ContainerState holds a possible state of container. Only one of its members may be specified. If none of them is specified, the default one is ContainerStateWaiting.

Source

Property	Type	Description
`running`	V1ContainerStateRunning
`terminated`	V1ContainerStateTerminated
`waiting`	V1ContainerStateWaiting

V1ContainerStateRunning

ContainerStateRunning is a running state of a container.

Source

Property	Type	Description
`startedAt`	`Date`	Time at which the container was last (re-)started

V1ContainerStateTerminated

ContainerStateTerminated is a terminated state of a container.

Source

Property	Type	Description
`containerID`	`string`	Container's ID in the format '://<container_id>'
`exitCode`	`number`	Exit status from the last termination of the container
`finishedAt`	`Date`	Time at which the container last terminated
`message`	`string`	Message regarding the last termination of the container
`reason`	`string`	(brief) reason from the last termination of the container
`signal`	`number`	Signal from the last termination of the container
`startedAt`	`Date`	Time at which previous execution of the container started

V1ContainerStateWaiting

ContainerStateWaiting is a waiting state of a container.

Source

Property	Type	Description
`message`	`string`	Message regarding why the container is not yet running.
`reason`	`string`	(brief) reason the container is not yet running.

V1ContainerStatus

ContainerStatus contains details for the current status of this container.

Source

Property	Type	Description
`allocatedResources`	`{ [key: string]: string`	AllocatedResources represents the compute resources allocated for this container by the node. Kubelet sets this value to Container.Resources.Requests upon successful pod admission and after...
`allocatedResourcesStatus`	V1ResourceStatus[]	AllocatedResourcesStatus represents the status of various resources allocated for this Pod.
`containerID`	`string`	ContainerID is the ID of the container in the format '://<container_id>'. Where type is a container runtime identifier, returned from Version call of CRI API (for example "containerd").
`image`	`string`	Image is the name of container image that the container is running. The container image may not match the image used in the PodSpec, as it may have been resolved by the runtime. More info:...
`imageID`	`string`	ImageID is the image ID of the container's image. The image ID may not match the image ID of the image used in the PodSpec, as it may have been resolved by the runtime.
`name`	`string`	Name is a DNS_LABEL representing the unique name of the container. Each container in a pod must have a unique name across all container types. Cannot be updated.
`ready`	`boolean`	Ready specifies whether the container is currently passing its readiness check. The value will change as readiness probes keep executing. If no readiness probes are specified, this field defaults to...
`restartCount`	`number`	RestartCount holds the number of times the container has been restarted. Kubelet makes an effort to always increment the value, but there are cases when the state may be lost due to node restarts and...
`started`	`boolean`	Started indicates whether the container has finished its postStart lifecycle hook and passed its startup probe. Initialized as false, becomes true after startupProbe is considered successful. Resets...
`stopSignal`	`string`	StopSignal reports the effective stop signal for this container
`volumeMounts`	V1VolumeMountStatus[]	Status of volume mounts.
`lastState`	V1ContainerState
`resources`	V1ResourceRequirements
`state`	V1ContainerState
`user`	V1ContainerUser

V1ContainerUser

ContainerUser represents user identity information

Source

Property	Type	Description
`linux`	V1LinuxContainerUser

V1Counter

Counter describes a quantity associated with a device.

Source

Property	Type	Description
`value`	`string`	Value defines how much of a certain device counter is available.

V1CounterSet

CounterSet defines a named set of counters that are available to be used by devices defined in the ResourcePool. The counters are not allocatable by themselves, but can be referenced by devices. When a device is allocated, the portion of counters it uses will no longer be available for use by other devices.

Source

Property	Type	Description
`counters`	{ [key: string]: V1Counter	Counters defines the set of counters for this CounterSet The name of each counter must be unique in that set and must be a DNS label. The maximum number of counters is 32.
`name`	`string`	Name defines the name of the counter set. It must be a DNS label.

V1CrossVersionObjectReference

CrossVersionObjectReference contains enough information to let you identify the referred resource.

Source

Property	Type	Description
`apiVersion`	`string`	apiVersion is the API version of the referent
`kind`	`string`	kind is the kind of the referent; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
`name`	`string`	name is the name of the referent; More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

V1CustomResourceColumnDefinition

CustomResourceColumnDefinition specifies a column for server side printing.

Source

Property	Type	Description
`description`	`string`	description is a human readable description of this column.
`format`	`string`	format is an optional OpenAPI type definition for this column. The 'name' format is applied to the primary identifier column to assist in clients identifying column is the resource name. See...
`jsonPath`	`string`	jsonPath is a simple JSON path (i.e. with array notation) which is evaluated against each custom resource to produce the value for this column.
`name`	`string`	name is a human readable name for the column.
`priority`	`number`	priority is an integer defining the relative importance of this column compared to others. Lower numbers are considered higher priority. Columns that may be omitted in limited space scenarios should...
`type`	`string`	type is an OpenAPI type definition for this column. See https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#data-types for details.

V1CustomResourceConversion

CustomResourceConversion describes how to convert different versions of a CR.

Source

Property	Type	Description
`strategy`	`string`	strategy specifies how custom resources are converted between versions. Allowed values are: - `\"None\"`: The converter only change the apiVersion and would not touch any other field in the custom...
`webhook`	V1WebhookConversion

V1CustomResourceSubresourceScale

CustomResourceSubresourceScale defines how to serve the scale subresource for CustomResources.

Source

Property	Type	Description
`labelSelectorPath`	`string`	labelSelectorPath defines the JSON path inside of a custom resource that corresponds to Scale `status.selector`. Only JSON paths without the array notation are allowed. Must be a JSON Path under...
`specReplicasPath`	`string`	specReplicasPath defines the JSON path inside of a custom resource that corresponds to Scale `spec.replicas`. Only JSON paths without the array notation are allowed. Must be a JSON Path under...
`statusReplicasPath`	`string`	statusReplicasPath defines the JSON path inside of a custom resource that corresponds to Scale `status.replicas`. Only JSON paths without the array notation are allowed. Must be a JSON Path under...

V1CustomResourceSubresources

CustomResourceSubresources defines the status and scale subresources for CustomResources.

Source

Property	Type	Description
`status`	`any`	status indicates the custom resource should serve a `/status` subresource. When enabled: 1. requests to the custom resource primary endpoint ignore changes to the `status` stanza of the object. 2....
`scale`	V1CustomResourceSubresourceScale

V1CustomResourceValidation

CustomResourceValidation is a list of validation methods for CustomResources.

Source

Property	Type	Description
`openAPIV3Schema`	V1JSONSchemaProps

V1DaemonEndpoint

DaemonEndpoint contains information about a single Daemon endpoint.

Source

Property	Type	Description
`Port`	`number`	Port number of the given endpoint.

V1DeleteOptions

DeleteOptions may be provided when deleting an API object.

Source

Property	Type	Description
`apiVersion`	`string`	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info:...
`dryRun`	`string[]`	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values...
`gracePeriodSeconds`	`number`	The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the...
`ignoreStoreReadErrorWithClusterBreakingPotential`	`boolean`	if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from...
`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:...
`orphanDependents`	`boolean`	Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the...
`propagationPolicy`	`string`	Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the...
`preconditions`	V1Preconditions

and 92 more…

V1Device

Device represents one individual hardware instance that can be selected based on its attributes. Besides the name, exactly one field must be set.

Source

Property	Type	Description
`allNodes`	`boolean`	AllNodes indicates that all nodes have access to the device. Must only be set if Spec.PerDeviceNodeSelection is set to true. At most one of NodeName, NodeSelector and AllNodes can be set.
`allowMultipleAllocations`	`boolean`	AllowMultipleAllocations marks whether the device is allowed to be allocated to multiple DeviceRequests. If AllowMultipleAllocations is set to true, the device can be allocated more than once, and...
`attributes`	{ [key: string]: V1DeviceAttribute	Attributes defines the set of attributes for this device. The name of each attribute must be unique in that set. The maximum number of attributes and capacities combined is 32.
`bindingConditions`	`string[]`	BindingConditions defines the conditions for proceeding with binding. All of these conditions must be set in the per-device status conditions with a value of True to proceed with binding the pod to...
`bindingFailureConditions`	`string[]`	BindingFailureConditions defines the conditions for binding failure. They may be set in the per-device status conditions. If any is set to "True", a binding failure occurred. The maximum number of...
`bindsToNode`	`boolean`	BindsToNode indicates if the usage of an allocation involving this device has to be limited to exactly the node that was chosen when allocating the claim. If set to true, the scheduler will set the...
`capacity`	{ [key: string]: V1DeviceCapacity	Capacity defines the set of capacities for this device. The name of each capacity must be unique in that set. The maximum number of attributes and capacities combined is 32.
`consumesCounters`	V1DeviceCounterConsumption[]	ConsumesCounters defines a list of references to sharedCounters and the set of counters that the device will consume from those counter sets. There can only be a single entry per counterSet. The...
`name`	`string`	Name is unique identifier among all devices managed by the driver in the pool. It must be a DNS label.
`nodeName`	`string`	NodeName identifies the node where the device is available. Must only be set if Spec.PerDeviceNodeSelection is set to true. At most one of NodeName, NodeSelector and AllNodes can be set.
`taints`	V1DeviceTaint[]	If specified, these are the driver-defined taints. The maximum number of taints is 16. If taints are set for any device in a ResourceSlice, then the maximum number of allowed devices per...
`nodeSelector`	V1NodeSelector

V1DeviceAttribute

DeviceAttribute must have exactly one field set.

Source

Property	Type	Description
`bool`	`boolean`	BoolValue is a true/false value.
`_int`	`number`	IntValue is a number.
`string`	`string`	StringValue is a string. Must not be longer than 64 characters.
`version`	`string`	VersionValue is a semantic version according to semver.org spec 2.0.0. Must not be longer than 64 characters.

V1DeviceCapacity

DeviceCapacity describes a quantity associated with a device.

Source

Property	Type	Description
`value`	`string`	Value defines how much of a certain capacity that device has. This field reflects the fixed total capacity and does not change. The consumed amount is tracked separately by scheduler and does not...
`requestPolicy`	V1CapacityRequestPolicy

V1DeviceClaim

DeviceClaim defines how to request devices with a ResourceClaim.

Source

Property	Type	Description
`config`	V1DeviceClaimConfiguration[]	This field holds configuration for multiple potential drivers which could satisfy requests in this claim. It is ignored while allocating the claim.
`constraints`	V1DeviceConstraint[]	These constraints must be satisfied by the set of devices that get allocated for the claim.
`requests`	V1DeviceRequest[]	Requests represent individual requests for distinct devices which must all be satisfied. If empty, nothing needs to be allocated.

V1DeviceClaimConfiguration

DeviceClaimConfiguration is used for configuration parameters in DeviceClaim.

Source

Property	Type	Description
`requests`	`string[]`	Requests lists the names of requests where the configuration applies. If empty, it applies to all requests. References to subrequests must include the name of the main request and may include the...
`opaque`	V1OpaqueDeviceConfiguration

V1DeviceClass

DeviceClass is a vendor- or admin-provided resource that contains device configuration and selectors. It can be referenced in the device requests of a claim to apply these presets. Cluster scoped. This is an alpha type and requires enabling the DynamicResourceAllocation feature gate.

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`	V1DeviceClassSpec

Example

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

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

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

Used by: ResourceV1Api.createDeviceClass · ResourceV1Api.patchDeviceClass · ResourceV1Api.readDeviceClass

V1DeviceClassConfiguration

DeviceClassConfiguration is used in DeviceClass.

Source

Property	Type	Description
`opaque`	V1OpaqueDeviceConfiguration

V1DeviceClassList

DeviceClassList is a collection of classes.

Source

Property	Type	Description
`apiVersion`	`string`	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info:...
`items`	V1DeviceClass[]	Items is the list of resource classes.
`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.ResourceV1Api);

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

Used by: ResourceV1Api.listDeviceClass

V1DeviceClassSpec

DeviceClassSpec is used in a [DeviceClass] to define what can be allocated and how to configure it.

Source

Property	Type	Description
`config`	V1DeviceClassConfiguration[]	Config defines configuration parameters that apply to each device that is claimed via this class. Some classses may potentially be satisfied by multiple drivers, so each instance of a vendor...
`extendedResourceName`	`string`	ExtendedResourceName is the extended resource name for the devices of this class. The devices of this class can be used to satisfy a pod's extended resource requests. It has the same format as the...
`selectors`	V1DeviceSelector[]	Each selector must be satisfied by a device which is claimed via this class.

V1DeviceConstraint

DeviceConstraint must have exactly one field set besides Requests.

Source

Property	Type	Description
`distinctAttribute`	`string`	DistinctAttribute requires that all devices in question have this attribute and that its type and value are unique across those devices. This acts as the inverse of MatchAttribute. This constraint...
`matchAttribute`	`string`	MatchAttribute requires that all devices in question have this attribute and that its type and value are the same across those devices. For example, if you specified "dra.example.com/numa" (a...
`requests`	`string[]`	Requests is a list of the one or more requests in this claim which must co-satisfy this constraint. If a request is fulfilled by multiple devices, then all of the devices must satisfy the constraint....

V1DeviceCounterConsumption

DeviceCounterConsumption defines a set of counters that a device will consume from a CounterSet.

Source

Property	Type	Description
`counterSet`	`string`	CounterSet is the name of the set from which the counters defined will be consumed.
`counters`	{ [key: string]: V1Counter	Counters defines the counters that will be consumed by the device. The maximum number of counters is 32.

V1DeviceRequest

DeviceRequest is a request for devices required for a claim. This is typically a request for a single resource like a device, but can also ask for several identical devices. With FirstAvailable it is also possible to provide a prioritized list of requests.

Source

Property	Type	Description
`firstAvailable`	V1DeviceSubRequest[]	FirstAvailable contains subrequests, of which exactly one will be selected by the scheduler. It tries to satisfy them in the order in which they are listed here. So if there are two entries in the...
`name`	`string`	Name can be used to reference this request in a pod.spec.containers[].resources.claims entry and in a constraint of the claim. References using the name in the DeviceRequest will uniquely identify a...
`exactly`	V1ExactDeviceRequest

V1DeviceSelector

DeviceSelector must have exactly one field set.

Source

Property	Type	Description
`cel`	V1CELDeviceSelector

V1DeviceSubRequest

DeviceSubRequest describes a request for device provided in the claim.spec.devices.requests[].firstAvailable array. Each is typically a request for a single resource like a device, but can also ask for several identical devices. DeviceSubRequest is similar to ExactDeviceRequest, but doesn't expose the AdminAccess field as that one is only supported when requesting a specific device.

Source

Property	Type	Description
`allocationMode`	`string`	AllocationMode and its related fields define how devices are allocated to satisfy this subrequest. Supported values are: - ExactCount: This request is for a specific number of devices. This is the...
`count`	`number`	Count is used only when the count mode is "ExactCount". Must be greater than zero. If AllocationMode is ExactCount and this field is not specified, the default is one.
`deviceClassName`	`string`	DeviceClassName references a specific DeviceClass, which can define additional configuration and selectors to be inherited by this subrequest. A class is required. Which classes are available...
`name`	`string`	Name can be used to reference this subrequest in the list of constraints or the list of configurations for the claim. References must use the format /. Must be a DNS label.
`selectors`	V1DeviceSelector[]	Selectors define criteria which must be satisfied by a specific device in order for that device to be considered for this subrequest. All selectors must be satisfied for a device to be considered.
`tolerations`	V1DeviceToleration[]	If specified, the request's tolerations. Tolerations for NoSchedule are required to allocate a device which has a taint with that effect. The same applies to NoExecute. In addition, should any of...
`capacity`	V1CapacityRequirements

V1DeviceTaint

The device this taint is attached to has the "effect" on any claim which does not tolerate the taint and, through the claim, to pods using the claim.

Source

Property	Type	Description
`effect`	`string`	The effect of the taint on claims that do not tolerate the taint and through such claims on the pods using them. Valid effects are None, NoSchedule and NoExecute. PreferNoSchedule as used for nodes...
`key`	`string`	The taint key to be applied to a device. Must be a label name.
`timeAdded`	`Date`	TimeAdded represents the time at which the taint was added. Added automatically during create or update if not set.
`value`	`string`	The taint value corresponding to the taint key. Must be a label value.

V1DeviceToleration

The ResourceClaim this DeviceToleration is attached to tolerates any taint that matches the triple <key,value,effect> using the matching operator .

Source

Property	Type	Description
`effect`	`string`	Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule and NoExecute.
`key`	`string`	Key is the taint key that the toleration applies to. Empty means match all taint keys. If the key is empty, operator must be Exists; this combination means to match all values and all keys. Must be a...
`operator`	`string`	Operator represents a key's relationship to the value. Valid operators are Exists and Equal. Defaults to Equal. Exists is equivalent to wildcard for value, so that a ResourceClaim can tolerate all...
`tolerationSeconds`	`number`	TolerationSeconds represents the period of time the toleration (which must be of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, it is not set, which means...
`value`	`string`	Value is the taint value the toleration matches to. If the operator is Exists, the value must be empty, otherwise just a regular string. Must be a label value.

V1DownwardAPIProjection

Represents downward API info for projecting into a projected volume. Note that this is identical to a downwardAPI volume source without the default mode.

Source

Property	Type	Description
`items`	V1DownwardAPIVolumeFile[]	Items is a list of DownwardAPIVolume file

V1DownwardAPIVolumeFile

DownwardAPIVolumeFile represents information to create the file containing the pod field

Source

Property	Type	Description
`mode`	`number`	Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires...
`path`	`string`	Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with...
`fieldRef`	V1ObjectFieldSelector
`resourceFieldRef`	V1ResourceFieldSelector

V1DownwardAPIVolumeSource

DownwardAPIVolumeSource represents a volume containing downward API info. Downward API volumes support ownership management and SELinux relabeling.

Source

Property	Type	Description
`defaultMode`	`number`	Optional: mode bits to use on created files by default. Must be a Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal...
`items`	V1DownwardAPIVolumeFile[]	Items is a list of downward API volume file

V1EmptyDirVolumeSource

Represents an empty directory for a pod. Empty directory volumes support ownership management and SELinux relabeling.

Source

Property	Type	Description
`medium`	`string`	medium represents what type of storage medium should back this directory. The default is "" which means to use the node's default medium. Must be an empty string (default) or Memory. More info:...
`sizeLimit`	`string`	sizeLimit is the total amount of local storage required for this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum...

V1EnvFromSource

EnvFromSource represents the source of a set of ConfigMaps or Secrets

Source

Property	Type	Description
`prefix`	`string`	Optional text to prepend to the name of each environment variable. May consist of any printable ASCII characters except '='.
`configMapRef`	V1ConfigMapEnvSource
`secretRef`	V1SecretEnvSource

V1EnvVar

EnvVar represents an environment variable present in a Container.

Source

Property	Type	Description
`name`	`string`	Name of the environment variable. May consist of any printable ASCII characters except '='.
`value`	`string`	Variable references $(VAR_NAME) are expanded using the previously defined environment variables in the container and any service environment variables. If a variable cannot be resolved, the reference...
`valueFrom`	V1EnvVarSource

V1EnvVarSource

EnvVarSource represents a source for the value of an EnvVar.

Source

Property	Type	Description
`configMapKeyRef`	V1ConfigMapKeySelector
`fieldRef`	V1ObjectFieldSelector
`fileKeyRef`	V1FileKeySelector
`resourceFieldRef`	V1ResourceFieldSelector
`secretKeyRef`	V1SecretKeySelector

V1EphemeralContainer

An EphemeralContainer is a temporary container that you may add to an existing Pod for user-initiated activities such as debugging. Ephemeral containers have no resource or scheduling guarantees, and they will not be restarted when they exit or when a Pod is removed or restarted. The kubelet may evict a Pod if an ephemeral container causes the Pod to exceed its resource allocation. To add an ephemeral container, use the ephemeralcontainers subresource of an existing Pod. Ephemeral containers may not be removed or restarted.

Source

Property	Type	Description
`args`	`string[]`	Arguments to the entrypoint. The image's CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot be resolved, the...
`command`	`string[]`	Entrypoint array. Not executed within a shell. The image's ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container's environment. If a variable...
`env`	V1EnvVar[]	List of environment variables to set in the container. Cannot be updated.
`envFrom`	V1EnvFromSource[]	List of sources to populate environment variables in the container. The keys defined within a source may consist of any printable ASCII characters except '='. When a key exists in multiple sources,...
`image`	`string`	Container image name. More info: https://kubernetes.io/docs/concepts/containers/images
`imagePullPolicy`	`string`	Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info:...
`name`	`string`	Name of the ephemeral container specified as a DNS_LABEL. This name must be unique among all containers, init containers and ephemeral containers.
`ports`	V1ContainerPort[]	Ports are not allowed for ephemeral containers.
`resizePolicy`	V1ContainerResizePolicy[]	Resources resize policy for the container.
`restartPolicy`	`string`	Restart policy for the container to manage the restart behavior of each container within a pod. You cannot set this field on ephemeral containers.
`restartPolicyRules`	V1ContainerRestartRule[]	Represents a list of rules to be checked to determine if the container should be restarted on exit. You cannot set this field on ephemeral containers.
`stdin`	`boolean`	Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false.
`stdinOnce`	`boolean`	Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If...
`targetContainerName`	`string`	If set, the name of the container from PodSpec that this ephemeral container targets. The ephemeral container will be run in the namespaces (IPC, PID, etc) of this container. If not set then the...
`terminationMessagePath`	`string`	Optional: Path at which the file to which the container's termination message will be written is mounted into the container's filesystem. Message written is intended to be brief final status, such...
`terminationMessagePolicy`	`string`	Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure....
`tty`	`boolean`	Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. Default is false.
`volumeDevices`	V1VolumeDevice[]	volumeDevices is the list of block devices to be used by the container.
`volumeMounts`	V1VolumeMount[]	Pod volumes to mount into the container's filesystem. Subpath mounts are not allowed for ephemeral containers. Cannot be updated.
`workingDir`	`string`	Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image. Cannot be updated.
`lifecycle`	V1Lifecycle
`livenessProbe`	V1Probe
`readinessProbe`	V1Probe
`resources`	V1ResourceRequirements
`securityContext`	V1SecurityContext
`startupProbe`	V1Probe

V1EphemeralVolumeSource

Represents an ephemeral volume that is handled by a normal storage driver.

Source

Property	Type	Description
`volumeClaimTemplate`	V1PersistentVolumeClaimTemplate

V1Eviction

Eviction evicts a pod from its node subject to certain policies and safety constraints. This is a subresource of Pod. A request to cause such an eviction is created by POSTing to .../pods//evictions.

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:...
`deleteOptions`	V1DeleteOptions
`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.V1Eviction = {
    metadata: { name: 'example' },
};
const res = await api.createNamespacedPodEviction({ namespace: 'default', body });
console.log(res.metadata?.name);

Used by: CoreV1Api.createNamespacedPodEviction

V1ExactDeviceRequest

ExactDeviceRequest is a request for one or more identical devices.

Source

Property	Type	Description
`adminAccess`	`boolean`	AdminAccess indicates that this is a claim for administrative access to the device(s). Claims with AdminAccess are expected to be used for monitoring or other management services for a device. They...
`allocationMode`	`string`	AllocationMode and its related fields define how devices are allocated to satisfy this request. Supported values are: - ExactCount: This request is for a specific number of devices. This is the...
`count`	`number`	Count is used only when the count mode is "ExactCount". Must be greater than zero. If AllocationMode is ExactCount and this field is not specified, the default is one.
`deviceClassName`	`string`	DeviceClassName references a specific DeviceClass, which can define additional configuration and selectors to be inherited by this request. A DeviceClassName is required. Administrators may use...
`selectors`	V1DeviceSelector[]	Selectors define criteria which must be satisfied by a specific device in order for that device to be considered for this request. All selectors must be satisfied for a device to be considered.
`tolerations`	V1DeviceToleration[]	If specified, the request's tolerations. Tolerations for NoSchedule are required to allocate a device which has a taint with that effect. The same applies to NoExecute. In addition, should any of...
`capacity`	V1CapacityRequirements

V1ExecAction

ExecAction describes a "run in container" action.

Source

Property	Type	Description
`command`	`string[]`	Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is simply exec'd, it is not run inside...

V1ExemptPriorityLevelConfiguration

ExemptPriorityLevelConfiguration describes the configurable aspects of the handling of exempt requests. In the mandatory exempt configuration object the values in the fields here can be modified by authorized users, unlike the rest of the spec.

Source

Property	Type	Description
`lendablePercent`	`number`	`lendablePercent` prescribes the fraction of the level's NominalCL that can be borrowed by other priority levels. This value of this field must be between 0 and 100, inclusive, and it defaults to...
`nominalConcurrencyShares`	`number`	`nominalConcurrencyShares` (NCS) contributes to the computation of the NominalConcurrencyLimit (NominalCL) of this level. This is the number of execution seats nominally reserved for this priority...

V1ExpressionWarning

ExpressionWarning is a warning information that targets a specific expression.

Source

Property	Type	Description
`fieldRef`	`string`	The path to the field that refers the expression. For example, the reference to the expression of the first item of validations is "spec.validations[0].expression"
`warning`	`string`	The content of type checking information in a human-readable form. Each line of the warning contains the type that the expression is checked against, followed by the type check error from the...

V1ExternalDocumentation

ExternalDocumentation allows referencing an external resource for extended documentation.

Source

Property	Type	Description
`description`	`string`
`url`	`string`

V1FCVolumeSource

Represents a Fibre Channel volume. Fibre Channel volumes can only be mounted as read/write once. Fibre Channel volumes support ownership management and SELinux relabeling.

Source

Property	Type	Description
`fsType`	`string`	fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
`lun`	`number`	lun is Optional: FC target lun number
`readOnly`	`boolean`	readOnly is Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
`targetWWNs`	`string[]`	targetWWNs is Optional: FC target worldwide names (WWNs)
`wwids`	`string[]`	wwids Optional: FC volume world wide identifiers (wwids) Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously.

V1FieldSelectorAttributes

FieldSelectorAttributes indicates a field limited access. Webhook authors are encouraged to * ensure rawSelector and requirements are not both set * consider the requirements field if set * not try to parse or consider the rawSelector field if set. This is to avoid another CVE-2022-2880 (i.e. getting different systems to agree on how exactly to parse a query is not something we want), see https://www.oxeye.io/resources/golang-parameter-smuggling-attack for more details. For the *SubjectAccessReview endpoints of the kube-apiserver: * If rawSelector is empty and requirements are empty, the request is not limited. * If rawSelector is present and requirements are empty, the rawSelector will be parsed and limited if the parsing succeeds. * If rawSelector is empty and requirements are present, the requirements should be honored * If rawSelector is present and requirements are present, the request is invalid.

Source

Property	Type	Description
`rawSelector`	`string`	rawSelector is the serialization of a field selector that would be included in a query parameter. Webhook implementations are encouraged to ignore rawSelector. The kube-apiserver's...
`requirements`	V1FieldSelectorRequirement[]	requirements is the parsed interpretation of a field selector. All requirements must be met for a resource instance to match the selector. Webhook implementations should handle requirements, but how...

V1FieldSelectorRequirement

FieldSelectorRequirement is a selector that contains values, a key, and an operator that relates the key and values.

Source

Property	Type	Description
`key`	`string`	key is the field selector key that the requirement applies to.
`operator`	`string`	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist. The list of operators may grow in the future.
`values`	`string[]`	values is 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.

V1FileKeySelector

FileKeySelector selects a key of the env file.

Source

Property	Type	Description
`key`	`string`	The key within the env file. An invalid key will prevent the pod from starting. The keys defined within a source may consist of any printable ASCII characters except '='. During Alpha stage of the...
`optional`	`boolean`	Specify whether the file or its key must be defined. If the file or key does not exist, then the env var is not published. If optional is set to true and the specified key does not exist, the...
`path`	`string`	The path within the volume from which to select the file. Must be relative and may not contain the '..' path or start with '..'.
`volumeName`	`string`	The name of the volume mount containing the env file.

V1FlexPersistentVolumeSource

FlexPersistentVolumeSource represents a generic persistent volume resource that is provisioned/attached using an exec based plugin.

Source

Property	Type	Description
`driver`	`string`	driver is the name of the driver to use for this volume.
`fsType`	`string`	fsType is the Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". The default filesystem depends on FlexVolume script.
`options`	`{ [key: string]: string`	options is Optional: this field holds extra command options if any.
`readOnly`	`boolean`	readOnly is Optional: defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
`secretRef`	V1SecretReference

V1FlexVolumeSource

FlexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin.

Source

Property	Type	Description
`driver`	`string`	driver is the name of the driver to use for this volume.
`fsType`	`string`	fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". The default filesystem depends on FlexVolume script.
`options`	`{ [key: string]: string`	options is Optional: this field holds extra command options if any.
`readOnly`	`boolean`	readOnly is Optional: defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
`secretRef`	V1LocalObjectReference

V1FlockerVolumeSource

Represents a Flocker volume mounted by the Flocker agent. One and only one of datasetName and datasetUUID should be set. Flocker volumes do not support ownership management or SELinux relabeling.

Source

Property	Type	Description
`datasetName`	`string`	datasetName is Name of the dataset stored as metadata -> name on the dataset for Flocker should be considered as deprecated
`datasetUUID`	`string`	datasetUUID is the UUID of the dataset. This is unique identifier of a Flocker dataset

V1FlowDistinguisherMethod

FlowDistinguisherMethod specifies the method of a flow distinguisher.

Source

Property	Type	Description
`type`	`string`	`type` is the type of flow distinguisher method The supported types are "ByUser" and "ByNamespace". Required.

V1ForNode

ForNode provides information about which nodes should consume this endpoint.

Source

Property	Type	Description
`name`	`string`	name represents the name of the node.

V1ForZone

ForZone provides information about which zones should consume this endpoint.

Source

Property	Type	Description
`name`	`string`	name represents the name of the zone.

V1GCEPersistentDiskVolumeSource

Represents a Persistent Disk resource in Google Compute Engine. A GCE PD must exist before mounting to a container. The disk must also be in the same GCE project and zone as the kubelet. A GCE PD can only be mounted as read/write once or read-only many times. GCE PDs support ownership management and SELinux relabeling.

Source

Property	Type	Description
`fsType`	`string`	fsType is filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly...
`partition`	`number`	partition is the partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the...
`pdName`	`string`	pdName is unique name of the PD resource in GCE. Used to identify the disk in GCE. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
`readOnly`	`boolean`	readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk

V1GRPCAction

GRPCAction specifies an action involving a GRPC service.

Source

Property	Type	Description
`port`	`number`	Port number of the gRPC service. Number must be in the range 1 to 65535.
`service`	`string`	Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). If this is not specified, the default behavior is...

V1GitRepoVolumeSource

Represents a volume that is populated with the contents of a git repository. Git repo volumes do not support ownership management. Git repo volumes support SELinux relabeling. DEPRECATED: GitRepo is deprecated. To provision a container with a git repo, mount an EmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir into the Pod's container.

Source

Property	Type	Description
`directory`	`string`	directory is the target directory name. Must not contain or start with '..'. If '.' is supplied, the volume directory will be the git repository. Otherwise, if specified, the volume will...
`repository`	`string`	repository is the URL
`revision`	`string`	revision is the commit hash for the specified revision.

V1GlusterfsPersistentVolumeSource

Represents a Glusterfs mount that lasts the lifetime of a pod. Glusterfs volumes do not support ownership management or SELinux relabeling.

Source

Property	Type	Description
`endpoints`	`string`	endpoints is the endpoint name that details Glusterfs topology. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod
`endpointsNamespace`	`string`	endpointsNamespace is the namespace that contains Glusterfs endpoint. If this field is empty, the EndpointNamespace defaults to the same namespace as the bound PVC. More info:...
`path`	`string`	path is the Glusterfs volume path. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod
`readOnly`	`boolean`	readOnly here will force the Glusterfs volume to be mounted with read-only permissions. Defaults to false. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod

V1GlusterfsVolumeSource

Represents a Glusterfs mount that lasts the lifetime of a pod. Glusterfs volumes do not support ownership management or SELinux relabeling.

Source

Property	Type	Description
`endpoints`	`string`	endpoints is the endpoint name that details Glusterfs topology.
`path`	`string`	path is the Glusterfs volume path. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod
`readOnly`	`boolean`	readOnly here will force the Glusterfs volume to be mounted with read-only permissions. Defaults to false. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod

V1GroupResource

GroupResource specifies a Group and a Resource, but does not force a version. This is useful for identifying concepts during lookup stages without having partially valid types

Source

Property	Type	Description
`group`	`string`
`resource`	`string`

V1HTTPGetAction

HTTPGetAction describes an action based on HTTP Get requests.

Source

Property	Type	Description
`host`	`string`	Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead.
`httpHeaders`	V1HTTPHeader[]	Custom headers to set in the request. HTTP allows repeated headers.
`path`	`string`	Path to access on the HTTP server.
`port`	`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...
`scheme`	`string`	Scheme to use for connecting to the host. Defaults to HTTP.

V1HTTPHeader

HTTPHeader describes a custom header to be used in HTTP probes

Source

Property	Type	Description
`name`	`string`	The header field name. This will be canonicalized upon output, so case-variant names will be understood as the same header.
`value`	`string`	The header field value

V1HTTPIngressPath

HTTPIngressPath associates a path with a backend. Incoming urls matching the path are forwarded to the backend.

Source

Property	Type	Description
`path`	`string`	path is matched against the path of an incoming request. Currently it can contain characters disallowed from the conventional "path" part of a URL as defined by RFC 3986. Paths must begin with a...
`pathType`	`string`	pathType determines the interpretation of the path matching. PathType can be one of the following values: * Exact: Matches the URL path exactly. * Prefix: Matches based on a URL path prefix split by...
`backend`	V1IngressBackend

V1HTTPIngressRuleValue

HTTPIngressRuleValue is a list of http selectors pointing to backends. In the example: http:///? -> backend where where parts of the url correspond to RFC 3986, this resource will be used to match against everything after the last '/' and before the first '?' or '#'.

Source

Property	Type	Description
`paths`	V1HTTPIngressPath[]	paths is a collection of paths that map requests to backends.

V1HostAlias

HostAlias holds the mapping between IP and hostnames that will be injected as an entry in the pod's hosts file.

Source

Property	Type	Description
`hostnames`	`string[]`	Hostnames for the above IP address.
`ip`	`string`	IP address of the host file entry.

V1HostIP

HostIP represents a single IP address allocated to the host.

Source

Property	Type	Description
`ip`	`string`	IP is the IP address assigned to the host

V1HostPathVolumeSource

Represents a host path mapped into a pod. Host path volumes do not support ownership management or SELinux relabeling.

Source

Property	Type	Description
`path`	`string`	path of the directory on the host. If the path is a symlink, it will follow the link to the real path. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath
`type`	`string`	type for HostPath Volume Defaults to "" More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath

V1IPBlock

IPBlock describes a particular CIDR (Ex. "192.168.1.0/24","2001:db8::/64") that is allowed to the pods matched by a NetworkPolicySpec's podSelector. The except entry describes CIDRs that should not be included within this rule.

Source

Property	Type	Description
`cidr`	`string`	cidr is a string representing the IPBlock Valid examples are "192.168.1.0/24" or "2001:db8::/64"
`except`	`string[]`	except is a slice of CIDRs that should not be included within an IPBlock Valid examples are "192.168.1.0/24" or "2001:db8::/64" Except values will be rejected if they are outside the cidr range

V1ISCSIPersistentVolumeSource

ISCSIPersistentVolumeSource represents an ISCSI disk. ISCSI volumes can only be mounted as read/write once. ISCSI volumes support ownership management and SELinux relabeling.

Source

Property	Type	Description
`chapAuthDiscovery`	`boolean`	chapAuthDiscovery defines whether support iSCSI Discovery CHAP authentication
`chapAuthSession`	`boolean`	chapAuthSession defines whether support iSCSI Session CHAP authentication
`fsType`	`string`	fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly...
`initiatorName`	`string`	initiatorName is the custom iSCSI Initiator Name. If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface : will be created for the...
`iqn`	`string`	iqn is Target iSCSI Qualified Name.
`iscsiInterface`	`string`	iscsiInterface is the interface Name that uses an iSCSI transport. Defaults to 'default' (tcp).
`lun`	`number`	lun is iSCSI Target Lun number.
`portals`	`string[]`	portals is the iSCSI Target Portal List. The Portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260).
`readOnly`	`boolean`	readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false.
`targetPortal`	`string`	targetPortal is iSCSI Target Portal. The Portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260).
`secretRef`	V1SecretReference

V1ISCSIVolumeSource

Represents an ISCSI disk. ISCSI volumes can only be mounted as read/write once. ISCSI volumes support ownership management and SELinux relabeling.

Source

Property	Type	Description
`chapAuthDiscovery`	`boolean`	chapAuthDiscovery defines whether support iSCSI Discovery CHAP authentication
`chapAuthSession`	`boolean`	chapAuthSession defines whether support iSCSI Session CHAP authentication
`fsType`	`string`	fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly...
`initiatorName`	`string`	initiatorName is the custom iSCSI Initiator Name. If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface : will be created for the...
`iqn`	`string`	iqn is the target iSCSI Qualified Name.
`iscsiInterface`	`string`	iscsiInterface is the interface Name that uses an iSCSI transport. Defaults to 'default' (tcp).
`lun`	`number`	lun represents iSCSI Target Lun number.
`portals`	`string[]`	portals is the iSCSI Target Portal List. The portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260).
`readOnly`	`boolean`	readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false.
`targetPortal`	`string`	targetPortal is iSCSI Target Portal. The Portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260).
`secretRef`	V1LocalObjectReference

V1ImageVolumeSource

ImageVolumeSource represents a image volume resource.

Source

Property	Type	Description
`pullPolicy`	`string`	Policy for pulling OCI objects. Possible values are: Always: the kubelet always attempts to pull the reference. Container creation will fail If the pull fails. Never: the kubelet never pulls the...
`reference`	`string`	Required: Image or artifact reference to be used. Behaves in the same way as pod.spec.containers[*].image. Pull secrets will be assembled in the same way as for the container image by looking up node...

V1JSONSchemaProps

JSONSchemaProps is a JSON-Schema following Specification Draft 4 (http://json-schema.org/).

Source

Property	Type	Description
`additionalItems`	`any`	JSONSchemaPropsOrBool represents JSONSchemaProps or a boolean value. Defaults to true for the boolean property.
`additionalProperties`	`any`	JSONSchemaPropsOrBool represents JSONSchemaProps or a boolean value. Defaults to true for the boolean property.
`_default`	`any`	default is a default value for undefined object fields. Defaulting is a beta feature under the CustomResourceDefaulting feature gate. Defaulting requires spec.preserveUnknownFields to be false.
`example`	`any`	JSON represents any valid JSON value. These types are supported: bool, int64, float64, string, []interface{}, map[string]interface{} and nil.
`format`	`string`	format is an OpenAPI v3 format string. Unknown formats are ignored. The following formats are validated: - bsonobjectid: a bson object ID, i.e. a 24 characters hex string - uri: an URI as parsed by...
`items`	`any`	JSONSchemaPropsOrArray represents a value that can either be a JSONSchemaProps or an array of JSONSchemaProps. Mainly here for serialization purposes.
`x_kubernetes_embedded_resource`	`boolean`	x-kubernetes-embedded-resource defines that the value is an embedded Kubernetes runtime.Object, with TypeMeta and ObjectMeta. The type must be object. It is allowed to further restrict the embedded...
`x_kubernetes_int_or_string`	`boolean`	x-kubernetes-int-or-string specifies that this value is either an integer or a string. If this is true, an empty type is allowed and type as child of anyOf is permitted if following one of the...
`x_kubernetes_list_map_keys`	`string[]`	x-kubernetes-list-map-keys annotates an array with the x-kubernetes-list-type `map` by specifying the keys used as the index of the map. This tag MUST only be used on lists that have the...
`x_kubernetes_list_type`	`string`	x-kubernetes-list-type annotates an array to further describe its topology. This extension must only be used on lists and may have 3 possible values: 1) `atomic`: the list is treated as a single...
`x_kubernetes_map_type`	`string`	x-kubernetes-map-type annotates an object to further describe its topology. This extension must only be used when type is object and may have 2 possible values: 1) `granular`: These maps are...
`x_kubernetes_preserve_unknown_fields`	`boolean`	x-kubernetes-preserve-unknown-fields stops the API server decoding step from pruning fields which are not specified in the validation schema. This affects fields recursively, but switches back to...
`x_kubernetes_validations`	V1ValidationRule[]	x-kubernetes-validations describes a list of validation rules written in the CEL expression language.
`ref`	`string`
`schema`	`string`
`allOf`	V1JSONSchemaProps[]
`anyOf`	V1JSONSchemaProps[]
`definitions`	{ [key: string]: V1JSONSchemaProps
`dependencies`	`{ [key: string]: any`
`description`	`string`
`_enum`	`any[]`
`exclusiveMaximum`	`boolean`
`exclusiveMinimum`	`boolean`
`externalDocs`	V1ExternalDocumentation
`id`	`string`
`maxItems`	`number`
`maxLength`	`number`
`maxProperties`	`number`
`maximum`	`number`
`minItems`	`number`
`minLength`	`number`
`minProperties`	`number`
`minimum`	`number`
`multipleOf`	`number`
`not`	V1JSONSchemaProps
`nullable`	`boolean`
`oneOf`	V1JSONSchemaProps[]
`pattern`	`string`
`patternProperties`	{ [key: string]: V1JSONSchemaProps
`properties`	{ [key: string]: V1JSONSchemaProps
`required`	`string[]`
`title`	`string`
`type`	`string`
`uniqueItems`	`boolean`

V1KeyToPath

Maps a string key to a path within a volume.

Source

Property	Type	Description
`key`	`string`	key is the key to project.
`mode`	`number`	mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON...
`path`	`string`	path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.

V1LabelSelector

A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects.

Source

Property	Type	Description
`matchExpressions`	V1LabelSelectorRequirement[]	matchExpressions is a list of label selector requirements. The requirements are ANDed.
`matchLabels`	`{ [key: string]: string`	matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the...

V1LabelSelectorAttributes

LabelSelectorAttributes indicates a label limited access. Webhook authors are encouraged to * ensure rawSelector and requirements are not both set * consider the requirements field if set * not try to parse or consider the rawSelector field if set. This is to avoid another CVE-2022-2880 (i.e. getting different systems to agree on how exactly to parse a query is not something we want), see https://www.oxeye.io/resources/golang-parameter-smuggling-attack for more details. For the *SubjectAccessReview endpoints of the kube-apiserver: * If rawSelector is empty and requirements are empty, the request is not limited. * If rawSelector is present and requirements are empty, the rawSelector will be parsed and limited if the parsing succeeds. * If rawSelector is empty and requirements are present, the requirements should be honored * If rawSelector is present and requirements are present, the request is invalid.

Source

Property	Type	Description
`rawSelector`	`string`	rawSelector is the serialization of a field selector that would be included in a query parameter. Webhook implementations are encouraged to ignore rawSelector. The kube-apiserver's...
`requirements`	V1LabelSelectorRequirement[]	requirements is the parsed interpretation of a label selector. All requirements must be met for a resource instance to match the selector. Webhook implementations should handle requirements, but how...

V1LabelSelectorRequirement

A label 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`	key is the label key that the selector applies to.
`operator`	`string`	operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
`values`	`string[]`	values is 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. This array is...

V1Lifecycle

Lifecycle describes actions that the management system should take in response to container lifecycle events. For the PostStart and PreStop lifecycle handlers, management of the container blocks until the action is complete, unless the container process fails, in which case the handler is aborted.

Source

Property	Type	Description
`stopSignal`	`string`	StopSignal defines which signal will be sent to a container when it is being stopped. If not specified, the default is defined by the container runtime in use. StopSignal can only be set for Pods...
`postStart`	V1LifecycleHandler
`preStop`	V1LifecycleHandler

V1LifecycleHandler

LifecycleHandler defines a specific action that should be taken in a lifecycle hook. One and only one of the fields, except TCPSocket must be specified.

Source

Property	Type	Description
`exec`	V1ExecAction
`httpGet`	V1HTTPGetAction
`sleep`	V1SleepAction
`tcpSocket`	V1TCPSocketAction

V1LimitResponse

LimitResponse defines how to handle requests that can not be executed right now.

Source

Property	Type	Description
`type`	`string`	`type` is "Queue" or "Reject". "Queue" means that requests that can not be executed upon arrival are held in a queue until they can be executed or a queuing limit is reached. "Reject" means...
`queuing`	V1QueuingConfiguration

V1LimitedPriorityLevelConfiguration

LimitedPriorityLevelConfiguration specifies how to handle requests that are subject to limits. It addresses two issues: - How are requests for this priority level limited? - What should be done with requests that exceed the limit?

Source

Property	Type	Description
`borrowingLimitPercent`	`number`	`borrowingLimitPercent`, if present, configures a limit on how many seats this priority level can borrow from other priority levels. The limit is known as this level's BorrowingConcurrencyLimit...
`lendablePercent`	`number`	`lendablePercent` prescribes the fraction of the level's NominalCL that can be borrowed by other priority levels. The value of this field must be between 0 and 100, inclusive, and it defaults to 0....
`nominalConcurrencyShares`	`number`	`nominalConcurrencyShares` (NCS) contributes to the computation of the NominalConcurrencyLimit (NominalCL) of this level. This is the number of execution seats available at this priority level. This...
`limitResponse`	V1LimitResponse

V1LinuxContainerUser

LinuxContainerUser represents user identity information in Linux containers

Source

Property	Type	Description
`gid`	`number`	GID is the primary gid initially attached to the first process in the container
`supplementalGroups`	`number[]`	SupplementalGroups are the supplemental groups initially attached to the first process in the container
`uid`	`number`	UID is the primary uid initially attached to the first process in the container

V1ListMeta

ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.

Source

Property	Type	Description
`_continue`	`string`	continue may be set if the user set a limit on the number of items returned, and indicates that the server has more data available. The value is opaque and may be used to issue another request to the...
`remainingItemCount`	`number`	remainingItemCount is the number of subsequent items in the list which are not included in this list response. If the list request contained label or field selectors, then the number of remaining...
`resourceVersion`	`string`	String that identifies the server's internal version of this object that can be used by clients to determine when objects have changed. Value must be treated as opaque by clients and passed...
`selfLink`	`string`	Deprecated: selfLink is a legacy read-only field that is no longer populated by the system.

V1LoadBalancerIngress

LoadBalancerIngress represents the status of a load-balancer ingress point: traffic intended for the service should be sent to an ingress point.

Source

Property	Type	Description
`hostname`	`string`	Hostname is set for load-balancer ingress points that are DNS based (typically AWS load-balancers)
`ip`	`string`	IP is set for load-balancer ingress points that are IP based (typically GCE or OpenStack load-balancers)
`ipMode`	`string`	IPMode specifies how the load-balancer IP behaves, and may only be specified when the ip field is specified. Setting this to "VIP" indicates that traffic is delivered to the node with the...
`ports`	V1PortStatus[]	Ports is a list of records of service ports If used, every port defined in the service should have an entry in it

V1LoadBalancerStatus

LoadBalancerStatus represents the status of a load-balancer.

Source

Property	Type	Description
`ingress`	V1LoadBalancerIngress[]	Ingress is a list containing ingress points for the load-balancer. Traffic intended for the service should be sent to these ingress points.

V1LocalObjectReference

LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.

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...

V1LocalVolumeSource

Local represents directly-attached storage with node affinity

Source

Property	Type	Description
`fsType`	`string`	fsType is the filesystem type to mount. It applies only when the Path is a block device. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". The default...
`path`	`string`	path of the full path to the volume on the node. It can be either a directory or block device (disk, partition, ...).

V1ManagedFieldsEntry

ManagedFieldsEntry is a workflow-id, a FieldSet and the group version of the resource that the fieldset applies to.

Source

Property	Type	Description
`apiVersion`	`string`	APIVersion defines the version of this resource that this field set applies to. The format is "group/version" just like the top-level APIVersion field. It is necessary to track the version of a...
`fieldsType`	`string`	FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1"
`fieldsV1`	`any`	FieldsV1 holds the first JSON version format as described in the "FieldsV1" type.
`manager`	`string`	Manager is an identifier of the workflow managing these fields.
`operation`	`string`	Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are 'Apply' and 'Update'.
`subresource`	`string`	Subresource is the name of the subresource used to update that object, or empty string if the object was updated through the main resource. The value of this field is used to distinguish between...
`time`	`Date`	Time is the timestamp of when the ManagedFields entry was added. The timestamp will also be updated if a field is added, the manager changes any of the owned fields value or removes a field. The...

V1MatchCondition

MatchCondition represents a condition which must by fulfilled for a request to be sent to a webhook.

Source

Property	Type	Description
`expression`	`string`	Expression represents the expression which will be evaluated by CEL. Must evaluate to bool. CEL expressions have access to the contents of the AdmissionRequest and Authorizer, organized into CEL...
`name`	`string`	Name is an identifier for this match condition, used for strategic merging of MatchConditions, as well as providing an identifier for logging purposes. A good name should be descriptive of the...

V1MatchResources

MatchResources decides whether to run the admission control policy on an object based on whether it meets the match criteria. The exclude rules take precedence over include rules (if a resource matches both, it is excluded)

Source

Property	Type	Description
`excludeResourceRules`	V1NamedRuleWithOperations[]	ExcludeResourceRules describes what operations on what resources/subresources the ValidatingAdmissionPolicy should not care about. The exclude rules take precedence over include rules (if a resource...
`matchPolicy`	`string`	matchPolicy defines how the "MatchResources" list is used to match incoming requests. Allowed values are "Exact" or "Equivalent". - Exact: match a request only if it exactly matches a...
`resourceRules`	V1NamedRuleWithOperations[]	ResourceRules describes what operations on what resources/subresources the ValidatingAdmissionPolicy matches. The policy cares about an operation if it matches any Rule.
`namespaceSelector`	V1LabelSelector
`objectSelector`	V1LabelSelector

V1ModifyVolumeStatus

ModifyVolumeStatus represents the status object of ControllerModifyVolume operation

Source

Property	Type	Description
`status`	`string`	status is the status of the ControllerModifyVolume operation. It can be in any of following states: - Pending Pending indicates that the PersistentVolumeClaim cannot be modified due to unmet...
`targetVolumeAttributesClassName`	`string`	targetVolumeAttributesClassName is the name of the VolumeAttributesClass the PVC currently being reconciled

V1MutatingWebhook

MutatingWebhook describes an admission webhook and the resources and operations it applies to.

Source

Property	Type	Description
`admissionReviewVersions`	`string[]`	AdmissionReviewVersions is an ordered list of preferred `AdmissionReview` versions the Webhook expects. API server will try to use first version in the list which it supports. If none of the versions...
`failurePolicy`	`string`	FailurePolicy defines how unrecognized errors from the admission endpoint are handled - allowed values are Ignore or Fail. Defaults to Fail.
`matchConditions`	V1MatchCondition[]	MatchConditions is a list of conditions that must be met for a request to be sent to this webhook. Match conditions filter requests that have already been matched by the rules, namespaceSelector, and...
`matchPolicy`	`string`	matchPolicy defines how the "rules" list is used to match incoming requests. Allowed values are "Exact" or "Equivalent". - Exact: match a request only if it exactly matches a specified rule....
`name`	`string`	The name of the admission webhook. Name should be fully qualified, e.g., imagepolicy.kubernetes.io, where "imagepolicy" is the name of the webhook, and kubernetes.io is the name of the...
`reinvocationPolicy`	`string`	reinvocationPolicy indicates whether this webhook should be called multiple times as part of a single admission evaluation. Allowed values are "Never" and "IfNeeded". Never: the webhook will not...
`rules`	V1RuleWithOperations[]	Rules describes what operations on what resources/subresources the webhook cares about. The webhook cares about an operation if it matches any Rule. However, in order to prevent...
`sideEffects`	`string`	SideEffects states whether this webhook has side effects. Acceptable values are: None, NoneOnDryRun (webhooks created via v1beta1 may also specify Some or Unknown). Webhooks with side effects MUST...
`timeoutSeconds`	`number`	TimeoutSeconds specifies the timeout for this webhook. After the timeout passes, the webhook call will be ignored or the API call will fail based on the failure policy. The timeout value must be...
`clientConfig`	`AdmissionregistrationV1WebhookClientConfig`
`namespaceSelector`	V1LabelSelector
`objectSelector`	V1LabelSelector

V1NFSVolumeSource

Represents an NFS mount that lasts the lifetime of a pod. NFS volumes do not support ownership management or SELinux relabeling.

Source

Property	Type	Description
`path`	`string`	path that is exported by the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
`readOnly`	`boolean`	readOnly here will force the NFS export to be mounted with read-only permissions. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
`server`	`string`	server is the hostname or IP address of the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs

V1NamedRuleWithOperations

NamedRuleWithOperations is a tuple of Operations and Resources with ResourceNames.

Source

Property	Type	Description
`apiGroups`	`string[]`	APIGroups is the API groups the resources belong to. '' is all groups. If '' is present, the length of the slice must be one. Required.
`apiVersions`	`string[]`	APIVersions is the API versions the resources belong to. '' is all versions. If '' is present, the length of the slice must be one. Required.
`operations`	`string[]`	Operations is the operations the admission hook cares about - CREATE, UPDATE, DELETE, CONNECT or * for all of those operations and any future admission operations that are added. If '*' is present,...
`resourceNames`	`string[]`	ResourceNames is an optional white list of names that the rule applies to. An empty set means that everything is allowed.
`resources`	`string[]`	Resources is a list of resources this rule applies to. For example: 'pods' means pods. 'pods/log' means the log subresource of pods. '' means all resources, but not subresources. 'pods/_'...
`scope`	`string`	scope specifies the scope of this rule. Valid values are "Cluster", "Namespaced", and "*" "Cluster" means that only cluster-scoped resources will match this rule. Namespace API objects are...

V1NonResourceAttributes

NonResourceAttributes includes the authorization attributes available for non-resource requests to the Authorizer interface

Source

Property	Type	Description
`path`	`string`	Path is the URL path of the request
`verb`	`string`	Verb is the standard HTTP verb

V1NonResourcePolicyRule

NonResourcePolicyRule is a predicate that matches non-resource requests according to their verb and the target non-resource URL. A NonResourcePolicyRule matches a request if and only if both (a) at least one member of verbs matches the request and (b) at least one member of nonResourceURLs matches the request.

Source

Property	Type	Description
`nonResourceURLs`	`string[]`	`nonResourceURLs` is a set of url prefixes that a user should have access to and may not be empty. For example: - "/healthz" is legal - "/hea*" is illegal - "/hea" is legal but matches...
`verbs`	`string[]`	`verbs` is a list of matching verbs and may not be empty. "*" matches all verbs. If it is present, it must be the only entry. Required.

V1NonResourceRule

NonResourceRule holds information that describes a rule for the non-resource

Source

Property	Type	Description
`nonResourceURLs`	`string[]`	NonResourceURLs is a set of partial urls that a user should have access to. s are allowed, but only as the full, final step in the path. "" means all.
`verbs`	`string[]`	Verb is a list of kubernetes non-resource API verbs, like: get, post, put, delete, patch, head, options. "*" means all.

V1ObjectFieldSelector

ObjectFieldSelector selects an APIVersioned field of an object.

Source

Property	Type	Description
`apiVersion`	`string`	Version of the schema the FieldPath is written in terms of, defaults to "v1".
`fieldPath`	`string`	Path of the field to select in the specified API version.

V1ObjectMeta

ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.

Source

Property	Type	Description
`annotations`	`{ [key: string]: string`	Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when...
`creationTimestamp`	`Date`	CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this...
`deletionGracePeriodSeconds`	`number`	Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.
`deletionTimestamp`	`Date`	DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by...
`finalizers`	`string[]`	Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the...
`generateName`	`string`	GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be...
`generation`	`number`	A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.
`labels`	`{ [key: string]: string`	Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info:...
`managedFields`	V1ManagedFieldsEntry[]	ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand...
`name`	`string`	Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is...
`namespace`	`string`	Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are...
`ownerReferences`	V1OwnerReference[]	List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list...
`resourceVersion`	`string`	An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and...
`selfLink`	`string`	Deprecated: selfLink is a legacy read-only field that is no longer populated by the system.
`uid`	`string`	UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations. Populated by...

V1ObjectReference

ObjectReference contains enough information to let you inspect or modify the referred object.

Source

Property	Type	Description
`apiVersion`	`string`	API version of the referent.
`fieldPath`	`string`	If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the...
`kind`	`string`	Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
`name`	`string`	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
`namespace`	`string`	Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/
`resourceVersion`	`string`	Specific resourceVersion to which this reference is made, if any. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency
`uid`	`string`	UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

V1OpaqueDeviceConfiguration

OpaqueDeviceConfiguration contains configuration parameters for a driver in a format defined by the driver vendor.

Source

Property	Type	Description
`driver`	`string`	Driver is used to determine which kubelet plugin needs to be passed these configuration parameters. An admission policy provided by the driver developer could use this to decide whether it needs to...
`parameters`	`any`	Parameters can contain arbitrary data. It is the responsibility of the driver developer to handle validation and versioning. Typically this includes self-identification and a version ("kind" +...

V1Overhead

Overhead structure represents the resource overhead associated with running a pod.

Source

Property	Type	Description
`podFixed`	`{ [key: string]: string`	podFixed represents the fixed resource overhead associated with running a pod.

V1OwnerReference

OwnerReference contains enough information to let you identify an owning object. An owning object must be in the same namespace as the dependent, or be cluster-scoped, so there is no namespace field.

Source

Property	Type	Description
`apiVersion`	`string`	API version of the referent.
`blockOwnerDeletion`	`boolean`	If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. See...
`controller`	`boolean`	If true, this reference points to the managing controller.
`kind`	`string`	Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
`name`	`string`	Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names
`uid`	`string`	UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids

V1ParamKind

ParamKind is a tuple of Group Kind and Version.

Source

Property	Type	Description
`apiVersion`	`string`	APIVersion is the API group version the resources belong to. In format of "group/version". Required.
`kind`	`string`	Kind is the API kind the resources belong to. Required.

V1ParamRef

ParamRef describes how to locate the params to be used as input to expressions of rules applied by a policy binding.

Source

Property	Type	Description
`name`	`string`	name is the name of the resource being referenced. One of `name` or `selector` must be set, but `name` and `selector` are mutually exclusive properties. If one is set, the other must be unset. A...
`namespace`	`string`	namespace is the namespace of the referenced resource. Allows limiting the search for params to a specific namespace. Applies to both `name` and `selector` fields. A per-namespace parameter may be...
`parameterNotFoundAction`	`string`	`parameterNotFoundAction` controls the behavior of the binding when the resource exists, and name or selector is valid, but there are no parameters matched by the binding. If the value is set to...
`selector`	V1LabelSelector

V1ParentReference

ParentReference describes a reference to a parent object.

Source

Property	Type	Description
`group`	`string`	Group is the group of the object being referenced.
`name`	`string`	Name is the name of the object being referenced.
`namespace`	`string`	Namespace is the namespace of the object being referenced.
`resource`	`string`	Resource is the resource of the object being referenced.

V1PhotonPersistentDiskVolumeSource

Represents a Photon Controller persistent disk resource.

Source

Property	Type	Description
`fsType`	`string`	fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
`pdID`	`string`	pdID is the ID that identifies Photon Controller persistent disk

V1PolicyRule

PolicyRule holds information that describes a policy rule, but does not contain information about who the rule applies to or which namespace the rule applies to.

Source

Property	Type	Description
`apiGroups`	`string[]`	APIGroups is the name of the APIGroup that contains the resources. If multiple API groups are specified, any action requested against one of the enumerated resources in any API group will be...
`nonResourceURLs`	`string[]`	NonResourceURLs is a set of partial urls that a user should have access to. *s are allowed, but only as the full, final step in the path Since non-resource URLs are not namespaced, this field is...
`resourceNames`	`string[]`	ResourceNames is an optional white list of names that the rule applies to. An empty set means that everything is allowed.
`resources`	`string[]`	Resources is a list of resources this rule applies to. '*' represents all resources.
`verbs`	`string[]`	Verbs is a list of Verbs that apply to ALL the ResourceKinds contained in this rule. '*' represents all verbs.

V1PolicyRulesWithSubjects

PolicyRulesWithSubjects prescribes a test that applies to a request to an apiserver. The test considers the subject making the request, the verb being requested, and the resource to be acted upon. This PolicyRulesWithSubjects matches a request if and only if both (a) at least one member of subjects matches the request and (b) at least one member of resourceRules or nonResourceRules matches the request.

Source

Property	Type	Description
`nonResourceRules`	V1NonResourcePolicyRule[]	`nonResourceRules` is a list of NonResourcePolicyRules that identify matching requests according to their verb and the target non-resource URL.
`resourceRules`	V1ResourcePolicyRule[]	`resourceRules` is a slice of ResourcePolicyRules that identify matching requests according to their verb and the target resource. At least one of `resourceRules` and `nonResourceRules` has to be...
`subjects`	`FlowcontrolV1Subject[]`	subjects is the list of normal user, serviceaccount, or group that this rule cares about. There must be at least one member in this slice. A slice that includes both the system:authenticated and...

V1PortStatus

PortStatus represents the error condition of a service port

Source

Property	Type	Description
`error`	`string`	Error is to record the problem with the service port The format of the error shall comply with the following rules: - built-in error values shall be specified in this file and those shall use ...
`port`	`number`	Port is the port number of the service port of which status is recorded here
`protocol`	`string`	Protocol is the protocol of the service port of which status is recorded here The supported values are: "TCP", "UDP", "SCTP"

V1PortworxVolumeSource

PortworxVolumeSource represents a Portworx volume resource.

Source

Property	Type	Description
`fsType`	`string`	fSType represents the filesystem type to mount Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs". Implicitly inferred to be "ext4" if unspecified.
`readOnly`	`boolean`	readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
`volumeID`	`string`	volumeID uniquely identifies a Portworx volume

V1Preconditions

Preconditions must be fulfilled before an operation (update, delete, etc.) is carried out.

Source

Property	Type	Description
`resourceVersion`	`string`	Specifies the target ResourceVersion
`uid`	`string`	Specifies the target UID.

V1PreferredSchedulingTerm

An empty preferred scheduling term matches all objects with implicit weight 0 (i.e. it's a no-op). A null preferred scheduling term matches no objects (i.e. is also a no-op).

Source

Property	Type	Description
`weight`	`number`	Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100.
`preference`	V1NodeSelectorTerm

V1Probe

Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.

Source

Property	Type	Description
`failureThreshold`	`number`	Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.
`initialDelaySeconds`	`number`	Number of seconds after the container has started before liveness probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
`periodSeconds`	`number`	How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.
`successThreshold`	`number`	Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.
`terminationGracePeriodSeconds`	`number`	Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal...
`timeoutSeconds`	`number`	Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
`exec`	V1ExecAction
`grpc`	V1GRPCAction
`httpGet`	V1HTTPGetAction
`tcpSocket`	V1TCPSocketAction

V1ProjectedVolumeSource

Represents a projected volume source

Source

Property	Type	Description
`defaultMode`	`number`	defaultMode are the 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...
`sources`	V1VolumeProjection[]	sources is the list of volume projections. Each entry in this list handles one source.

V1QueuingConfiguration

QueuingConfiguration holds the configuration parameters for queuing

Source

Property	Type	Description
`handSize`	`number`	`handSize` is a small positive number that configures the shuffle sharding of requests into queues. When enqueuing a request at this priority level the request's flow identifier (a string pair) is...
`queueLengthLimit`	`number`	`queueLengthLimit` is the maximum number of requests allowed to be waiting in a given queue of this priority level at a time; excess requests are rejected. This value must be positive. If not...
`queues`	`number`	`queues` is the number of queues for this priority level. The queues exist independently at each apiserver. The value must be positive. Setting it to 1 effectively precludes shufflesharding and thus...

V1QuobyteVolumeSource

Represents a Quobyte mount that lasts the lifetime of a pod. Quobyte volumes do not support ownership management or SELinux relabeling.

Source

Property	Type	Description
`group`	`string`	group to map volume access to Default is no group
`readOnly`	`boolean`	readOnly here will force the Quobyte volume to be mounted with read-only permissions. Defaults to false.
`registry`	`string`	registry represents a single or multiple Quobyte Registry services specified as a string as host:port pair (multiple entries are separated with commas) which acts as the central registry for volumes
`tenant`	`string`	tenant owning the given Quobyte volume in the Backend Used with dynamically provisioned Quobyte volumes, value is set by the plugin
`user`	`string`	user to map volume access to Defaults to serivceaccount user
`volume`	`string`	volume is a string that references an already created Quobyte volume by name.

V1RBDPersistentVolumeSource

Represents a Rados Block Device mount that lasts the lifetime of a pod. RBD volumes support ownership management and SELinux relabeling.

Source

Property	Type	Description
`fsType`	`string`	fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly...
`image`	`string`	image is the rados image name. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
`keyring`	`string`	keyring is the path to key ring for RBDUser. Default is /etc/ceph/keyring. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
`monitors`	`string[]`	monitors is a collection of Ceph monitors. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
`pool`	`string`	pool is the rados pool name. Default is rbd. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
`readOnly`	`boolean`	readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
`user`	`string`	user is the rados user name. Default is admin. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
`secretRef`	V1SecretReference

V1RBDVolumeSource

Represents a Rados Block Device mount that lasts the lifetime of a pod. RBD volumes support ownership management and SELinux relabeling.

Source

Property	Type	Description
`fsType`	`string`	fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly...
`image`	`string`	image is the rados image name. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
`keyring`	`string`	keyring is the path to key ring for RBDUser. Default is /etc/ceph/keyring. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
`monitors`	`string[]`	monitors is a collection of Ceph monitors. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
`pool`	`string`	pool is the rados pool name. Default is rbd. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
`readOnly`	`boolean`	readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
`user`	`string`	user is the rados user name. Default is admin. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
`secretRef`	V1LocalObjectReference

V1ResourceAttributes

ResourceAttributes includes the authorization attributes available for resource requests to the Authorizer interface

Source

Property	Type	Description
`group`	`string`	Group is the API Group of the Resource. "*" means all.
`name`	`string`	Name is the name of the resource being requested for a "get" or deleted for a "delete". "" (empty) means all.
`namespace`	`string`	Namespace is the namespace of the action being requested. Currently, there is no distinction between no namespace and all namespaces "" (empty) is defaulted for LocalSubjectAccessReviews ""...
`resource`	`string`	Resource is one of the existing resource types. "*" means all.
`subresource`	`string`	Subresource is one of the existing resource types. "" means none.
`verb`	`string`	Verb is a kubernetes resource API verb, like: get, list, watch, create, update, delete, proxy. "*" means all.
`version`	`string`	Version is the API Version of the Resource. "*" means all.
`fieldSelector`	V1FieldSelectorAttributes
`labelSelector`	V1LabelSelectorAttributes

V1ResourceClaim

ResourceClaim references one entry in PodSpec.ResourceClaims.

Source

Property	Type	Description
`name`	`string`	Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container.
`request`	`string`	Request is the name chosen for a request in the referenced claim. If empty, everything from the claim is made available, otherwise only the result of this request.

V1ResourceClaimList

ResourceClaimList is a collection of claims.

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`	`ResourceV1ResourceClaim[]`	Items is the list of resource claims.
`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.ResourceV1Api);

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

Used by: ResourceV1Api.listNamespacedResourceClaim · ResourceV1Api.listResourceClaimForAllNamespaces

V1ResourceClaimSpec

ResourceClaimSpec defines what is being requested in a ResourceClaim and how to configure it.

Source

Property	Type	Description
`devices`	V1DeviceClaim

V1ResourceClaimTemplate

ResourceClaimTemplate is used to produce ResourceClaim objects. This is an alpha type and requires enabling the DynamicResourceAllocation feature gate.

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`	V1ResourceClaimTemplateSpec

Example

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

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

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

Used by: ResourceV1Api.createNamespacedResourceClaimTemplate · ResourceV1Api.patchNamespacedResourceClaimTemplate · ResourceV1Api.readNamespacedResourceClaimTemplate

V1ResourceClaimTemplateList

ResourceClaimTemplateList is a collection of claim templates.

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`	V1ResourceClaimTemplate[]	Items is the list of resource claim 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.ResourceV1Api);

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

Used by: ResourceV1Api.listNamespacedResourceClaimTemplate · ResourceV1Api.listResourceClaimTemplateForAllNamespaces

V1ResourceClaimTemplateSpec

ResourceClaimTemplateSpec contains the metadata and fields for a ResourceClaim.

Source

Property	Type	Description
`metadata`	V1ObjectMeta
`spec`	V1ResourceClaimSpec

V1ResourceFieldSelector

ResourceFieldSelector represents container resources (cpu, memory) and their output format

Source

Property	Type	Description
`containerName`	`string`	Container name: required for volumes, optional for env vars
`divisor`	`string`	Specifies the output format of the exposed resources, defaults to "1"
`resource`	`string`	Required: resource to select

V1ResourceHealth

ResourceHealth represents the health of a resource. It has the latest device health information. This is a part of KEP https://kep.k8s.io/4680.

Source

Property	Type	Description
`health`	`string`	Health of the resource. can be one of: - Healthy: operates as normal - Unhealthy: reported unhealthy. We consider this a temporary health issue since we do not have a mechanism today...
`resourceID`	`string`	ResourceID is the unique identifier of the resource. See the ResourceID type for more information.

V1ResourcePolicyRule

ResourcePolicyRule is a predicate that matches some resource requests, testing the request's verb and the target resource. A ResourcePolicyRule matches a resource request if and only if: (a) at least one member of verbs matches the request, (b) at least one member of apiGroups matches the request, (c) at least one member of resources matches the request, and (d) either (d1) the request does not specify a namespace (i.e., Namespace==\"\") and clusterScope is true or (d2) the request specifies a namespace and least one member of namespaces matches the request's namespace.

Source

Property	Type	Description
`apiGroups`	`string[]`	`apiGroups` is a list of matching API groups and may not be empty. "*" matches all API groups and, if present, must be the only entry. Required.
`clusterScope`	`boolean`	`clusterScope` indicates whether to match requests that do not specify a namespace (which happens either because the resource is not namespaced or the request targets all namespaces). If this field...
`namespaces`	`string[]`	`namespaces` is a list of target namespaces that restricts matches. A request that specifies a target namespace matches only if either (a) this list contains that target namespace or (b) this list...
`resources`	`string[]`	`resources` is a list of matching resources (i.e., lowercase and plural) with, if desired, subresource. For example, [ "services", "nodes/status" ]. This list may not be empty. "*" matches...
`verbs`	`string[]`	`verbs` is a list of matching verbs and may not be empty. "*" matches all verbs and, if present, must be the only entry. Required.

V1ResourcePool

ResourcePool describes the pool that ResourceSlices belong to.

Source

Property	Type	Description
`generation`	`number`	Generation tracks the change in a pool over time. Whenever a driver changes something about one or more of the resources in a pool, it must change the generation in all ResourceSlices which are part...
`name`	`string`	Name is used to identify the pool. For node-local devices, this is often the node name, but this is not required. It must not be longer than 253 characters and must consist of one or more DNS...
`resourceSliceCount`	`number`	ResourceSliceCount is the total number of ResourceSlices in the pool at this generation number. Must be greater than zero. Consumers can use this to check whether they have seen all ResourceSlices...

V1ResourceRequirements

ResourceRequirements describes the compute resource requirements.

Source

Property	Type	Description
`claims`	`CoreV1ResourceClaim[]`	Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. This field depends on the DynamicResourceAllocation feature gate. This field is immutable. It...
`limits`	`{ [key: string]: string`	Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
`requests`	`{ [key: string]: string`	Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an...

V1ResourceRule

ResourceRule is the list of actions the subject is allowed to perform on resources. The list ordering isn't significant, may contain duplicates, and possibly be incomplete.

Source

Property	Type	Description
`apiGroups`	`string[]`	APIGroups is the name of the APIGroup that contains the resources. If multiple API groups are specified, any action requested against one of the enumerated resources in any API group will be...
`resourceNames`	`string[]`	ResourceNames is an optional white list of names that the rule applies to. An empty set means that everything is allowed. "*" means all.
`resources`	`string[]`	Resources is a list of resources this rule applies to. "" means all in the specified apiGroups. "_/foo" represents the subresource 'foo' for all resources in the specified apiGroups.
`verbs`	`string[]`	Verb is a list of kubernetes resource API verbs, like: get, list, watch, create, update, delete, proxy. "*" means all.

V1ResourceSlice

ResourceSlice represents one or more resources in a pool of similar resources, managed by a common driver. A pool may span more than one ResourceSlice, and exactly how many ResourceSlices comprise a pool is determined by the driver. At the moment, the only supported resources are devices with attributes and capacities. Each device in a given pool, regardless of how many ResourceSlices, must have a unique name. The ResourceSlice in which a device gets published may change over time. The unique identifier for a device is the tuple , , . Whenever a driver needs to update a pool, it increments the pool.Spec.Pool.Generation number and updates all ResourceSlices with that new number and new resource definitions. A consumer must only use ResourceSlices with the highest generation number and ignore all others. When allocating all resources in a pool matching certain criteria or when looking for the best solution among several different alternatives, a consumer should check the number of ResourceSlices in a pool (included in each ResourceSlice) to determine whether its view of a pool is complete and if not, should wait until the driver has completed updating the pool. For resources that are not local to a node, the node name is not set. Instead, the driver may use a node selector to specify where the devices are available. This is an alpha type and requires enabling the DynamicResourceAllocation feature gate.

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`	V1ResourceSliceSpec

Example

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

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

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

Used by: ResourceV1Api.createResourceSlice · ResourceV1Api.patchResourceSlice · ResourceV1Api.readResourceSlice

V1ResourceSliceList

ResourceSliceList is a collection of ResourceSlices.

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`	V1ResourceSlice[]	Items is the list of resource ResourceSlices.
`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.ResourceV1Api);

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

Used by: ResourceV1Api.listResourceSlice

V1ResourceSliceSpec

ResourceSliceSpec contains the information published by the driver in one ResourceSlice.

Source

Property	Type	Description
`allNodes`	`boolean`	AllNodes indicates that all nodes have access to the resources in the pool. Exactly one of NodeName, NodeSelector, AllNodes, and PerDeviceNodeSelection must be set.
`devices`	V1Device[]	Devices lists some or all of the devices in this pool. Must not have more than 128 entries. If any device uses taints or consumes counters the limit is 64. Only one of Devices and SharedCounters...
`driver`	`string`	Driver identifies the DRA driver providing the capacity information. A field selector can be used to list only ResourceSlice objects with a certain driver name. Must be a DNS subdomain and should...
`nodeName`	`string`	NodeName identifies the node which provides the resources in this pool. A field selector can be used to list only ResourceSlice objects belonging to a certain node. This field can be used to limit...
`perDeviceNodeSelection`	`boolean`	PerDeviceNodeSelection defines whether the access from nodes to resources in the pool is set on the ResourceSlice level or on each device. If it is set to true, every device defined the ResourceSlice...
`sharedCounters`	V1CounterSet[]	SharedCounters defines a list of counter sets, each of which has a name and a list of counters available. The names of the counter sets must be unique in the ResourcePool. Only one of Devices and...
`nodeSelector`	V1NodeSelector
`pool`	V1ResourcePool

V1ResourceStatus

ResourceStatus represents the status of a single resource allocated to a Pod.

Source

Property	Type	Description
`name`	`string`	Name of the resource. Must be unique within the pod and in case of non-DRA resource, match one of the resources from the pod spec. For DRA resources, the value must be...
`resources`	V1ResourceHealth[]	List of unique resources health. Each element in the list contains an unique resource ID and its health. At a minimum, for the lifetime of a Pod, resource ID must uniquely identify the resource...

V1RollingUpdateDaemonSet

Spec to control the desired behavior of daemon set rolling update.

Source

Property	Type	Description
`maxSurge`	`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...
`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...

V1RollingUpdateDeployment

Spec to control the desired behavior of rolling update.

Source

Property	Type	Description
`maxSurge`	`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...
`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...

V1RollingUpdateStatefulSetStrategy

RollingUpdateStatefulSetStrategy is used to communicate parameter for RollingUpdateStatefulSetStrategyType.

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...
`partition`	`number`	Partition indicates the ordinal at which the StatefulSet should be partitioned for updates. During a rolling update, all pods from ordinal Replicas-1 to Partition are updated. All pods from ordinal...

V1RuleWithOperations

RuleWithOperations is a tuple of Operations and Resources. It is recommended to make sure that all the tuple expansions are valid.

Source

Property	Type	Description
`apiGroups`	`string[]`	APIGroups is the API groups the resources belong to. '' is all groups. If '' is present, the length of the slice must be one. Required.
`apiVersions`	`string[]`	APIVersions is the API versions the resources belong to. '' is all versions. If '' is present, the length of the slice must be one. Required.
`operations`	`string[]`	Operations is the operations the admission hook cares about - CREATE, UPDATE, DELETE, CONNECT or * for all of those operations and any future admission operations that are added. If '*' is present,...
`resources`	`string[]`	Resources is a list of resources this rule applies to. For example: 'pods' means pods. 'pods/log' means the log subresource of pods. '' means all resources, but not subresources. 'pods/_'...
`scope`	`string`	scope specifies the scope of this rule. Valid values are "Cluster", "Namespaced", and "*" "Cluster" means that only cluster-scoped resources will match this rule. Namespace API objects are...

V1RuntimeClass

RuntimeClass defines a class of container runtime supported in the cluster. The RuntimeClass is used to determine which container runtime is used to run all containers in a pod. RuntimeClasses are manually defined by a user or cluster provisioner, and referenced in the PodSpec. The Kubelet is responsible for resolving the RuntimeClassName reference before running the pod. For more details, see https://kubernetes.io/docs/concepts/containers/runtime-class/

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:...
`handler`	`string`	handler specifies the underlying runtime and configuration that the CRI implementation will use to handle pods of this class. The possible values are specific to the node & CRI configuration. It is...
`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
`overhead`	V1Overhead
`scheduling`	V1Scheduling

Example

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

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

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

Used by: NodeV1Api.createRuntimeClass · NodeV1Api.patchRuntimeClass · NodeV1Api.readRuntimeClass

V1RuntimeClassList

RuntimeClassList is a list of RuntimeClass 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`	V1RuntimeClass[]	items is a list of schema 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.NodeV1Api);

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

Used by: NodeV1Api.listRuntimeClass

V1SELinuxOptions

SELinuxOptions are the labels to be applied to the container

Source

Property	Type	Description
`level`	`string`	Level is SELinux level label that applies to the container.
`role`	`string`	Role is a SELinux role label that applies to the container.
`type`	`string`	Type is a SELinux type label that applies to the container.
`user`	`string`	User is a SELinux user label that applies to the container.

V1ScopeSelector

A scope selector represents the AND of the selectors represented by the scoped-resource selector requirements.

Source

Property	Type	Description
`matchExpressions`	V1ScopedResourceSelectorRequirement[]	A list of scope selector requirements by scope of the resources.

V1ScopedResourceSelectorRequirement

A scoped-resource selector requirement is a selector that contains values, a scope name, and an operator that relates the scope name and values.

Source

Property	Type	Description
`operator`	`string`	Represents a scope's relationship to a set of values. Valid operators are In, NotIn, Exists, DoesNotExist.
`scopeName`	`string`	The name of the scope that the selector applies to.
`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. This array is replaced during...

V1SeccompProfile

SeccompProfile defines a pod/container's seccomp profile settings. Only one profile source may be set.

Source

Property	Type	Description
`localhostProfile`	`string`	localhostProfile indicates a profile defined in a file on the node should be used. The profile must be preconfigured on the node to work. Must be a descending path, relative to the kubelet's...
`type`	`string`	type indicates which kind of seccomp profile will be applied. Valid options are: Localhost - a profile defined in a file on the node should be used. RuntimeDefault - the container runtime default...

V1SecurityContext

SecurityContext holds security configuration that will be applied to a container. Some fields are present in both SecurityContext and PodSecurityContext. When both are set, the values in SecurityContext take precedence.

Source

Property	Type	Description
`allowPrivilegeEscalation`	`boolean`	AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process. This bool directly controls if the no_new_privs flag will be set on the container process....
`privileged`	`boolean`	Run container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false. Note that this field cannot be set when spec.os.name is windows.
`procMount`	`string`	procMount denotes the type of proc mount to use for the containers. The default value is Default which uses the container runtime defaults for readonly paths and masked paths. This requires the...
`readOnlyRootFilesystem`	`boolean`	Whether this container has a read-only root filesystem. Default is false. Note that this field cannot be set when spec.os.name is windows.
`runAsGroup`	`number`	The GID to run the entrypoint of the container process. Uses runtime default if unset. May also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, the value...
`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 PodSecurityContext. If set in both SecurityContext and...
`appArmorProfile`	V1AppArmorProfile
`capabilities`	V1Capabilities
`seLinuxOptions`	V1SELinuxOptions
`seccompProfile`	V1SeccompProfile
`windowsOptions`	V1WindowsSecurityContextOptions

V1SelectableField

SelectableField specifies the JSON path of a field that may be used with field selectors.

Source

Property	Type	Description
`jsonPath`	`string`	jsonPath is a simple JSON path which is evaluated against each custom resource to produce a field selector value. Only JSON paths without the array notation are allowed. Must point to a field of type...

V1SelfSubjectReview

SelfSubjectReview contains the user information that the kube-apiserver has about the user making this request. When using impersonation, users will receive the user info of the user being impersonated. If impersonation or request header authentication is used, any extra keys will have their case ignored and returned as lowercase.

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
`status`	V1SelfSubjectReviewStatus

Example

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

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

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

Used by: AuthenticationV1Api.createSelfSubjectReview

V1SelfSubjectReviewStatus

SelfSubjectReviewStatus is filled by the kube-apiserver and sent back to a user.

Source

Property	Type	Description
`userInfo`	V1UserInfo

V1SessionAffinityConfig

SessionAffinityConfig represents the configurations of session affinity.

Source

Property	Type	Description
`clientIP`	V1ClientIPConfig

V1SleepAction

SleepAction describes a "sleep" action.

Source

Property	Type	Description
`seconds`	`number`	Seconds is the number of seconds to sleep.

V1Status

Status is a return value for calls that don't return other 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:...
`code`	`number`	Suggested HTTP return code for this status, 0 if not set.
`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:...
`message`	`string`	A human-readable description of the status of this operation.
`reason`	`string`	A machine-readable description of why this operation is in the "Failure" status. If this value is empty there is no information available. A Reason clarifies an HTTP status code but does not...
`status`	`string`	Status of the operation. One of: "Success" or "Failure". More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
`details`	V1StatusDetails
`metadata`	V1ListMeta

and 80 more…

V1StatusCause

StatusCause provides more information about an api.Status failure, including cases when multiple errors are encountered.

Source

Property	Type	Description
`field`	`string`	The field of the resource that has caused this error, as named by its JSON serialization. May include dot and postfix notation for nested attributes. Arrays are zero-indexed. Fields may appear more...
`message`	`string`	A human-readable description of the cause of the error. This field may be presented as-is to a reader.
`reason`	`string`	A machine-readable description of the cause of the error. If this value is empty there is no information available.

V1StatusDetails

StatusDetails is a set of additional properties that MAY be set by the server to provide additional information about a response. The Reason field of a Status object defines what attributes will be set. Clients must ignore fields that do not match the defined type of each attribute, and should assume that any attribute may be empty, invalid, or under defined.

Source

Property	Type	Description
`causes`	V1StatusCause[]	The Causes array includes more details associated with the StatusReason failure. Not all StatusReasons may provide detailed causes.
`group`	`string`	The group attribute of the resource associated with the status StatusReason.
`kind`	`string`	The kind attribute of the resource associated with the status StatusReason. On some operations may differ from the requested resource Kind. More info:...
`name`	`string`	The name attribute of the resource associated with the status StatusReason (when there is a single name which can be described).
`retryAfterSeconds`	`number`	If specified, the time in seconds before the operation should be retried. Some errors may indicate the client must take an alternate action - for those errors this field may indicate how long to wait...
`uid`	`string`	UID of the resource. (when there is a single resource which can be described). More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids

V1StorageOSPersistentVolumeSource

Represents a StorageOS persistent volume resource.

Source

Property	Type	Description
`fsType`	`string`	fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
`readOnly`	`boolean`	readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
`volumeName`	`string`	volumeName is the human-readable name of the StorageOS volume. Volume names are only unique within a namespace.
`volumeNamespace`	`string`	volumeNamespace specifies the scope of the volume within StorageOS. If no namespace is specified then the Pod's namespace will be used. This allows the Kubernetes name scoping to be mirrored...
`secretRef`	V1ObjectReference

V1StorageOSVolumeSource

Represents a StorageOS persistent volume resource.

Source

Property	Type	Description
`fsType`	`string`	fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
`readOnly`	`boolean`	readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.
`volumeName`	`string`	volumeName is the human-readable name of the StorageOS volume. Volume names are only unique within a namespace.
`volumeNamespace`	`string`	volumeNamespace specifies the scope of the volume within StorageOS. If no namespace is specified then the Pod's namespace will be used. This allows the Kubernetes name scoping to be mirrored...
`secretRef`	V1LocalObjectReference

V1SubjectRulesReviewStatus

SubjectRulesReviewStatus contains the result of a rules check. This check can be incomplete depending on the set of authorizers the server is configured with and any errors experienced during evaluation. Because authorization rules are additive, if a rule appears in a list it's safe to assume the subject has that permission, even if that list is incomplete.

Source

Property	Type	Description
`evaluationError`	`string`	EvaluationError can appear in combination with Rules. It indicates an error occurred during rule evaluation, such as an authorizer that doesn't support rule evaluation, and that ResourceRules and/or...
`incomplete`	`boolean`	Incomplete is true when the rules returned by this call are incomplete. This is most commonly encountered when an authorizer, such as an external authorizer, doesn't support rules evaluation.
`nonResourceRules`	V1NonResourceRule[]	NonResourceRules is the list of actions the subject is allowed to perform on non-resources. The list ordering isn't significant, may contain duplicates, and possibly be incomplete.
`resourceRules`	V1ResourceRule[]	ResourceRules is the list of actions the subject is allowed to perform on resources. The list ordering isn't significant, may contain duplicates, and possibly be incomplete.

V1SuccessPolicy

SuccessPolicy describes when a Job can be declared as succeeded based on the success of some indexes.

Source

Property	Type	Description
`rules`	V1SuccessPolicyRule[]	rules represents the list of alternative rules for the declaring the Jobs as successful before `.status.succeeded >= .spec.completions`. Once any of the rules are met, the "SuccessCriteriaMet"...

V1SuccessPolicyRule

SuccessPolicyRule describes rule for declaring a Job as succeeded. Each rule must have at least one of the "succeededIndexes" or "succeededCount" specified.

Source

Property	Type	Description
`succeededCount`	`number`	succeededCount specifies the minimal required size of the actual set of the succeeded indexes for the Job. When succeededCount is used along with succeededIndexes, the check is constrained only to...
`succeededIndexes`	`string`	succeededIndexes specifies the set of indexes which need to be contained in the actual set of the succeeded indexes for the Job. The list of indexes must be within 0 to ".spec.completions-1" and...

V1Sysctl

Sysctl defines a kernel parameter to be set

Source

Property	Type	Description
`name`	`string`	Name of a property to set
`value`	`string`	Value of a property to set

V1TCPSocketAction

TCPSocketAction describes an action based on opening a socket

Source

Property	Type	Description
`host`	`string`	Optional: Host name to connect to, defaults to the pod IP.
`port`	`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...

V1Taint

The node this Taint is attached to has the "effect" on any pod that does not tolerate the Taint.

Source

Property	Type	Description
`effect`	`string`	Required. The effect of the taint on pods that do not tolerate the taint. Valid effects are NoSchedule, PreferNoSchedule and NoExecute.
`key`	`string`	Required. The taint key to be applied to a node.
`timeAdded`	`Date`	TimeAdded represents the time at which the taint was added.
`value`	`string`	The taint value corresponding to the taint key.

V1Toleration

The pod this Toleration is attached to tolerates any taint that matches the triple <key,value,effect> using the matching operator .

Source

Property	Type	Description
`effect`	`string`	Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.
`key`	`string`	Key is the taint key that the toleration applies to. Empty means match all taint keys. If the key is empty, operator must be Exists; this combination means to match all values and all keys.
`operator`	`string`	Operator represents a key's relationship to the value. Valid operators are Exists, Equal, Lt, and Gt. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all...
`tolerationSeconds`	`number`	TolerationSeconds represents the period of time the toleration (which must be of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, it is not set, which means...
`value`	`string`	Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string.

V1TopologySelectorLabelRequirement

A topology selector requirement is a selector that matches given label. This is an alpha feature and may change in the future.

Source

Property	Type	Description
`key`	`string`	The label key that the selector applies to.
`values`	`string[]`	An array of string values. One value must match the label to be selected. Each entry in Values is ORed.

V1TopologySelectorTerm

A topology selector term represents the result of label queries. A null or empty topology selector term matches no objects. The requirements of them are ANDed. It provides a subset of functionality as NodeSelectorTerm. This is an alpha feature and may change in the future.

Source

Property	Type	Description
`matchLabelExpressions`	V1TopologySelectorLabelRequirement[]	A list of topology selector requirements by labels.

V1TopologySpreadConstraint

TopologySpreadConstraint specifies how to spread matching pods among the given topology.

Source

Property	Type	Description
`matchLabelKeys`	`string[]`	MatchLabelKeys is a set of pod label keys to select the pods over which spreading will be calculated. The keys are used to lookup values from the incoming pod labels, those key-value labels are ANDed...
`maxSkew`	`number`	MaxSkew describes the degree to which pods may be unevenly distributed. When `whenUnsatisfiable=DoNotSchedule`, it is the maximum permitted difference between the number of matching pods in the...
`minDomains`	`number`	MinDomains indicates a minimum number of eligible domains. When the number of eligible domains with matching topology keys is less than minDomains, Pod Topology Spread treats "global minimum" as 0,...
`nodeAffinityPolicy`	`string`	NodeAffinityPolicy indicates how we will treat Pod's nodeAffinity/nodeSelector when calculating pod topology spread skew. Options are: - Honor: only nodes matching nodeAffinity/nodeSelector are...
`nodeTaintsPolicy`	`string`	NodeTaintsPolicy indicates how we will treat node taints when calculating pod topology spread skew. Options are: - Honor: nodes without taints, along with tainted nodes for which the incoming pod has...
`topologyKey`	`string`	TopologyKey is the key of node labels. Nodes that have a label with this key and identical values are considered to be in the same topology. We consider each <key, value> as a "bucket", and try to...
`whenUnsatisfiable`	`string`	WhenUnsatisfiable indicates how to deal with a pod if it doesn't satisfy the spread constraint. - DoNotSchedule (default) tells the scheduler not to schedule it. - ScheduleAnyway tells the scheduler...
`labelSelector`	V1LabelSelector

V1TypeChecking

TypeChecking contains results of type checking the expressions in the ValidatingAdmissionPolicy

Source

Property	Type	Description
`expressionWarnings`	V1ExpressionWarning[]	The type checking warnings for each expression.

V1TypedLocalObjectReference

TypedLocalObjectReference contains enough information to let you locate the typed referenced object inside the same namespace.

Source

Property	Type	Description
`apiGroup`	`string`	APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.
`kind`	`string`	Kind is the type of resource being referenced
`name`	`string`	Name is the name of resource being referenced

V1TypedObjectReference

TypedObjectReference contains enough information to let you locate the typed referenced object

Source

Property	Type	Description
`apiGroup`	`string`	APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.
`kind`	`string`	Kind is the type of resource being referenced
`name`	`string`	Name is the name of resource being referenced
`namespace`	`string`	Namespace is the namespace of resource being referenced Note that when a namespace is specified, a gateway.networking.k8s.io/ReferenceGrant object is required in the referent namespace to allow that...

V1UncountedTerminatedPods

UncountedTerminatedPods holds UIDs of Pods that have terminated but haven't been accounted in Job status counters.

Source

Property	Type	Description
`failed`	`string[]`	failed holds UIDs of failed Pods.
`succeeded`	`string[]`	succeeded holds UIDs of succeeded Pods.

V1UserInfo

UserInfo holds the information about the user needed to implement the user.Info interface.

Source

Property	Type	Description
`extra`	`{ [key: string]: string[]`	Any additional information provided by the authenticator.
`groups`	`string[]`	The names of groups this user is a part of.
`uid`	`string`	A unique value that identifies this user across time. If this user is deleted and another user by the same name is added, they will have different UIDs.
`username`	`string`	The name that uniquely identifies this user among all active users.

V1ValidatingWebhook

ValidatingWebhook describes an admission webhook and the resources and operations it applies to.

Source

Property	Type	Description
`admissionReviewVersions`	`string[]`	AdmissionReviewVersions is an ordered list of preferred `AdmissionReview` versions the Webhook expects. API server will try to use first version in the list which it supports. If none of the versions...
`failurePolicy`	`string`	FailurePolicy defines how unrecognized errors from the admission endpoint are handled - allowed values are Ignore or Fail. Defaults to Fail.
`matchConditions`	V1MatchCondition[]	MatchConditions is a list of conditions that must be met for a request to be sent to this webhook. Match conditions filter requests that have already been matched by the rules, namespaceSelector, and...
`matchPolicy`	`string`	matchPolicy defines how the "rules" list is used to match incoming requests. Allowed values are "Exact" or "Equivalent". - Exact: match a request only if it exactly matches a specified rule....
`name`	`string`	The name of the admission webhook. Name should be fully qualified, e.g., imagepolicy.kubernetes.io, where "imagepolicy" is the name of the webhook, and kubernetes.io is the name of the...
`rules`	V1RuleWithOperations[]	Rules describes what operations on what resources/subresources the webhook cares about. The webhook cares about an operation if it matches any Rule. However, in order to prevent...
`sideEffects`	`string`	SideEffects states whether this webhook has side effects. Acceptable values are: None, NoneOnDryRun (webhooks created via v1beta1 may also specify Some or Unknown). Webhooks with side effects MUST...
`timeoutSeconds`	`number`	TimeoutSeconds specifies the timeout for this webhook. After the timeout passes, the webhook call will be ignored or the API call will fail based on the failure policy. The timeout value must be...
`clientConfig`	`AdmissionregistrationV1WebhookClientConfig`
`namespaceSelector`	V1LabelSelector
`objectSelector`	V1LabelSelector

V1Validation

Validation specifies the CEL expression which is used to apply the validation.

Source

Property	Type	Description
`expression`	`string`	Expression represents the expression which will be evaluated by CEL. ref: https://github.com/google/cel-spec CEL expressions have access to the contents of the API request/response, organized into...
`message`	`string`	Message represents the message displayed when validation fails. The message is required if the Expression contains line breaks. The message must not contain line breaks. If unset, the message is...
`messageExpression`	`string`	messageExpression declares a CEL expression that evaluates to the validation failure message that is returned when this rule fails. Since messageExpression is used as a failure message, it must...
`reason`	`string`	Reason represents a machine-readable description of why this validation failed. If this is the first validation in the list to fail, this reason, as well as the corresponding HTTP response code, are...

V1ValidationRule

ValidationRule describes a validation rule written in the CEL expression language.

Source

Property	Type	Description
`fieldPath`	`string`	fieldPath represents the field path returned when the validation fails. It must be a relative JSON path (i.e. with array notation) scoped to the location of this x-kubernetes-validations extension in...
`message`	`string`	Message represents the message displayed when validation fails. The message is required if the Rule contains line breaks. The message must not contain line breaks. If unset, the message is "failed...
`messageExpression`	`string`	MessageExpression declares a CEL expression that evaluates to the validation failure message that is returned when this rule fails. Since messageExpression is used as a failure message, it must...
`optionalOldSelf`	`boolean`	optionalOldSelf is used to opt a transition rule into evaluation even when the object is first created, or if the old object is missing the value. When enabled `oldSelf` will be a CEL optional whose...
`reason`	`string`	reason provides a machine-readable validation failure reason that is returned to the caller when a request fails this validation rule. The HTTP status code returned to the caller will match the...
`rule`	`string`	Rule represents the expression which will be evaluated by CEL. ref: https://github.com/google/cel-spec The Rule is scoped to the location of the x-kubernetes-validations extension in the schema. The...

V1Variable

Variable is the definition of a variable that is used for composition. A variable is defined as a named expression.

Source

Property	Type	Description
`expression`	`string`	Expression is the expression that will be evaluated as the value of the variable. The CEL expression has access to the same identifiers as the CEL expressions in Validation.
`name`	`string`	Name is the name of the variable. The name must be a valid CEL identifier and unique among all variables. The variable can be accessed in other expressions through `variables` For example, if name is...

V1Volume

Volume represents a named volume in a pod that may be accessed by any container in the pod.

Source

Property	Type	Description
`name`	`string`	name of the volume. Must be a DNS_LABEL and unique within the pod. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
`awsElasticBlockStore`	V1AWSElasticBlockStoreVolumeSource
`azureDisk`	V1AzureDiskVolumeSource
`azureFile`	V1AzureFileVolumeSource
`cephfs`	V1CephFSVolumeSource
`cinder`	V1CinderVolumeSource
`configMap`	V1ConfigMapVolumeSource
`csi`	V1CSIVolumeSource
`downwardAPI`	V1DownwardAPIVolumeSource
`emptyDir`	V1EmptyDirVolumeSource
`ephemeral`	V1EphemeralVolumeSource
`fc`	V1FCVolumeSource
`flexVolume`	V1FlexVolumeSource
`flocker`	V1FlockerVolumeSource
`gcePersistentDisk`	V1GCEPersistentDiskVolumeSource
`gitRepo`	V1GitRepoVolumeSource
`glusterfs`	V1GlusterfsVolumeSource
`hostPath`	V1HostPathVolumeSource
`image`	V1ImageVolumeSource
`iscsi`	V1ISCSIVolumeSource
`nfs`	V1NFSVolumeSource
`persistentVolumeClaim`	V1PersistentVolumeClaimVolumeSource
`photonPersistentDisk`	V1PhotonPersistentDiskVolumeSource
`portworxVolume`	V1PortworxVolumeSource
`projected`	V1ProjectedVolumeSource
`quobyte`	V1QuobyteVolumeSource
`rbd`	V1RBDVolumeSource
`scaleIO`	V1ScaleIOVolumeSource
`secret`	V1SecretVolumeSource
`storageos`	V1StorageOSVolumeSource
`vsphereVolume`	V1VsphereVirtualDiskVolumeSource

V1VolumeAttributesClass

VolumeAttributesClass represents a specification of mutable volume attributes defined by the CSI driver. The class can be specified during dynamic provisioning of PersistentVolumeClaims, and changed in the PersistentVolumeClaim spec after provisioning.

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:...
`driverName`	`string`	Name of the CSI driver This field is immutable.
`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:...
`parameters`	`{ [key: string]: string`	parameters hold volume attributes defined by the CSI driver. These values are opaque to the Kubernetes and are passed directly to the CSI driver. The underlying storage provider supports changing...
`metadata`	V1ObjectMeta

Example

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

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

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

Used by: StorageV1Api.createVolumeAttributesClass · StorageV1Api.patchVolumeAttributesClass · StorageV1Api.readVolumeAttributesClass

V1VolumeAttributesClassList

VolumeAttributesClassList is a collection of VolumeAttributesClass 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`	V1VolumeAttributesClass[]	items is the list of VolumeAttributesClass 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.StorageV1Api);

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

Used by: StorageV1Api.listVolumeAttributesClass

V1VolumeDevice

volumeDevice describes a mapping of a raw block device within a container.

Source

Property	Type	Description
`devicePath`	`string`	devicePath is the path inside of the container that the device will be mapped to.
`name`	`string`	name must match the name of a persistentVolumeClaim in the pod

V1VolumeError

VolumeError captures an error encountered during a volume operation.

Source

Property	Type	Description
`errorCode`	`number`	errorCode is a numeric gRPC code representing the error encountered during Attach or Detach operations. This is an optional, beta field that requires the MutableCSINodeAllocatableCount feature gate...
`message`	`string`	message represents the error encountered during Attach or Detach operation. This string may be logged, so it should not contain sensitive information.
`time`	`Date`	time represents the time the error was encountered.

V1VolumeMount

VolumeMount describes a mounting of a Volume within a container.

Source

Property	Type	Description
`mountPath`	`string`	Path within the container at which the volume should be mounted. Must not contain ':'.
`mountPropagation`	`string`	mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10. When...
`name`	`string`	This must match the Name of a Volume.
`readOnly`	`boolean`	Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.
`recursiveReadOnly`	`string`	RecursiveReadOnly specifies whether read-only mounts should be handled recursively. If ReadOnly is false, this field has no meaning and must be unspecified. If ReadOnly is true, and this field is...
`subPath`	`string`	Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root).
`subPathExpr`	`string`	Expanded path within the volume from which the container's volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's...

V1VolumeMountStatus

VolumeMountStatus shows status of volume mounts.

Source

Property	Type	Description
`mountPath`	`string`	MountPath corresponds to the original VolumeMount.
`name`	`string`	Name corresponds to the name of the original VolumeMount.
`readOnly`	`boolean`	ReadOnly corresponds to the original VolumeMount.
`recursiveReadOnly`	`string`	RecursiveReadOnly must be set to Disabled, Enabled, or unspecified (for non-readonly mounts). An IfPossible value in the original VolumeMount must be translated to Disabled or Enabled, depending on...

V1VolumeNodeAffinity

VolumeNodeAffinity defines constraints that limit what nodes this volume can be accessed from.

Source

Property	Type	Description
`required`	V1NodeSelector

V1VolumeNodeResources

VolumeNodeResources is a set of resource limits for scheduling of volumes.

Source

Property	Type	Description
`count`	`number`	count indicates the maximum number of unique volumes managed by the CSI driver that can be used on a node. A volume that is both attached and mounted on a node is considered to be used once, not...

V1VolumeProjection

Projection that may be projected along with other supported volume types. Exactly one of these fields must be set.

Source

Property	Type	Description
`clusterTrustBundle`	V1ClusterTrustBundleProjection
`configMap`	V1ConfigMapProjection
`downwardAPI`	V1DownwardAPIProjection
`podCertificate`	V1PodCertificateProjection
`secret`	V1SecretProjection
`serviceAccountToken`	V1ServiceAccountTokenProjection

V1VolumeResourceRequirements

VolumeResourceRequirements describes the storage resource requirements for a volume.

Source

Property	Type	Description
`limits`	`{ [key: string]: string`	Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
`requests`	`{ [key: string]: string`	Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an...

V1VsphereVirtualDiskVolumeSource

Represents a vSphere volume resource.

Source

Property	Type	Description
`fsType`	`string`	fsType is filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
`storagePolicyID`	`string`	storagePolicyID is the storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName.
`storagePolicyName`	`string`	storagePolicyName is the storage Policy Based Management (SPBM) profile name.
`volumePath`	`string`	volumePath is the path that identifies vSphere volume vmdk

V1WebhookConversion

WebhookConversion describes how to call a conversion webhook

Source

Property	Type	Description
`conversionReviewVersions`	`string[]`	conversionReviewVersions is an ordered list of preferred `ConversionReview` versions the Webhook expects. The API server will use the first version in the list which it supports. If none of the...
`clientConfig`	`ApiextensionsV1WebhookClientConfig`

V1WeightedPodAffinityTerm

The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)

Source

Property	Type	Description
`weight`	`number`	weight associated with matching the corresponding podAffinityTerm, in the range 1-100.
`podAffinityTerm`	V1PodAffinityTerm

V1WindowsSecurityContextOptions

WindowsSecurityContextOptions contain Windows-specific options and credentials.

Source

Property	Type	Description
`gmsaCredentialSpec`	`string`	GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field.
`gmsaCredentialSpecName`	`string`	GMSACredentialSpecName is the name of the GMSA credential spec to use.
`hostProcess`	`boolean`	HostProcess determines if a container should be run as a 'Host Process' container. All of a Pod's containers must have the same effective HostProcess value (it is not allowed to have a mix of...
`runAsUserName`	`string`	The UserName in Windows to run the entrypoint of the container process. Defaults to the user specified in image metadata if unspecified. May also be set in PodSecurityContext. If set in both...

V1WorkloadReference

WorkloadReference identifies the Workload object and PodGroup membership that a Pod belongs to. The scheduler uses this information to apply workload-aware scheduling semantics.

Source

Property	Type	Description
`name`	`string`	Name defines the name of the Workload object this Pod belongs to. Workload must be in the same namespace as the Pod. If it doesn't match any existing Workload, the Pod will remain unschedulable...
`podGroup`	`string`	PodGroup is the name of the PodGroup within the Workload that this Pod belongs to. If it doesn't match any existing PodGroup within the Workload, the Pod will remain unschedulable until the Workload...
`podGroupReplicaKey`	`string`	PodGroupReplicaKey specifies the replica key of the PodGroup to which this Pod belongs. It is used to distinguish pods belonging to different replicas of the same pod group. The pod group policy is...

V1alpha1ApplyConfiguration

ApplyConfiguration defines the desired configuration values of an object.

Source

Property	Type	Description
`expression`	`string`	expression will be evaluated by CEL to create an apply configuration. ref: https://github.com/google/cel-spec Apply configurations are declared in CEL using object initialization. For example, this...

V1alpha1ClusterTrustBundle

ClusterTrustBundle is a cluster-scoped container for X.509 trust anchors (root certificates). ClusterTrustBundle objects are considered to be readable by any authenticated user in the cluster, because they can be mounted by pods using the clusterTrustBundle projection. All service accounts have read access to ClusterTrustBundles by default. Users who only have namespace-level access to a cluster can read ClusterTrustBundles by impersonating a serviceaccount that they have access to. It can be optionally associated with a particular assigner, in which case it contains one valid set of trust anchors for that signer. Signers may have multiple associated ClusterTrustBundles; each is an independent set of trust anchors for that signer. Admission control is used to enforce that only users with permissions on the signer can create or modify the corresponding bundle.

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`	V1alpha1ClusterTrustBundleSpec

Example

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

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

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

Used by: CertificatesV1alpha1Api.createClusterTrustBundle · CertificatesV1alpha1Api.patchClusterTrustBundle · CertificatesV1alpha1Api.readClusterTrustBundle

V1alpha1ClusterTrustBundleList

ClusterTrustBundleList is a collection of ClusterTrustBundle 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`	V1alpha1ClusterTrustBundle[]	items is a collection of ClusterTrustBundle 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.CertificatesV1alpha1Api);

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

Used by: CertificatesV1alpha1Api.listClusterTrustBundle

V1alpha1ClusterTrustBundleSpec

ClusterTrustBundleSpec contains the signer and trust anchors.

Source

Property	Type	Description
`signerName`	`string`	signerName indicates the associated signer, if any. In order to create or update a ClusterTrustBundle that sets signerName, you must have the following cluster-scoped permission:...
`trustBundle`	`string`	trustBundle contains the individual X.509 trust anchors for this bundle, as PEM bundle of PEM-wrapped, DER-formatted X.509 certificates. The data must consist only of PEM certificate blocks that...

V1alpha1GangSchedulingPolicy

GangSchedulingPolicy defines the parameters for gang scheduling.

Source

Property	Type	Description
`minCount`	`number`	MinCount is the minimum number of pods that must be schedulable or scheduled at the same time for the scheduler to admit the entire group. It must be a positive integer.

V1alpha1JSONPatch

JSONPatch defines a JSON Patch.

Source

Property	Type	Description
`expression`	`string`	expression will be evaluated by CEL to create a JSON patch. ref: https://github.com/google/cel-spec expression must return an array of JSONPatch values. For example, this...

V1alpha1MatchCondition

Source

Property	Type	Description
`expression`	`string`	Expression represents the expression which will be evaluated by CEL. Must evaluate to bool. CEL expressions have access to the contents of the AdmissionRequest and Authorizer, organized into CEL...
`name`	`string`	Name is an identifier for this match condition, used for strategic merging of MatchConditions, as well as providing an identifier for logging purposes. A good name should be descriptive of the...

V1alpha1MatchResources

MatchResources decides whether to run the admission control policy on an object based on whether it meets the match criteria. The exclude rules take precedence over include rules (if a resource matches both, it is excluded)

Source

Property	Type	Description
`excludeResourceRules`	V1alpha1NamedRuleWithOperations[]	ExcludeResourceRules describes what operations on what resources/subresources the policy should not care about. The exclude rules take precedence over include rules (if a resource matches both, it is...
`matchPolicy`	`string`	matchPolicy defines how the "MatchResources" list is used to match incoming requests. Allowed values are "Exact" or "Equivalent". - Exact: match a request only if it exactly matches a...
`resourceRules`	V1alpha1NamedRuleWithOperations[]	ResourceRules describes what operations on what resources/subresources the admission policy matches. The policy cares about an operation if it matches any Rule.
`namespaceSelector`	V1LabelSelector
`objectSelector`	V1LabelSelector

V1alpha1MutatingAdmissionPolicy

MutatingAdmissionPolicy describes the definition of an admission mutation policy that mutates the object coming into admission chain.

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`	V1alpha1MutatingAdmissionPolicySpec

Example

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

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

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

Used by: AdmissionregistrationV1alpha1Api.createMutatingAdmissionPolicy · AdmissionregistrationV1alpha1Api.patchMutatingAdmissionPolicy · AdmissionregistrationV1alpha1Api.readMutatingAdmissionPolicy

V1alpha1MutatingAdmissionPolicyBinding

MutatingAdmissionPolicyBinding binds the MutatingAdmissionPolicy with parametrized resources. MutatingAdmissionPolicyBinding and the optional parameter resource together define how cluster administrators configure policies for clusters. For a given admission request, each binding will cause its policy to be evaluated N times, where N is 1 for policies/bindings that don't use params, otherwise N is the number of parameters selected by the binding. Each evaluation is constrained by a runtime cost budget. Adding/removing policies, bindings, or params can not affect whether a given (policy, binding, param) combination is within its own CEL budget.

Source

Property	Type	Description
`apiVersion`	`string`	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info:...
`kind`	`string`	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info:...
`metadata`	V1ObjectMeta
`spec`	V1alpha1MutatingAdmissionPolicyBindingSpec

Example

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

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

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

Used by: AdmissionregistrationV1alpha1Api.createMutatingAdmissionPolicyBinding · AdmissionregistrationV1alpha1Api.patchMutatingAdmissionPolicyBinding · AdmissionregistrationV1alpha1Api.readMutatingAdmissionPolicyBinding

V1alpha1MutatingAdmissionPolicyBindingList

MutatingAdmissionPolicyBindingList is a list of MutatingAdmissionPolicyBinding.

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`	V1alpha1MutatingAdmissionPolicyBinding[]	List of PolicyBinding.
`kind`	`string`	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info:...
`metadata`	V1ListMeta

Example

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

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

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

Used by: AdmissionregistrationV1alpha1Api.listMutatingAdmissionPolicyBinding

V1alpha1MutatingAdmissionPolicyBindingSpec

MutatingAdmissionPolicyBindingSpec is the specification of the MutatingAdmissionPolicyBinding.

Source

Property	Type	Description
`policyName`	`string`	policyName references a MutatingAdmissionPolicy name which the MutatingAdmissionPolicyBinding binds to. If the referenced resource does not exist, this binding is considered invalid and will be...
`matchResources`	V1alpha1MatchResources
`paramRef`	V1alpha1ParamRef

V1alpha1MutatingAdmissionPolicyList

MutatingAdmissionPolicyList is a list of MutatingAdmissionPolicy.

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`	V1alpha1MutatingAdmissionPolicy[]	List of ValidatingAdmissionPolicy.
`kind`	`string`	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info:...
`metadata`	V1ListMeta

Example

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

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

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

Used by: AdmissionregistrationV1alpha1Api.listMutatingAdmissionPolicy

V1alpha1MutatingAdmissionPolicySpec

MutatingAdmissionPolicySpec is the specification of the desired behavior of the admission policy.

Source

Property	Type	Description
`failurePolicy`	`string`	failurePolicy defines how to handle failures for the admission policy. Failures can occur from CEL expression parse errors, type check errors, runtime errors and invalid or mis-configured policy...
`matchConditions`	V1alpha1MatchCondition[]	matchConditions is a list of conditions that must be met for a request to be validated. Match conditions filter requests that have already been matched by the matchConstraints. An empty list of...
`mutations`	V1alpha1Mutation[]	mutations contain operations to perform on matching objects. mutations may not be empty; a minimum of one mutation is required. mutations are evaluated in order, and are reinvoked according to the...
`reinvocationPolicy`	`string`	reinvocationPolicy indicates whether mutations may be called multiple times per MutatingAdmissionPolicyBinding as part of a single admission evaluation. Allowed values are "Never" and "IfNeeded"....
`variables`	V1alpha1Variable[]	variables contain definitions of variables that can be used in composition of other expressions. Each variable is defined as a named CEL expression. The variables defined here will be available under...
`matchConstraints`	V1alpha1MatchResources
`paramKind`	V1alpha1ParamKind

V1alpha1Mutation

Mutation specifies the CEL expression which is used to apply the Mutation.

Source

Property	Type	Description
`patchType`	`string`	patchType indicates the patch strategy used. Allowed values are "ApplyConfiguration" and "JSONPatch". Required.
`applyConfiguration`	V1alpha1ApplyConfiguration
`jsonPatch`	V1alpha1JSONPatch

V1alpha1NamedRuleWithOperations

NamedRuleWithOperations is a tuple of Operations and Resources with ResourceNames.

Source

Property	Type	Description
`apiGroups`	`string[]`	APIGroups is the API groups the resources belong to. '' is all groups. If '' is present, the length of the slice must be one. Required.
`apiVersions`	`string[]`	APIVersions is the API versions the resources belong to. '' is all versions. If '' is present, the length of the slice must be one. Required.
`operations`	`string[]`	Operations is the operations the admission hook cares about - CREATE, UPDATE, DELETE, CONNECT or * for all of those operations and any future admission operations that are added. If '*' is present,...
`resourceNames`	`string[]`	ResourceNames is an optional white list of names that the rule applies to. An empty set means that everything is allowed.
`resources`	`string[]`	Resources is a list of resources this rule applies to. For example: 'pods' means pods. 'pods/log' means the log subresource of pods. '' means all resources, but not subresources. 'pods/_'...
`scope`	`string`	scope specifies the scope of this rule. Valid values are "Cluster", "Namespaced", and "*" "Cluster" means that only cluster-scoped resources will match this rule. Namespace API objects are...

V1alpha1ParamKind

ParamKind is a tuple of Group Kind and Version.

Source

Property	Type	Description
`apiVersion`	`string`	APIVersion is the API group version the resources belong to. In format of "group/version". Required.
`kind`	`string`	Kind is the API kind the resources belong to. Required.

V1alpha1ParamRef

ParamRef describes how to locate the params to be used as input to expressions of rules applied by a policy binding.

Source

Property	Type	Description
`name`	`string`	`name` is the name of the resource being referenced. `name` and `selector` are mutually exclusive properties. If one is set, the other must be unset.
`namespace`	`string`	namespace is the namespace of the referenced resource. Allows limiting the search for params to a specific namespace. Applies to both `name` and `selector` fields. A per-namespace parameter may be...
`parameterNotFoundAction`	`string`	`parameterNotFoundAction` controls the behavior of the binding when the resource exists, and name or selector is valid, but there are no parameters matched by the binding. If the value is set to...
`selector`	V1LabelSelector

V1alpha1PodGroup

PodGroup represents a set of pods with a common scheduling policy.

Source

Property	Type	Description
`name`	`string`	Name is a unique identifier for the PodGroup within the Workload. It must be a DNS label. This field is immutable.
`policy`	V1alpha1PodGroupPolicy

V1alpha1PodGroupPolicy

PodGroupPolicy defines the scheduling configuration for a PodGroup.

Source

Property	Type	Description
`basic`	`any`	Basic specifies that the pods in this group should be scheduled using standard Kubernetes scheduling behavior.
`gang`	V1alpha1GangSchedulingPolicy

V1alpha1ServerStorageVersion

An API server instance reports the version it can decode and the version it encodes objects to when persisting objects in the backend.

Source

Property	Type	Description
`apiServerID`	`string`	The ID of the reporting API server.
`decodableVersions`	`string[]`	The API server can decode objects encoded in these versions. The encodingVersion must be included in the decodableVersions.
`encodingVersion`	`string`	The API server encodes the object to this version when persisting it in the backend (e.g., etcd).
`servedVersions`	`string[]`	The API server can serve these versions. DecodableVersions must include all ServedVersions.

V1alpha1StorageVersion

Storage version of a specific resource.

Source

Property	Type	Description
`apiVersion`	`string`	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info:...
`kind`	`string`	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info:...
`spec`	`any`	Spec is an empty spec. It is here to comply with Kubernetes API style.
`metadata`	V1ObjectMeta
`status`	V1alpha1StorageVersionStatus

Example

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

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

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

Used by: InternalApiserverV1alpha1Api.createStorageVersion · InternalApiserverV1alpha1Api.readStorageVersion · InternalApiserverV1alpha1Api.readStorageVersionStatus

V1alpha1StorageVersionCondition

Describes the state of the storageVersion at a certain point.

Source

Property	Type	Description
`lastTransitionTime`	`Date`	Last time the condition transitioned from one status to another.
`message`	`string`	A human readable message indicating details about the transition.
`observedGeneration`	`number`	If set, this represents the .metadata.generation that the condition was set based upon.
`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 the condition.

V1alpha1StorageVersionList

A list of StorageVersions.

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`	V1alpha1StorageVersion[]	Items holds a list of StorageVersion
`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.InternalApiserverV1alpha1Api);

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

Used by: InternalApiserverV1alpha1Api.listStorageVersion

V1alpha1StorageVersionStatus

API server instances report the versions they can decode and the version they encode objects to when persisting objects in the backend.

Source

Property	Type	Description
`commonEncodingVersion`	`string`	If all API server instances agree on the same encoding storage version, then this field is set to that version. Otherwise this field is left empty. API servers should finish updating its...
`conditions`	V1alpha1StorageVersionCondition[]	The latest available observations of the storageVersion's state.
`storageVersions`	V1alpha1ServerStorageVersion[]	The reported versions per API server instance.

V1alpha1TypedLocalObjectReference

TypedLocalObjectReference allows to reference typed object inside the same namespace.

Source

Property	Type	Description
`apiGroup`	`string`	APIGroup is the group for the resource being referenced. If APIGroup is empty, the specified Kind must be in the core API group. For any other third-party types, setting APIGroup is required. It must...
`kind`	`string`	Kind is the type of resource being referenced. It must be a path segment name.
`name`	`string`	Name is the name of resource being referenced. It must be a path segment name.

V1alpha1Variable

Variable is the definition of a variable that is used for composition.

Source

Property	Type	Description
`expression`	`string`	Expression is the expression that will be evaluated as the value of the variable. The CEL expression has access to the same identifiers as the CEL expressions in Validation.
`name`	`string`	Name is the name of the variable. The name must be a valid CEL identifier and unique among all variables. The variable can be accessed in other expressions through `variables` For example, if name is...

V1alpha1Workload

Workload allows for expressing scheduling constraints that should be used when managing lifecycle of workloads from scheduling perspective, including scheduling, preemption, eviction and other phases.

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`	V1alpha1WorkloadSpec

Example

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

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

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

Used by: SchedulingV1alpha1Api.createNamespacedWorkload · SchedulingV1alpha1Api.patchNamespacedWorkload · SchedulingV1alpha1Api.readNamespacedWorkload

V1alpha1WorkloadList

WorkloadList contains a list of Workload resources.

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`	V1alpha1Workload[]	Items is the list of Workloads.
`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.SchedulingV1alpha1Api);

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

Used by: SchedulingV1alpha1Api.listNamespacedWorkload · SchedulingV1alpha1Api.listWorkloadForAllNamespaces

V1alpha1WorkloadSpec

WorkloadSpec defines the desired state of a Workload.

Source

Property	Type	Description
`podGroups`	V1alpha1PodGroup[]	PodGroups is the list of pod groups that make up the Workload. The maximum number of pod groups is 8. This field is immutable.
`controllerRef`	V1alpha1TypedLocalObjectReference

V1alpha2LeaseCandidate

LeaseCandidate defines a candidate for a Lease object. Candidates are created such that coordinated leader election will pick the best leader from the list of candidates.

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`	V1alpha2LeaseCandidateSpec

Example

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

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

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

Used by: CoordinationV1alpha2Api.createNamespacedLeaseCandidate · CoordinationV1alpha2Api.patchNamespacedLeaseCandidate · CoordinationV1alpha2Api.readNamespacedLeaseCandidate

V1alpha2LeaseCandidateList

LeaseCandidateList is a list of Lease 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`	V1alpha2LeaseCandidate[]	items is a list of schema 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.CoordinationV1alpha2Api);

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

Used by: CoordinationV1alpha2Api.listLeaseCandidateForAllNamespaces · CoordinationV1alpha2Api.listNamespacedLeaseCandidate

V1alpha2LeaseCandidateSpec

LeaseCandidateSpec is a specification of a Lease.

Source

Property	Type	Description
`binaryVersion`	`string`	BinaryVersion is the binary version. It must be in a semver format without leading `v`. This field is required.
`emulationVersion`	`string`	EmulationVersion is the emulation version. It must be in a semver format without leading `v`. EmulationVersion must be less than or equal to BinaryVersion. This field is required when strategy is...
`leaseName`	`string`	LeaseName is the name of the lease for which this candidate is contending. This field is immutable.
`pingTime`	`V1MicroTime`	MicroTime is version of Time with microsecond level precision.
`renewTime`	`V1MicroTime`	MicroTime is version of Time with microsecond level precision.
`strategy`	`string`	Strategy is the strategy that coordinated leader election will use for picking the leader. If multiple candidates for the same Lease return different strategies, the strategy provided by the...

V1alpha3DeviceTaint

The device this taint is attached to has the "effect" on any claim which does not tolerate the taint and, through the claim, to pods using the claim.

Source

Property	Type	Description
`effect`	`string`	The effect of the taint on claims that do not tolerate the taint and through such claims on the pods using them. Valid effects are None, NoSchedule and NoExecute. PreferNoSchedule as used for nodes...
`key`	`string`	The taint key to be applied to a device. Must be a label name.
`timeAdded`	`Date`	TimeAdded represents the time at which the taint was added. Added automatically during create or update if not set.
`value`	`string`	The taint value corresponding to the taint key. Must be a label value.

V1alpha3DeviceTaintRule

DeviceTaintRule adds one taint to all devices which match the selector. This has the same effect as if the taint was specified directly in the ResourceSlice by the DRA driver.

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`	V1alpha3DeviceTaintRuleSpec
`status`	V1alpha3DeviceTaintRuleStatus

Example

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

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

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

Used by: ResourceV1alpha3Api.createDeviceTaintRule · ResourceV1alpha3Api.readDeviceTaintRule · ResourceV1alpha3Api.readDeviceTaintRuleStatus

V1alpha3DeviceTaintRuleList

DeviceTaintRuleList is a collection of DeviceTaintRules.

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`	V1alpha3DeviceTaintRule[]	Items is the list of DeviceTaintRules.
`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.ResourceV1alpha3Api);

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

Used by: ResourceV1alpha3Api.listDeviceTaintRule

V1alpha3DeviceTaintRuleSpec

DeviceTaintRuleSpec specifies the selector and one taint.

Source

Property	Type	Description
`deviceSelector`	V1alpha3DeviceTaintSelector
`taint`	V1alpha3DeviceTaint

V1alpha3DeviceTaintRuleStatus

DeviceTaintRuleStatus provides information about an on-going pod eviction.

Source

Property	Type	Description
`conditions`	V1Condition[]	Conditions provide information about the state of the DeviceTaintRule and the cluster at some point in time, in a machine-readable and human-readable format. The following condition is currently...

V1alpha3DeviceTaintSelector

DeviceTaintSelector defines which device(s) a DeviceTaintRule applies to. The empty selector matches all devices. Without a selector, no devices are matched.

Source

Property	Type	Description
`device`	`string`	If device is set, only devices with that name are selected. This field corresponds to slice.spec.devices[].name. Setting also driver and pool may be required to avoid ambiguity, but is not required.
`driver`	`string`	If driver is set, only devices from that driver are selected. This fields corresponds to slice.spec.driver.
`pool`	`string`	If pool is set, only devices in that pool are selected. Also setting the driver name may be useful to avoid ambiguity when different drivers use the same pool name, but this is not required because...

V1beta1AllocatedDeviceStatus

AllocatedDeviceStatus contains the status of an allocated device, if the driver chooses to report it. This may include driver-specific information. The combination of Driver, Pool, Device, and ShareID must match the corresponding key in Status.Allocation.Devices.

Source

Property	Type	Description
`conditions`	V1Condition[]	Conditions contains the latest observation of the device's state. If the device has been configured according to the class and claim config references, the `Ready` condition should be True. Must...
`data`	`any`	Data contains arbitrary driver-specific data. The length of the raw data must be smaller or equal to 10 Ki.
`device`	`string`	Device references one device instance via its name in the driver's resource pool. It must be a DNS label.
`driver`	`string`	Driver specifies the name of the DRA driver whose kubelet plugin should be invoked to process the allocation once the claim is needed on a node. Must be a DNS subdomain and should end with a DNS...
`pool`	`string`	This name together with the driver name and the device name field identify which device was allocated (`<driver name>/<pool name>/<device name>`). Must not be longer than 253 characters and may...
`shareID`	`string`	ShareID uniquely identifies an individual allocation share of the device.
`networkData`	V1beta1NetworkDeviceData

V1beta1AllocationResult

AllocationResult contains attributes of an allocated resource.

Source

Property	Type	Description
`allocationTimestamp`	`Date`	AllocationTimestamp stores the time when the resources were allocated. This field is not guaranteed to be set, in which case that time is unknown. This is an alpha field and requires enabling the...
`devices`	V1beta1DeviceAllocationResult
`nodeSelector`	V1NodeSelector

V1beta1ApplyConfiguration

ApplyConfiguration defines the desired configuration values of an object.

Source

Property	Type	Description
`expression`	`string`	expression will be evaluated by CEL to create an apply configuration. ref: https://github.com/google/cel-spec Apply configurations are declared in CEL using object initialization. For example, this...

V1beta1BasicDevice

BasicDevice defines one device instance.

Source

Property	Type	Description
`allNodes`	`boolean`	AllNodes indicates that all nodes have access to the device. Must only be set if Spec.PerDeviceNodeSelection is set to true. At most one of NodeName, NodeSelector and AllNodes can be set.
`allowMultipleAllocations`	`boolean`	AllowMultipleAllocations marks whether the device is allowed to be allocated to multiple DeviceRequests. If AllowMultipleAllocations is set to true, the device can be allocated more than once, and...
`attributes`	{ [key: string]: V1beta1DeviceAttribute	Attributes defines the set of attributes for this device. The name of each attribute must be unique in that set. The maximum number of attributes and capacities combined is 32.
`bindingConditions`	`string[]`	BindingConditions defines the conditions for proceeding with binding. All of these conditions must be set in the per-device status conditions with a value of True to proceed with binding the pod to...
`bindingFailureConditions`	`string[]`	BindingFailureConditions defines the conditions for binding failure. They may be set in the per-device status conditions. If any is true, a binding failure occurred. The maximum number of binding...
`bindsToNode`	`boolean`	BindsToNode indicates if the usage of an allocation involving this device has to be limited to exactly the node that was chosen when allocating the claim. If set to true, the scheduler will set the...
`capacity`	{ [key: string]: V1beta1DeviceCapacity	Capacity defines the set of capacities for this device. The name of each capacity must be unique in that set. The maximum number of attributes and capacities combined is 32.
`consumesCounters`	V1beta1DeviceCounterConsumption[]	ConsumesCounters defines a list of references to sharedCounters and the set of counters that the device will consume from those counter sets. There can only be a single entry per counterSet. The...
`nodeName`	`string`	NodeName identifies the node where the device is available. Must only be set if Spec.PerDeviceNodeSelection is set to true. At most one of NodeName, NodeSelector and AllNodes can be set.
`taints`	V1beta1DeviceTaint[]	If specified, these are the driver-defined taints. The maximum number of taints is 16. If taints are set for any device in a ResourceSlice, then the maximum number of allowed devices per...
`nodeSelector`	V1NodeSelector

V1beta1CELDeviceSelector

CELDeviceSelector contains a CEL expression for selecting a device.

Source

Property	Type	Description
`expression`	`string`	Expression is a CEL expression which evaluates a single device. It must evaluate to true when the device under consideration satisfies the desired criteria, and false when it does not. Any other...

V1beta1CapacityRequestPolicy

CapacityRequestPolicy defines how requests consume device capacity. Must not set more than one ValidRequestValues.

Source

Property	Type	Description
`_default`	`string`	Default specifies how much of this capacity is consumed by a request that does not contain an entry for it in DeviceRequest's Capacity.
`validValues`	`string[]`	ValidValues defines a set of acceptable quantity values in consuming requests. Must not contain more than 10 entries. Must be sorted in ascending order. If this field is set, Default must be...
`validRange`	V1beta1CapacityRequestPolicyRange

V1beta1CapacityRequestPolicyRange

CapacityRequestPolicyRange defines a valid range for consumable capacity values. - If the requested amount is less than Min, it is rounded up to the Min value. - If Step is set and the requested amount is between Min and Max but not aligned with Step, it will be rounded up to the next value equal to Min + (n * Step). - If Step is not set, the requested amount is used as-is if it falls within the range Min to Max (if set). - If the requested or rounded amount exceeds Max (if set), the request does not satisfy the policy, and the device cannot be allocated.

Source

Property	Type	Description
`max`	`string`	Max defines the upper limit for capacity that can be requested. Max must be less than or equal to the capacity value. Min and requestPolicy.default must be less than or equal to the maximum.
`min`	`string`	Min specifies the minimum capacity allowed for a consumption request. Min must be greater than or equal to zero, and less than or equal to the capacity value. requestPolicy.default must be more than...
`step`	`string`	Step defines the step size between valid capacity amounts within the range. Max (if set) and requestPolicy.default must be a multiple of Step. Min + Step must be less than or equal to the capacity...

V1beta1CapacityRequirements

CapacityRequirements defines the capacity requirements for a specific device request.

Source

Property	Type	Description
`requests`	`{ [key: string]: string`	Requests represent individual device resource requests for distinct resources, all of which must be provided by the device. This value is used as an additional filtering condition against the...

V1beta1ClusterTrustBundle

ClusterTrustBundle is a cluster-scoped container for X.509 trust anchors (root certificates). ClusterTrustBundle objects are considered to be readable by any authenticated user in the cluster, because they can be mounted by pods using the clusterTrustBundle projection. All service accounts have read access to ClusterTrustBundles by default. Users who only have namespace-level access to a cluster can read ClusterTrustBundles by impersonating a serviceaccount that they have access to. It can be optionally associated with a particular assigner, in which case it contains one valid set of trust anchors for that signer. Signers may have multiple associated ClusterTrustBundles; each is an independent set of trust anchors for that signer. Admission control is used to enforce that only users with permissions on the signer can create or modify the corresponding bundle.

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`	V1beta1ClusterTrustBundleSpec

Example

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

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

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

Used by: CertificatesV1beta1Api.createClusterTrustBundle · CertificatesV1beta1Api.patchClusterTrustBundle · CertificatesV1beta1Api.readClusterTrustBundle

V1beta1ClusterTrustBundleList

ClusterTrustBundleList is a collection of ClusterTrustBundle 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`	V1beta1ClusterTrustBundle[]	items is a collection of ClusterTrustBundle 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.CertificatesV1beta1Api);

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

Used by: CertificatesV1beta1Api.listClusterTrustBundle

V1beta1ClusterTrustBundleSpec

ClusterTrustBundleSpec contains the signer and trust anchors.

Source

Property	Type	Description
`signerName`	`string`	signerName indicates the associated signer, if any. In order to create or update a ClusterTrustBundle that sets signerName, you must have the following cluster-scoped permission:...
`trustBundle`	`string`	trustBundle contains the individual X.509 trust anchors for this bundle, as PEM bundle of PEM-wrapped, DER-formatted X.509 certificates. The data must consist only of PEM certificate blocks that...

V1beta1Counter

Counter describes a quantity associated with a device.

Source

Property	Type	Description
`value`	`string`	Value defines how much of a certain device counter is available.

V1beta1CounterSet

CounterSet defines a named set of counters that are available to be used by devices defined in the ResourcePool. The counters are not allocatable by themselves, but can be referenced by devices. When a device is allocated, the portion of counters it uses will no longer be available for use by other devices.

Source

Property	Type	Description
`counters`	{ [key: string]: V1beta1Counter	Counters defines the set of counters for this CounterSet The name of each counter must be unique in that set and must be a DNS label. The maximum number of counters is 32.
`name`	`string`	Name defines the name of the counter set. It must be a DNS label.

V1beta1Device

Device represents one individual hardware instance that can be selected based on its attributes. Besides the name, exactly one field must be set.

Source

Property	Type	Description
`name`	`string`	Name is unique identifier among all devices managed by the driver in the pool. It must be a DNS label.
`basic`	V1beta1BasicDevice

V1beta1DeviceAllocationConfiguration

DeviceAllocationConfiguration gets embedded in an AllocationResult.

Source

Property	Type	Description
`requests`	`string[]`	Requests lists the names of requests where the configuration applies. If empty, its applies to all requests. References to subrequests must include the name of the main request and may include the...
`source`	`string`	Source records whether the configuration comes from a class and thus is not something that a normal user would have been able to set or from a claim.
`opaque`	V1beta1OpaqueDeviceConfiguration

V1beta1DeviceAllocationResult

DeviceAllocationResult is the result of allocating devices.

Source

Property	Type	Description
`config`	V1beta1DeviceAllocationConfiguration[]	This field is a combination of all the claim and class configuration parameters. Drivers can distinguish between those based on a flag. This includes configuration parameters for drivers which have...
`results`	V1beta1DeviceRequestAllocationResult[]	Results lists all allocated devices.

V1beta1DeviceAttribute

DeviceAttribute must have exactly one field set.

Source

Property	Type	Description
`bool`	`boolean`	BoolValue is a true/false value.
`_int`	`number`	IntValue is a number.
`string`	`string`	StringValue is a string. Must not be longer than 64 characters.
`version`	`string`	VersionValue is a semantic version according to semver.org spec 2.0.0. Must not be longer than 64 characters.

V1beta1DeviceCapacity

DeviceCapacity describes a quantity associated with a device.

Source

Property	Type	Description
`value`	`string`	Value defines how much of a certain capacity that device has. This field reflects the fixed total capacity and does not change. The consumed amount is tracked separately by scheduler and does not...
`requestPolicy`	V1beta1CapacityRequestPolicy

V1beta1DeviceClaim

DeviceClaim defines how to request devices with a ResourceClaim.

Source

Property	Type	Description
`config`	V1beta1DeviceClaimConfiguration[]	This field holds configuration for multiple potential drivers which could satisfy requests in this claim. It is ignored while allocating the claim.
`constraints`	V1beta1DeviceConstraint[]	These constraints must be satisfied by the set of devices that get allocated for the claim.
`requests`	V1beta1DeviceRequest[]	Requests represent individual requests for distinct devices which must all be satisfied. If empty, nothing needs to be allocated.

V1beta1DeviceClaimConfiguration

DeviceClaimConfiguration is used for configuration parameters in DeviceClaim.

Source

Property	Type	Description
`requests`	`string[]`	Requests lists the names of requests where the configuration applies. If empty, it applies to all requests. References to subrequests must include the name of the main request and may include the...
`opaque`	V1beta1OpaqueDeviceConfiguration

V1beta1DeviceClass

DeviceClass is a vendor- or admin-provided resource that contains device configuration and selectors. It can be referenced in the device requests of a claim to apply these presets. Cluster scoped. This is an alpha type and requires enabling the DynamicResourceAllocation feature gate.

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`	V1beta1DeviceClassSpec

Example

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

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

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

Used by: ResourceV1beta1Api.createDeviceClass · ResourceV1beta1Api.patchDeviceClass · ResourceV1beta1Api.readDeviceClass

V1beta1DeviceClassConfiguration

DeviceClassConfiguration is used in DeviceClass.

Source

Property	Type	Description
`opaque`	V1beta1OpaqueDeviceConfiguration

V1beta1DeviceClassList

DeviceClassList is a collection of classes.

Source

Property	Type	Description
`apiVersion`	`string`	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info:...
`items`	V1beta1DeviceClass[]	Items is the list of resource classes.
`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.ResourceV1beta1Api);

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

Used by: ResourceV1beta1Api.listDeviceClass

V1beta1DeviceClassSpec

DeviceClassSpec is used in a [DeviceClass] to define what can be allocated and how to configure it.

Source

Property	Type	Description
`config`	V1beta1DeviceClassConfiguration[]	Config defines configuration parameters that apply to each device that is claimed via this class. Some classses may potentially be satisfied by multiple drivers, so each instance of a vendor...
`extendedResourceName`	`string`	ExtendedResourceName is the extended resource name for the devices of this class. The devices of this class can be used to satisfy a pod's extended resource requests. It has the same format as the...
`selectors`	V1beta1DeviceSelector[]	Each selector must be satisfied by a device which is claimed via this class.

V1beta1DeviceConstraint

DeviceConstraint must have exactly one field set besides Requests.

Source

Property	Type	Description
`distinctAttribute`	`string`	DistinctAttribute requires that all devices in question have this attribute and that its type and value are unique across those devices. This acts as the inverse of MatchAttribute. This constraint...
`matchAttribute`	`string`	MatchAttribute requires that all devices in question have this attribute and that its type and value are the same across those devices. For example, if you specified "dra.example.com/numa" (a...
`requests`	`string[]`	Requests is a list of the one or more requests in this claim which must co-satisfy this constraint. If a request is fulfilled by multiple devices, then all of the devices must satisfy the constraint....

V1beta1DeviceCounterConsumption

DeviceCounterConsumption defines a set of counters that a device will consume from a CounterSet.

Source

Property	Type	Description
`counterSet`	`string`	CounterSet is the name of the set from which the counters defined will be consumed.
`counters`	{ [key: string]: V1beta1Counter	Counters defines the counters that will be consumed by the device. The maximum number of counters is 32.

V1beta1DeviceRequest

DeviceRequest is a request for devices required for a claim. This is typically a request for a single resource like a device, but can also ask for several identical devices.

Source

Property	Type	Description
`adminAccess`	`boolean`	AdminAccess indicates that this is a claim for administrative access to the device(s). Claims with AdminAccess are expected to be used for monitoring or other management services for a device. They...
`allocationMode`	`string`	AllocationMode and its related fields define how devices are allocated to satisfy this request. Supported values are: - ExactCount: This request is for a specific number of devices. This is the...
`count`	`number`	Count is used only when the count mode is "ExactCount". Must be greater than zero. If AllocationMode is ExactCount and this field is not specified, the default is one. This field can only be set...
`deviceClassName`	`string`	DeviceClassName references a specific DeviceClass, which can define additional configuration and selectors to be inherited by this request. A class is required if no subrequests are specified in the...
`firstAvailable`	V1beta1DeviceSubRequest[]	FirstAvailable contains subrequests, of which exactly one will be satisfied by the scheduler to satisfy this request. It tries to satisfy them in the order in which they are listed here. So if there...
`name`	`string`	Name can be used to reference this request in a pod.spec.containers[].resources.claims entry and in a constraint of the claim. Must be a DNS label and unique among all DeviceRequests in a...
`selectors`	V1beta1DeviceSelector[]	Selectors define criteria which must be satisfied by a specific device in order for that device to be considered for this request. All selectors must be satisfied for a device to be considered. This...
`tolerations`	V1beta1DeviceToleration[]	If specified, the request's tolerations. Tolerations for NoSchedule are required to allocate a device which has a taint with that effect. The same applies to NoExecute. In addition, should any of...
`capacity`	V1beta1CapacityRequirements

V1beta1DeviceRequestAllocationResult

DeviceRequestAllocationResult contains the allocation result for one request.

Source

Property	Type	Description
`adminAccess`	`boolean`	AdminAccess indicates that this device was allocated for administrative access. See the corresponding request field for a definition of mode. This is an alpha field and requires enabling the...
`bindingConditions`	`string[]`	BindingConditions contains a copy of the BindingConditions from the corresponding ResourceSlice at the time of allocation. This is an alpha field and requires enabling the DRADeviceBindingConditions...
`bindingFailureConditions`	`string[]`	BindingFailureConditions contains a copy of the BindingFailureConditions from the corresponding ResourceSlice at the time of allocation. This is an alpha field and requires enabling the...
`consumedCapacity`	`{ [key: string]: string`	ConsumedCapacity tracks the amount of capacity consumed per device as part of the claim request. The consumed amount may differ from the requested amount: it is rounded up to the nearest valid value...
`device`	`string`	Device references one device instance via its name in the driver's resource pool. It must be a DNS label.
`driver`	`string`	Driver specifies the name of the DRA driver whose kubelet plugin should be invoked to process the allocation once the claim is needed on a node. Must be a DNS subdomain and should end with a DNS...
`pool`	`string`	This name together with the driver name and the device name field identify which device was allocated (`<driver name>/<pool name>/<device name>`). Must not be longer than 253 characters and may...
`request`	`string`	Request is the name of the request in the claim which caused this device to be allocated. If it references a subrequest in the firstAvailable list on a DeviceRequest, this field must include both the...
`shareID`	`string`	ShareID uniquely identifies an individual allocation share of the device, used when the device supports multiple simultaneous allocations. It serves as an additional map key to differentiate...
`tolerations`	V1beta1DeviceToleration[]	A copy of all tolerations specified in the request at the time when the device got allocated. The maximum number of tolerations is 16. This is an alpha field and requires enabling the...

V1beta1DeviceSelector

DeviceSelector must have exactly one field set.

Source

Property	Type	Description
`cel`	V1beta1CELDeviceSelector

V1beta1DeviceSubRequest

DeviceSubRequest describes a request for device provided in the claim.spec.devices.requests[].firstAvailable array. Each is typically a request for a single resource like a device, but can also ask for several identical devices. DeviceSubRequest is similar to Request, but doesn't expose the AdminAccess or FirstAvailable fields, as those can only be set on the top-level request. AdminAccess is not supported for requests with a prioritized list, and recursive FirstAvailable fields are not supported.

Source

Property	Type	Description
`allocationMode`	`string`	AllocationMode and its related fields define how devices are allocated to satisfy this subrequest. Supported values are: - ExactCount: This request is for a specific number of devices. This is the...
`count`	`number`	Count is used only when the count mode is "ExactCount". Must be greater than zero. If AllocationMode is ExactCount and this field is not specified, the default is one.
`deviceClassName`	`string`	DeviceClassName references a specific DeviceClass, which can define additional configuration and selectors to be inherited by this subrequest. A class is required. Which classes are available...
`name`	`string`	Name can be used to reference this subrequest in the list of constraints or the list of configurations for the claim. References must use the format /. Must be a DNS label.
`selectors`	V1beta1DeviceSelector[]	Selectors define criteria which must be satisfied by a specific device in order for that device to be considered for this subrequest. All selectors must be satisfied for a device to be considered.
`tolerations`	V1beta1DeviceToleration[]	If specified, the request's tolerations. Tolerations for NoSchedule are required to allocate a device which has a taint with that effect. The same applies to NoExecute. In addition, should any of...
`capacity`	V1beta1CapacityRequirements

V1beta1DeviceTaint

The device this taint is attached to has the "effect" on any claim which does not tolerate the taint and, through the claim, to pods using the claim.

Source

Property	Type	Description
`effect`	`string`	The effect of the taint on claims that do not tolerate the taint and through such claims on the pods using them. Valid effects are None, NoSchedule and NoExecute. PreferNoSchedule as used for nodes...
`key`	`string`	The taint key to be applied to a device. Must be a label name.
`timeAdded`	`Date`	TimeAdded represents the time at which the taint was added. Added automatically during create or update if not set.
`value`	`string`	The taint value corresponding to the taint key. Must be a label value.

V1beta1DeviceToleration

The ResourceClaim this DeviceToleration is attached to tolerates any taint that matches the triple <key,value,effect> using the matching operator .

Source

Property	Type	Description
`effect`	`string`	Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule and NoExecute.
`key`	`string`	Key is the taint key that the toleration applies to. Empty means match all taint keys. If the key is empty, operator must be Exists; this combination means to match all values and all keys. Must be a...
`operator`	`string`	Operator represents a key's relationship to the value. Valid operators are Exists and Equal. Defaults to Equal. Exists is equivalent to wildcard for value, so that a ResourceClaim can tolerate all...
`tolerationSeconds`	`number`	TolerationSeconds represents the period of time the toleration (which must be of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, it is not set, which means...
`value`	`string`	Value is the taint value the toleration matches to. If the operator is Exists, the value must be empty, otherwise just a regular string. Must be a label value.

V1beta1IPAddress

IPAddress represents a single IP of a single IP Family. The object is designed to be used by APIs that operate on IP addresses. The object is used by the Service core API for allocation of IP addresses. An IP address can be represented in different formats, to guarantee the uniqueness of the IP, the name of the object is the IP address in canonical format, four decimal digits separated by dots suppressing leading zeros for IPv4 and the representation defined by RFC 5952 for IPv6. Valid: 192.168.1.5 or 2001:db8::1 or 2001:db8:aaaa:bbbb:cccc:dddd:eeee:1 Invalid: 10.01.2.3 or 2001:db8:0:0:0::1

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`	V1beta1IPAddressSpec

Example

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

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

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

Used by: NetworkingV1beta1Api.createIPAddress · NetworkingV1beta1Api.patchIPAddress · NetworkingV1beta1Api.readIPAddress

V1beta1IPAddressList

IPAddressList contains a list of IPAddress.

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`	V1beta1IPAddress[]	items is the list of IPAddresses.
`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.NetworkingV1beta1Api);

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

Used by: NetworkingV1beta1Api.listIPAddress

V1beta1IPAddressSpec

IPAddressSpec describe the attributes in an IP Address.

Source

Property	Type	Description
`parentRef`	V1beta1ParentReference

V1beta1JSONPatch

JSONPatch defines a JSON Patch.

Source

Property	Type	Description
`expression`	`string`	expression will be evaluated by CEL to create a JSON patch. ref: https://github.com/google/cel-spec expression must return an array of JSONPatch values. For example, this...

V1beta1LeaseCandidate

LeaseCandidate defines a candidate for a Lease object. Candidates are created such that coordinated leader election will pick the best leader from the list of candidates.

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`	V1beta1LeaseCandidateSpec

Example

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

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

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

Used by: CoordinationV1beta1Api.createNamespacedLeaseCandidate · CoordinationV1beta1Api.patchNamespacedLeaseCandidate · CoordinationV1beta1Api.readNamespacedLeaseCandidate

V1beta1LeaseCandidateList

LeaseCandidateList is a list of Lease 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`	V1beta1LeaseCandidate[]	items is a list of schema 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.CoordinationV1beta1Api);

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

Used by: CoordinationV1beta1Api.listLeaseCandidateForAllNamespaces · CoordinationV1beta1Api.listNamespacedLeaseCandidate

V1beta1LeaseCandidateSpec

LeaseCandidateSpec is a specification of a Lease.

Source

Property	Type	Description
`binaryVersion`	`string`	BinaryVersion is the binary version. It must be in a semver format without leading `v`. This field is required.
`emulationVersion`	`string`	EmulationVersion is the emulation version. It must be in a semver format without leading `v`. EmulationVersion must be less than or equal to BinaryVersion. This field is required when strategy is...
`leaseName`	`string`	LeaseName is the name of the lease for which this candidate is contending. The limits on this field are the same as on Lease.name. Multiple lease candidates may reference the same Lease.name. This...
`pingTime`	`V1MicroTime`	MicroTime is version of Time with microsecond level precision.
`renewTime`	`V1MicroTime`	MicroTime is version of Time with microsecond level precision.
`strategy`	`string`	Strategy is the strategy that coordinated leader election will use for picking the leader. If multiple candidates for the same Lease return different strategies, the strategy provided by the...

V1beta1MatchCondition

MatchCondition represents a condition which must be fulfilled for a request to be sent to a webhook.

Source

Property	Type	Description
`expression`	`string`	Expression represents the expression which will be evaluated by CEL. Must evaluate to bool. CEL expressions have access to the contents of the AdmissionRequest and Authorizer, organized into CEL...
`name`	`string`	Name is an identifier for this match condition, used for strategic merging of MatchConditions, as well as providing an identifier for logging purposes. A good name should be descriptive of the...

V1beta1MatchResources

MatchResources decides whether to run the admission control policy on an object based on whether it meets the match criteria. The exclude rules take precedence over include rules (if a resource matches both, it is excluded)

Source

Property	Type	Description
`excludeResourceRules`	V1beta1NamedRuleWithOperations[]	ExcludeResourceRules describes what operations on what resources/subresources the ValidatingAdmissionPolicy should not care about. The exclude rules take precedence over include rules (if a resource...
`matchPolicy`	`string`	matchPolicy defines how the "MatchResources" list is used to match incoming requests. Allowed values are "Exact" or "Equivalent". - Exact: match a request only if it exactly matches a...
`resourceRules`	V1beta1NamedRuleWithOperations[]	ResourceRules describes what operations on what resources/subresources the ValidatingAdmissionPolicy matches. The policy cares about an operation if it matches any Rule.
`namespaceSelector`	V1LabelSelector
`objectSelector`	V1LabelSelector

V1beta1MutatingAdmissionPolicy

MutatingAdmissionPolicy describes the definition of an admission mutation policy that mutates the object coming into admission chain.

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`	V1beta1MutatingAdmissionPolicySpec

Example

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

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

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

Used by: AdmissionregistrationV1beta1Api.createMutatingAdmissionPolicy · AdmissionregistrationV1beta1Api.patchMutatingAdmissionPolicy · AdmissionregistrationV1beta1Api.readMutatingAdmissionPolicy

V1beta1MutatingAdmissionPolicyBinding

MutatingAdmissionPolicyBinding binds the MutatingAdmissionPolicy with parametrized resources. MutatingAdmissionPolicyBinding and the optional parameter resource together define how cluster administrators configure policies for clusters. For a given admission request, each binding will cause its policy to be evaluated N times, where N is 1 for policies/bindings that don't use params, otherwise N is the number of parameters selected by the binding. Each evaluation is constrained by a runtime cost budget. Adding/removing policies, bindings, or params can not affect whether a given (policy, binding, param) combination is within its own CEL budget.

Source

Property	Type	Description
`apiVersion`	`string`	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info:...
`kind`	`string`	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info:...
`metadata`	V1ObjectMeta
`spec`	V1beta1MutatingAdmissionPolicyBindingSpec

Example

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

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

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

Used by: AdmissionregistrationV1beta1Api.createMutatingAdmissionPolicyBinding · AdmissionregistrationV1beta1Api.patchMutatingAdmissionPolicyBinding · AdmissionregistrationV1beta1Api.readMutatingAdmissionPolicyBinding

V1beta1MutatingAdmissionPolicyBindingList

MutatingAdmissionPolicyBindingList is a list of MutatingAdmissionPolicyBinding.

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`	V1beta1MutatingAdmissionPolicyBinding[]	List of PolicyBinding.
`kind`	`string`	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info:...
`metadata`	V1ListMeta

Example

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

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

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

Used by: AdmissionregistrationV1beta1Api.listMutatingAdmissionPolicyBinding

V1beta1MutatingAdmissionPolicyBindingSpec

MutatingAdmissionPolicyBindingSpec is the specification of the MutatingAdmissionPolicyBinding.

Source

Property	Type	Description
`policyName`	`string`	policyName references a MutatingAdmissionPolicy name which the MutatingAdmissionPolicyBinding binds to. If the referenced resource does not exist, this binding is considered invalid and will be...
`matchResources`	V1beta1MatchResources
`paramRef`	V1beta1ParamRef

V1beta1MutatingAdmissionPolicyList

MutatingAdmissionPolicyList is a list of MutatingAdmissionPolicy.

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`	V1beta1MutatingAdmissionPolicy[]	List of ValidatingAdmissionPolicy.
`kind`	`string`	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info:...
`metadata`	V1ListMeta

Example

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

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

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

Used by: AdmissionregistrationV1beta1Api.listMutatingAdmissionPolicy

V1beta1MutatingAdmissionPolicySpec

MutatingAdmissionPolicySpec is the specification of the desired behavior of the admission policy.

Source

Property	Type	Description
`failurePolicy`	`string`	failurePolicy defines how to handle failures for the admission policy. Failures can occur from CEL expression parse errors, type check errors, runtime errors and invalid or mis-configured policy...
`matchConditions`	V1beta1MatchCondition[]	matchConditions is a list of conditions that must be met for a request to be validated. Match conditions filter requests that have already been matched by the matchConstraints. An empty list of...
`mutations`	V1beta1Mutation[]	mutations contain operations to perform on matching objects. mutations may not be empty; a minimum of one mutation is required. mutations are evaluated in order, and are reinvoked according to the...
`reinvocationPolicy`	`string`	reinvocationPolicy indicates whether mutations may be called multiple times per MutatingAdmissionPolicyBinding as part of a single admission evaluation. Allowed values are "Never" and "IfNeeded"....
`variables`	V1beta1Variable[]	variables contain definitions of variables that can be used in composition of other expressions. Each variable is defined as a named CEL expression. The variables defined here will be available under...
`matchConstraints`	V1beta1MatchResources
`paramKind`	V1beta1ParamKind

V1beta1Mutation

Mutation specifies the CEL expression which is used to apply the Mutation.

Source

Property	Type	Description
`patchType`	`string`	patchType indicates the patch strategy used. Allowed values are "ApplyConfiguration" and "JSONPatch". Required.
`applyConfiguration`	V1beta1ApplyConfiguration
`jsonPatch`	V1beta1JSONPatch

V1beta1NamedRuleWithOperations

NamedRuleWithOperations is a tuple of Operations and Resources with ResourceNames.

Source

Property	Type	Description
`apiGroups`	`string[]`	APIGroups is the API groups the resources belong to. '' is all groups. If '' is present, the length of the slice must be one. Required.
`apiVersions`	`string[]`	APIVersions is the API versions the resources belong to. '' is all versions. If '' is present, the length of the slice must be one. Required.
`operations`	`string[]`	Operations is the operations the admission hook cares about - CREATE, UPDATE, DELETE, CONNECT or * for all of those operations and any future admission operations that are added. If '*' is present,...
`resourceNames`	`string[]`	ResourceNames is an optional white list of names that the rule applies to. An empty set means that everything is allowed.
`resources`	`string[]`	Resources is a list of resources this rule applies to. For example: 'pods' means pods. 'pods/log' means the log subresource of pods. '' means all resources, but not subresources. 'pods/_'...
`scope`	`string`	scope specifies the scope of this rule. Valid values are "Cluster", "Namespaced", and "*" "Cluster" means that only cluster-scoped resources will match this rule. Namespace API objects are...

V1beta1NetworkDeviceData

NetworkDeviceData provides network-related details for the allocated device. This information may be filled by drivers or other components to configure or identify the device within a network context.

Source

Property	Type	Description
`hardwareAddress`	`string`	HardwareAddress represents the hardware address (e.g. MAC Address) of the device's network interface. Must not be longer than 128 characters.
`interfaceName`	`string`	InterfaceName specifies the name of the network interface associated with the allocated device. This might be the name of a physical or virtual network interface being configured in the pod. Must...
`ips`	`string[]`	IPs lists the network addresses assigned to the device's network interface. This can include both IPv4 and IPv6 addresses. The IPs are in the CIDR notation, which includes both the address and the...

V1beta1OpaqueDeviceConfiguration

OpaqueDeviceConfiguration contains configuration parameters for a driver in a format defined by the driver vendor.

Source

Property	Type	Description
`driver`	`string`	Driver is used to determine which kubelet plugin needs to be passed these configuration parameters. An admission policy provided by the driver developer could use this to decide whether it needs to...
`parameters`	`any`	Parameters can contain arbitrary data. It is the responsibility of the driver developer to handle validation and versioning. Typically this includes self-identification and a version ("kind" +...

V1beta1ParamKind

ParamKind is a tuple of Group Kind and Version.

Source

Property	Type	Description
`apiVersion`	`string`	APIVersion is the API group version the resources belong to. In format of "group/version". Required.
`kind`	`string`	Kind is the API kind the resources belong to. Required.

V1beta1ParamRef

ParamRef describes how to locate the params to be used as input to expressions of rules applied by a policy binding.

Source

Property	Type	Description
`name`	`string`	name is the name of the resource being referenced. One of `name` or `selector` must be set, but `name` and `selector` are mutually exclusive properties. If one is set, the other must be unset. A...
`namespace`	`string`	namespace is the namespace of the referenced resource. Allows limiting the search for params to a specific namespace. Applies to both `name` and `selector` fields. A per-namespace parameter may be...
`parameterNotFoundAction`	`string`	`parameterNotFoundAction` controls the behavior of the binding when the resource exists, and name or selector is valid, but there are no parameters matched by the binding. If the value is set to...
`selector`	V1LabelSelector

V1beta1ParentReference

ParentReference describes a reference to a parent object.

Source

Property	Type	Description
`group`	`string`	Group is the group of the object being referenced.
`name`	`string`	Name is the name of the object being referenced.
`namespace`	`string`	Namespace is the namespace of the object being referenced.
`resource`	`string`	Resource is the resource of the object being referenced.

V1beta1PodCertificateRequest

PodCertificateRequest encodes a pod requesting a certificate from a given signer. Kubelets use this API to implement podCertificate projected 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`	V1beta1PodCertificateRequestSpec
`status`	V1beta1PodCertificateRequestStatus

V1beta1PodCertificateRequestList

PodCertificateRequestList is a collection of PodCertificateRequest 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`	V1beta1PodCertificateRequest[]	items is a collection of PodCertificateRequest 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.CertificatesV1beta1Api);

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

Used by: CertificatesV1beta1Api.listNamespacedPodCertificateRequest · CertificatesV1beta1Api.listPodCertificateRequestForAllNamespaces

V1beta1PodCertificateRequestSpec

PodCertificateRequestSpec describes the certificate request. All fields are immutable after creation.

Source

Property	Type	Description
`maxExpirationSeconds`	`number`	maxExpirationSeconds is the maximum lifetime permitted for the certificate. If omitted, kube-apiserver will set it to 86400(24 hours). kube-apiserver will reject values shorter than 3600 (1 hour). ...
`nodeName`	`string`	nodeName is the name of the node the pod is assigned to.
`nodeUID`	`string`	nodeUID is the UID of the node the pod is assigned to.
`pkixPublicKey`	`string`	pkixPublicKey is the PKIX-serialized public key the signer will issue the certificate to. The key must be one of RSA3072, RSA4096, ECDSAP256, ECDSAP384, ECDSAP521, or ED25519. Note that this list...
`podName`	`string`	podName is the name of the pod into which the certificate will be mounted.
`podUID`	`string`	podUID is the UID of the pod into which the certificate will be mounted.
`proofOfPossession`	`string`	proofOfPossession proves that the requesting kubelet holds the private key corresponding to pkixPublicKey. It is contructed by signing the ASCII bytes of the pod's UID using `pkixPublicKey`. ...
`serviceAccountName`	`string`	serviceAccountName is the name of the service account the pod is running as.
`serviceAccountUID`	`string`	serviceAccountUID is the UID of the service account the pod is running as.
`signerName`	`string`	signerName indicates the requested signer. All signer names beginning with `kubernetes.io` are reserved for use by the Kubernetes project. There is currently one well-known signer documented by the...
`unverifiedUserAnnotations`	`{ [key: string]: string`	unverifiedUserAnnotations allow pod authors to pass additional information to the signer implementation. Kubernetes does not restrict or validate this metadata in any way. Entries are subject to...

V1beta1PodCertificateRequestStatus

PodCertificateRequestStatus describes the status of the request, and holds the certificate data if the request is issued.

Source

Property	Type	Description
`beginRefreshAt`	`Date`	beginRefreshAt is the time at which the kubelet should begin trying to refresh the certificate. This field is set via the /status subresource, and must be set at the same time as certificateChain. ...
`certificateChain`	`string`	certificateChain is populated with an issued certificate by the signer. This field is set via the /status subresource. Once populated, this field is immutable. If the certificate signing request is...
`conditions`	V1Condition[]	conditions applied to the request. The types "Issued", "Denied", and "Failed" have special handling. At most one of these conditions may be present, and they must have status "True". If...
`notAfter`	`Date`	notAfter is the time at which the certificate expires. The value must be the same as the notAfter value in the leaf certificate in certificateChain. This field is set via the /status subresource. ...
`notBefore`	`Date`	notBefore is the time at which the certificate becomes valid. The value must be the same as the notBefore value in the leaf certificate in certificateChain. This field is set via the /status...

V1beta1ResourceClaim

ResourceClaim describes a request for access to resources in the cluster, for use by workloads. For example, if a workload needs an accelerator device with specific properties, this is how that request is expressed. The status stanza tracks whether this claim has been satisfied and what specific resources have been allocated. This is an alpha type and requires enabling the DynamicResourceAllocation feature gate.

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`	V1beta1ResourceClaimSpec
`status`	V1beta1ResourceClaimStatus

Example

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

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

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

Used by: ResourceV1beta1Api.createNamespacedResourceClaim · ResourceV1beta1Api.readNamespacedResourceClaim · ResourceV1beta1Api.readNamespacedResourceClaimStatus

V1beta1ResourceClaimConsumerReference

ResourceClaimConsumerReference contains enough information to let you locate the consumer of a ResourceClaim. The user must be a resource in the same namespace as the ResourceClaim.

Source

Property	Type	Description
`apiGroup`	`string`	APIGroup is the group for the resource being referenced. It is empty for the core API. This matches the group in the APIVersion that is used when creating the resources.
`name`	`string`	Name is the name of resource being referenced.
`resource`	`string`	Resource is the type of resource being referenced, for example "pods".
`uid`	`string`	UID identifies exactly one incarnation of the resource.

V1beta1ResourceClaimList

ResourceClaimList is a collection of claims.

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`	V1beta1ResourceClaim[]	Items is the list of resource claims.
`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.ResourceV1beta1Api);

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

Used by: ResourceV1beta1Api.listNamespacedResourceClaim · ResourceV1beta1Api.listResourceClaimForAllNamespaces

V1beta1ResourceClaimSpec

ResourceClaimSpec defines what is being requested in a ResourceClaim and how to configure it.

Source

Property	Type	Description
`devices`	V1beta1DeviceClaim

V1beta1ResourceClaimStatus

ResourceClaimStatus tracks whether the resource has been allocated and what the result of that was.

Source

Property	Type	Description
`devices`	V1beta1AllocatedDeviceStatus[]	Devices contains the status of each device allocated for this claim, as reported by the driver. This can include driver-specific information. Entries are owned by their respective drivers.
`reservedFor`	V1beta1ResourceClaimConsumerReference[]	ReservedFor indicates which entities are currently allowed to use the claim. A Pod which references a ResourceClaim which is not reserved for that Pod will not be started. A claim that is in use or...
`allocation`	V1beta1AllocationResult

V1beta1ResourceClaimTemplate

ResourceClaimTemplate is used to produce ResourceClaim objects. This is an alpha type and requires enabling the DynamicResourceAllocation feature gate.

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`	V1beta1ResourceClaimTemplateSpec

Example

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

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

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

Used by: ResourceV1beta1Api.createNamespacedResourceClaimTemplate · ResourceV1beta1Api.patchNamespacedResourceClaimTemplate · ResourceV1beta1Api.readNamespacedResourceClaimTemplate

V1beta1ResourceClaimTemplateList

ResourceClaimTemplateList is a collection of claim templates.

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`	V1beta1ResourceClaimTemplate[]	Items is the list of resource claim 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.ResourceV1beta1Api);

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

Used by: ResourceV1beta1Api.listNamespacedResourceClaimTemplate · ResourceV1beta1Api.listResourceClaimTemplateForAllNamespaces

V1beta1ResourceClaimTemplateSpec

ResourceClaimTemplateSpec contains the metadata and fields for a ResourceClaim.

Source

Property	Type	Description
`metadata`	V1ObjectMeta
`spec`	V1beta1ResourceClaimSpec

V1beta1ResourcePool

ResourcePool describes the pool that ResourceSlices belong to.

Source

Property	Type	Description
`generation`	`number`	Generation tracks the change in a pool over time. Whenever a driver changes something about one or more of the resources in a pool, it must change the generation in all ResourceSlices which are part...
`name`	`string`	Name is used to identify the pool. For node-local devices, this is often the node name, but this is not required. It must not be longer than 253 characters and must consist of one or more DNS...
`resourceSliceCount`	`number`	ResourceSliceCount is the total number of ResourceSlices in the pool at this generation number. Must be greater than zero. Consumers can use this to check whether they have seen all ResourceSlices...

V1beta1ResourceSlice

ResourceSlice represents one or more resources in a pool of similar resources, managed by a common driver. A pool may span more than one ResourceSlice, and exactly how many ResourceSlices comprise a pool is determined by the driver. At the moment, the only supported resources are devices with attributes and capacities. Each device in a given pool, regardless of how many ResourceSlices, must have a unique name. The ResourceSlice in which a device gets published may change over time. The unique identifier for a device is the tuple , , . Whenever a driver needs to update a pool, it increments the pool.Spec.Pool.Generation number and updates all ResourceSlices with that new number and new resource definitions. A consumer must only use ResourceSlices with the highest generation number and ignore all others. When allocating all resources in a pool matching certain criteria or when looking for the best solution among several different alternatives, a consumer should check the number of ResourceSlices in a pool (included in each ResourceSlice) to determine whether its view of a pool is complete and if not, should wait until the driver has completed updating the pool. For resources that are not local to a node, the node name is not set. Instead, the driver may use a node selector to specify where the devices are available. This is an alpha type and requires enabling the DynamicResourceAllocation feature gate.

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`	V1beta1ResourceSliceSpec

Example

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

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

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

Used by: ResourceV1beta1Api.createResourceSlice · ResourceV1beta1Api.patchResourceSlice · ResourceV1beta1Api.readResourceSlice

V1beta1ResourceSliceList

ResourceSliceList is a collection of ResourceSlices.

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`	V1beta1ResourceSlice[]	Items is the list of resource ResourceSlices.
`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.ResourceV1beta1Api);

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

Used by: ResourceV1beta1Api.listResourceSlice

V1beta1ResourceSliceSpec

ResourceSliceSpec contains the information published by the driver in one ResourceSlice.

Source

Property	Type	Description
`allNodes`	`boolean`	AllNodes indicates that all nodes have access to the resources in the pool. Exactly one of NodeName, NodeSelector, AllNodes, and PerDeviceNodeSelection must be set.
`devices`	V1beta1Device[]	Devices lists some or all of the devices in this pool. Must not have more than 128 entries. If any device uses taints or consumes counters the limit is 64. Only one of Devices and SharedCounters...
`driver`	`string`	Driver identifies the DRA driver providing the capacity information. A field selector can be used to list only ResourceSlice objects with a certain driver name. Must be a DNS subdomain and should...
`nodeName`	`string`	NodeName identifies the node which provides the resources in this pool. A field selector can be used to list only ResourceSlice objects belonging to a certain node. This field can be used to limit...
`perDeviceNodeSelection`	`boolean`	PerDeviceNodeSelection defines whether the access from nodes to resources in the pool is set on the ResourceSlice level or on each device. If it is set to true, every device defined the ResourceSlice...
`sharedCounters`	V1beta1CounterSet[]	SharedCounters defines a list of counter sets, each of which has a name and a list of counters available. The names of the counter sets must be unique in the ResourcePool. Only one of Devices and...
`nodeSelector`	V1NodeSelector
`pool`	V1beta1ResourcePool

V1beta1ServiceCIDR

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`	V1beta1ServiceCIDRSpec
`status`	V1beta1ServiceCIDRStatus

Example

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

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

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

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

V1beta1ServiceCIDRList

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`	V1beta1ServiceCIDR[]	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.NetworkingV1beta1Api);

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

Used by: NetworkingV1beta1Api.listServiceCIDR

V1beta1ServiceCIDRSpec

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...

V1beta1ServiceCIDRStatus

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

V1beta1StorageVersionMigration

StorageVersionMigration represents a migration of stored data to the latest storage version.

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`	V1beta1StorageVersionMigrationSpec
`status`	V1beta1StorageVersionMigrationStatus

Example

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

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

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

Used by: StoragemigrationV1beta1Api.createStorageVersionMigration · StoragemigrationV1beta1Api.readStorageVersionMigration · StoragemigrationV1beta1Api.readStorageVersionMigrationStatus

V1beta1StorageVersionMigrationList

StorageVersionMigrationList is a collection of storage version migrations.

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`	V1beta1StorageVersionMigration[]	Items is the list of StorageVersionMigration
`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.StoragemigrationV1beta1Api);

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

Used by: StoragemigrationV1beta1Api.listStorageVersionMigration

V1beta1StorageVersionMigrationSpec

Spec of the storage version migration.

Source

Property	Type	Description
`resource`	V1GroupResource

V1beta1StorageVersionMigrationStatus

Status of the storage version migration.

Source

Property	Type	Description
`conditions`	V1Condition[]	The latest available observations of the migration's current state.
`resourceVersion`	`string`	ResourceVersion to compare with the GC cache for performing the migration. This is the current resource version of given group, version and resource when kube-controller-manager first observes this...

V1beta1Variable

Variable is the definition of a variable that is used for composition. A variable is defined as a named expression.

Source

Property	Type	Description
`expression`	`string`	Expression is the expression that will be evaluated as the value of the variable. The CEL expression has access to the same identifiers as the CEL expressions in Validation.
`name`	`string`	Name is the name of the variable. The name must be a valid CEL identifier and unique among all variables. The variable can be accessed in other expressions through `variables` For example, if name is...

V1beta1VolumeAttributesClass

VolumeAttributesClass represents a specification of mutable volume attributes defined by the CSI driver. The class can be specified during dynamic provisioning of PersistentVolumeClaims, and changed in the PersistentVolumeClaim spec after provisioning.

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:...
`driverName`	`string`	Name of the CSI driver This field is immutable.
`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:...
`parameters`	`{ [key: string]: string`	parameters hold volume attributes defined by the CSI driver. These values are opaque to the Kubernetes and are passed directly to the CSI driver. The underlying storage provider supports changing...
`metadata`	V1ObjectMeta

Example

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

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

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

Used by: StorageV1beta1Api.createVolumeAttributesClass · StorageV1beta1Api.patchVolumeAttributesClass · StorageV1beta1Api.readVolumeAttributesClass

V1beta1VolumeAttributesClassList

VolumeAttributesClassList is a collection of VolumeAttributesClass 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`	V1beta1VolumeAttributesClass[]	items is the list of VolumeAttributesClass 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.StorageV1beta1Api);

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

Used by: StorageV1beta1Api.listVolumeAttributesClass

V1beta2AllocatedDeviceStatus

AllocatedDeviceStatus contains the status of an allocated device, if the driver chooses to report it. This may include driver-specific information. The combination of Driver, Pool, Device, and ShareID must match the corresponding key in Status.Allocation.Devices.

Source

Property	Type	Description
`conditions`	V1Condition[]	Conditions contains the latest observation of the device's state. If the device has been configured according to the class and claim config references, the `Ready` condition should be True. Must...
`data`	`any`	Data contains arbitrary driver-specific data. The length of the raw data must be smaller or equal to 10 Ki.
`device`	`string`	Device references one device instance via its name in the driver's resource pool. It must be a DNS label.
`driver`	`string`	Driver specifies the name of the DRA driver whose kubelet plugin should be invoked to process the allocation once the claim is needed on a node. Must be a DNS subdomain and should end with a DNS...
`pool`	`string`	This name together with the driver name and the device name field identify which device was allocated (`<driver name>/<pool name>/<device name>`). Must not be longer than 253 characters and may...
`shareID`	`string`	ShareID uniquely identifies an individual allocation share of the device.
`networkData`	V1beta2NetworkDeviceData

V1beta2AllocationResult

AllocationResult contains attributes of an allocated resource.

Source

Property	Type	Description
`allocationTimestamp`	`Date`	AllocationTimestamp stores the time when the resources were allocated. This field is not guaranteed to be set, in which case that time is unknown. This is an alpha field and requires enabling the...
`devices`	V1beta2DeviceAllocationResult
`nodeSelector`	V1NodeSelector

V1beta2CELDeviceSelector

CELDeviceSelector contains a CEL expression for selecting a device.

Source

Property	Type	Description
`expression`	`string`	Expression is a CEL expression which evaluates a single device. It must evaluate to true when the device under consideration satisfies the desired criteria, and false when it does not. Any other...

V1beta2CapacityRequestPolicy

CapacityRequestPolicy defines how requests consume device capacity. Must not set more than one ValidRequestValues.

Source

Property	Type	Description
`_default`	`string`	Default specifies how much of this capacity is consumed by a request that does not contain an entry for it in DeviceRequest's Capacity.
`validValues`	`string[]`	ValidValues defines a set of acceptable quantity values in consuming requests. Must not contain more than 10 entries. Must be sorted in ascending order. If this field is set, Default must be...
`validRange`	V1beta2CapacityRequestPolicyRange

V1beta2CapacityRequestPolicyRange

CapacityRequestPolicyRange defines a valid range for consumable capacity values. - If the requested amount is less than Min, it is rounded up to the Min value. - If Step is set and the requested amount is between Min and Max but not aligned with Step, it will be rounded up to the next value equal to Min + (n * Step). - If Step is not set, the requested amount is used as-is if it falls within the range Min to Max (if set). - If the requested or rounded amount exceeds Max (if set), the request does not satisfy the policy, and the device cannot be allocated.

Source

Property	Type	Description
`max`	`string`	Max defines the upper limit for capacity that can be requested. Max must be less than or equal to the capacity value. Min and requestPolicy.default must be less than or equal to the maximum.
`min`	`string`	Min specifies the minimum capacity allowed for a consumption request. Min must be greater than or equal to zero, and less than or equal to the capacity value. requestPolicy.default must be more than...
`step`	`string`	Step defines the step size between valid capacity amounts within the range. Max (if set) and requestPolicy.default must be a multiple of Step. Min + Step must be less than or equal to the capacity...

V1beta2CapacityRequirements

CapacityRequirements defines the capacity requirements for a specific device request.

Source

Property	Type	Description
`requests`	`{ [key: string]: string`	Requests represent individual device resource requests for distinct resources, all of which must be provided by the device. This value is used as an additional filtering condition against the...

V1beta2Counter

Counter describes a quantity associated with a device.

Source

Property	Type	Description
`value`	`string`	Value defines how much of a certain device counter is available.

V1beta2CounterSet

CounterSet defines a named set of counters that are available to be used by devices defined in the ResourcePool. The counters are not allocatable by themselves, but can be referenced by devices. When a device is allocated, the portion of counters it uses will no longer be available for use by other devices.

Source

Property	Type	Description
`counters`	{ [key: string]: V1beta2Counter	Counters defines the set of counters for this CounterSet The name of each counter must be unique in that set and must be a DNS label. The maximum number of counters is 32.
`name`	`string`	Name defines the name of the counter set. It must be a DNS label.

V1beta2Device

Device represents one individual hardware instance that can be selected based on its attributes. Besides the name, exactly one field must be set.

Source

Property	Type	Description
`allNodes`	`boolean`	AllNodes indicates that all nodes have access to the device. Must only be set if Spec.PerDeviceNodeSelection is set to true. At most one of NodeName, NodeSelector and AllNodes can be set.
`allowMultipleAllocations`	`boolean`	AllowMultipleAllocations marks whether the device is allowed to be allocated to multiple DeviceRequests. If AllowMultipleAllocations is set to true, the device can be allocated more than once, and...
`attributes`	{ [key: string]: V1beta2DeviceAttribute	Attributes defines the set of attributes for this device. The name of each attribute must be unique in that set. The maximum number of attributes and capacities combined is 32.
`bindingConditions`	`string[]`	BindingConditions defines the conditions for proceeding with binding. All of these conditions must be set in the per-device status conditions with a value of True to proceed with binding the pod to...
`bindingFailureConditions`	`string[]`	BindingFailureConditions defines the conditions for binding failure. They may be set in the per-device status conditions. If any is set to "True", a binding failure occurred. The maximum number of...
`bindsToNode`	`boolean`	BindsToNode indicates if the usage of an allocation involving this device has to be limited to exactly the node that was chosen when allocating the claim. If set to true, the scheduler will set the...
`capacity`	{ [key: string]: V1beta2DeviceCapacity	Capacity defines the set of capacities for this device. The name of each capacity must be unique in that set. The maximum number of attributes and capacities combined is 32.
`consumesCounters`	V1beta2DeviceCounterConsumption[]	ConsumesCounters defines a list of references to sharedCounters and the set of counters that the device will consume from those counter sets. There can only be a single entry per counterSet. The...
`name`	`string`	Name is unique identifier among all devices managed by the driver in the pool. It must be a DNS label.
`nodeName`	`string`	NodeName identifies the node where the device is available. Must only be set if Spec.PerDeviceNodeSelection is set to true. At most one of NodeName, NodeSelector and AllNodes can be set.
`taints`	V1beta2DeviceTaint[]	If specified, these are the driver-defined taints. The maximum number of taints is 16. If taints are set for any device in a ResourceSlice, then the maximum number of allowed devices per...
`nodeSelector`	V1NodeSelector

V1beta2DeviceAllocationConfiguration

DeviceAllocationConfiguration gets embedded in an AllocationResult.

Source

Property	Type	Description
`requests`	`string[]`	Requests lists the names of requests where the configuration applies. If empty, its applies to all requests. References to subrequests must include the name of the main request and may include the...
`source`	`string`	Source records whether the configuration comes from a class and thus is not something that a normal user would have been able to set or from a claim.
`opaque`	V1beta2OpaqueDeviceConfiguration

V1beta2DeviceAllocationResult

DeviceAllocationResult is the result of allocating devices.

Source

Property	Type	Description
`config`	V1beta2DeviceAllocationConfiguration[]	This field is a combination of all the claim and class configuration parameters. Drivers can distinguish between those based on a flag. This includes configuration parameters for drivers which have...
`results`	V1beta2DeviceRequestAllocationResult[]	Results lists all allocated devices.

V1beta2DeviceAttribute

DeviceAttribute must have exactly one field set.

Source

Property	Type	Description
`bool`	`boolean`	BoolValue is a true/false value.
`_int`	`number`	IntValue is a number.
`string`	`string`	StringValue is a string. Must not be longer than 64 characters.
`version`	`string`	VersionValue is a semantic version according to semver.org spec 2.0.0. Must not be longer than 64 characters.

V1beta2DeviceCapacity

DeviceCapacity describes a quantity associated with a device.

Source

Property	Type	Description
`value`	`string`	Value defines how much of a certain capacity that device has. This field reflects the fixed total capacity and does not change. The consumed amount is tracked separately by scheduler and does not...
`requestPolicy`	V1beta2CapacityRequestPolicy

V1beta2DeviceClaim

DeviceClaim defines how to request devices with a ResourceClaim.

Source

Property	Type	Description
`config`	V1beta2DeviceClaimConfiguration[]	This field holds configuration for multiple potential drivers which could satisfy requests in this claim. It is ignored while allocating the claim.
`constraints`	V1beta2DeviceConstraint[]	These constraints must be satisfied by the set of devices that get allocated for the claim.
`requests`	V1beta2DeviceRequest[]	Requests represent individual requests for distinct devices which must all be satisfied. If empty, nothing needs to be allocated.

V1beta2DeviceClaimConfiguration

DeviceClaimConfiguration is used for configuration parameters in DeviceClaim.

Source

Property	Type	Description
`requests`	`string[]`	Requests lists the names of requests where the configuration applies. If empty, it applies to all requests. References to subrequests must include the name of the main request and may include the...
`opaque`	V1beta2OpaqueDeviceConfiguration

V1beta2DeviceClass

DeviceClass is a vendor- or admin-provided resource that contains device configuration and selectors. It can be referenced in the device requests of a claim to apply these presets. Cluster scoped. This is an alpha type and requires enabling the DynamicResourceAllocation feature gate.

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`	V1beta2DeviceClassSpec

Example

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

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

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

Used by: ResourceV1beta2Api.createDeviceClass · ResourceV1beta2Api.patchDeviceClass · ResourceV1beta2Api.readDeviceClass

V1beta2DeviceClassConfiguration

DeviceClassConfiguration is used in DeviceClass.

Source

Property	Type	Description
`opaque`	V1beta2OpaqueDeviceConfiguration

V1beta2DeviceClassList

DeviceClassList is a collection of classes.

Source

Property	Type	Description
`apiVersion`	`string`	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info:...
`items`	V1beta2DeviceClass[]	Items is the list of resource classes.
`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.ResourceV1beta2Api);

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

Used by: ResourceV1beta2Api.listDeviceClass

V1beta2DeviceClassSpec

DeviceClassSpec is used in a [DeviceClass] to define what can be allocated and how to configure it.

Source

Property	Type	Description
`config`	V1beta2DeviceClassConfiguration[]	Config defines configuration parameters that apply to each device that is claimed via this class. Some classses may potentially be satisfied by multiple drivers, so each instance of a vendor...
`extendedResourceName`	`string`	ExtendedResourceName is the extended resource name for the devices of this class. The devices of this class can be used to satisfy a pod's extended resource requests. It has the same format as the...
`selectors`	V1beta2DeviceSelector[]	Each selector must be satisfied by a device which is claimed via this class.

V1beta2DeviceConstraint

DeviceConstraint must have exactly one field set besides Requests.

Source

Property	Type	Description
`distinctAttribute`	`string`	DistinctAttribute requires that all devices in question have this attribute and that its type and value are unique across those devices. This acts as the inverse of MatchAttribute. This constraint...
`matchAttribute`	`string`	MatchAttribute requires that all devices in question have this attribute and that its type and value are the same across those devices. For example, if you specified "dra.example.com/numa" (a...
`requests`	`string[]`	Requests is a list of the one or more requests in this claim which must co-satisfy this constraint. If a request is fulfilled by multiple devices, then all of the devices must satisfy the constraint....

V1beta2DeviceCounterConsumption

DeviceCounterConsumption defines a set of counters that a device will consume from a CounterSet.

Source

Property	Type	Description
`counterSet`	`string`	CounterSet is the name of the set from which the counters defined will be consumed.
`counters`	{ [key: string]: V1beta2Counter	Counters defines the counters that will be consumed by the device. The maximum number of counters is 32.

V1beta2DeviceRequest

DeviceRequest is a request for devices required for a claim. This is typically a request for a single resource like a device, but can also ask for several identical devices. With FirstAvailable it is also possible to provide a prioritized list of requests.

Source

Property	Type	Description
`firstAvailable`	V1beta2DeviceSubRequest[]	FirstAvailable contains subrequests, of which exactly one will be selected by the scheduler. It tries to satisfy them in the order in which they are listed here. So if there are two entries in the...
`name`	`string`	Name can be used to reference this request in a pod.spec.containers[].resources.claims entry and in a constraint of the claim. References using the name in the DeviceRequest will uniquely identify a...
`exactly`	V1beta2ExactDeviceRequest

V1beta2DeviceRequestAllocationResult

DeviceRequestAllocationResult contains the allocation result for one request.

Source

Property	Type	Description
`adminAccess`	`boolean`	AdminAccess indicates that this device was allocated for administrative access. See the corresponding request field for a definition of mode. This is an alpha field and requires enabling the...
`bindingConditions`	`string[]`	BindingConditions contains a copy of the BindingConditions from the corresponding ResourceSlice at the time of allocation. This is an alpha field and requires enabling the DRADeviceBindingConditions...
`bindingFailureConditions`	`string[]`	BindingFailureConditions contains a copy of the BindingFailureConditions from the corresponding ResourceSlice at the time of allocation. This is an alpha field and requires enabling the...
`consumedCapacity`	`{ [key: string]: string`	ConsumedCapacity tracks the amount of capacity consumed per device as part of the claim request. The consumed amount may differ from the requested amount: it is rounded up to the nearest valid value...
`device`	`string`	Device references one device instance via its name in the driver's resource pool. It must be a DNS label.
`driver`	`string`	Driver specifies the name of the DRA driver whose kubelet plugin should be invoked to process the allocation once the claim is needed on a node. Must be a DNS subdomain and should end with a DNS...
`pool`	`string`	This name together with the driver name and the device name field identify which device was allocated (`<driver name>/<pool name>/<device name>`). Must not be longer than 253 characters and may...
`request`	`string`	Request is the name of the request in the claim which caused this device to be allocated. If it references a subrequest in the firstAvailable list on a DeviceRequest, this field must include both the...
`shareID`	`string`	ShareID uniquely identifies an individual allocation share of the device, used when the device supports multiple simultaneous allocations. It serves as an additional map key to differentiate...
`tolerations`	V1beta2DeviceToleration[]	A copy of all tolerations specified in the request at the time when the device got allocated. The maximum number of tolerations is 16. This is an alpha field and requires enabling the...

V1beta2DeviceSelector

DeviceSelector must have exactly one field set.

Source

Property	Type	Description
`cel`	V1beta2CELDeviceSelector

V1beta2DeviceSubRequest

DeviceSubRequest describes a request for device provided in the claim.spec.devices.requests[].firstAvailable array. Each is typically a request for a single resource like a device, but can also ask for several identical devices. DeviceSubRequest is similar to ExactDeviceRequest, but doesn't expose the AdminAccess field as that one is only supported when requesting a specific device.

Source

Property	Type	Description
`allocationMode`	`string`	AllocationMode and its related fields define how devices are allocated to satisfy this subrequest. Supported values are: - ExactCount: This request is for a specific number of devices. This is the...
`count`	`number`	Count is used only when the count mode is "ExactCount". Must be greater than zero. If AllocationMode is ExactCount and this field is not specified, the default is one.
`deviceClassName`	`string`	DeviceClassName references a specific DeviceClass, which can define additional configuration and selectors to be inherited by this subrequest. A class is required. Which classes are available...
`name`	`string`	Name can be used to reference this subrequest in the list of constraints or the list of configurations for the claim. References must use the format /. Must be a DNS label.
`selectors`	V1beta2DeviceSelector[]	Selectors define criteria which must be satisfied by a specific device in order for that device to be considered for this subrequest. All selectors must be satisfied for a device to be considered.
`tolerations`	V1beta2DeviceToleration[]	If specified, the request's tolerations. Tolerations for NoSchedule are required to allocate a device which has a taint with that effect. The same applies to NoExecute. In addition, should any of...
`capacity`	V1beta2CapacityRequirements

V1beta2DeviceTaint

The device this taint is attached to has the "effect" on any claim which does not tolerate the taint and, through the claim, to pods using the claim.

Source

Property	Type	Description
`effect`	`string`	The effect of the taint on claims that do not tolerate the taint and through such claims on the pods using them. Valid effects are None, NoSchedule and NoExecute. PreferNoSchedule as used for nodes...
`key`	`string`	The taint key to be applied to a device. Must be a label name.
`timeAdded`	`Date`	TimeAdded represents the time at which the taint was added. Added automatically during create or update if not set.
`value`	`string`	The taint value corresponding to the taint key. Must be a label value.

V1beta2DeviceToleration

The ResourceClaim this DeviceToleration is attached to tolerates any taint that matches the triple <key,value,effect> using the matching operator .

Source

Property	Type	Description
`effect`	`string`	Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule and NoExecute.
`key`	`string`	Key is the taint key that the toleration applies to. Empty means match all taint keys. If the key is empty, operator must be Exists; this combination means to match all values and all keys. Must be a...
`operator`	`string`	Operator represents a key's relationship to the value. Valid operators are Exists and Equal. Defaults to Equal. Exists is equivalent to wildcard for value, so that a ResourceClaim can tolerate all...
`tolerationSeconds`	`number`	TolerationSeconds represents the period of time the toleration (which must be of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, it is not set, which means...
`value`	`string`	Value is the taint value the toleration matches to. If the operator is Exists, the value must be empty, otherwise just a regular string. Must be a label value.

V1beta2ExactDeviceRequest

ExactDeviceRequest is a request for one or more identical devices.

Source

Property	Type	Description
`adminAccess`	`boolean`	AdminAccess indicates that this is a claim for administrative access to the device(s). Claims with AdminAccess are expected to be used for monitoring or other management services for a device. They...
`allocationMode`	`string`	AllocationMode and its related fields define how devices are allocated to satisfy this request. Supported values are: - ExactCount: This request is for a specific number of devices. This is the...
`count`	`number`	Count is used only when the count mode is "ExactCount". Must be greater than zero. If AllocationMode is ExactCount and this field is not specified, the default is one.
`deviceClassName`	`string`	DeviceClassName references a specific DeviceClass, which can define additional configuration and selectors to be inherited by this request. A DeviceClassName is required. Administrators may use...
`selectors`	V1beta2DeviceSelector[]	Selectors define criteria which must be satisfied by a specific device in order for that device to be considered for this request. All selectors must be satisfied for a device to be considered.
`tolerations`	V1beta2DeviceToleration[]	If specified, the request's tolerations. Tolerations for NoSchedule are required to allocate a device which has a taint with that effect. The same applies to NoExecute. In addition, should any of...
`capacity`	V1beta2CapacityRequirements

V1beta2NetworkDeviceData

NetworkDeviceData provides network-related details for the allocated device. This information may be filled by drivers or other components to configure or identify the device within a network context.

Source

Property	Type	Description
`hardwareAddress`	`string`	HardwareAddress represents the hardware address (e.g. MAC Address) of the device's network interface. Must not be longer than 128 characters.
`interfaceName`	`string`	InterfaceName specifies the name of the network interface associated with the allocated device. This might be the name of a physical or virtual network interface being configured in the pod. Must...
`ips`	`string[]`	IPs lists the network addresses assigned to the device's network interface. This can include both IPv4 and IPv6 addresses. The IPs are in the CIDR notation, which includes both the address and the...

V1beta2OpaqueDeviceConfiguration

OpaqueDeviceConfiguration contains configuration parameters for a driver in a format defined by the driver vendor.

Source

Property	Type	Description
`driver`	`string`	Driver is used to determine which kubelet plugin needs to be passed these configuration parameters. An admission policy provided by the driver developer could use this to decide whether it needs to...
`parameters`	`any`	Parameters can contain arbitrary data. It is the responsibility of the driver developer to handle validation and versioning. Typically this includes self-identification and a version ("kind" +...

V1beta2ResourceClaim

ResourceClaim describes a request for access to resources in the cluster, for use by workloads. For example, if a workload needs an accelerator device with specific properties, this is how that request is expressed. The status stanza tracks whether this claim has been satisfied and what specific resources have been allocated. This is an alpha type and requires enabling the DynamicResourceAllocation feature gate.

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`	V1beta2ResourceClaimSpec
`status`	V1beta2ResourceClaimStatus

Example

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

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

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

Used by: ResourceV1beta2Api.createNamespacedResourceClaim · ResourceV1beta2Api.readNamespacedResourceClaim · ResourceV1beta2Api.readNamespacedResourceClaimStatus

V1beta2ResourceClaimConsumerReference

ResourceClaimConsumerReference contains enough information to let you locate the consumer of a ResourceClaim. The user must be a resource in the same namespace as the ResourceClaim.

Source

Property	Type	Description
`apiGroup`	`string`	APIGroup is the group for the resource being referenced. It is empty for the core API. This matches the group in the APIVersion that is used when creating the resources.
`name`	`string`	Name is the name of resource being referenced.
`resource`	`string`	Resource is the type of resource being referenced, for example "pods".
`uid`	`string`	UID identifies exactly one incarnation of the resource.

V1beta2ResourceClaimList

ResourceClaimList is a collection of claims.

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`	V1beta2ResourceClaim[]	Items is the list of resource claims.
`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.ResourceV1beta2Api);

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

Used by: ResourceV1beta2Api.listNamespacedResourceClaim · ResourceV1beta2Api.listResourceClaimForAllNamespaces

V1beta2ResourceClaimSpec

ResourceClaimSpec defines what is being requested in a ResourceClaim and how to configure it.

Source

Property	Type	Description
`devices`	V1beta2DeviceClaim

V1beta2ResourceClaimStatus

ResourceClaimStatus tracks whether the resource has been allocated and what the result of that was.

Source

Property	Type	Description
`devices`	V1beta2AllocatedDeviceStatus[]	Devices contains the status of each device allocated for this claim, as reported by the driver. This can include driver-specific information. Entries are owned by their respective drivers.
`reservedFor`	V1beta2ResourceClaimConsumerReference[]	ReservedFor indicates which entities are currently allowed to use the claim. A Pod which references a ResourceClaim which is not reserved for that Pod will not be started. A claim that is in use or...
`allocation`	V1beta2AllocationResult

V1beta2ResourceClaimTemplate

ResourceClaimTemplate is used to produce ResourceClaim objects. This is an alpha type and requires enabling the DynamicResourceAllocation feature gate.

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`	V1beta2ResourceClaimTemplateSpec

Example

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

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

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

Used by: ResourceV1beta2Api.createNamespacedResourceClaimTemplate · ResourceV1beta2Api.patchNamespacedResourceClaimTemplate · ResourceV1beta2Api.readNamespacedResourceClaimTemplate

V1beta2ResourceClaimTemplateList

ResourceClaimTemplateList is a collection of claim templates.

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`	V1beta2ResourceClaimTemplate[]	Items is the list of resource claim 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.ResourceV1beta2Api);

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

Used by: ResourceV1beta2Api.listNamespacedResourceClaimTemplate · ResourceV1beta2Api.listResourceClaimTemplateForAllNamespaces

V1beta2ResourceClaimTemplateSpec

ResourceClaimTemplateSpec contains the metadata and fields for a ResourceClaim.

Source

Property	Type	Description
`metadata`	V1ObjectMeta
`spec`	V1beta2ResourceClaimSpec

V1beta2ResourcePool

ResourcePool describes the pool that ResourceSlices belong to.

Source

Property	Type	Description
`generation`	`number`	Generation tracks the change in a pool over time. Whenever a driver changes something about one or more of the resources in a pool, it must change the generation in all ResourceSlices which are part...
`name`	`string`	Name is used to identify the pool. For node-local devices, this is often the node name, but this is not required. It must not be longer than 253 characters and must consist of one or more DNS...
`resourceSliceCount`	`number`	ResourceSliceCount is the total number of ResourceSlices in the pool at this generation number. Must be greater than zero. Consumers can use this to check whether they have seen all ResourceSlices...

V1beta2ResourceSlice

ResourceSlice represents one or more resources in a pool of similar resources, managed by a common driver. A pool may span more than one ResourceSlice, and exactly how many ResourceSlices comprise a pool is determined by the driver. At the moment, the only supported resources are devices with attributes and capacities. Each device in a given pool, regardless of how many ResourceSlices, must have a unique name. The ResourceSlice in which a device gets published may change over time. The unique identifier for a device is the tuple , , . Whenever a driver needs to update a pool, it increments the pool.Spec.Pool.Generation number and updates all ResourceSlices with that new number and new resource definitions. A consumer must only use ResourceSlices with the highest generation number and ignore all others. When allocating all resources in a pool matching certain criteria or when looking for the best solution among several different alternatives, a consumer should check the number of ResourceSlices in a pool (included in each ResourceSlice) to determine whether its view of a pool is complete and if not, should wait until the driver has completed updating the pool. For resources that are not local to a node, the node name is not set. Instead, the driver may use a node selector to specify where the devices are available. This is an alpha type and requires enabling the DynamicResourceAllocation feature gate.

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`	V1beta2ResourceSliceSpec

Example

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

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

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

Used by: ResourceV1beta2Api.createResourceSlice · ResourceV1beta2Api.patchResourceSlice · ResourceV1beta2Api.readResourceSlice

V1beta2ResourceSliceList

ResourceSliceList is a collection of ResourceSlices.

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`	V1beta2ResourceSlice[]	Items is the list of resource ResourceSlices.
`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.ResourceV1beta2Api);

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

Used by: ResourceV1beta2Api.listResourceSlice

V1beta2ResourceSliceSpec

ResourceSliceSpec contains the information published by the driver in one ResourceSlice.

Source

Property	Type	Description
`allNodes`	`boolean`	AllNodes indicates that all nodes have access to the resources in the pool. Exactly one of NodeName, NodeSelector, AllNodes, and PerDeviceNodeSelection must be set.
`devices`	V1beta2Device[]	Devices lists some or all of the devices in this pool. Must not have more than 128 entries. If any device uses taints or consumes counters the limit is 64. Only one of Devices and SharedCounters...
`driver`	`string`	Driver identifies the DRA driver providing the capacity information. A field selector can be used to list only ResourceSlice objects with a certain driver name. Must be a DNS subdomain and should...
`nodeName`	`string`	NodeName identifies the node which provides the resources in this pool. A field selector can be used to list only ResourceSlice objects belonging to a certain node. This field can be used to limit...
`perDeviceNodeSelection`	`boolean`	PerDeviceNodeSelection defines whether the access from nodes to resources in the pool is set on the ResourceSlice level or on each device. If it is set to true, every device defined the ResourceSlice...
`sharedCounters`	V1beta2CounterSet[]	SharedCounters defines a list of counter sets, each of which has a name and a list of counters available. The names of the counter sets must be unique in the ResourcePool. Only one of Devices and...
`nodeSelector`	V1NodeSelector
`pool`	V1beta2ResourcePool

V2ContainerResourceMetricSource

ContainerResourceMetricSource indicates how to scale on a resource metric known to Kubernetes, as specified in requests and limits, describing each pod in the current scale target (e.g. CPU or memory). The values will be averaged together before being compared to the target. Such metrics are built in to Kubernetes, and have special scaling options on top of those available to normal per-pod metrics using the "pods" source. Only one "target" type should be set.

Source

Property	Type	Description
`container`	`string`	container is the name of the container in the pods of the scaling target
`name`	`string`	name is the name of the resource in question.
`target`	V2MetricTarget

V2ContainerResourceMetricStatus

ContainerResourceMetricStatus indicates the current value of a resource metric known to Kubernetes, as specified in requests and limits, describing a single container in each pod in the current scale target (e.g. CPU or memory). Such metrics are built in to Kubernetes, and have special scaling options on top of those available to normal per-pod metrics using the "pods" source.

Source

Property	Type	Description
`container`	`string`	container is the name of the container in the pods of the scaling target
`name`	`string`	name is the name of the resource in question.
`current`	V2MetricValueStatus

V2CrossVersionObjectReference

CrossVersionObjectReference contains enough information to let you identify the referred resource.

Source

Property	Type	Description
`apiVersion`	`string`	apiVersion is the API version of the referent
`kind`	`string`	kind is the kind of the referent; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
`name`	`string`	name is the name of the referent; More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

V2ExternalMetricSource

ExternalMetricSource indicates how to scale on a metric not associated with any Kubernetes object (for example length of queue in cloud messaging service, or QPS from loadbalancer running outside of cluster).

Source

Property	Type	Description
`metric`	V2MetricIdentifier
`target`	V2MetricTarget

V2ExternalMetricStatus

ExternalMetricStatus indicates the current value of a global metric not associated with any Kubernetes object.

Source

Property	Type	Description
`current`	V2MetricValueStatus
`metric`	V2MetricIdentifier

V2HPAScalingPolicy

HPAScalingPolicy is a single policy which must hold true for a specified past interval.

Source

Property	Type	Description
`periodSeconds`	`number`	periodSeconds specifies the window of time for which the policy should hold true. PeriodSeconds must be greater than zero and less than or equal to 1800 (30 min).
`type`	`string`	type is used to specify the scaling policy.
`value`	`number`	value contains the amount of change which is permitted by the policy. It must be greater than zero

V2HPAScalingRules

HPAScalingRules configures the scaling behavior for one direction via scaling Policy Rules and a configurable metric tolerance. Scaling Policy Rules are applied after calculating DesiredReplicas from metrics for the HPA. They can limit the scaling velocity by specifying scaling policies. They can prevent flapping by specifying the stabilization window, so that the number of replicas is not set instantly, instead, the safest value from the stabilization window is chosen. The tolerance is applied to the metric values and prevents scaling too eagerly for small metric variations. (Note that setting a tolerance requires the beta HPAConfigurableTolerance feature gate to be enabled.)

Source

Property	Type	Description
`policies`	V2HPAScalingPolicy[]	policies is a list of potential scaling polices which can be used during scaling. If not set, use the default values: - For scale up: allow doubling the number of pods, or an absolute change of 4...
`selectPolicy`	`string`	selectPolicy is used to specify which policy should be used. If not set, the default value Max is used.
`stabilizationWindowSeconds`	`number`	stabilizationWindowSeconds is the number of seconds for which past recommendations should be considered while scaling up or scaling down. StabilizationWindowSeconds must be greater than or equal to...
`tolerance`	`string`	tolerance is the tolerance on the ratio between the current and desired metric value under which no updates are made to the desired number of replicas (e.g. 0.01 for 1%). Must be greater than or...

V2HorizontalPodAutoscaler

HorizontalPodAutoscaler is the configuration for a horizontal pod autoscaler, which automatically manages the replica count of any resource implementing the scale subresource based on the metrics specified.

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`	V2HorizontalPodAutoscalerSpec
`status`	V2HorizontalPodAutoscalerStatus

Example

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

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

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

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

V2HorizontalPodAutoscalerBehavior

HorizontalPodAutoscalerBehavior configures the scaling behavior of the target in both Up and Down directions (scaleUp and scaleDown fields respectively).

Source

Property	Type	Description
`scaleDown`	V2HPAScalingRules
`scaleUp`	V2HPAScalingRules

V2HorizontalPodAutoscalerCondition

HorizontalPodAutoscalerCondition describes the state of a HorizontalPodAutoscaler at a certain point.

Source

Property	Type	Description
`lastTransitionTime`	`Date`	lastTransitionTime is the last time the condition transitioned from one status to another
`message`	`string`	message is a human-readable explanation containing details about the transition
`reason`	`string`	reason is the reason for the condition's last transition.
`status`	`string`	status is the status of the condition (True, False, Unknown)
`type`	`string`	type describes the current condition

V2HorizontalPodAutoscalerList

HorizontalPodAutoscalerList is a list of horizontal pod autoscaler objects.

Source

Property	Type	Description
`apiVersion`	`string`	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info:...
`items`	V2HorizontalPodAutoscaler[]	items is the list of horizontal pod autoscaler objects.
`kind`	`string`	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info:...
`metadata`	V1ListMeta

Example

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

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

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

Used by: AutoscalingV2Api.listHorizontalPodAutoscalerForAllNamespaces · AutoscalingV2Api.listNamespacedHorizontalPodAutoscaler

V2HorizontalPodAutoscalerSpec

HorizontalPodAutoscalerSpec describes the desired functionality of the HorizontalPodAutoscaler.

Source

Property	Type	Description
`maxReplicas`	`number`	maxReplicas is the upper limit for the number of replicas to which the autoscaler can scale up. It cannot be less that minReplicas.
`metrics`	V2MetricSpec[]	metrics contains the specifications for which to use to calculate the desired replica count (the maximum replica count across all metrics will be used). The desired replica count is calculated...
`minReplicas`	`number`	minReplicas is the lower limit for the number of replicas to which the autoscaler can scale down. It defaults to 1 pod. minReplicas is allowed to be 0 if the alpha feature gate HPAScaleToZero is...
`behavior`	V2HorizontalPodAutoscalerBehavior
`scaleTargetRef`	V2CrossVersionObjectReference

V2HorizontalPodAutoscalerStatus

HorizontalPodAutoscalerStatus describes the current status of a horizontal pod autoscaler.

Source

Property	Type	Description
`conditions`	V2HorizontalPodAutoscalerCondition[]	conditions is the set of conditions required for this autoscaler to scale its target, and indicates whether or not those conditions are met.
`currentMetrics`	V2MetricStatus[]	currentMetrics is the last read state of the metrics used by this autoscaler.
`currentReplicas`	`number`	currentReplicas is current number of replicas of pods managed by this autoscaler, as last seen by the autoscaler.
`desiredReplicas`	`number`	desiredReplicas is the desired number of replicas of pods managed by this autoscaler, as last calculated by the autoscaler.
`lastScaleTime`	`Date`	lastScaleTime is the last time the HorizontalPodAutoscaler scaled the number of pods, used by the autoscaler to control how often the number of pods is changed.
`observedGeneration`	`number`	observedGeneration is the most recent generation observed by this autoscaler.

V2MetricIdentifier

MetricIdentifier defines the name and optionally selector for a metric

Source

Property	Type	Description
`name`	`string`	name is the name of the given metric
`selector`	V1LabelSelector

V2MetricSpec

MetricSpec specifies how to scale based on a single metric (only type and one other matching field should be set at once).

Source

Property	Type	Description
`type`	`string`	type is the type of metric source. It should be one of "ContainerResource", "External", "Object", "Pods" or "Resource", each mapping to a matching field in the object.
`containerResource`	V2ContainerResourceMetricSource
`external`	V2ExternalMetricSource
`object`	V2ObjectMetricSource
`pods`	V2PodsMetricSource
`resource`	V2ResourceMetricSource

V2MetricStatus

MetricStatus describes the last-read state of a single metric.

Source

Property	Type	Description
`type`	`string`	type is the type of metric source. It will be one of "ContainerResource", "External", "Object", "Pods" or "Resource", each corresponds to a matching field in the object.
`containerResource`	V2ContainerResourceMetricStatus
`external`	V2ExternalMetricStatus
`object`	V2ObjectMetricStatus
`pods`	V2PodsMetricStatus
`resource`	V2ResourceMetricStatus

V2MetricTarget

MetricTarget defines the target value, average value, or average utilization of a specific metric

Source

Property	Type	Description
`averageUtilization`	`number`	averageUtilization is the target value of the average of the resource metric across all relevant pods, represented as a percentage of the requested value of the resource for the pods. Currently only...
`averageValue`	`string`	averageValue is the target value of the average of the metric across all relevant pods (as a quantity)
`type`	`string`	type represents whether the metric type is Utilization, Value, or AverageValue
`value`	`string`	value is the target value of the metric (as a quantity).

V2MetricValueStatus

MetricValueStatus holds the current value for a metric

Source

Property	Type	Description
`averageUtilization`	`number`	currentAverageUtilization is the current value of the average of the resource metric across all relevant pods, represented as a percentage of the requested value of the resource for the pods.
`averageValue`	`string`	averageValue is the current value of the average of the metric across all relevant pods (as a quantity)
`value`	`string`	value is the current value of the metric (as a quantity).

V2ObjectMetricSource

ObjectMetricSource indicates how to scale on a metric describing a kubernetes object (for example, hits-per-second on an Ingress object).

Source

Property	Type	Description
`describedObject`	V2CrossVersionObjectReference
`metric`	V2MetricIdentifier
`target`	V2MetricTarget

V2ObjectMetricStatus

ObjectMetricStatus indicates the current value of a metric describing a kubernetes object (for example, hits-per-second on an Ingress object).

Source

Property	Type	Description
`current`	V2MetricValueStatus
`describedObject`	V2CrossVersionObjectReference
`metric`	V2MetricIdentifier

V2PodsMetricSource

PodsMetricSource indicates how to scale on a metric describing each pod in the current scale target (for example, transactions-processed-per-second). The values will be averaged together before being compared to the target value.

Source

Property	Type	Description
`metric`	V2MetricIdentifier
`target`	V2MetricTarget

V2PodsMetricStatus

PodsMetricStatus indicates the current value of a metric describing each pod in the current scale target (for example, transactions-processed-per-second).

Source

Property	Type	Description
`current`	V2MetricValueStatus
`metric`	V2MetricIdentifier

V2ResourceMetricSource

ResourceMetricSource indicates how to scale on a resource metric known to Kubernetes, as specified in requests and limits, describing each pod in the current scale target (e.g. CPU or memory). The values will be averaged together before being compared to the target. Such metrics are built in to Kubernetes, and have special scaling options on top of those available to normal per-pod metrics using the "pods" source. Only one "target" type should be set.

Source

Property	Type	Description
`name`	`string`	name is the name of the resource in question.
`target`	V2MetricTarget

V2ResourceMetricStatus

ResourceMetricStatus indicates the current value of a resource metric known to Kubernetes, as specified in requests and limits, describing each pod in the current scale target (e.g. CPU or memory). Such metrics are built in to Kubernetes, and have special scaling options on top of those available to normal per-pod metrics using the "pods" source.

Source

Property	Type	Description
`name`	`string`	name is the name of the resource in question.
`current`	V2MetricValueStatus

V1AWSElasticBlockStoreVolumeSource
V1Affinity
V1AggregationRule
V1AppArmorProfile
V1AttachedVolume
V1AuditAnnotation
V1AzureDiskVolumeSource
V1AzureFilePersistentVolumeSource
V1AzureFileVolumeSource
V1CELDeviceSelector
V1Capabilities
V1CapacityRequestPolicy
V1CapacityRequestPolicyRange
V1CapacityRequirements
V1CephFSPersistentVolumeSource
V1CephFSVolumeSource
V1CinderPersistentVolumeSource
V1CinderVolumeSource
V1ClientIPConfig
V1ClusterTrustBundleProjection
V1Condition
V1Container
V1ContainerExtendedResourceRequest
V1ContainerImage
V1ContainerPort
V1ContainerResizePolicy
V1ContainerRestartRule
V1ContainerRestartRuleOnExitCodes
V1ContainerState
V1ContainerStateRunning
V1ContainerStateTerminated
V1ContainerStateWaiting
V1ContainerStatus
V1ContainerUser
V1Counter
V1CounterSet
V1CrossVersionObjectReference
V1CustomResourceColumnDefinition
V1CustomResourceConversion
V1CustomResourceSubresourceScale
V1CustomResourceSubresources
V1CustomResourceValidation
V1DaemonEndpoint
V1DeleteOptions
V1Device
V1DeviceAttribute
V1DeviceCapacity
V1DeviceClaim
V1DeviceClaimConfiguration
V1DeviceClass
V1DeviceClassConfiguration
V1DeviceClassList
V1DeviceClassSpec
V1DeviceConstraint
V1DeviceCounterConsumption
V1DeviceRequest
V1DeviceSelector
V1DeviceSubRequest
V1DeviceTaint
V1DeviceToleration
V1DownwardAPIProjection
V1DownwardAPIVolumeFile
V1DownwardAPIVolumeSource
V1EmptyDirVolumeSource
V1EnvFromSource
V1EnvVar
V1EnvVarSource
V1EphemeralContainer
V1EphemeralVolumeSource
V1Eviction
V1ExactDeviceRequest
V1ExecAction
V1ExemptPriorityLevelConfiguration
V1ExpressionWarning
V1ExternalDocumentation
V1FCVolumeSource
V1FieldSelectorAttributes
V1FieldSelectorRequirement
V1FileKeySelector
V1FlexPersistentVolumeSource
V1FlexVolumeSource
V1FlockerVolumeSource
V1FlowDistinguisherMethod
V1ForNode
V1ForZone
V1GCEPersistentDiskVolumeSource
V1GRPCAction
V1GitRepoVolumeSource
V1GlusterfsPersistentVolumeSource
V1GlusterfsVolumeSource
V1GroupResource
V1HTTPGetAction
V1HTTPHeader
V1HTTPIngressPath
V1HTTPIngressRuleValue
V1HostAlias
V1HostIP
V1HostPathVolumeSource
V1IPBlock
V1ISCSIPersistentVolumeSource
V1ISCSIVolumeSource
V1ImageVolumeSource
V1JSONSchemaProps
V1KeyToPath
V1LabelSelector
V1LabelSelectorAttributes
V1LabelSelectorRequirement
V1Lifecycle
V1LifecycleHandler
V1LimitResponse
V1LimitedPriorityLevelConfiguration
V1LinuxContainerUser
V1ListMeta
V1LoadBalancerIngress
V1LoadBalancerStatus
V1LocalObjectReference
V1LocalVolumeSource
V1ManagedFieldsEntry
V1MatchCondition
V1MatchResources
V1ModifyVolumeStatus
V1MutatingWebhook
V1NFSVolumeSource
V1NamedRuleWithOperations
V1NonResourceAttributes
V1NonResourcePolicyRule
V1NonResourceRule
V1ObjectFieldSelector
V1ObjectMeta
V1ObjectReference
V1OpaqueDeviceConfiguration
V1Overhead
V1OwnerReference
V1ParamKind
V1ParamRef
V1ParentReference
V1PhotonPersistentDiskVolumeSource
V1PolicyRule
V1PolicyRulesWithSubjects
V1PortStatus
V1PortworxVolumeSource
V1Preconditions
V1PreferredSchedulingTerm
V1Probe
V1ProjectedVolumeSource
V1QueuingConfiguration
V1QuobyteVolumeSource
V1RBDPersistentVolumeSource
V1RBDVolumeSource
V1ResourceAttributes
V1ResourceClaim
V1ResourceClaimList
V1ResourceClaimSpec
V1ResourceClaimTemplate
V1ResourceClaimTemplateList
V1ResourceClaimTemplateSpec
V1ResourceFieldSelector
V1ResourceHealth
V1ResourcePolicyRule
V1ResourcePool
V1ResourceRequirements
V1ResourceRule
V1ResourceSlice
V1ResourceSliceList
V1ResourceSliceSpec
V1ResourceStatus
V1RollingUpdateDaemonSet
V1RollingUpdateDeployment
V1RollingUpdateStatefulSetStrategy
V1RuleWithOperations
V1RuntimeClass
V1RuntimeClassList
V1SELinuxOptions
V1ScopeSelector
V1ScopedResourceSelectorRequirement
V1SeccompProfile
V1SecurityContext
V1SelectableField
V1SelfSubjectReview
V1SelfSubjectReviewStatus
V1SessionAffinityConfig
V1SleepAction
V1Status
V1StatusCause
V1StatusDetails
V1StorageOSPersistentVolumeSource
V1StorageOSVolumeSource
V1SubjectRulesReviewStatus
V1SuccessPolicy
V1SuccessPolicyRule
V1Sysctl
V1TCPSocketAction
V1Taint
V1Toleration
V1TopologySelectorLabelRequirement
V1TopologySelectorTerm
V1TopologySpreadConstraint
V1TypeChecking
V1TypedLocalObjectReference
V1TypedObjectReference
V1UncountedTerminatedPods
V1UserInfo
V1ValidatingWebhook
V1Validation
V1ValidationRule
V1Variable
V1Volume
V1VolumeAttributesClass
V1VolumeAttributesClassList
V1VolumeDevice
V1VolumeError
V1VolumeMount
V1VolumeMountStatus
V1VolumeNodeAffinity
V1VolumeNodeResources
V1VolumeProjection
V1VolumeResourceRequirements
V1VsphereVirtualDiskVolumeSource
V1WebhookConversion
V1WeightedPodAffinityTerm
V1WindowsSecurityContextOptions
V1WorkloadReference
V1alpha1ApplyConfiguration
V1alpha1ClusterTrustBundle
V1alpha1ClusterTrustBundleList
V1alpha1ClusterTrustBundleSpec
V1alpha1GangSchedulingPolicy
V1alpha1JSONPatch
V1alpha1MatchCondition
V1alpha1MatchResources
V1alpha1MutatingAdmissionPolicy
V1alpha1MutatingAdmissionPolicyBinding
V1alpha1MutatingAdmissionPolicyBindingList
V1alpha1MutatingAdmissionPolicyBindingSpec
V1alpha1MutatingAdmissionPolicyList
V1alpha1MutatingAdmissionPolicySpec
V1alpha1Mutation
V1alpha1NamedRuleWithOperations
V1alpha1ParamKind
V1alpha1ParamRef
V1alpha1PodGroup
V1alpha1PodGroupPolicy
V1alpha1ServerStorageVersion
V1alpha1StorageVersion
V1alpha1StorageVersionCondition
V1alpha1StorageVersionList
V1alpha1StorageVersionStatus
V1alpha1TypedLocalObjectReference
V1alpha1Variable
V1alpha1Workload
V1alpha1WorkloadList
V1alpha1WorkloadSpec
V1alpha2LeaseCandidate
V1alpha2LeaseCandidateList
V1alpha2LeaseCandidateSpec
V1alpha3DeviceTaint
V1alpha3DeviceTaintRule
V1alpha3DeviceTaintRuleList
V1alpha3DeviceTaintRuleSpec
V1alpha3DeviceTaintRuleStatus
V1alpha3DeviceTaintSelector
V1beta1AllocatedDeviceStatus
V1beta1AllocationResult
V1beta1ApplyConfiguration
V1beta1BasicDevice
V1beta1CELDeviceSelector
V1beta1CapacityRequestPolicy
V1beta1CapacityRequestPolicyRange
V1beta1CapacityRequirements
V1beta1ClusterTrustBundle
V1beta1ClusterTrustBundleList
V1beta1ClusterTrustBundleSpec
V1beta1Counter
V1beta1CounterSet
V1beta1Device
V1beta1DeviceAllocationConfiguration
V1beta1DeviceAllocationResult
V1beta1DeviceAttribute
V1beta1DeviceCapacity
V1beta1DeviceClaim
V1beta1DeviceClaimConfiguration
V1beta1DeviceClass
V1beta1DeviceClassConfiguration
V1beta1DeviceClassList
V1beta1DeviceClassSpec
V1beta1DeviceConstraint
V1beta1DeviceCounterConsumption
V1beta1DeviceRequest
V1beta1DeviceRequestAllocationResult
V1beta1DeviceSelector
V1beta1DeviceSubRequest
V1beta1DeviceTaint
V1beta1DeviceToleration
V1beta1IPAddress
V1beta1IPAddressList
V1beta1IPAddressSpec
V1beta1JSONPatch
V1beta1LeaseCandidate
V1beta1LeaseCandidateList
V1beta1LeaseCandidateSpec
V1beta1MatchCondition
V1beta1MatchResources
V1beta1MutatingAdmissionPolicy
V1beta1MutatingAdmissionPolicyBinding
V1beta1MutatingAdmissionPolicyBindingList
V1beta1MutatingAdmissionPolicyBindingSpec
V1beta1MutatingAdmissionPolicyList
V1beta1MutatingAdmissionPolicySpec
V1beta1Mutation
V1beta1NamedRuleWithOperations
V1beta1NetworkDeviceData
V1beta1OpaqueDeviceConfiguration
V1beta1ParamKind
V1beta1ParamRef
V1beta1ParentReference
V1beta1PodCertificateRequest
V1beta1PodCertificateRequestList
V1beta1PodCertificateRequestSpec
V1beta1PodCertificateRequestStatus
V1beta1ResourceClaim
V1beta1ResourceClaimConsumerReference
V1beta1ResourceClaimList
V1beta1ResourceClaimSpec
V1beta1ResourceClaimStatus
V1beta1ResourceClaimTemplate
V1beta1ResourceClaimTemplateList
V1beta1ResourceClaimTemplateSpec
V1beta1ResourcePool
V1beta1ResourceSlice
V1beta1ResourceSliceList
V1beta1ResourceSliceSpec
V1beta1ServiceCIDR
V1beta1ServiceCIDRList
V1beta1ServiceCIDRSpec
V1beta1ServiceCIDRStatus
V1beta1StorageVersionMigration
V1beta1StorageVersionMigrationList
V1beta1StorageVersionMigrationSpec
V1beta1StorageVersionMigrationStatus
V1beta1Variable
V1beta1VolumeAttributesClass
V1beta1VolumeAttributesClassList
V1beta2AllocatedDeviceStatus
V1beta2AllocationResult
V1beta2CELDeviceSelector
V1beta2CapacityRequestPolicy
V1beta2CapacityRequestPolicyRange
V1beta2CapacityRequirements
V1beta2Counter
V1beta2CounterSet
V1beta2Device
V1beta2DeviceAllocationConfiguration
V1beta2DeviceAllocationResult
V1beta2DeviceAttribute
V1beta2DeviceCapacity
V1beta2DeviceClaim
V1beta2DeviceClaimConfiguration
V1beta2DeviceClass
V1beta2DeviceClassConfiguration
V1beta2DeviceClassList
V1beta2DeviceClassSpec
V1beta2DeviceConstraint
V1beta2DeviceCounterConsumption
V1beta2DeviceRequest
V1beta2DeviceRequestAllocationResult
V1beta2DeviceSelector
V1beta2DeviceSubRequest
V1beta2DeviceTaint
V1beta2DeviceToleration
V1beta2ExactDeviceRequest
V1beta2NetworkDeviceData
V1beta2OpaqueDeviceConfiguration
V1beta2ResourceClaim
V1beta2ResourceClaimConsumerReference
V1beta2ResourceClaimList
V1beta2ResourceClaimSpec
V1beta2ResourceClaimStatus
V1beta2ResourceClaimTemplate
V1beta2ResourceClaimTemplateList
V1beta2ResourceClaimTemplateSpec
V1beta2ResourcePool
V1beta2ResourceSlice
V1beta2ResourceSliceList
V1beta2ResourceSliceSpec
V2ContainerResourceMetricSource
V2ContainerResourceMetricStatus
V2CrossVersionObjectReference
V2ExternalMetricSource
V2ExternalMetricStatus
V2HPAScalingPolicy
V2HPAScalingRules
V2HorizontalPodAutoscaler
V2HorizontalPodAutoscalerBehavior
V2HorizontalPodAutoscalerCondition
V2HorizontalPodAutoscalerList
V2HorizontalPodAutoscalerSpec
V2HorizontalPodAutoscalerStatus
V2MetricIdentifier
V2MetricSpec
V2MetricStatus
V2MetricTarget
V2MetricValueStatus
V2ObjectMetricSource
V2ObjectMetricStatus
V2PodsMetricSource
V2PodsMetricStatus
V2ResourceMetricSource
V2ResourceMetricStatus

V1AWSElasticBlockStoreVolumeSource​

V1Affinity​

V1AggregationRule​

V1AppArmorProfile​

V1AttachedVolume​

V1AuditAnnotation​

V1AzureDiskVolumeSource​

V1AzureFilePersistentVolumeSource​

V1AzureFileVolumeSource​

V1CELDeviceSelector​

V1Capabilities​

V1CapacityRequestPolicy​

V1CapacityRequestPolicyRange​

V1CapacityRequirements​

V1CephFSPersistentVolumeSource​

V1CephFSVolumeSource​

V1CinderPersistentVolumeSource​

V1CinderVolumeSource​

V1ClientIPConfig​

V1ClusterTrustBundleProjection​

V1Condition​

V1Container​

V1ContainerExtendedResourceRequest​

V1ContainerImage​

V1ContainerPort​

V1ContainerResizePolicy​

V1ContainerRestartRule​

V1ContainerRestartRuleOnExitCodes​

V1ContainerState​

V1ContainerStateRunning​

V1ContainerStateTerminated​

V1ContainerStateWaiting​

V1ContainerStatus​

V1ContainerUser​

V1Counter​

V1CounterSet​

V1CrossVersionObjectReference​

V1CustomResourceColumnDefinition​

V1CustomResourceConversion​

V1CustomResourceSubresourceScale​

V1CustomResourceSubresources​

V1CustomResourceValidation​

V1DaemonEndpoint​

V1DeleteOptions​

V1Device​

V1DeviceAttribute​

V1DeviceCapacity​

V1DeviceClaim​

V1DeviceClaimConfiguration​

V1DeviceClass​

V1DeviceClassConfiguration​

V1DeviceClassList​

V1DeviceClassSpec​

V1DeviceConstraint​

V1DeviceCounterConsumption​

V1DeviceRequest​

V1DeviceSelector​

V1DeviceSubRequest​

V1DeviceTaint​

V1DeviceToleration​

V1DownwardAPIProjection​

V1DownwardAPIVolumeFile​

V1DownwardAPIVolumeSource​

V1EmptyDirVolumeSource​

V1EnvFromSource​

V1EnvVar​

V1EnvVarSource​

V1EphemeralContainer​

V1EphemeralVolumeSource​

V1Eviction​

V1ExactDeviceRequest​

V1ExecAction​

V1ExemptPriorityLevelConfiguration​

V1ExpressionWarning​

V1ExternalDocumentation​

V1FCVolumeSource​

V1FieldSelectorAttributes​

V1FieldSelectorRequirement​

V1FileKeySelector​

V1FlexPersistentVolumeSource​

V1AWSElasticBlockStoreVolumeSource

V1Affinity

V1AggregationRule

V1AppArmorProfile

V1AttachedVolume

V1AuditAnnotation

V1AzureDiskVolumeSource

V1AzureFilePersistentVolumeSource

V1AzureFileVolumeSource

V1CELDeviceSelector

V1Capabilities

V1CapacityRequestPolicy

V1CapacityRequestPolicyRange

V1CapacityRequirements

V1CephFSPersistentVolumeSource

V1CephFSVolumeSource

V1CinderPersistentVolumeSource

V1CinderVolumeSource

V1ClientIPConfig

V1ClusterTrustBundleProjection

V1Condition

V1Container

V1ContainerExtendedResourceRequest

V1ContainerImage

V1ContainerPort

V1ContainerResizePolicy

V1ContainerRestartRule

V1ContainerRestartRuleOnExitCodes

V1ContainerState

V1ContainerStateRunning

V1ContainerStateTerminated

V1ContainerStateWaiting

V1ContainerStatus

V1ContainerUser

V1Counter

V1CounterSet

V1CrossVersionObjectReference

V1CustomResourceColumnDefinition

V1CustomResourceConversion

V1CustomResourceSubresourceScale

V1CustomResourceSubresources

V1CustomResourceValidation

V1DaemonEndpoint

V1DeleteOptions

V1Device

V1DeviceAttribute

V1DeviceCapacity

V1DeviceClaim

V1DeviceClaimConfiguration

V1DeviceClass

V1DeviceClassConfiguration

V1DeviceClassList

V1DeviceClassSpec

V1DeviceConstraint

V1DeviceCounterConsumption

V1DeviceRequest

V1DeviceSelector

V1DeviceSubRequest

V1DeviceTaint

V1DeviceToleration

V1DownwardAPIProjection

V1DownwardAPIVolumeFile

V1DownwardAPIVolumeSource

V1EmptyDirVolumeSource

V1EnvFromSource

V1EnvVar

V1EnvVarSource

V1EphemeralContainer

V1EphemeralVolumeSource

V1Eviction

V1ExactDeviceRequest

V1ExecAction

V1ExemptPriorityLevelConfiguration

V1ExpressionWarning

V1ExternalDocumentation

V1FCVolumeSource

V1FieldSelectorAttributes

V1FieldSelectorRequirement

V1FileKeySelector

V1FlexPersistentVolumeSource