Skip to content

cdk8s-plus-24 (TypeScript)

Constructs

AbstractPod

Initializers

import { AbstractPod } from 'cdk8s-plus-24'

new AbstractPod(scope: Construct, id: string, props?: AbstractPodProps)
scopeRequired

idRequired
  • Type: string

propsOptional

Methods

addContainer
public addContainer(cont: ContainerProps)
contRequired

addHostAlias
public addHostAlias(hostAlias: HostAlias)
hostAliasRequired

addInitContainer
public addInitContainer(cont: ContainerProps)
contRequired

addVolume
public addVolume(vol: Volume)
volRequired

toNetworkPolicyPeerConfig
public toNetworkPolicyPeerConfig()
toPodSelector
public toPodSelector()
toPodSelectorConfig
public toPodSelectorConfig()
toSubjectConfiguration
public toSubjectConfiguration()

Properties

automountServiceAccountTokenRequired
public readonly automountServiceAccountToken: boolean;
  • Type: boolean

containersRequired
public readonly containers: Container[];

dnsRequired
public readonly dns: PodDns;

hostAliasesRequired
public readonly hostAliases: HostAlias[];

initContainersRequired
public readonly initContainers: Container[];

podMetadataRequired
public readonly podMetadata: ApiObjectMetadataDefinition;

securityContextRequired
public readonly securityContext: PodSecurityContext;

volumesRequired
public readonly volumes: Volume[];

dockerRegistryAuthOptional
public readonly dockerRegistryAuth: DockerConfigSecret;

restartPolicyOptional
public readonly restartPolicy: RestartPolicy;

serviceAccountOptional
public readonly serviceAccount: IServiceAccount;

AwsElasticBlockStorePersistentVolume

Represents an AWS Disk resource that is attached to a kubelet’s host machine and then exposed to the pod.

https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore

Initializers

import { AwsElasticBlockStorePersistentVolume } from 'cdk8s-plus-24'

new AwsElasticBlockStorePersistentVolume(scope: Construct, id: string, props: AwsElasticBlockStorePersistentVolumeProps)
scopeRequired

idRequired
  • Type: string

propsRequired

Properties

fsTypeRequired
public readonly fsType: string;
  • Type: string

File system type of this volume.


readOnlyRequired
public readonly readOnly: boolean;
  • Type: boolean

Whether or not it is mounted as a read-only volume.


volumeIdRequired
public readonly volumeId: string;
  • Type: string

Volume id of this volume.


partitionOptional
public readonly partition: number;
  • Type: number

Partition of this volume.


AzureDiskPersistentVolume

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

Initializers

import { AzureDiskPersistentVolume } from 'cdk8s-plus-24'

new AzureDiskPersistentVolume(scope: Construct, id: string, props: AzureDiskPersistentVolumeProps)
scopeRequired

idRequired
  • Type: string

propsRequired

Properties

azureKindRequired
public readonly azureKind: AzureDiskPersistentVolumeKind;

Azure kind of this volume.


cachingModeRequired
public readonly cachingMode: AzureDiskPersistentVolumeCachingMode;

Caching mode of this volume.


diskNameRequired
public readonly diskName: string;
  • Type: string

Disk name of this volume.


diskUriRequired
public readonly diskUri: string;
  • Type: string

Disk URI of this volume.


fsTypeRequired
public readonly fsType: string;
  • Type: string

File system type of this volume.


readOnlyRequired
public readonly readOnly: boolean;
  • Type: boolean

Whether or not it is mounted as a read-only volume.


BasicAuthSecret

Create a secret for basic authentication.

https://kubernetes.io/docs/concepts/configuration/secret/#basic-authentication-secret

Initializers

import { BasicAuthSecret } from 'cdk8s-plus-24'

new BasicAuthSecret(scope: Construct, id: string, props: BasicAuthSecretProps)
scopeRequired

idRequired
  • Type: string

propsRequired

ClusterRole

ClusterRole is a cluster level, logical grouping of PolicyRules that can be referenced as a unit by a RoleBinding or ClusterRoleBinding.

Initializers

import { ClusterRole } from 'cdk8s-plus-24'

new ClusterRole(scope: Construct, id: string, props?: ClusterRoleProps)
scopeRequired

idRequired
  • Type: string

propsOptional

Methods

aggregate
public aggregate(key: string, value: string)
keyRequired
  • Type: string

valueRequired
  • Type: string

allow
public allow(verbs: string[], endpoints: IApiEndpoint)
verbsRequired
  • Type: string[]

endpointsRequired

The endpoints(s) to apply to.


allowCreate
public allowCreate(endpoints: IApiEndpoint)
endpointsRequired

The resource(s) to apply to.


allowDelete
public allowDelete(endpoints: IApiEndpoint)
endpointsRequired

The resource(s) to apply to.


allowDeleteCollection
public allowDeleteCollection(endpoints: IApiEndpoint)
endpointsRequired

The resource(s) to apply to.


allowGet
public allowGet(endpoints: IApiEndpoint)
endpointsRequired

The resource(s) to apply to.


allowList
public allowList(endpoints: IApiEndpoint)
endpointsRequired

The resource(s) to apply to.


allowPatch
public allowPatch(endpoints: IApiEndpoint)
endpointsRequired

The resource(s) to apply to.


allowRead
public allowRead(endpoints: IApiEndpoint)
endpointsRequired

The resource(s) to apply to.


allowReadWrite
public allowReadWrite(endpoints: IApiEndpoint)
endpointsRequired

The resource(s) to apply to.


allowUpdate
public allowUpdate(endpoints: IApiEndpoint)
endpointsRequired

The resource(s) to apply to.


allowWatch
public allowWatch(endpoints: IApiEndpoint)
endpointsRequired

The resource(s) to apply to.


bind
public bind(subjects: ISubject)
subjectsRequired

a list of subjects to bind to.


bindInNamespace
public bindInNamespace(namespace: string, subjects: ISubject)
namespaceRequired
  • Type: string

the namespace to limit permissions to.


subjectsRequired

a list of subjects to bind to.


combine
public combine(rol: ClusterRole)
rolRequired

Static Functions

fromClusterRoleName
import { ClusterRole } from 'cdk8s-plus-24'

ClusterRole.fromClusterRoleName(scope: Construct, id: string, name: string)
scopeRequired

idRequired
  • Type: string

nameRequired
  • Type: string

Properties

resourceTypeRequired
public readonly resourceType: string;
  • Type: string

The name of a resource type as it appears in the relevant API endpoint.


rulesRequired
public readonly rules: ClusterRolePolicyRule[];

Rules associaated with this Role.

Returns a copy, use allow to add rules.


ClusterRoleBinding

A ClusterRoleBinding grants permissions cluster-wide to a user or set of users.

Initializers

import { ClusterRoleBinding } from 'cdk8s-plus-24'

new ClusterRoleBinding(scope: Construct, id: string, props: ClusterRoleBindingProps)
scopeRequired

idRequired
  • Type: string

propsRequired

Methods

addSubjects
public addSubjects(subjects: ISubject)
subjectsRequired

The subjects to add.


Properties

resourceTypeRequired
public readonly resourceType: string;
  • Type: string

The name of a resource type as it appears in the relevant API endpoint.


roleRequired
public readonly role: IClusterRole;

subjectsRequired
public readonly subjects: ISubject[];

ConfigMap

ConfigMap holds configuration data for pods to consume.

Initializers

import { ConfigMap } from 'cdk8s-plus-24'

new ConfigMap(scope: Construct, id: string, props?: ConfigMapProps)
scopeRequired

idRequired
  • Type: string

propsOptional

Methods

addBinaryData
public addBinaryData(key: string, value: string)
keyRequired
  • Type: string

The key.


valueRequired
  • Type: string

The value.


addData
public addData(key: string, value: string)
keyRequired
  • Type: string

The key.


valueRequired
  • Type: string

The value.


addDirectory
public addDirectory(localDir: string, options?: AddDirectoryOptions)
localDirRequired
  • Type: string

A path to a local directory.


optionsOptional

Options.


addFile
public addFile(localFile: string, key?: string)
localFileRequired
  • Type: string

The path to the local file.


keyOptional
  • Type: string

The ConfigMap key (default to the file name).


Static Functions

fromConfigMapName
import { ConfigMap } from 'cdk8s-plus-24'

ConfigMap.fromConfigMapName(scope: Construct, id: string, name: string)
scopeRequired

idRequired
  • Type: string

nameRequired
  • Type: string

Properties

binaryDataRequired
public readonly binaryData: {[ key: string ]: string};
  • Type: {[ key: string ]: string}

The binary data associated with this config map.

Returns a copy. To add data records, use addBinaryData() or addData().


dataRequired
public readonly data: {[ key: string ]: string};
  • Type: {[ key: string ]: string}

The data associated with this config map.

Returns an copy. To add data records, use addData() or addBinaryData().


immutableRequired
public readonly immutable: boolean;
  • Type: boolean

Whether or not this config map is immutable.


resourceTypeRequired
public readonly resourceType: string;
  • Type: string

The name of a resource type as it appears in the relevant API endpoint.


CronJob

A CronJob is responsible for creating a Job and scheduling it based on provided cron schedule.

This helps running Jobs in a recurring manner.

Initializers

import { CronJob } from 'cdk8s-plus-24'

new CronJob(scope: Construct, id: string, props: CronJobProps)
scopeRequired

idRequired
  • Type: string

propsRequired

Properties

concurrencyPolicyRequired
public readonly concurrencyPolicy: string;
  • Type: string

The policy used by this cron job to determine the concurrency mode in which to schedule jobs.


failedJobsRetainedRequired
public readonly failedJobsRetained: number;
  • Type: number

The number of failed jobs retained by this cron job.


resourceTypeRequired
public readonly resourceType: string;
  • Type: string

Represents the resource type.


scheduleRequired
public readonly schedule: Cron;

The schedule this cron job is scheduled to run in.


startingDeadlineRequired
public readonly startingDeadline: Duration;

The time by which the running cron job needs to schedule the next job execution.

The job is considered as failed if it misses this deadline.


successfulJobsRetainedRequired
public readonly successfulJobsRetained: number;
  • Type: number

The number of successful jobs retained by this cron job.


suspendRequired
public readonly suspend: boolean;
  • Type: boolean

Whether or not the cron job is currently suspended or not.


timeZoneOptional
public readonly timeZone: string;
  • Type: string

The timezone which this cron job would follow to schedule jobs.


DaemonSet

A DaemonSet ensures that all (or some) Nodes run a copy of a Pod.

As nodes are added to the cluster, Pods are added to them. As nodes are removed from the cluster, those Pods are garbage collected. Deleting a DaemonSet will clean up the Pods it created.

Some typical uses of a DaemonSet are:

  • running a cluster storage daemon on every node
  • running a logs collection daemon on every node
  • running a node monitoring daemon on every node

In a simple case, one DaemonSet, covering all nodes, would be used for each type of daemon. A more complex setup might use multiple DaemonSets for a single type of daemon, but with different flags and/or different memory and cpu requests for different hardware types.

Initializers

import { DaemonSet } from 'cdk8s-plus-24'

new DaemonSet(scope: Construct, id: string, props?: DaemonSetProps)
scopeRequired

idRequired
  • Type: string

propsOptional

Properties

minReadySecondsRequired
public readonly minReadySeconds: number;
  • Type: number

resourceTypeRequired
public readonly resourceType: string;
  • Type: string

The name of a resource type as it appears in the relevant API endpoint.


Deployment

A Deployment provides declarative updates for Pods and ReplicaSets.

You describe a desired state in a Deployment, and the Deployment Controller changes the actual state to the desired state at a controlled rate. You can define Deployments to create new ReplicaSets, or to remove existing Deployments and adopt all their resources with new Deployments.

Note: Do not manage ReplicaSets owned by a Deployment. Consider opening an issue in the main Kubernetes repository if your use case is not covered below.

Use Case

The following are typical use cases for Deployments:

  • Create a Deployment to rollout a ReplicaSet. The ReplicaSet creates Pods in the background. Check the status of the rollout to see if it succeeds or not.
  • Declare the new state of the Pods by updating the PodTemplateSpec of the Deployment. A new ReplicaSet is created and the Deployment manages moving the Pods from the old ReplicaSet to the new one at a controlled rate. Each new ReplicaSet updates the revision of the Deployment.
  • Rollback to an earlier Deployment revision if the current state of the Deployment is not stable. Each rollback updates the revision of the Deployment.
  • Scale up the Deployment to facilitate more load.
  • Pause the Deployment to apply multiple fixes to its PodTemplateSpec and then resume it to start a new rollout.
  • Use the status of the Deployment as an indicator that a rollout has stuck.
  • Clean up older ReplicaSets that you don’t need anymore.

Initializers

import { Deployment } from 'cdk8s-plus-24'

new Deployment(scope: Construct, id: string, props?: DeploymentProps)
scopeRequired

idRequired
  • Type: string

propsOptional

Methods

exposeViaIngress
public exposeViaIngress(path: string, options?: ExposeDeploymentViaIngressOptions)
pathRequired
  • Type: string

The ingress path to register under.


optionsOptional

Additional options.


exposeViaService
public exposeViaService(options?: DeploymentExposeViaServiceOptions)
optionsOptional

Options to determine details of the service and port exposed.


Properties

minReadyRequired
public readonly minReady: Duration;

Minimum duration for which a newly created pod should be ready without any of its container crashing, for it to be considered available.


progressDeadlineRequired
public readonly progressDeadline: Duration;

The maximum duration for a deployment to make progress before it is considered to be failed.


replicasRequired
public readonly replicas: number;
  • Type: number

Number of desired pods.


resourceTypeRequired
public readonly resourceType: string;
  • Type: string

The name of a resource type as it appears in the relevant API endpoint.


strategyRequired
public readonly strategy: DeploymentStrategy;

DockerConfigSecret

Create a secret for storing credentials for accessing a container image registry.

https://kubernetes.io/docs/concepts/configuration/secret/#docker-config-secrets

Initializers

import { DockerConfigSecret } from 'cdk8s-plus-24'

new DockerConfigSecret(scope: Construct, id: string, props: DockerConfigSecretProps)
scopeRequired

idRequired
  • Type: string

propsRequired

GCEPersistentDiskPersistentVolume

GCEPersistentDisk represents a GCE Disk resource that is attached to a kubelet’s host machine and then exposed to the pod.

Provisioned by an admin.

https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk

Initializers

import { GCEPersistentDiskPersistentVolume } from 'cdk8s-plus-24'

new GCEPersistentDiskPersistentVolume(scope: Construct, id: string, props: GCEPersistentDiskPersistentVolumeProps)
scopeRequired

idRequired
  • Type: string

propsRequired

Properties

fsTypeRequired
public readonly fsType: string;
  • Type: string

File system type of this volume.


pdNameRequired
public readonly pdName: string;
  • Type: string

PD resource in GCE of this volume.


readOnlyRequired
public readonly readOnly: boolean;
  • Type: boolean

Whether or not it is mounted as a read-only volume.


partitionOptional
public readonly partition: number;
  • Type: number

Partition of this volume.


Group

Represents a group.

Methods

toSubjectConfiguration
public toSubjectConfiguration()

Static Functions

fromName
import { Group } from 'cdk8s-plus-24'

Group.fromName(scope: Construct, id: string, name: string)
scopeRequired

idRequired
  • Type: string

nameRequired
  • Type: string

Properties

kindRequired
public readonly kind: string;
  • Type: string

nameRequired
public readonly name: string;
  • Type: string

apiGroupOptional
public readonly apiGroup: string;
  • Type: string

Ingress

Ingress is a collection of rules that allow inbound connections to reach the endpoints defined by a backend.

An Ingress can be configured to give services externally-reachable urls, load balance traffic, terminate SSL, offer name based virtual hosting etc.

Initializers

import { Ingress } from 'cdk8s-plus-24'

new Ingress(scope: Construct, id: string, props?: IngressProps)
scopeRequired

idRequired
  • Type: string

propsOptional

Methods

addDefaultBackend
public addDefaultBackend(backend: IngressBackend)
backendRequired

The backend to use for requests that do not match any rule.


addHostDefaultBackend
public addHostDefaultBackend(host: string, backend: IngressBackend)
hostRequired
  • Type: string

The host name to match.


backendRequired

The backend to route to.


addHostRule
public addHostRule(host: string, path: string, backend: IngressBackend, pathType?: HttpIngressPathType)
hostRequired
  • Type: string

The host name.


pathRequired
  • Type: string

The HTTP path.


backendRequired

The backend to route requests to.


pathTypeOptional

How the path is matched against request paths.


addRule
public addRule(path: string, backend: IngressBackend, pathType?: HttpIngressPathType)
pathRequired
  • Type: string

The HTTP path.


backendRequired

The backend to route requests to.


pathTypeOptional

How the path is matched against request paths.


addRules
public addRules(rules: IngressRule)
rulesRequired

The rules to add.


addTls
public addTls(tls: IngressTls[])
tlsRequired

Properties

resourceTypeRequired
public readonly resourceType: string;
  • Type: string

The name of a resource type as it appears in the relevant API endpoint.


Job

A Job creates one or more Pods and ensures that a specified number of them successfully terminate.

As pods successfully complete, the Job tracks the successful completions. When a specified number of successful completions is reached, the task (ie, Job) is complete. Deleting a Job will clean up the Pods it created. A simple case is to create one Job object in order to reliably run one Pod to completion. The Job object will start a new Pod if the first Pod fails or is deleted (for example due to a node hardware failure or a node reboot). You can also use a Job to run multiple Pods in parallel.

Initializers

import { Job } from 'cdk8s-plus-24'

new Job(scope: Construct, id: string, props?: JobProps)
scopeRequired

idRequired
  • Type: string

propsOptional

Properties

resourceTypeRequired
public readonly resourceType: string;
  • Type: string

The name of a resource type as it appears in the relevant API endpoint.


activeDeadlineOptional
public readonly activeDeadline: Duration;

Duration before job is terminated.

If undefined, there is no deadline.


backoffLimitOptional
public readonly backoffLimit: number;
  • Type: number

Number of retries before marking failed.


ttlAfterFinishedOptional
public readonly ttlAfterFinished: Duration;

TTL before the job is deleted after it is finished.


Namespace

In Kubernetes, namespaces provides a mechanism for isolating groups of resources within a single cluster.

Names of resources need to be unique within a namespace, but not across namespaces. Namespace-based scoping is applicable only for namespaced objects (e.g. Deployments, Services, etc) and not for cluster-wide objects (e.g. StorageClass, Nodes, PersistentVolumes, etc).

Initializers

import { Namespace } from 'cdk8s-plus-24'

new Namespace(scope: Construct, id: string, props?: NamespaceProps)
scopeRequired

idRequired
  • Type: string

propsOptional

Methods

toNamespaceSelectorConfig
public toNamespaceSelectorConfig()
toNetworkPolicyPeerConfig
public toNetworkPolicyPeerConfig()
toPodSelector
public toPodSelector()

Properties

resourceTypeRequired
public readonly resourceType: string;
  • Type: string

The name of a resource type as it appears in the relevant API endpoint.


Constants

NAME_LABEL
  • Type: string

https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/#automatic-labelling


Namespaces

Represents a group of namespaces.

Initializers

import { Namespaces } from 'cdk8s-plus-24'

new Namespaces(scope: Construct, id: string, expressions?: LabelExpression[], names?: string[], labels?: {[ key: string ]: string})
scopeRequired

idRequired
  • Type: string

expressionsOptional

namesOptional
  • Type: string[]

labelsOptional
  • Type: {[ key: string ]: string}

Methods

toNamespaceSelectorConfig
public toNamespaceSelectorConfig()
toNetworkPolicyPeerConfig
public toNetworkPolicyPeerConfig()
toPodSelector
public toPodSelector()

Static Functions

all
import { Namespaces } from 'cdk8s-plus-24'

Namespaces.all(scope: Construct, id: string)
scopeRequired

idRequired
  • Type: string

select
import { Namespaces } from 'cdk8s-plus-24'

Namespaces.select(scope: Construct, id: string, options: NamespacesSelectOptions)
scopeRequired

idRequired
  • Type: string

optionsRequired

NetworkPolicy

Control traffic flow at the IP address or port level (OSI layer 3 or 4), network policies are an application-centric construct which allow you to specify how a pod is allowed to communicate with various network peers.

Outgoing traffic is allowed if there are no network policies selecting the pod (and cluster policy otherwise allows the traffic), OR if the traffic matches at least one egress rule across all of the network policies that select the pod.

  • Incoming traffic is allowed to a pod if there are no network policies selecting the pod (and cluster policy otherwise allows the traffic), OR if the traffic source is the pod’s local node, OR if the traffic matches at least one ingress rule across all of the network policies that select the pod.

Network policies do not conflict; they are additive. If any policy or policies apply to a given pod for a given direction, the connections allowed in that direction from that pod is the union of what the applicable policies allow. Thus, order of evaluation does not affect the policy result.

For a connection from a source pod to a destination pod to be allowed, both the egress policy on the source pod and the ingress policy on the destination pod need to allow the connection. If either side does not allow the connection, it will not happen.

https://kubernetes.io/docs/concepts/services-networking/network-policies/#networkpolicy-resource

Initializers

import { NetworkPolicy } from 'cdk8s-plus-24'

new NetworkPolicy(scope: Construct, id: string, props?: NetworkPolicyProps)
scopeRequired

idRequired
  • Type: string

propsOptional

Methods

addEgressRule
public addEgressRule(peer: INetworkPolicyPeer, ports?: NetworkPolicyPort[])
peerRequired

portsOptional

addIngressRule
public addIngressRule(peer: INetworkPolicyPeer, ports?: NetworkPolicyPort[])
peerRequired

portsOptional

Properties

resourceTypeRequired
public readonly resourceType: string;
  • Type: string

The name of a resource type as it appears in the relevant API endpoint.


NetworkPolicyIpBlock

Describes a particular CIDR (Ex.

“192.168.1.1/24”,”2001:db9::/64”) that is allowed to the pods matched by a network policy selector. The except entry describes CIDRs that should not be included within this rule.

Methods

toNetworkPolicyPeerConfig
public toNetworkPolicyPeerConfig()
toPodSelector
public toPodSelector()

Static Functions

anyIpv4
import { NetworkPolicyIpBlock } from 'cdk8s-plus-24'

NetworkPolicyIpBlock.anyIpv4(scope: Construct, id: string)
scopeRequired

idRequired
  • Type: string

anyIpv6
import { NetworkPolicyIpBlock } from 'cdk8s-plus-24'

NetworkPolicyIpBlock.anyIpv6(scope: Construct, id: string)
scopeRequired

idRequired
  • Type: string

ipv4
import { NetworkPolicyIpBlock } from 'cdk8s-plus-24'

NetworkPolicyIpBlock.ipv4(scope: Construct, id: string, cidrIp: string, except?: string[])
scopeRequired

idRequired
  • Type: string

cidrIpRequired
  • Type: string

exceptOptional
  • Type: string[]

ipv6
import { NetworkPolicyIpBlock } from 'cdk8s-plus-24'

NetworkPolicyIpBlock.ipv6(scope: Construct, id: string, cidrIp: string, except?: string[])
scopeRequired

idRequired
  • Type: string

cidrIpRequired
  • Type: string

exceptOptional
  • Type: string[]

Properties

cidrRequired
public readonly cidr: string;
  • Type: string

A string representing the IP Block Valid examples are “192.168.1.1/24” or “2001:db9::/64”.


exceptOptional
public readonly except: string[];
  • Type: string[]

A slice of CIDRs that should not be included within an IP Block Valid examples are “192.168.1.1/24” or “2001:db9::/64”. Except values will be rejected if they are outside the CIDR range.


PersistentVolume

A PersistentVolume (PV) is a piece of storage in the cluster that has been provisioned by an administrator or dynamically provisioned using Storage Classes.

It is a resource in the cluster just like a node is a cluster resource. PVs are volume plugins like Volumes, but have a lifecycle independent of any individual Pod that uses the PV. This API object captures the details of the implementation of the storage, be that NFS, iSCSI, or a cloud-provider-specific storage system.

Initializers

import { PersistentVolume } from 'cdk8s-plus-24'

new PersistentVolume(scope: Construct, id: string, props?: PersistentVolumeProps)
scopeRequired

idRequired
  • Type: string

propsOptional

Methods

asVolume
public asVolume()
bind
public bind(claim: IPersistentVolumeClaim)
claimRequired

The PVC to bind to.


reserve
public reserve()

Static Functions

fromPersistentVolumeName
import { PersistentVolume } from 'cdk8s-plus-24'

PersistentVolume.fromPersistentVolumeName(scope: Construct, id: string, volumeName: string)
scopeRequired

idRequired
  • Type: string

volumeNameRequired
  • Type: string

Properties

modeRequired
public readonly mode: PersistentVolumeMode;

Volume mode of this volume.


reclaimPolicyRequired
public readonly reclaimPolicy: PersistentVolumeReclaimPolicy;

Reclaim policy of this volume.


resourceTypeRequired
public readonly resourceType: string;
  • Type: string

The name of a resource type as it appears in the relevant API endpoint.


accessModesOptional
public readonly accessModes: PersistentVolumeAccessMode[];

Access modes requirement of this claim.


claimOptional
public readonly claim: IPersistentVolumeClaim;

PVC this volume is bound to.

Undefined means this volume is not yet claimed by any PVC.


mountOptionsOptional
public readonly mountOptions: string[];
  • Type: string[]

Mount options of this volume.


storageOptional
public readonly storage: Size;

Storage size of this volume.


storageClassNameOptional
public readonly storageClassName: string;
  • Type: string

Storage class this volume belongs to.


PersistentVolumeClaim

A PersistentVolumeClaim (PVC) is a request for storage by a user.

It is similar to a Pod. Pods consume node resources and PVCs consume PV resources. Pods can request specific levels of resources (CPU and Memory). Claims can request specific size and access modes

Initializers

import { PersistentVolumeClaim } from 'cdk8s-plus-24'

new PersistentVolumeClaim(scope: Construct, id: string, props?: PersistentVolumeClaimProps)
scopeRequired

idRequired
  • Type: string

propsOptional

Methods

bind
public bind(vol: IPersistentVolume)
volRequired

The PV to bind to.


Static Functions

fromClaimName
import { PersistentVolumeClaim } from 'cdk8s-plus-24'

PersistentVolumeClaim.fromClaimName(scope: Construct, id: string, claimName: string)
scopeRequired

idRequired
  • Type: string

claimNameRequired
  • Type: string

Properties

resourceTypeRequired
public readonly resourceType: string;
  • Type: string

The name of a resource type as it appears in the relevant API endpoint.


volumeModeRequired
public readonly volumeMode: PersistentVolumeMode;

Volume mode requirement of this claim.


accessModesOptional
public readonly accessModes: PersistentVolumeAccessMode[];

Access modes requirement of this claim.


storageOptional
public readonly storage: Size;

Storage requirement of this claim.


storageClassNameOptional
public readonly storageClassName: string;
  • Type: string

Storage class requirment of this claim.


volumeOptional
public readonly volume: IPersistentVolume;

PV this claim is bound to.

Undefined means the claim is not bound to any specific volume.


Pod

Pod is a collection of containers that can run on a host.

This resource is created by clients and scheduled onto hosts.

Initializers

import { Pod } from 'cdk8s-plus-24'

new Pod(scope: Construct, id: string, props?: PodProps)
scopeRequired

idRequired
  • Type: string

propsOptional

Properties

connectionsRequired
public readonly connections: PodConnections;

podMetadataRequired
public readonly podMetadata: ApiObjectMetadataDefinition;

resourceTypeRequired
public readonly resourceType: string;
  • Type: string

The name of a resource type as it appears in the relevant API endpoint.


schedulingRequired
public readonly scheduling: PodScheduling;

Constants

ADDRESS_LABEL
  • Type: string

This label is autoamtically added by cdk8s to any pod.

It provides a unique and stable identifier for the pod.


Pods

Represents a group of pods.

Initializers

import { Pods } from 'cdk8s-plus-24'

new Pods(scope: Construct, id: string, expressions?: LabelExpression[], labels?: {[ key: string ]: string}, namespaces?: INamespaceSelector)
scopeRequired

idRequired
  • Type: string

expressionsOptional

labelsOptional
  • Type: {[ key: string ]: string}

namespacesOptional

Methods

toNetworkPolicyPeerConfig
public toNetworkPolicyPeerConfig()
toPodSelector
public toPodSelector()
toPodSelectorConfig
public toPodSelectorConfig()

Static Functions

all
import { Pods } from 'cdk8s-plus-24'

Pods.all(scope: Construct, id: string, options?: PodsAllOptions)
scopeRequired

idRequired
  • Type: string

optionsOptional

select
import { Pods } from 'cdk8s-plus-24'

Pods.select(scope: Construct, id: string, options: PodsSelectOptions)
scopeRequired

idRequired
  • Type: string

optionsRequired

Resource

Base class for all Kubernetes objects in stdk8s.

Represents a single resource.

Initializers

import { Resource } from 'cdk8s-plus-24'

new Resource(scope: Construct, id: string)
scopeRequired

idRequired
  • Type: string

Methods

asApiResource
public asApiResource()
asNonApiResource
public asNonApiResource()

Properties

apiGroupRequired
public readonly apiGroup: string;
  • Type: string

The group portion of the API version (e.g. “authorization.k8s.io”).


apiVersionRequired
public readonly apiVersion: string;
  • Type: string

The object’s API version (e.g. “authorization.k8s.io/v1”).


kindRequired
public readonly kind: string;
  • Type: string

The object kind (e.g. “Deployment”).


metadataRequired
public readonly metadata: ApiObjectMetadataDefinition;

nameRequired
public readonly name: string;
  • Type: string

The name of this API object.


permissionsRequired
public readonly permissions: ResourcePermissions;

resourceTypeRequired
public readonly resourceType: string;
  • Type: string

The name of a resource type as it appears in the relevant API endpoint.


resourceNameOptional
public readonly resourceName: string;
  • Type: string

The unique, namespace-global, name of an object inside the Kubernetes cluster.

If this is omitted, the ApiResource should represent all objects of the given type.


Role

Role is a namespaced, logical grouping of PolicyRules that can be referenced as a unit by a RoleBinding.

Initializers

import { Role } from 'cdk8s-plus-24'

new Role(scope: Construct, id: string, props?: RoleProps)
scopeRequired

idRequired
  • Type: string

propsOptional

Methods

allow
public allow(verbs: string[], resources: IApiResource)
verbsRequired
  • Type: string[]

resourcesRequired

The resource(s) to apply to.


allowCreate
public allowCreate(resources: IApiResource)
resourcesRequired

The resource(s) to apply to.


allowDelete
public allowDelete(resources: IApiResource)
resourcesRequired

The resource(s) to apply to.


allowDeleteCollection
public allowDeleteCollection(resources: IApiResource)
resourcesRequired

The resource(s) to apply to.


allowGet
public allowGet(resources: IApiResource)
resourcesRequired

The resource(s) to apply to.


allowList
public allowList(resources: IApiResource)
resourcesRequired

The resource(s) to apply to.


allowPatch
public allowPatch(resources: IApiResource)
resourcesRequired

The resource(s) to apply to.


allowRead
public allowRead(resources: IApiResource)
resourcesRequired

The resource(s) to apply to.


allowReadWrite
public allowReadWrite(resources: IApiResource)
resourcesRequired

The resource(s) to apply to.


allowUpdate
public allowUpdate(resources: IApiResource)
resourcesRequired

The resource(s) to apply to.


allowWatch
public allowWatch(resources: IApiResource)
resourcesRequired

The resource(s) to apply to.


bind
public bind(subjects: ISubject)
subjectsRequired

a list of subjects to bind to.


Static Functions

fromRoleName
import { Role } from 'cdk8s-plus-24'

Role.fromRoleName(scope: Construct, id: string, name: string)
scopeRequired

idRequired
  • Type: string

nameRequired
  • Type: string

Properties

resourceTypeRequired
public readonly resourceType: string;
  • Type: string

The name of a resource type as it appears in the relevant API endpoint.


rulesRequired
public readonly rules: RolePolicyRule[];

Rules associaated with this Role.

Returns a copy, use allow to add rules.


RoleBinding

A RoleBinding grants permissions within a specific namespace to a user or set of users.

Initializers

import { RoleBinding } from 'cdk8s-plus-24'

new RoleBinding(scope: Construct, id: string, props: RoleBindingProps)
scopeRequired

idRequired
  • Type: string

propsRequired

Methods

addSubjects
public addSubjects(subjects: ISubject)
subjectsRequired

The subjects to add.


Properties

resourceTypeRequired
public readonly resourceType: string;
  • Type: string

The name of a resource type as it appears in the relevant API endpoint.


roleRequired
public readonly role: IRole;

subjectsRequired
public readonly subjects: ISubject[];

Secret

Kubernetes Secrets let you store and manage sensitive information, such as passwords, OAuth tokens, and ssh keys.

Storing confidential information in a Secret is safer and more flexible than putting it verbatim in a Pod definition or in a container image.

https://kubernetes.io/docs/concepts/configuration/secret

Initializers

import { Secret } from 'cdk8s-plus-24'

new Secret(scope: Construct, id: string, props?: SecretProps)
scopeRequired

idRequired
  • Type: string

propsOptional

Methods

addStringData
public addStringData(key: string, value: string)
keyRequired
  • Type: string

Key.


valueRequired
  • Type: string

Value.


getStringData
public getStringData(key: string)
keyRequired
  • Type: string

Key.


Static Functions

fromSecretName
import { Secret } from 'cdk8s-plus-24'

Secret.fromSecretName(scope: Construct, id: string, name: string)
scopeRequired

idRequired
  • Type: string

nameRequired
  • Type: string

Properties

immutableRequired
public readonly immutable: boolean;
  • Type: boolean

Whether or not the secret is immutable.


resourceTypeRequired
public readonly resourceType: string;
  • Type: string

The name of a resource type as it appears in the relevant API endpoint.


Service

An abstract way to expose an application running on a set of Pods as a network service.

With Kubernetes you don’t need to modify your application to use an unfamiliar service discovery mechanism. Kubernetes gives Pods their own IP addresses and a single DNS name for a set of Pods, and can load-balance across them.

For example, consider a stateless image-processing backend which is running with 3 replicas. Those replicas are fungible—frontends do not care which backend they use. While the actual Pods that compose the backend set may change, the frontend clients should not need to be aware of that, nor should they need to keep track of the set of backends themselves. The Service abstraction enables this decoupling.

If you’re able to use Kubernetes APIs for service discovery in your application, you can query the API server for Endpoints, that get updated whenever the set of Pods in a Service changes. For non-native applications, Kubernetes offers ways to place a network port or load balancer in between your application and the backend Pods.

Initializers

import { Service } from 'cdk8s-plus-24'

new Service(scope: Construct, id: string, props?: ServiceProps)
scopeRequired

idRequired
  • Type: string

propsOptional

Methods

bind
public bind(port: number, options?: ServiceBindOptions)
portRequired
  • Type: number

The port definition.


optionsOptional

exposeViaIngress
public exposeViaIngress(path: string, options?: ExposeServiceViaIngressOptions)
pathRequired
  • Type: string

The path to expose the service under.


optionsOptional

Additional options.


select
public select(selector: IPodSelector)
selectorRequired

selectLabel
public selectLabel(key: string, value: string)
keyRequired
  • Type: string

valueRequired
  • Type: string

Properties

portsRequired
public readonly ports: ServicePort[];

Ports for this service.

Use bind() to bind additional service ports.


resourceTypeRequired
public readonly resourceType: string;
  • Type: string

The name of a resource type as it appears in the relevant API endpoint.


typeRequired
public readonly type: ServiceType;

Determines how the Service is exposed.


clusterIPOptional
public readonly clusterIP: string;
  • Type: string

The IP address of the service and is usually assigned randomly by the master.


externalNameOptional
public readonly externalName: string;
  • Type: string

The externalName to be used for EXTERNAL_NAME types.


ServiceAccount

A service account provides an identity for processes that run in a Pod.

When you (a human) access the cluster (for example, using kubectl), you are authenticated by the apiserver as a particular User Account (currently this is usually admin, unless your cluster administrator has customized your cluster). Processes in containers inside pods can also contact the apiserver. When they do, they are authenticated as a particular Service Account (for example, default).

https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account

Initializers

import { ServiceAccount } from 'cdk8s-plus-24'

new ServiceAccount(scope: Construct, id: string, props?: ServiceAccountProps)
scopeRequired

idRequired
  • Type: string

propsOptional

Methods

addSecret
public addSecret(secr: ISecret)
secrRequired

The secret.


toSubjectConfiguration
public toSubjectConfiguration()

Static Functions

fromServiceAccountName
import { ServiceAccount } from 'cdk8s-plus-24'

ServiceAccount.fromServiceAccountName(scope: Construct, id: string, name: string)
scopeRequired

idRequired
  • Type: string

nameRequired
  • Type: string

The name of the service account resource.


Properties

automountTokenRequired
public readonly automountToken: boolean;
  • Type: boolean

Whether or not a token is automatically mounted for this service account.


resourceTypeRequired
public readonly resourceType: string;
  • Type: string

The name of a resource type as it appears in the relevant API endpoint.


secretsRequired
public readonly secrets: ISecret[];

List of secrets allowed to be used by pods running using this service account.

Returns a copy. To add a secret, use addSecret().


ServiceAccountTokenSecret

Create a secret for a service account token.

https://kubernetes.io/docs/concepts/configuration/secret/#service-account-token-secrets

Initializers

import { ServiceAccountTokenSecret } from 'cdk8s-plus-24'

new ServiceAccountTokenSecret(scope: Construct, id: string, props: ServiceAccountTokenSecretProps)
scopeRequired

idRequired
  • Type: string

propsRequired

SshAuthSecret

Create a secret for ssh authentication.

https://kubernetes.io/docs/concepts/configuration/secret/#ssh-authentication-secrets

Initializers

import { SshAuthSecret } from 'cdk8s-plus-24'

new SshAuthSecret(scope: Construct, id: string, props: SshAuthSecretProps)
scopeRequired

idRequired
  • Type: string

propsRequired

StatefulSet

StatefulSet is the workload API object used to manage stateful applications.

Manages the deployment and scaling of a set of Pods, and provides guarantees about the ordering and uniqueness of these Pods.

Like a Deployment, a StatefulSet manages Pods that are based on an identical container spec. Unlike a Deployment, a StatefulSet maintains a sticky identity for each of their Pods. These pods are created from the same spec, but are not interchangeable: each has a persistent identifier that it maintains across any rescheduling.

If you want to use storage volumes to provide persistence for your workload, you can use a StatefulSet as part of the solution. Although individual Pods in a StatefulSet are susceptible to failure, the persistent Pod identifiers make it easier to match existing volumes to the new Pods that replace any that have failed.

Using StatefulSets

StatefulSets are valuable for applications that require one or more of the following.

  • Stable, unique network identifiers.
  • Stable, persistent storage.
  • Ordered, graceful deployment and scaling.
  • Ordered, automated rolling updates.

Initializers

import { StatefulSet } from 'cdk8s-plus-24'

new StatefulSet(scope: Construct, id: string, props: StatefulSetProps)
scopeRequired

idRequired
  • Type: string

propsRequired

Properties

minReadyRequired
public readonly minReady: Duration;

Minimum duration for which a newly created pod should be ready without any of its container crashing, for it to be considered available.


podManagementPolicyRequired
public readonly podManagementPolicy: PodManagementPolicy;

Management policy to use for the set.


replicasRequired
public readonly replicas: number;
  • Type: number

Number of desired pods.


resourceTypeRequired
public readonly resourceType: string;
  • Type: string

The name of a resource type as it appears in the relevant API endpoint.


strategyRequired
public readonly strategy: StatefulSetUpdateStrategy;

The update startegy of this stateful set.


TlsSecret

Create a secret for storing a TLS certificate and its associated key.

https://kubernetes.io/docs/concepts/configuration/secret/#tls-secrets

Initializers

import { TlsSecret } from 'cdk8s-plus-24'

new TlsSecret(scope: Construct, id: string, props: TlsSecretProps)
scopeRequired

idRequired
  • Type: string

propsRequired

User

Represents a user.

Methods

toSubjectConfiguration
public toSubjectConfiguration()

Static Functions

fromName
import { User } from 'cdk8s-plus-24'

User.fromName(scope: Construct, id: string, name: string)
scopeRequired

idRequired
  • Type: string

nameRequired
  • Type: string

Properties

kindRequired
public readonly kind: string;
  • Type: string

nameRequired
public readonly name: string;
  • Type: string

apiGroupOptional
public readonly apiGroup: string;
  • Type: string

Volume

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

Docker also has a concept of volumes, though it is somewhat looser and less managed. In Docker, a volume is simply a directory on disk or in another Container. Lifetimes are not managed and until very recently there were only local-disk-backed volumes. Docker now provides volume drivers, but the functionality is very limited for now (e.g. as of Docker 1.7 only one volume driver is allowed per Container and there is no way to pass parameters to volumes).

A Kubernetes volume, on the other hand, has an explicit lifetime - the same as the Pod that encloses it. Consequently, a volume outlives any Containers that run within the Pod, and data is preserved across Container restarts. Of course, when a Pod ceases to exist, the volume will cease to exist, too. Perhaps more importantly than this, Kubernetes supports many types of volumes, and a Pod can use any number of them simultaneously.

At its core, a volume is just a directory, possibly with some data in it, which is accessible to the Containers in a Pod. How that directory comes to be, the medium that backs it, and the contents of it are determined by the particular volume type used.

To use a volume, a Pod specifies what volumes to provide for the Pod (the .spec.volumes field) and where to mount those into Containers (the .spec.containers[*].volumeMounts field).

A process in a container sees a filesystem view composed from their Docker image and volumes. The Docker image is at the root of the filesystem hierarchy, and any volumes are mounted at the specified paths within the image. Volumes can not mount onto other volumes

Methods

asVolume
public asVolume()

Static Functions

fromAwsElasticBlockStore
import { Volume } from 'cdk8s-plus-24'

Volume.fromAwsElasticBlockStore(scope: Construct, id: string, volumeId: string, options?: AwsElasticBlockStoreVolumeOptions)
scopeRequired

idRequired
  • Type: string

volumeIdRequired
  • Type: string

optionsOptional

fromAzureDisk
import { Volume } from 'cdk8s-plus-24'

Volume.fromAzureDisk(scope: Construct, id: string, diskName: string, diskUri: string, options?: AzureDiskVolumeOptions)
scopeRequired

idRequired
  • Type: string

diskNameRequired
  • Type: string

diskUriRequired
  • Type: string

optionsOptional

fromConfigMap
import { Volume } from 'cdk8s-plus-24'

Volume.fromConfigMap(scope: Construct, id: string, configMap: IConfigMap, options?: ConfigMapVolumeOptions)
scopeRequired

idRequired
  • Type: string

configMapRequired

The config map to use to populate the volume.


optionsOptional

Options.


fromEmptyDir
import { Volume } from 'cdk8s-plus-24'

Volume.fromEmptyDir(scope: Construct, id: string, name: string, options?: EmptyDirVolumeOptions)
scopeRequired

idRequired
  • Type: string

nameRequired
  • Type: string

optionsOptional

Additional options.


fromGcePersistentDisk
import { Volume } from 'cdk8s-plus-24'

Volume.fromGcePersistentDisk(scope: Construct, id: string, pdName: string, options?: GCEPersistentDiskVolumeOptions)
scopeRequired

idRequired
  • Type: string

pdNameRequired
  • Type: string

optionsOptional

fromHostPath
import { Volume } from 'cdk8s-plus-24'

Volume.fromHostPath(scope: Construct, id: string, name: string, options: HostPathVolumeOptions)
scopeRequired

idRequired
  • Type: string

nameRequired
  • Type: string

optionsRequired

fromPersistentVolumeClaim
import { Volume } from 'cdk8s-plus-24'

Volume.fromPersistentVolumeClaim(scope: Construct, id: string, claim: IPersistentVolumeClaim, options?: PersistentVolumeClaimVolumeOptions)
scopeRequired

idRequired
  • Type: string

claimRequired

optionsOptional

fromSecret
import { Volume } from 'cdk8s-plus-24'

Volume.fromSecret(scope: Construct, id: string, secr: ISecret, options?: SecretVolumeOptions)
scopeRequired

idRequired
  • Type: string

secrRequired

The secret to use to populate the volume.


optionsOptional

Options.


Properties

nameRequired
public readonly name: string;
  • Type: string

Workload

A workload is an application running on Kubernetes.

Whether your workload is a single component or several that work together, on Kubernetes you run it inside a set of pods. In Kubernetes, a Pod represents a set of running containers on your cluster.

Initializers

import { Workload } from 'cdk8s-plus-24'

new Workload(scope: Construct, id: string, props?: WorkloadProps)
scopeRequired

idRequired
  • Type: string

propsOptional

Methods

select
public select(selectors: LabelSelector)
selectorsRequired

Properties

connectionsRequired
public readonly connections: PodConnections;

matchExpressionsRequired
public readonly matchExpressions: LabelSelectorRequirement[];

The expression matchers this workload will use in order to select pods.

Returns a a copy. Use select() to add expression matchers.


matchLabelsRequired
public readonly matchLabels: {[ key: string ]: string};
  • Type: {[ key: string ]: string}

The label matchers this workload will use in order to select pods.

Returns a a copy. Use select() to add label matchers.


podMetadataRequired
public readonly podMetadata: ApiObjectMetadataDefinition;

The metadata of pods in this workload.


schedulingRequired
public readonly scheduling: WorkloadScheduling;

Structs

AbstractPodProps

Properties for AbstractPod.

Initializer

import { AbstractPodProps } from 'cdk8s-plus-24'

const abstractPodProps: AbstractPodProps = { ... }
metadataOptional
public readonly metadata: ApiObjectMetadata;

Metadata that all persisted resources must have, which includes all objects users must create.


automountServiceAccountTokenOptional
public readonly automountServiceAccountToken: boolean;
  • Type: boolean
  • Default: false

Indicates whether a service account token should be automatically mounted.

https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/#use-the-default-service-account-to-access-the-api-server


containersOptional
public readonly containers: ContainerProps[];

List of containers belonging to the pod.

Containers cannot currently be added or removed. There must be at least one container in a Pod.

You can add additionnal containers using podSpec.addContainer()


dnsOptional
public readonly dns: PodDnsProps;

DNS settings for the pod.

https://kubernetes.io/docs/concepts/services-networking/dns-pod-service/


dockerRegistryAuthOptional
public readonly dockerRegistryAuth: DockerConfigSecret;

A secret containing docker credentials for authenticating to a registry.


hostAliasesOptional
public readonly hostAliases: HostAlias[];

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


initContainersOptional
public readonly initContainers: ContainerProps[];

List of initialization containers belonging to the pod.

Init containers are executed in order prior to containers being started. If any init container fails, the pod is considered to have failed and is handled according to its restartPolicy. The name for an init container or normal container must be unique among all containers. Init containers may not have Lifecycle actions, Readiness probes, Liveness probes, or Startup probes. The resourceRequirements of an init container are taken into account during scheduling by finding the highest request/limit for each resource type, and then using the max of of that value or the sum of the normal containers. Limits are applied to init containers in a similar fashion.

Init containers cannot currently be added ,removed or updated.

https://kubernetes.io/docs/concepts/workloads/pods/init-containers/


restartPolicyOptional
public readonly restartPolicy: RestartPolicy;

Restart policy for all containers within the pod.

https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#restart-policy


securityContextOptional
public readonly securityContext: PodSecurityContextProps;

SecurityContext holds pod-level security attributes and common container settings.


serviceAccountOptional
public readonly serviceAccount: IServiceAccount;

A service account provides an identity for processes that run in a Pod.

When you (a human) access the cluster (for example, using kubectl), you are authenticated by the apiserver as a particular User Account (currently this is usually admin, unless your cluster administrator has customized your cluster). Processes in containers inside pods can also contact the apiserver. When they do, they are authenticated as a particular Service Account (for example, default).

https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/


volumesOptional
public readonly volumes: Volume[];

List of volumes that can be mounted by containers belonging to the pod.

You can also add volumes later using podSpec.addVolume()

https://kubernetes.io/docs/concepts/storage/volumes


AddDeploymentOptions

Options to add a deployment to a service.

Initializer

import { AddDeploymentOptions } from 'cdk8s-plus-24'

const addDeploymentOptions: AddDeploymentOptions = { ... }
nameOptional
public readonly name: string;
  • Type: string

The name of this port within the service.

This must be a DNS_LABEL. All ports within a ServiceSpec must have unique names. This maps to the ‘Name’ field in EndpointPort objects. Optional if only one ServicePort is defined on this service.


nodePortOptional
public readonly nodePort: number;
  • Type: number
  • Default: auto-allocate a port if the ServiceType of this Service requires one.

The port on each node on which this service is exposed when type=NodePort or LoadBalancer.

Usually assigned by the system. If specified, it will be allocated to the service if unused or else creation of the service will fail. Default is to auto-allocate a port if the ServiceType of this Service requires one.

https://kubernetes.io/docs/concepts/services-networking/service/#type-nodeport


protocolOptional
public readonly protocol: Protocol;

The IP protocol for this port.

Supports “TCP”, “UDP”, and “SCTP”. Default is TCP.


targetPortOptional
public readonly targetPort: number;
  • Type: number
  • Default: The value of port will be used.

The port number the service will redirect to.


portOptional
public readonly port: number;
  • Type: number
  • Default: Copied from the first container of the deployment.

The port number the service will bind to.


AddDirectoryOptions

Options for configmap.addDirectory().

Initializer

import { AddDirectoryOptions } from 'cdk8s-plus-24'

const addDirectoryOptions: AddDirectoryOptions = { ... }
excludeOptional
public readonly exclude: string[];
  • Type: string[]
  • Default: include all files

Glob patterns to exclude when adding files.


keyPrefixOptional
public readonly keyPrefix: string;
  • Type: string
  • Default: “”

A prefix to add to all keys in the config map.


ApiResourceOptions

Options for ApiResource.

Initializer

import { ApiResourceOptions } from 'cdk8s-plus-24'

const apiResourceOptions: ApiResourceOptions = { ... }
apiGroupRequired
public readonly apiGroup: string;
  • Type: string

The group portion of the API version (e.g. authorization.k8s.io).


resourceTypeRequired
public readonly resourceType: string;
  • Type: string

The name of the resource type as it appears in the relevant API endpoint.

https://kubernetes.io/docs/reference/access-authn-authz/rbac/#referring-to-resources


AwsElasticBlockStorePersistentVolumeProps

Properties for AwsElasticBlockStorePersistentVolume.

Initializer

import { AwsElasticBlockStorePersistentVolumeProps } from 'cdk8s-plus-24'

const awsElasticBlockStorePersistentVolumeProps: AwsElasticBlockStorePersistentVolumeProps = { ... }
metadataOptional
public readonly metadata: ApiObjectMetadata;

Metadata that all persisted resources must have, which includes all objects users must create.


accessModesOptional
public readonly accessModes: PersistentVolumeAccessMode[];

Contains all ways the volume can be mounted.

https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes


claimOptional
public readonly claim: IPersistentVolumeClaim;

Part of a bi-directional binding between PersistentVolume and PersistentVolumeClaim.

Expected to be non-nil when bound.

https://kubernetes.io/docs/concepts/storage/persistent-volumes#binding


mountOptionsOptional
public readonly mountOptions: string[];
  • Type: string[]
  • Default: No options.

A list of mount options, e.g. [“ro”, “soft”]. Not validated - mount will simply fail if one is invalid.

https://kubernetes.io/docs/concepts/storage/persistent-volumes/#mount-options


reclaimPolicyOptional
public readonly reclaimPolicy: PersistentVolumeReclaimPolicy;

When a user is done with their volume, they can delete the PVC objects from the API that allows reclamation of the resource.

The reclaim policy tells the cluster what to do with the volume after it has been released of its claim.

https://kubernetes.io/docs/concepts/storage/persistent-volumes#reclaiming


storageOptional
public readonly storage: Size;

What is the storage capacity of this volume.

https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources


storageClassNameOptional
public readonly storageClassName: string;
  • Type: string
  • Default: Volume does not belong to any storage class.

Name of StorageClass to which this persistent volume belongs.


volumeModeOptional
public readonly volumeMode: PersistentVolumeMode;

Defines what type of volume is required by the claim.


volumeIdRequired
public readonly volumeId: string;
  • Type: string

Unique ID of the persistent disk resource in AWS (Amazon EBS volume).

More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore

https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore


fsTypeOptional
public readonly fsType: string;
  • Type: string
  • Default: ‘ext4’

Filesystem type of the volume that you want to mount.

Tip: Ensure that the filesystem type is supported by the host operating system.

https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore


partitionOptional
public readonly partition: number;
  • Type: number
  • Default: No partition.

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 volume partition for /dev/sda is “0” (or you can leave the property empty).


readOnlyOptional
public readonly readOnly: boolean;
  • Type: boolean
  • Default: false

Specify “true” to force and set the ReadOnly property in VolumeMounts to “true”.

https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore


AwsElasticBlockStoreVolumeOptions

Options of Volume.fromAwsElasticBlockStore.

Initializer

import { AwsElasticBlockStoreVolumeOptions } from 'cdk8s-plus-24'

const awsElasticBlockStoreVolumeOptions: AwsElasticBlockStoreVolumeOptions = { ... }
fsTypeOptional
public readonly fsType: string;
  • Type: string
  • Default: ‘ext4’

Filesystem type of the volume that you want to mount.

Tip: Ensure that the filesystem type is supported by the host operating system.

https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore


nameOptional
public readonly name: string;
  • Type: string
  • Default: auto-generated

The volume name.


partitionOptional
public readonly partition: number;
  • Type: number
  • Default: No partition.

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 volume partition for /dev/sda is “0” (or you can leave the property empty).


readOnlyOptional
public readonly readOnly: boolean;
  • Type: boolean
  • Default: false

Specify “true” to force and set the ReadOnly property in VolumeMounts to “true”.

https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore


AzureDiskPersistentVolumeProps

Properties for AzureDiskPersistentVolume.

Initializer

import { AzureDiskPersistentVolumeProps } from 'cdk8s-plus-24'

const azureDiskPersistentVolumeProps: AzureDiskPersistentVolumeProps = { ... }
metadataOptional
public readonly metadata: ApiObjectMetadata;

Metadata that all persisted resources must have, which includes all objects users must create.


accessModesOptional
public readonly accessModes: PersistentVolumeAccessMode[];

Contains all ways the volume can be mounted.

https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes


claimOptional
public readonly claim: IPersistentVolumeClaim;

Part of a bi-directional binding between PersistentVolume and PersistentVolumeClaim.

Expected to be non-nil when bound.

https://kubernetes.io/docs/concepts/storage/persistent-volumes#binding


mountOptionsOptional
public readonly mountOptions: string[];
  • Type: string[]
  • Default: No options.

A list of mount options, e.g. [“ro”, “soft”]. Not validated - mount will simply fail if one is invalid.

https://kubernetes.io/docs/concepts/storage/persistent-volumes/#mount-options


reclaimPolicyOptional
public readonly reclaimPolicy: PersistentVolumeReclaimPolicy;

When a user is done with their volume, they can delete the PVC objects from the API that allows reclamation of the resource.

The reclaim policy tells the cluster what to do with the volume after it has been released of its claim.

https://kubernetes.io/docs/concepts/storage/persistent-volumes#reclaiming


storageOptional
public readonly storage: Size;

What is the storage capacity of this volume.

https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources


storageClassNameOptional
public readonly storageClassName: string;
  • Type: string
  • Default: Volume does not belong to any storage class.

Name of StorageClass to which this persistent volume belongs.


volumeModeOptional
public readonly volumeMode: PersistentVolumeMode;

Defines what type of volume is required by the claim.


diskNameRequired
public readonly diskName: string;
  • Type: string

The Name of the data disk in the blob storage.


diskUriRequired
public readonly diskUri: string;
  • Type: string

The URI the data disk in the blob storage.


cachingModeOptional
public readonly cachingMode: AzureDiskPersistentVolumeCachingMode;

Host Caching mode.


fsTypeOptional
public readonly fsType: string;
  • Type: string
  • Default: ‘ext4’

Filesystem type to mount.

Must be a filesystem type supported by the host operating system.


kindOptional
public readonly kind: AzureDiskPersistentVolumeKind;

Kind of disk.


readOnlyOptional
public readonly readOnly: boolean;
  • Type: boolean
  • Default: false

Force the ReadOnly setting in VolumeMounts.


AzureDiskVolumeOptions

Options of Volume.fromAzureDisk.

Initializer

import { AzureDiskVolumeOptions } from 'cdk8s-plus-24'

const azureDiskVolumeOptions: AzureDiskVolumeOptions = { ... }
cachingModeOptional
public readonly cachingMode: AzureDiskPersistentVolumeCachingMode;

Host Caching mode.


fsTypeOptional
public readonly fsType: string;
  • Type: string
  • Default: ‘ext4’

Filesystem type to mount.

Must be a filesystem type supported by the host operating system.


kindOptional
public readonly kind: AzureDiskPersistentVolumeKind;

Kind of disk.


nameOptional
public readonly name: string;
  • Type: string
  • Default: auto-generated

The volume name.


readOnlyOptional
public readonly readOnly: boolean;
  • Type: boolean
  • Default: false

Force the ReadOnly setting in VolumeMounts.


BasicAuthSecretProps

Options for BasicAuthSecret.

Initializer

import { BasicAuthSecretProps } from 'cdk8s-plus-24'

const basicAuthSecretProps: BasicAuthSecretProps = { ... }
metadataOptional
public readonly metadata: ApiObjectMetadata;

Metadata that all persisted resources must have, which includes all objects users must create.


immutableOptional
public readonly immutable: boolean;
  • Type: boolean
  • Default: false

If set to true, ensures that data stored in the Secret cannot be updated (only object metadata can be modified).

If not set to true, the field can be modified at any time.


passwordRequired
public readonly password: string;
  • Type: string

The password or token for authentication.


usernameRequired
public readonly username: string;
  • Type: string

The user name for authentication.


ClusterRoleBindingProps

Properties for ClusterRoleBinding.

Initializer

import { ClusterRoleBindingProps } from 'cdk8s-plus-24'

const clusterRoleBindingProps: ClusterRoleBindingProps = { ... }
metadataOptional
public readonly metadata: ApiObjectMetadata;

Metadata that all persisted resources must have, which includes all objects users must create.


roleRequired
public readonly role: IClusterRole;

The role to bind to.


ClusterRolePolicyRule

Policy rule of a `ClusterRole.

Initializer

import { ClusterRolePolicyRule } from 'cdk8s-plus-24'

const clusterRolePolicyRule: ClusterRolePolicyRule = { ... }
endpointsRequired
public readonly endpoints: IApiEndpoint[];

Endpoints this rule applies to.

Can be either api resources or non api resources.


verbsRequired
public readonly verbs: string[];
  • Type: string[]

Verbs to allow.

(e.g [‘get’, ‘watch’])


ClusterRoleProps

Properties for ClusterRole.

Initializer

import { ClusterRoleProps } from 'cdk8s-plus-24'

const clusterRoleProps: ClusterRoleProps = { ... }
metadataOptional
public readonly metadata: ApiObjectMetadata;

Metadata that all persisted resources must have, which includes all objects users must create.


aggregationLabelsOptional
public readonly aggregationLabels: {[ key: string ]: string};
  • Type: {[ key: string ]: string}

Specify labels that should be used to locate ClusterRoles, whose rules will be automatically filled into this ClusterRole’s rules.


rulesOptional
public readonly rules: ClusterRolePolicyRule[];

A list of rules the role should allow.


CommandProbeOptions

Options for Probe.fromCommand().

Initializer

import { CommandProbeOptions } from 'cdk8s-plus-24'

const commandProbeOptions: CommandProbeOptions = { ... }
failureThresholdOptional
public readonly failureThreshold: number;
  • Type: number
  • Default: 3

Minimum consecutive failures for the probe to be considered failed after having succeeded.

Defaults to 3. Minimum value is 1.


initialDelaySecondsOptional
public readonly initialDelaySeconds: Duration;

Number of seconds after the container has started before liveness probes are initiated.

https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes


periodSecondsOptional
public readonly periodSeconds: Duration;
  • Type: cdk8s.Duration
  • Default: Duration.seconds(10) Minimum value is 1.

How often (in seconds) to perform the probe.

Default to 10 seconds. Minimum value is 1.


successThresholdOptional
public readonly successThreshold: number;
  • Type: number
  • Default: 1 Must be 1 for liveness and startup. Minimum value is 1.

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.


timeoutSecondsOptional
public readonly timeoutSeconds: Duration;

Number of seconds after which the probe times out.

Defaults to 1 second. Minimum value is 1.

https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes


CommonSecretProps

Common properties for Secret.

Initializer

import { CommonSecretProps } from 'cdk8s-plus-24'

const commonSecretProps: CommonSecretProps = { ... }
metadataOptional
public readonly metadata: ApiObjectMetadata;

Metadata that all persisted resources must have, which includes all objects users must create.


immutableOptional
public readonly immutable: boolean;
  • Type: boolean
  • Default: false

If set to true, ensures that data stored in the Secret cannot be updated (only object metadata can be modified).

If not set to true, the field can be modified at any time.


ConfigMapProps

Properties for initialization of ConfigMap.

Initializer

import { ConfigMapProps } from 'cdk8s-plus-24'

const configMapProps: ConfigMapProps = { ... }
metadataOptional
public readonly metadata: ApiObjectMetadata;

Metadata that all persisted resources must have, which includes all objects users must create.


binaryDataOptional
public readonly binaryData: {[ key: string ]: string};
  • Type: {[ key: string ]: string}

BinaryData contains the binary data.

Each key must consist of alphanumeric characters, ‘-‘, ‘_’ or ‘.’. BinaryData can contain byte sequences that are not in the UTF-8 range. The keys stored in BinaryData must not overlap with the ones in the Data field, this is enforced during validation process.

You can also add binary data using configMap.addBinaryData().


dataOptional
public readonly data: {[ key: string ]: string};
  • Type: {[ key: string ]: string}

Data contains the configuration data.

Each key must consist of alphanumeric characters, ‘-‘, ‘_’ or ‘.’. Values with non-UTF-8 byte sequences must use the BinaryData field. The keys stored in Data must not overlap with the keys in the BinaryData field, this is enforced during validation process.

You can also add data using configMap.addData().


immutableOptional
public readonly immutable: boolean;
  • Type: boolean
  • Default: false

If set to true, ensures that data stored in the ConfigMap cannot be updated (only object metadata can be modified).

If not set to true, the field can be modified at any time.


ConfigMapVolumeOptions

Options for the ConfigMap-based volume.

Initializer

import { ConfigMapVolumeOptions } from 'cdk8s-plus-24'

const configMapVolumeOptions: ConfigMapVolumeOptions = { ... }
defaultModeOptional
public readonly defaultMode: number;
  • Type: number
  • Default: 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

Mode bits to use on created files by default.

Must be a value between 0 and 0777. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.


itemsOptional
public readonly items: {[ key: string ]: PathMapping};

If unspecified, each key-value pair in the Data field of the referenced ConfigMap will be projected into the volume as a file whose name is the key and content is the value.

If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the ConfigMap, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the ‘..’ path or start with ‘..’.


nameOptional
public readonly name: string;
  • Type: string
  • Default: auto-generated

The volume name.


optionalOptional
public readonly optional: boolean;
  • Type: boolean
  • Default: undocumented

Specify whether the ConfigMap or its keys must be defined.


ContainerLifecycle

Container lifecycle properties.

Initializer

import { ContainerLifecycle } from 'cdk8s-plus-24'

const containerLifecycle: ContainerLifecycle = { ... }
postStartOptional
public readonly postStart: Handler;

This hook is executed immediately after a container is created.

However, there is no guarantee that the hook will execute before the container ENTRYPOINT.


preStopOptional
public readonly preStop: Handler;

This hook is called immediately before a container is terminated due to an API request or management event such as a liveness/startup probe failure, preemption, resource contention and others.

A call to the PreStop hook fails if the container is already in a terminated or completed state and the hook must complete before the TERM signal to stop the container can be sent. The Pod’s termination grace period countdown begins before the PreStop hook is executed, so regardless of the outcome of the handler, the container will eventually terminate within the Pod’s termination grace period. No parameters are passed to the handler.

https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#pod-termination


ContainerPort

Represents a network port in a single container.

Initializer

import { ContainerPort } from 'cdk8s-plus-24'

const containerPort: ContainerPort = { ... }
numberRequired
public readonly number: number;
  • Type: number

Number of port to expose on the pod’s IP address.

This must be a valid port number, 0 < x < 65536.


hostIpOptional
public readonly hostIp: string;
  • Type: string
  • Default: 127.0.0.1.

What host IP to bind the external port to.


hostPortOptional
public readonly hostPort: number;
  • Type: number
  • Default: auto generated by kubernetes and might change on restarts.

Number of port to expose on the host.

If specified, this must be a valid port number, 0 < x < 65536. Most containers do not need this.


nameOptional
public readonly name: string;
  • Type: string
  • Default: port is not named.

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.


protocolOptional
public readonly protocol: Protocol;

Protocol for port.

Must be UDP, TCP, or SCTP. Defaults to “TCP”.


ContainerProps

Properties for creating a container.

Initializer

import { ContainerProps } from 'cdk8s-plus-24'

const containerProps: ContainerProps = { ... }
imageRequired
public readonly image: string;
  • Type: string

Docker image name.


argsOptional
public readonly args: string[];
  • Type: string[]
  • Default: []

Arguments to the entrypoint. The docker image’s CMD is used if command is not provided.

Variable references $(VAR_NAME) are expanded using the container’s environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not.

Cannot be updated.

https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell


commandOptional
public readonly command: string[];
  • Type: string[]
  • Default: The docker image’s ENTRYPOINT.

Entrypoint array.

Not executed within a shell. The docker image’s ENTRYPOINT 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 reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell


envFromOptional
public readonly envFrom: EnvFrom[];

List of sources to populate environment variables in the container.

When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by the envVariables property with a duplicate key will take precedence.


envVariablesOptional
public readonly envVariables: {[ key: string ]: EnvValue};

Environment variables to set in the container.


imagePullPolicyOptional
public readonly imagePullPolicy: ImagePullPolicy;

Image pull policy for this container.


lifecycleOptional
public readonly lifecycle: ContainerLifecycle;

Describes actions that the management system should take in response to container lifecycle events.


livenessOptional
public readonly liveness: Probe;

Periodic probe of container liveness.

Container will be restarted if the probe fails.


nameOptional
public readonly name: string;
  • Type: string
  • Default: ‘main’

Name of the container specified as a DNS_LABEL.

Each container in a pod must have a unique name (DNS_LABEL). Cannot be updated.


~~port~~Optional
  • Deprecated: - use portNumber.
public readonly port: number;
  • Type: number

portNumberOptional
public readonly portNumber: number;
  • Type: number
  • Default: Only the ports mentiond in the ports property are exposed.

Number of port to expose on the pod’s IP address.

This must be a valid port number, 0 < x < 65536.

This is a convinience property if all you need a single TCP numbered port. In case more advanced configuartion is required, use the ports property.

This port is added to the list of ports mentioned in the ports property.


portsOptional
public readonly ports: ContainerPort[];

List of ports to expose from this container.


readinessOptional
public readonly readiness: Probe;

Determines when the container is ready to serve traffic.


resourcesOptional
public readonly resources: ContainerResources;

Compute resources (CPU and memory requests and limits) required by the container.

https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/


securityContextOptional
public readonly securityContext: ContainerSecurityContextProps;

SecurityContext defines the security options the container should be run with.

If set, the fields override equivalent fields of the pod’s security context.

https://kubernetes.io/docs/tasks/configure-pod-container/security-context/


startupOptional
public readonly startup: Probe;
  • Type: cdk8s-plus-24.Probe
  • Default: If a port is provided, then knocks on that port to determine when the container is ready for readiness and liveness probe checks. Otherwise, no startup probe is defined.

StartupProbe indicates that the Pod has successfully initialized.

If specified, no other probes are executed until this completes successfully


volumeMountsOptional
public readonly volumeMounts: VolumeMount[];

Pod volumes to mount into the container’s filesystem.

Cannot be updated.


workingDirOptional
public readonly workingDir: string;
  • Type: string
  • Default: The container runtime’s default.

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.


ContainerResources

CPU and memory compute resources.

Initializer

import { ContainerResources } from 'cdk8s-plus-24'

const containerResources: ContainerResources = { ... }
cpuOptional
public readonly cpu: CpuResources;

ephemeralStorageOptional
public readonly ephemeralStorage: EphemeralStorageResources;

memoryOptional
public readonly memory: MemoryResources;

ContainerSecurityContextProps

Properties for ContainerSecurityContext.

Initializer

import { ContainerSecurityContextProps } from 'cdk8s-plus-24'

const containerSecurityContextProps: ContainerSecurityContextProps = { ... }
allowPrivilegeEscalationOptional
public readonly allowPrivilegeEscalation: boolean;
  • Type: boolean
  • Default: false

Whether a process can gain more privileges than its parent process.


ensureNonRootOptional
public readonly ensureNonRoot: boolean;
  • Type: boolean
  • Default: true

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


groupOptional
public readonly group: number;
  • Type: number
  • Default: 26000. An arbitrary number bigger than 9999 is selected here. This is so that the container is blocked to access host files even if somehow it manages to get access to host file system.

The GID to run the entrypoint of the container process.


privilegedOptional
public readonly privileged: boolean;
  • Type: boolean
  • Default: false

Run container in privileged mode.

Processes in privileged containers are essentially equivalent to root on the host.


readOnlyRootFilesystemOptional
public readonly readOnlyRootFilesystem: boolean;
  • Type: boolean
  • Default: true

Whether this container has a read-only root filesystem.


userOptional
public readonly user: number;
  • Type: number
  • Default: 25000. An arbitrary number bigger than 9999 is selected here. This is so that the container is blocked to access host files even if somehow it manages to get access to host file system.

The UID to run the entrypoint of the container process.


CpuResources

CPU request and limit.

Initializer

import { CpuResources } from 'cdk8s-plus-24'

const cpuResources: CpuResources = { ... }
limitOptional
public readonly limit: Cpu;

requestOptional
public readonly request: Cpu;

CronJobProps

Properties for CronJob.

Initializer

import { CronJobProps } from 'cdk8s-plus-24'

const cronJobProps: CronJobProps = { ... }
metadataOptional
public readonly metadata: ApiObjectMetadata;

Metadata that all persisted resources must have, which includes all objects users must create.


automountServiceAccountTokenOptional
public readonly automountServiceAccountToken: boolean;
  • Type: boolean
  • Default: false

Indicates whether a service account token should be automatically mounted.

https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/#use-the-default-service-account-to-access-the-api-server


containersOptional
public readonly containers: ContainerProps[];

List of containers belonging to the pod.

Containers cannot currently be added or removed. There must be at least one container in a Pod.

You can add additionnal containers using podSpec.addContainer()


dnsOptional
public readonly dns: PodDnsProps;

DNS settings for the pod.

https://kubernetes.io/docs/concepts/services-networking/dns-pod-service/


dockerRegistryAuthOptional
public readonly dockerRegistryAuth: DockerConfigSecret;

A secret containing docker credentials for authenticating to a registry.


hostAliasesOptional
public readonly hostAliases: HostAlias[];

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


initContainersOptional
public readonly initContainers: ContainerProps[];

List of initialization containers belonging to the pod.

Init containers are executed in order prior to containers being started. If any init container fails, the pod is considered to have failed and is handled according to its restartPolicy. The name for an init container or normal container must be unique among all containers. Init containers may not have Lifecycle actions, Readiness probes, Liveness probes, or Startup probes. The resourceRequirements of an init container are taken into account during scheduling by finding the highest request/limit for each resource type, and then using the max of of that value or the sum of the normal containers. Limits are applied to init containers in a similar fashion.

Init containers cannot currently be added ,removed or updated.

https://kubernetes.io/docs/concepts/workloads/pods/init-containers/


restartPolicyOptional
public readonly restartPolicy: RestartPolicy;

Restart policy for all containers within the pod.

https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#restart-policy


securityContextOptional
public readonly securityContext: PodSecurityContextProps;

SecurityContext holds pod-level security attributes and common container settings.


serviceAccountOptional
public readonly serviceAccount: IServiceAccount;

A service account provides an identity for processes that run in a Pod.

When you (a human) access the cluster (for example, using kubectl), you are authenticated by the apiserver as a particular User Account (currently this is usually admin, unless your cluster administrator has customized your cluster). Processes in containers inside pods can also contact the apiserver. When they do, they are authenticated as a particular Service Account (for example, default).

https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/


volumesOptional
public readonly volumes: Volume[];

List of volumes that can be mounted by containers belonging to the pod.

You can also add volumes later using podSpec.addVolume()

https://kubernetes.io/docs/concepts/storage/volumes


podMetadataOptional
public readonly podMetadata: ApiObjectMetadata;

The pod metadata of this workload.


selectOptional
public readonly select: boolean;
  • Type: boolean
  • Default: true

Automatically allocates a pod label selector for this workload and add it to the pod metadata.

This ensures this workload manages pods created by its pod template.


spreadOptional
public readonly spread: boolean;
  • Type: boolean
  • Default: false

Automatically spread pods across hostname and zones.

https://kubernetes.io/docs/concepts/scheduling-eviction/topology-spread-constraints/#internal-default-constraints


activeDeadlineOptional
public readonly activeDeadline: Duration;

Specifies the duration the job may be active before the system tries to terminate it.


backoffLimitOptional
public readonly backoffLimit: number;
  • Type: number
  • Default: If not set, system defaults to 6.

Specifies the number of retries before marking this job failed.


ttlAfterFinishedOptional
public readonly ttlAfterFinished: Duration;
  • Type: cdk8s.Duration
  • Default: If this field is unset, the Job won’t be automatically deleted.

Limits the lifetime of a Job that has finished execution (either Complete or Failed).

If this field is set, after the Job finishes, it is eligible to be automatically deleted. When the Job is being deleted, its lifecycle guarantees (e.g. finalizers) will be honored. If this field is set to zero, the Job becomes eligible to be deleted immediately after it finishes. This field is alpha-level and is only honored by servers that enable the TTLAfterFinished feature.


scheduleRequired
public readonly schedule: Cron;

Specifies the time in which the job would run again.

This is defined as a cron expression in the CronJob resource.


concurrencyPolicyOptional
public readonly concurrencyPolicy: ConcurrencyPolicy;

Specifies the concurrency policy for the job.


failedJobsRetainedOptional
public readonly failedJobsRetained: number;
  • Type: number
  • Default: 1

Specifies the number of failed jobs history retained.

This would retain the Job and the associated Pod resource and can be useful for debugging.


startingDeadlineOptional
public readonly startingDeadline: Duration;

Kubernetes attempts to start cron jobs at its schedule time, but this is not guaranteed.

This deadline specifies how much time can pass after a schedule point, for which kubernetes can still start the job. For example, if this is set to 100 seconds, kubernetes is allowed to start the job at a maximum 100 seconds after the scheduled time.

Note that the Kubernetes CronJobController checks for things every 10 seconds, for this reason, a deadline below 10 seconds is not allowed, as it may cause your job to never be scheduled.

In addition, kubernetes will stop scheduling jobs if more than 100 schedules were missed (for any reason). This property also controls what time interval should kubernetes consider when counting for missed schedules.

For example, suppose a CronJob is set to schedule a new Job every one minute beginning at 08:30:00, and its startingDeadline field is not set. If the CronJob controller happens to be down from 08:29:00 to 10:21:00, the job will not start as the number of missed jobs which missed their schedule is greater than 100. However, if startingDeadline is set to 200 seconds, kubernetes will only count 3 missed schedules, and thus start a new execution at 10:22:00.


successfulJobsRetainedOptional
public readonly successfulJobsRetained: number;
  • Type: number
  • Default: 3

Specifies the number of successful jobs history retained.

This would retain the Job and the associated Pod resource and can be useful for debugging.


suspendOptional
public readonly suspend: boolean;
  • Type: boolean
  • Default: false

Specifies if the cron job should be suspended.

Only applies to future executions, current ones are remained untouched.


timeZoneOptional
public readonly timeZone: string;
  • Type: string
  • Default: Timezone of kube-controller-manager process.

Specifies the timezone for the job.

This helps aligining the schedule to follow the specified timezone.

{@link https://en.wikipedia.org/wiki/List_of_tz_database_time_zones} for list of valid timezone values.


DaemonSetProps

Properties for DaemonSet.

Initializer

import { DaemonSetProps } from 'cdk8s-plus-24'

const daemonSetProps: DaemonSetProps = { ... }
metadataOptional
public readonly metadata: ApiObjectMetadata;

Metadata that all persisted resources must have, which includes all objects users must create.


automountServiceAccountTokenOptional
public readonly automountServiceAccountToken: boolean;
  • Type: boolean
  • Default: false

Indicates whether a service account token should be automatically mounted.

https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/#use-the-default-service-account-to-access-the-api-server


containersOptional
public readonly containers: ContainerProps[];

List of containers belonging to the pod.

Containers cannot currently be added or removed. There must be at least one container in a Pod.

You can add additionnal containers using podSpec.addContainer()


dnsOptional
public readonly dns: PodDnsProps;

DNS settings for the pod.

https://kubernetes.io/docs/concepts/services-networking/dns-pod-service/


dockerRegistryAuthOptional
public readonly dockerRegistryAuth: DockerConfigSecret;

A secret containing docker credentials for authenticating to a registry.


hostAliasesOptional
public readonly hostAliases: HostAlias[];

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


initContainersOptional
public readonly initContainers: ContainerProps[];

List of initialization containers belonging to the pod.

Init containers are executed in order prior to containers being started. If any init container fails, the pod is considered to have failed and is handled according to its restartPolicy. The name for an init container or normal container must be unique among all containers. Init containers may not have Lifecycle actions, Readiness probes, Liveness probes, or Startup probes. The resourceRequirements of an init container are taken into account during scheduling by finding the highest request/limit for each resource type, and then using the max of of that value or the sum of the normal containers. Limits are applied to init containers in a similar fashion.

Init containers cannot currently be added ,removed or updated.

https://kubernetes.io/docs/concepts/workloads/pods/init-containers/


restartPolicyOptional
public readonly restartPolicy: RestartPolicy;

Restart policy for all containers within the pod.

https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#restart-policy


securityContextOptional
public readonly securityContext: PodSecurityContextProps;

SecurityContext holds pod-level security attributes and common container settings.


serviceAccountOptional
public readonly serviceAccount: IServiceAccount;

A service account provides an identity for processes that run in a Pod.

When you (a human) access the cluster (for example, using kubectl), you are authenticated by the apiserver as a particular User Account (currently this is usually admin, unless your cluster administrator has customized your cluster). Processes in containers inside pods can also contact the apiserver. When they do, they are authenticated as a particular Service Account (for example, default).

https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/


volumesOptional
public readonly volumes: Volume[];

List of volumes that can be mounted by containers belonging to the pod.

You can also add volumes later using podSpec.addVolume()

https://kubernetes.io/docs/concepts/storage/volumes


podMetadataOptional
public readonly podMetadata: ApiObjectMetadata;

The pod metadata of this workload.


selectOptional
public readonly select: boolean;
  • Type: boolean
  • Default: true

Automatically allocates a pod label selector for this workload and add it to the pod metadata.

This ensures this workload manages pods created by its pod template.


spreadOptional
public readonly spread: boolean;
  • Type: boolean
  • Default: false

Automatically spread pods across hostname and zones.

https://kubernetes.io/docs/concepts/scheduling-eviction/topology-spread-constraints/#internal-default-constraints


minReadySecondsOptional
public readonly minReadySeconds: number;
  • Type: number
  • Default: 0

Minimum number of seconds for which a newly created pod should be ready without any of its container crashing, for it to be considered available.


DeploymentExposeViaServiceOptions

Options for Deployment.exposeViaService.

Initializer

import { DeploymentExposeViaServiceOptions } from 'cdk8s-plus-24'

const deploymentExposeViaServiceOptions: DeploymentExposeViaServiceOptions = { ... }
nameOptional
public readonly name: string;
  • Type: string
  • Default: auto generated.

The name of the service to expose.

If you’d like to expose the deployment multiple times, you must explicitly set a name starting from the second expose call.


portsOptional
public readonly ports: ServicePort[];

The ports that the service should bind to.


serviceTypeOptional
public readonly serviceType: ServiceType;

The type of the exposed service.


DeploymentProps

Properties for Deployment.

Initializer

import { DeploymentProps } from 'cdk8s-plus-24'

const deploymentProps: DeploymentProps = { ... }
metadataOptional
public readonly metadata: ApiObjectMetadata;

Metadata that all persisted resources must have, which includes all objects users must create.


automountServiceAccountTokenOptional
public readonly automountServiceAccountToken: boolean;
  • Type: boolean
  • Default: false

Indicates whether a service account token should be automatically mounted.

https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/#use-the-default-service-account-to-access-the-api-server


containersOptional
public readonly containers: ContainerProps[];

List of containers belonging to the pod.

Containers cannot currently be added or removed. There must be at least one container in a Pod.

You can add additionnal containers using podSpec.addContainer()


dnsOptional
public readonly dns: PodDnsProps;

DNS settings for the pod.

https://kubernetes.io/docs/concepts/services-networking/dns-pod-service/


dockerRegistryAuthOptional
public readonly dockerRegistryAuth: DockerConfigSecret;

A secret containing docker credentials for authenticating to a registry.


hostAliasesOptional
public readonly hostAliases: HostAlias[];

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


initContainersOptional
public readonly initContainers: ContainerProps[];

List of initialization containers belonging to the pod.

Init containers are executed in order prior to containers being started. If any init container fails, the pod is considered to have failed and is handled according to its restartPolicy. The name for an init container or normal container must be unique among all containers. Init containers may not have Lifecycle actions, Readiness probes, Liveness probes, or Startup probes. The resourceRequirements of an init container are taken into account during scheduling by finding the highest request/limit for each resource type, and then using the max of of that value or the sum of the normal containers. Limits are applied to init containers in a similar fashion.

Init containers cannot currently be added ,removed or updated.

https://kubernetes.io/docs/concepts/workloads/pods/init-containers/


restartPolicyOptional
public readonly restartPolicy: RestartPolicy;

Restart policy for all containers within the pod.

https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#restart-policy


securityContextOptional
public readonly securityContext: PodSecurityContextProps;

SecurityContext holds pod-level security attributes and common container settings.


serviceAccountOptional
public readonly serviceAccount: IServiceAccount;

A service account provides an identity for processes that run in a Pod.

When you (a human) access the cluster (for example, using kubectl), you are authenticated by the apiserver as a particular User Account (currently this is usually admin, unless your cluster administrator has customized your cluster). Processes in containers inside pods can also contact the apiserver. When they do, they are authenticated as a particular Service Account (for example, default).

https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/


volumesOptional
public readonly volumes: Volume[];

List of volumes that can be mounted by containers belonging to the pod.

You can also add volumes later using podSpec.addVolume()

https://kubernetes.io/docs/concepts/storage/volumes


podMetadataOptional
public readonly podMetadata: ApiObjectMetadata;

The pod metadata of this workload.


selectOptional
public readonly select: boolean;
  • Type: boolean
  • Default: true

Automatically allocates a pod label selector for this workload and add it to the pod metadata.

This ensures this workload manages pods created by its pod template.


spreadOptional
public readonly spread: boolean;
  • Type: boolean
  • Default: false

Automatically spread pods across hostname and zones.

https://kubernetes.io/docs/concepts/scheduling-eviction/topology-spread-constraints/#internal-default-constraints


minReadyOptional
public readonly minReady: Duration;

Minimum duration for which a newly created pod should be ready without any of its container crashing, for it to be considered available.

Zero means the pod will be considered available as soon as it is ready.

https://kubernetes.io/docs/concepts/workloads/controllers/deployment/#min-ready-seconds


progressDeadlineOptional
public readonly progressDeadline: Duration;

The maximum duration for a deployment to make progress before it is considered to be failed.

The deployment controller will continue to process failed deployments and a condition with a ProgressDeadlineExceeded reason will be surfaced in the deployment status.

Note that progress will not be estimated during the time a deployment is paused.

https://kubernetes.io/docs/concepts/workloads/controllers/deployment/#progress-deadline-seconds


replicasOptional
public readonly replicas: number;
  • Type: number
  • Default: 2

Number of desired pods.


strategyOptional
public readonly strategy: DeploymentStrategy;

Specifies the strategy used to replace old Pods by new ones.


DeploymentStrategyRollingUpdateOptions

Options for DeploymentStrategy.rollingUpdate.

Initializer

import { DeploymentStrategyRollingUpdateOptions } from 'cdk8s-plus-24'

const deploymentStrategyRollingUpdateOptions: DeploymentStrategyRollingUpdateOptions = { ... }
maxSurgeOptional
public readonly maxSurge: PercentOrAbsolute;

The maximum number of pods that can be scheduled above the desired number of pods.

Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). Absolute number is calculated from percentage by rounding up. This can not be 0 if maxUnavailable is 0.

Example: when this is set to 30%, the new ReplicaSet can be scaled up immediately when the rolling update starts, such that the total number of old and new pods do not exceed 130% of desired pods. Once old pods have been killed, new ReplicaSet can be scaled up further, ensuring that total number of pods running at any time during the update is at most 130% of desired pods.


maxUnavailableOptional
public readonly maxUnavailable: PercentOrAbsolute;

The maximum number of pods that can be unavailable during the update.

Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). Absolute number is calculated from percentage by rounding down. This can not be 0 if maxSurge is 0.

Example: when this is set to 30%, the old ReplicaSet can be scaled down to 70% of desired pods immediately when the rolling update starts. Once new pods are ready, old ReplicaSet can be scaled down further, followed by scaling up the new ReplicaSet, ensuring that the total number of pods available at all times during the update is at least 70% of desired pods.


DnsOption

Custom DNS option.

Initializer

import { DnsOption } from 'cdk8s-plus-24'

const dnsOption: DnsOption = { ... }
nameRequired
public readonly name: string;
  • Type: string

Option name.


valueOptional
public readonly value: string;
  • Type: string
  • Default: No value.

Option value.


DockerConfigSecretProps

Options for DockerConfigSecret.

Initializer

import { DockerConfigSecretProps } from 'cdk8s-plus-24'

const dockerConfigSecretProps: DockerConfigSecretProps = { ... }
metadataOptional
public readonly metadata: ApiObjectMetadata;

Metadata that all persisted resources must have, which includes all objects users must create.


immutableOptional
public readonly immutable: boolean;
  • Type: boolean
  • Default: false

If set to true, ensures that data stored in the Secret cannot be updated (only object metadata can be modified).

If not set to true, the field can be modified at any time.


dataRequired
public readonly data: {[ key: string ]: any};
  • Type: {[ key: string ]: any}

JSON content to provide for the ~/.docker/config.json file. This will be stringified and inserted as stringData.

https://docs.docker.com/engine/reference/commandline/cli/#sample-configuration-file


EmptyDirVolumeOptions

Options for volumes populated with an empty directory.

Initializer

import { EmptyDirVolumeOptions } from 'cdk8s-plus-24'

const emptyDirVolumeOptions: EmptyDirVolumeOptions = { ... }
mediumOptional
public readonly medium: EmptyDirMedium;

By default, emptyDir volumes are stored on whatever medium is backing the node - that might be disk or SSD or network storage, depending on your environment.

However, you can set the emptyDir.medium field to EmptyDirMedium.MEMORY to tell Kubernetes to mount a tmpfs (RAM-backed filesystem) for you instead. While tmpfs is very fast, be aware that unlike disks, tmpfs is cleared on node reboot and any files you write will count against your Container’s memory limit.


sizeLimitOptional
public readonly sizeLimit: Size;

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 value between the SizeLimit specified here and the sum of memory limits of all containers in a pod.


EnvValueFromConfigMapOptions

Options to specify an envionment variable value from a ConfigMap key.

Initializer

import { EnvValueFromConfigMapOptions } from 'cdk8s-plus-24'

const envValueFromConfigMapOptions: EnvValueFromConfigMapOptions = { ... }
optionalOptional
public readonly optional: boolean;
  • Type: boolean
  • Default: false

Specify whether the ConfigMap or its key must be defined.


EnvValueFromFieldRefOptions

Options to specify an environment variable value from a field reference.

Initializer

import { EnvValueFromFieldRefOptions } from 'cdk8s-plus-24'

const envValueFromFieldRefOptions: EnvValueFromFieldRefOptions = { ... }
apiVersionOptional
public readonly apiVersion: string;
  • Type: string

Version of the schema the FieldPath is written in terms of.


keyOptional
public readonly key: string;
  • Type: string

The key to select the pod label or annotation.


EnvValueFromProcessOptions

Options to specify an environment variable value from the process environment.

Initializer

import { EnvValueFromProcessOptions } from 'cdk8s-plus-24'

const envValueFromProcessOptions: EnvValueFromProcessOptions = { ... }
requiredOptional
public readonly required: boolean;
  • Type: boolean
  • Default: false

Specify whether the key must exist in the environment.

If this is set to true, and the key does not exist, an error will thrown.


EnvValueFromResourceOptions

Options to specify an environment variable value from a resource.

Initializer

import { EnvValueFromResourceOptions } from 'cdk8s-plus-24'

const envValueFromResourceOptions: EnvValueFromResourceOptions = { ... }
containerOptional
public readonly container: Container;

The container to select the value from.


divisorOptional
public readonly divisor: string;
  • Type: string

The output format of the exposed resource.


EnvValueFromSecretOptions

Options to specify an environment variable value from a Secret.

Initializer

import { EnvValueFromSecretOptions } from 'cdk8s-plus-24'

const envValueFromSecretOptions: EnvValueFromSecretOptions = { ... }
optionalOptional
public readonly optional: boolean;
  • Type: boolean
  • Default: false

Specify whether the Secret or its key must be defined.


EphemeralStorageResources

Emphemeral storage request and limit.

Initializer

import { EphemeralStorageResources } from 'cdk8s-plus-24'

const ephemeralStorageResources: EphemeralStorageResources = { ... }
limitOptional
public readonly limit: Size;

requestOptional
public readonly request: Size;

ExposeDeploymentViaIngressOptions

Options for exposing a deployment via an ingress.

Initializer

import { ExposeDeploymentViaIngressOptions } from 'cdk8s-plus-24'

const exposeDeploymentViaIngressOptions: ExposeDeploymentViaIngressOptions = { ... }
nameOptional
public readonly name: string;
  • Type: string
  • Default: auto generated.

The name of the service to expose.

If you’d like to expose the deployment multiple times, you must explicitly set a name starting from the second expose call.


portsOptional
public readonly ports: ServicePort[];

The ports that the service should bind to.


serviceTypeOptional
public readonly serviceType: ServiceType;

The type of the exposed service.


ingressOptional
public readonly ingress: Ingress;

The ingress to add rules to.


pathTypeOptional
public readonly pathType: HttpIngressPathType;

The type of the path.


ExposeServiceViaIngressOptions

Options for exposing a service using an ingress.

Initializer

import { ExposeServiceViaIngressOptions } from 'cdk8s-plus-24'

const exposeServiceViaIngressOptions: ExposeServiceViaIngressOptions = { ... }
ingressOptional
public readonly ingress: Ingress;

The ingress to add rules to.


pathTypeOptional
public readonly pathType: HttpIngressPathType;

The type of the path.


GCEPersistentDiskPersistentVolumeProps

Properties for GCEPersistentDiskPersistentVolume.

Initializer

import { GCEPersistentDiskPersistentVolumeProps } from 'cdk8s-plus-24'

const gCEPersistentDiskPersistentVolumeProps: GCEPersistentDiskPersistentVolumeProps = { ... }
metadataOptional
public readonly metadata: ApiObjectMetadata;

Metadata that all persisted resources must have, which includes all objects users must create.


accessModesOptional
public readonly accessModes: PersistentVolumeAccessMode[];

Contains all ways the volume can be mounted.

https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes


claimOptional
public readonly claim: IPersistentVolumeClaim;

Part of a bi-directional binding between PersistentVolume and PersistentVolumeClaim.

Expected to be non-nil when bound.

https://kubernetes.io/docs/concepts/storage/persistent-volumes#binding


mountOptionsOptional
public readonly mountOptions: string[];
  • Type: string[]
  • Default: No options.

A list of mount options, e.g. [“ro”, “soft”]. Not validated - mount will simply fail if one is invalid.

https://kubernetes.io/docs/concepts/storage/persistent-volumes/#mount-options


reclaimPolicyOptional
public readonly reclaimPolicy: PersistentVolumeReclaimPolicy;

When a user is done with their volume, they can delete the PVC objects from the API that allows reclamation of the resource.

The reclaim policy tells the cluster what to do with the volume after it has been released of its claim.

https://kubernetes.io/docs/concepts/storage/persistent-volumes#reclaiming


storageOptional
public readonly storage: Size;

What is the storage capacity of this volume.

https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources


storageClassNameOptional
public readonly storageClassName: string;
  • Type: string
  • Default: Volume does not belong to any storage class.

Name of StorageClass to which this persistent volume belongs.


volumeModeOptional
public readonly volumeMode: PersistentVolumeMode;

Defines what type of volume is required by the claim.


pdNameRequired
public readonly pdName: string;
  • Type: string

Unique name of the PD resource in GCE.

Used to identify the disk in GCE.

https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk


fsTypeOptional
public readonly fsType: string;
  • Type: string
  • Default: ‘ext4’

Filesystem type of the volume that you want to mount.

Tip: Ensure that the filesystem type is supported by the host operating system.

https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore


partitionOptional
public readonly partition: number;
  • Type: number
  • Default: No partition.

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 volume partition for /dev/sda is “0” (or you can leave the property empty).


readOnlyOptional
public readonly readOnly: boolean;
  • Type: boolean
  • Default: false

Specify “true” to force and set the ReadOnly property in VolumeMounts to “true”.

https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore


GCEPersistentDiskVolumeOptions

Options of Volume.fromGcePersistentDisk.

Initializer

import { GCEPersistentDiskVolumeOptions } from 'cdk8s-plus-24'

const gCEPersistentDiskVolumeOptions: GCEPersistentDiskVolumeOptions = { ... }
fsTypeOptional
public readonly fsType: string;
  • Type: string
  • Default: ‘ext4’

Filesystem type of the volume that you want to mount.

Tip: Ensure that the filesystem type is supported by the host operating system.

https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore


nameOptional
public readonly name: string;
  • Type: string
  • Default: auto-generated

The volume name.


partitionOptional
public readonly partition: number;
  • Type: number
  • Default: No partition.

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 volume partition for /dev/sda is “0” (or you can leave the property empty).


readOnlyOptional
public readonly readOnly: boolean;
  • Type: boolean
  • Default: false

Specify “true” to force and set the ReadOnly property in VolumeMounts to “true”.

https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore


HandlerFromHttpGetOptions

Options for Handler.fromHttpGet.

Initializer

import { HandlerFromHttpGetOptions } from 'cdk8s-plus-24'

const handlerFromHttpGetOptions: HandlerFromHttpGetOptions = { ... }
portOptional
public readonly port: number;
  • Type: number
  • Default: defaults to container.port.

The TCP port to use when sending the GET request.


HandlerFromTcpSocketOptions

Options for Handler.fromTcpSocket.

Initializer

import { HandlerFromTcpSocketOptions } from 'cdk8s-plus-24'

const handlerFromTcpSocketOptions: HandlerFromTcpSocketOptions = { ... }
hostOptional
public readonly host: string;
  • Type: string
  • Default: defaults to the pod IP

The host name to connect to on the container.


portOptional
public readonly port: number;
  • Type: number
  • Default: defaults to container.port.

The TCP port to connect to on the container.


HostAlias

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

Initializer

import { HostAlias } from 'cdk8s-plus-24'

const hostAlias: HostAlias = { ... }
hostnamesRequired
public readonly hostnames: string[];
  • Type: string[]

Hostnames for the chosen IP address.


ipRequired
public readonly ip: string;
  • Type: string

IP address of the host file entry.


HostPathVolumeOptions

Options for a HostPathVolume-based volume.

Initializer

import { HostPathVolumeOptions } from 'cdk8s-plus-24'

const hostPathVolumeOptions: HostPathVolumeOptions = { ... }
pathRequired
public readonly path: string;
  • Type: string

The path of the directory on the host.


typeOptional
public readonly type: HostPathVolumeType;

The expected type of the path found on the host.


HttpGetProbeOptions

Options for Probe.fromHttpGet().

Initializer

import { HttpGetProbeOptions } from 'cdk8s-plus-24'

const httpGetProbeOptions: HttpGetProbeOptions = { ... }
failureThresholdOptional
public readonly failureThreshold: number;
  • Type: number
  • Default: 3

Minimum consecutive failures for the probe to be considered failed after having succeeded.

Defaults to 3. Minimum value is 1.


initialDelaySecondsOptional
public readonly initialDelaySeconds: Duration;

Number of seconds after the container has started before liveness probes are initiated.

https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes


periodSecondsOptional
public readonly periodSeconds: Duration;
  • Type: cdk8s.Duration
  • Default: Duration.seconds(10) Minimum value is 1.

How often (in seconds) to perform the probe.

Default to 10 seconds. Minimum value is 1.


successThresholdOptional
public readonly successThreshold: number;
  • Type: number
  • Default: 1 Must be 1 for liveness and startup. Minimum value is 1.

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.


timeoutSecondsOptional
public readonly timeoutSeconds: Duration;

Number of seconds after which the probe times out.

Defaults to 1 second. Minimum value is 1.

https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes


portOptional
public readonly port: number;
  • Type: number
  • Default: defaults to container.port.

The TCP port to use when sending the GET request.


schemeOptional
public readonly scheme: ConnectionScheme;

Scheme to use for connecting to the host (HTTP or HTTPS).


IngressProps

Properties for Ingress.

Initializer

import { IngressProps } from 'cdk8s-plus-24'

const ingressProps: IngressProps = { ... }
metadataOptional
public readonly metadata: ApiObjectMetadata;

Metadata that all persisted resources must have, which includes all objects users must create.


defaultBackendOptional
public readonly defaultBackend: IngressBackend;

The default backend services requests that do not match any rule.

Using this option or the addDefaultBackend() method is equivalent to adding a rule with both path and host undefined.


rulesOptional
public readonly rules: IngressRule[];

Routing rules for this ingress.

Each rule must define an IngressBackend that will receive the requests that match this rule. If both host and path are not specifiec, this backend will be used as the default backend of the ingress.

You can also add rules later using addRule(), addHostRule(), addDefaultBackend() and addHostDefaultBackend().


tlsOptional
public readonly tls: IngressTls[];

TLS settings for this ingress.

Using this option tells the ingress controller to expose a TLS endpoint. Currently the Ingress only supports a single TLS port, 443. If multiple members of this list specify different hosts, they will be multiplexed on the same port according to the hostname specified through the SNI TLS extension, if the ingress controller fulfilling the ingress supports SNI.


IngressRule

Represents the rules mapping the paths under a specified host to the related backend services.

Incoming requests are first evaluated for a host match, then routed to the backend associated with the matching path.

Initializer

import { IngressRule } from 'cdk8s-plus-24'

const ingressRule: IngressRule = { ... }
backendRequired
public readonly backend: IngressBackend;

Backend defines the referenced service endpoint to which the traffic will be forwarded to.


hostOptional
public readonly host: string;
  • Type: string
  • Default: If the host is unspecified, the Ingress routes all traffic based on the specified IngressRuleValue.

Host is the fully qualified domain name of a network host, as defined by RFC 3986.

Note the following deviations from the “host” part of the URI as defined in the RFC: 1. IPs are not allowed. Currently an IngressRuleValue can only apply to the IP in the Spec of the parent Ingress. 2. The : delimiter is not respected because ports are not allowed. Currently the port of an Ingress is implicitly :80 for http and :443 for https. Both these may change in the future. Incoming requests are matched against the host before the IngressRuleValue.


pathOptional
public readonly path: string;
  • Type: string
  • Default: If unspecified, the path defaults to a catch all sending traffic to the backend.

Path is an extended POSIX regex as defined by IEEE Std 1003.1, (i.e this follows the egrep/unix syntax, not the perl syntax) 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 ‘/’.


pathTypeOptional
public readonly pathType: HttpIngressPathType;

Specify how the path is matched against request paths.

By default, path types will be matched by prefix.

https://kubernetes.io/docs/concepts/services-networking/ingress/#path-types


IngressTls

Represents the TLS configuration mapping that is passed to the ingress controller for SSL termination.

Initializer

import { IngressTls } from 'cdk8s-plus-24'

const ingressTls: IngressTls = { ... }
hostsOptional
public readonly hosts: string[];
  • Type: string[]
  • Default: If unspecified, it defaults to the wildcard host setting for the loadbalancer controller fulfilling this Ingress.

Hosts are a list of hosts included in the TLS certificate.

The values in this list must match the name/s used in the TLS Secret.


secretOptional
public readonly secret: ISecret;

Secret is the secret that contains the certificate and key used to terminate SSL traffic on 443.

If the SNI host in a listener conflicts with the “Host” header field used by an IngressRule, the SNI host is used for termination and value of the Host header is used for routing.


JobProps

Properties for Job.

Initializer

import { JobProps } from 'cdk8s-plus-24'

const jobProps: JobProps = { ... }
metadataOptional
public readonly metadata: ApiObjectMetadata;

Metadata that all persisted resources must have, which includes all objects users must create.


automountServiceAccountTokenOptional
public readonly automountServiceAccountToken: boolean;
  • Type: boolean
  • Default: false

Indicates whether a service account token should be automatically mounted.

https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/#use-the-default-service-account-to-access-the-api-server


containersOptional
public readonly containers: ContainerProps[];

List of containers belonging to the pod.

Containers cannot currently be added or removed. There must be at least one container in a Pod.

You can add additionnal containers using podSpec.addContainer()


dnsOptional
public readonly dns: PodDnsProps;

DNS settings for the pod.

https://kubernetes.io/docs/concepts/services-networking/dns-pod-service/


dockerRegistryAuthOptional
public readonly dockerRegistryAuth: DockerConfigSecret;

A secret containing docker credentials for authenticating to a registry.


hostAliasesOptional
public readonly hostAliases: HostAlias[];

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


initContainersOptional
public readonly initContainers: ContainerProps[];

List of initialization containers belonging to the pod.

Init containers are executed in order prior to containers being started. If any init container fails, the pod is considered to have failed and is handled according to its restartPolicy. The name for an init container or normal container must be unique among all containers. Init containers may not have Lifecycle actions, Readiness probes, Liveness probes, or Startup probes. The resourceRequirements of an init container are taken into account during scheduling by finding the highest request/limit for each resource type, and then using the max of of that value or the sum of the normal containers. Limits are applied to init containers in a similar fashion.

Init containers cannot currently be added ,removed or updated.

https://kubernetes.io/docs/concepts/workloads/pods/init-containers/


restartPolicyOptional
public readonly restartPolicy: RestartPolicy;

Restart policy for all containers within the pod.

https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#restart-policy


securityContextOptional
public readonly securityContext: PodSecurityContextProps;

SecurityContext holds pod-level security attributes and common container settings.


serviceAccountOptional
public readonly serviceAccount: IServiceAccount;

A service account provides an identity for processes that run in a Pod.

When you (a human) access the cluster (for example, using kubectl), you are authenticated by the apiserver as a particular User Account (currently this is usually admin, unless your cluster administrator has customized your cluster). Processes in containers inside pods can also contact the apiserver. When they do, they are authenticated as a particular Service Account (for example, default).

https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/


volumesOptional
public readonly volumes: Volume[];

List of volumes that can be mounted by containers belonging to the pod.

You can also add volumes later using podSpec.addVolume()

https://kubernetes.io/docs/concepts/storage/volumes


podMetadataOptional
public readonly podMetadata: ApiObjectMetadata;

The pod metadata of this workload.


selectOptional
public readonly select: boolean;
  • Type: boolean
  • Default: true

Automatically allocates a pod label selector for this workload and add it to the pod metadata.

This ensures this workload manages pods created by its pod template.


spreadOptional
public readonly spread: boolean;
  • Type: boolean
  • Default: false

Automatically spread pods across hostname and zones.

https://kubernetes.io/docs/concepts/scheduling-eviction/topology-spread-constraints/#internal-default-constraints


activeDeadlineOptional
public readonly activeDeadline: Duration;

Specifies the duration the job may be active before the system tries to terminate it.


backoffLimitOptional
public readonly backoffLimit: number;
  • Type: number
  • Default: If not set, system defaults to 6.

Specifies the number of retries before marking this job failed.


ttlAfterFinishedOptional
public readonly ttlAfterFinished: Duration;
  • Type: cdk8s.Duration
  • Default: If this field is unset, the Job won’t be automatically deleted.

Limits the lifetime of a Job that has finished execution (either Complete or Failed).

If this field is set, after the Job finishes, it is eligible to be automatically deleted. When the Job is being deleted, its lifecycle guarantees (e.g. finalizers) will be honored. If this field is set to zero, the Job becomes eligible to be deleted immediately after it finishes. This field is alpha-level and is only honored by servers that enable the TTLAfterFinished feature.


LabelSelectorOptions

Options for LabelSelector.of.

Initializer

import { LabelSelectorOptions } from 'cdk8s-plus-24'

const labelSelectorOptions: LabelSelectorOptions = { ... }
expressionsOptional
public readonly expressions: LabelExpression[];

Expression based label matchers.


labelsOptional
public readonly labels: {[ key: string ]: string};
  • Type: {[ key: string ]: string}

Strict label matchers.


LabelSelectorRequirement

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

Initializer

import { LabelSelectorRequirement } from 'cdk8s-plus-24'

const labelSelectorRequirement: LabelSelectorRequirement = { ... }
keyRequired
public readonly key: string;
  • Type: string

The label key that the selector applies to.


operatorRequired
public readonly operator: string;
  • Type: string

Represents a key’s relationship to a set of values.


valuesOptional
public readonly values: string[];
  • Type: 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 a strategic merge patch.


MemoryResources

Memory request and limit.

Initializer

import { MemoryResources } from 'cdk8s-plus-24'

const memoryResources: MemoryResources = { ... }
limitOptional
public readonly limit: Size;

requestOptional
public readonly request: Size;

MountOptions

Options for mounts.

Initializer

import { MountOptions } from 'cdk8s-plus-24'

const mountOptions: MountOptions = { ... }
propagationOptional
public readonly propagation: MountPropagation;

Determines how mounts are propagated from the host to container and the other way around.

When not set, MountPropagationNone is used.

Mount propagation allows for sharing volumes mounted by a Container to other Containers in the same Pod, or even to other Pods on the same node.


readOnlyOptional
public readonly readOnly: boolean;
  • Type: boolean
  • Default: false

Mounted read-only if true, read-write otherwise (false or unspecified).

Defaults to false.


subPathOptional
public readonly subPath: string;
  • Type: string
  • Default: “” the volume’s root

Path within the volume from which the container’s volume should be mounted.).


subPathExprOptional
public readonly subPathExpr: string;
  • Type: string
  • Default: “” volume’s root.

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 environment. Defaults to “” (volume’s root).

subPathExpr and subPath are mutually exclusive.


NamespaceProps

Properties for Namespace.

Initializer

import { NamespaceProps } from 'cdk8s-plus-24'

const namespaceProps: NamespaceProps = { ... }
metadataOptional
public readonly metadata: ApiObjectMetadata;

Metadata that all persisted resources must have, which includes all objects users must create.


NamespaceSelectorConfig

Configuration for selecting namespaces.

Initializer

import { NamespaceSelectorConfig } from 'cdk8s-plus-24'

const namespaceSelectorConfig: NamespaceSelectorConfig = { ... }
labelSelectorOptional
public readonly labelSelector: LabelSelector;

A selector to select namespaces by labels.


namesOptional
public readonly names: string[];
  • Type: string[]

A list of names to select namespaces by names.


NamespacesSelectOptions

Options for Namespaces.select.

Initializer

import { NamespacesSelectOptions } from 'cdk8s-plus-24'

const namespacesSelectOptions: NamespacesSelectOptions = { ... }
expressionsOptional
public readonly expressions: LabelExpression[];

Namespaces must satisfy these selectors.

The selectors query labels, just like the labels property, but they provide a more advanced matching mechanism.


labelsOptional
public readonly labels: {[ key: string ]: string};
  • Type: {[ key: string ]: string}
  • Default: no strict labels requirements.

Labels the namespaces must have.

This is equivalent to using an ‘Is’ selector.


namesOptional
public readonly names: string[];
  • Type: string[]
  • Default: no name requirements.

Namespaces names must be one of these.


NetworkPolicyAddEgressRuleOptions

Options for NetworkPolicy.addEgressRule.

Initializer

import { NetworkPolicyAddEgressRuleOptions } from 'cdk8s-plus-24'

const networkPolicyAddEgressRuleOptions: NetworkPolicyAddEgressRuleOptions = { ... }
portsOptional
public readonly ports: NetworkPolicyPort[];

Ports the rule should allow outgoing traffic to.


NetworkPolicyPeerConfig

Configuration for network peers.

A peer can either by an ip block, or a selection of pods, not both.

Initializer

import { NetworkPolicyPeerConfig } from 'cdk8s-plus-24'

const networkPolicyPeerConfig: NetworkPolicyPeerConfig = { ... }
ipBlockOptional
public readonly ipBlock: NetworkPolicyIpBlock;

The ip block this peer represents.


podSelectorOptional
public readonly podSelector: PodSelectorConfig;

The pod selector this peer represents.


NetworkPolicyPortProps

Properties for NetworkPolicyPort.

Initializer

import { NetworkPolicyPortProps } from 'cdk8s-plus-24'

const networkPolicyPortProps: NetworkPolicyPortProps = { ... }
endPortOptional
public readonly endPort: number;
  • Type: number
  • Default: not a port range.

End port (relative to port).

Only applies if port is defined. Use this to specify a port range, rather that a specific one.


portOptional
public readonly port: number;
  • Type: number
  • Default: all ports are allowed.

Specific port number.


protocolOptional
public readonly protocol: NetworkProtocol;

Protocol.


NetworkPolicyProps

Properties for NetworkPolicy.

Initializer

import { NetworkPolicyProps } from 'cdk8s-plus-24'

const networkPolicyProps: NetworkPolicyProps = { ... }
metadataOptional
public readonly metadata: ApiObjectMetadata;

Metadata that all persisted resources must have, which includes all objects users must create.


egressOptional
public readonly egress: NetworkPolicyTraffic;

Egress traffic configuration.


ingressOptional
public readonly ingress: NetworkPolicyTraffic;

Ingress traffic configuration.


selectorOptional
public readonly selector: IPodSelector;

Which pods does this policy object applies to.

This can either be a single pod / workload, or a grouping of pods selected via the Pods.select function. Rules is applied to any pods selected by this property. Multiple network policies can select the same set of pods. In this case, the rules for each are combined additively.

Note that


NetworkPolicyRule

Describes a rule allowing traffic from / to pods matched by a network policy selector.

Initializer

import { NetworkPolicyRule } from 'cdk8s-plus-24'

const networkPolicyRule: NetworkPolicyRule = { ... }
peerRequired
public readonly peer: INetworkPolicyPeer;

Peer this rule interacts with.


portsOptional
public readonly ports: NetworkPolicyPort[];

The ports of the rule.


NetworkPolicyTraffic

Describes how the network policy should configure egress / ingress traffic.

Initializer

import { NetworkPolicyTraffic } from 'cdk8s-plus-24'

const networkPolicyTraffic: NetworkPolicyTraffic = { ... }
defaultOptional
public readonly default: NetworkPolicyTrafficDefault;

Specifies the default behavior of the policy when no rules are defined.


rulesOptional
public readonly rules: NetworkPolicyRule[];

List of rules to be applied to the selected pods.

If empty, the behavior of the policy is dictated by the default property.


NodeTaintQueryOptions

Options for NodeTaintQuery.

Initializer

import { NodeTaintQueryOptions } from 'cdk8s-plus-24'

const nodeTaintQueryOptions: NodeTaintQueryOptions = { ... }
effectOptional
public readonly effect: TaintEffect;

The taint effect to match.


evictAfterOptional
public readonly evictAfter: Duration;

How much time should a pod that tolerates the NO_EXECUTE effect be bound to the node.

Only applies for the NO_EXECUTE effect.


PathMapping

Maps a string key to a path within a volume.

Initializer

import { PathMapping } from 'cdk8s-plus-24'

const pathMapping: PathMapping = { ... }
pathRequired
public readonly path: string;
  • Type: string

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


modeOptional
public readonly mode: number;
  • Type: number

Optional: mode bits to use on this file, must be a value between 0 and 0777.

If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.


PersistentVolumeClaimProps

Properties for PersistentVolumeClaim.

Initializer

import { PersistentVolumeClaimProps } from 'cdk8s-plus-24'

const persistentVolumeClaimProps: PersistentVolumeClaimProps = { ... }
metadataOptional
public readonly metadata: ApiObjectMetadata;

Metadata that all persisted resources must have, which includes all objects users must create.


accessModesOptional
public readonly accessModes: PersistentVolumeAccessMode[];

Contains the access modes the volume should support.

https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1


storageOptional
public readonly storage: Size;
  • Type: cdk8s.Size
  • Default: No storage requirement.

Minimum storage size the volume should have.

https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources


storageClassNameOptional
public readonly storageClassName: string;
  • Type: string
  • Default: Not set.

Name of the StorageClass required by the claim. When this property is not set, the behavior is as follows:.

If the admission plugin is turned on, the storage class marked as default will be used. - If the admission plugin is turned off, the pvc can only be bound to volumes without a storage class.

https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1


volumeOptional
public readonly volume: IPersistentVolume;

The PersistentVolume backing this claim.

The control plane still checks that storage class, access modes, and requested storage size on the volume are valid.

Note that in order to guarantee a proper binding, the volume should also define a claimRef referring to this claim. Otherwise, the volume may be claimed be other pvc’s before it gets a chance to bind to this one.

If the volume is managed (i.e not imported), you can use pv.claim() to easily create a bi-directional bounded claim.

https://kubernetes.io/docs/concepts/storage/persistent-volumes/#binding.


volumeModeOptional
public readonly volumeMode: PersistentVolumeMode;

Defines what type of volume is required by the claim.


PersistentVolumeClaimVolumeOptions

Options for a PersistentVolumeClaim-based volume.

Initializer

import { PersistentVolumeClaimVolumeOptions } from 'cdk8s-plus-24'

const persistentVolumeClaimVolumeOptions: PersistentVolumeClaimVolumeOptions = { ... }
nameOptional
public readonly name: string;
  • Type: string
  • Default: Derived from the PVC name.

The volume name.


readOnlyOptional
public readonly readOnly: boolean;
  • Type: boolean
  • Default: false

Will force the ReadOnly setting in VolumeMounts.


PersistentVolumeProps

Properties for PersistentVolume.

Initializer

import { PersistentVolumeProps } from 'cdk8s-plus-24'

const persistentVolumeProps: PersistentVolumeProps = { ... }
metadataOptional
public readonly metadata: ApiObjectMetadata;

Metadata that all persisted resources must have, which includes all objects users must create.


accessModesOptional
public readonly accessModes: PersistentVolumeAccessMode[];

Contains all ways the volume can be mounted.

https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes


claimOptional
public readonly claim: IPersistentVolumeClaim;

Part of a bi-directional binding between PersistentVolume and PersistentVolumeClaim.

Expected to be non-nil when bound.

https://kubernetes.io/docs/concepts/storage/persistent-volumes#binding


mountOptionsOptional
public readonly mountOptions: string[];
  • Type: string[]
  • Default: No options.

A list of mount options, e.g. [“ro”, “soft”]. Not validated - mount will simply fail if one is invalid.

https://kubernetes.io/docs/concepts/storage/persistent-volumes/#mount-options


reclaimPolicyOptional
public readonly reclaimPolicy: PersistentVolumeReclaimPolicy;

When a user is done with their volume, they can delete the PVC objects from the API that allows reclamation of the resource.

The reclaim policy tells the cluster what to do with the volume after it has been released of its claim.

https://kubernetes.io/docs/concepts/storage/persistent-volumes#reclaiming


storageOptional
public readonly storage: Size;

What is the storage capacity of this volume.

https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources


storageClassNameOptional
public readonly storageClassName: string;
  • Type: string
  • Default: Volume does not belong to any storage class.

Name of StorageClass to which this persistent volume belongs.


volumeModeOptional
public readonly volumeMode: PersistentVolumeMode;

Defines what type of volume is required by the claim.


PodConnectionsAllowFromOptions

Options for PodConnections.allowFrom.

Initializer

import { PodConnectionsAllowFromOptions } from 'cdk8s-plus-24'

const podConnectionsAllowFromOptions: PodConnectionsAllowFromOptions = { ... }
isolationOptional
public readonly isolation: PodConnectionsIsolation;

Which isolation should be applied to establish the connection.


portsOptional
public readonly ports: NetworkPolicyPort[];

Ports to allow incoming traffic to.


PodConnectionsAllowToOptions

Options for PodConnections.allowTo.

Initializer

import { PodConnectionsAllowToOptions } from 'cdk8s-plus-24'

const podConnectionsAllowToOptions: PodConnectionsAllowToOptions = { ... }
isolationOptional
public readonly isolation: PodConnectionsIsolation;

Which isolation should be applied to establish the connection.


portsOptional
public readonly ports: NetworkPolicyPort[];

Ports to allow outgoing traffic to.


PodDnsProps

Properties for PodDns.

Initializer

import { PodDnsProps } from 'cdk8s-plus-24'

const podDnsProps: PodDnsProps = { ... }
hostnameOptional
public readonly hostname: string;
  • Type: string
  • Default: Set to a system-defined value.

Specifies the hostname of the Pod.


hostnameAsFQDNOptional
public readonly hostnameAsFQDN: boolean;
  • Type: boolean
  • Default: false

If true the pod’s hostname will be configured as the pod’s FQDN, rather than the leaf name (the default).

In Linux containers, this means setting the FQDN in the hostname field of the kernel (the nodename field of struct utsname). In Windows containers, this means setting the registry value of hostname for the registry key HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\Tcpip\Parameters to FQDN. If a pod does not have FQDN, this has no effect.


nameserversOptional
public readonly nameservers: string[];
  • Type: string[]

A list of IP addresses that will be used as DNS servers for the Pod.

There can be at most 3 IP addresses specified. When the policy is set to “NONE”, the list must contain at least one IP address, otherwise this property is optional. The servers listed will be combined to the base nameservers generated from the specified DNS policy with duplicate addresses removed.


optionsOptional
public readonly options: DnsOption[];

List of objects where each object may have a name property (required) and a value property (optional).

The contents in this property will be merged to the options generated from the specified DNS policy. Duplicate entries are removed.


policyOptional
public readonly policy: DnsPolicy;

Set DNS policy for the pod.

If policy is set to None, other configuration must be supplied.


searchesOptional
public readonly searches: string[];
  • Type: string[]

A list of DNS search domains for hostname lookup in the Pod.

When specified, the provided list will be merged into the base search domain names generated from the chosen DNS policy. Duplicate domain names are removed.

Kubernetes allows for at most 6 search domains.


subdomainOptional
public readonly subdomain: string;
  • Type: string
  • Default: No subdomain.

If specified, the fully qualified Pod hostname will be “...svc.“.


PodProps

Properties for Pod.

Initializer

import { PodProps } from 'cdk8s-plus-24'

const podProps: PodProps = { ... }
metadataOptional
public readonly metadata: ApiObjectMetadata;

Metadata that all persisted resources must have, which includes all objects users must create.


automountServiceAccountTokenOptional
public readonly automountServiceAccountToken: boolean;
  • Type: boolean
  • Default: false

Indicates whether a service account token should be automatically mounted.

https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/#use-the-default-service-account-to-access-the-api-server


containersOptional
public readonly containers: ContainerProps[];

List of containers belonging to the pod.

Containers cannot currently be added or removed. There must be at least one container in a Pod.

You can add additionnal containers using podSpec.addContainer()


dnsOptional
public readonly dns: PodDnsProps;

DNS settings for the pod.

https://kubernetes.io/docs/concepts/services-networking/dns-pod-service/


dockerRegistryAuthOptional
public readonly dockerRegistryAuth: DockerConfigSecret;

A secret containing docker credentials for authenticating to a registry.


hostAliasesOptional
public readonly hostAliases: HostAlias[];

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


initContainersOptional
public readonly initContainers: ContainerProps[];

List of initialization containers belonging to the pod.

Init containers are executed in order prior to containers being started. If any init container fails, the pod is considered to have failed and is handled according to its restartPolicy. The name for an init container or normal container must be unique among all containers. Init containers may not have Lifecycle actions, Readiness probes, Liveness probes, or Startup probes. The resourceRequirements of an init container are taken into account during scheduling by finding the highest request/limit for each resource type, and then using the max of of that value or the sum of the normal containers. Limits are applied to init containers in a similar fashion.

Init containers cannot currently be added ,removed or updated.

https://kubernetes.io/docs/concepts/workloads/pods/init-containers/


restartPolicyOptional
public readonly restartPolicy: RestartPolicy;

Restart policy for all containers within the pod.

https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#restart-policy


securityContextOptional
public readonly securityContext: PodSecurityContextProps;

SecurityContext holds pod-level security attributes and common container settings.


serviceAccountOptional
public readonly serviceAccount: IServiceAccount;

A service account provides an identity for processes that run in a Pod.

When you (a human) access the cluster (for example, using kubectl), you are authenticated by the apiserver as a particular User Account (currently this is usually admin, unless your cluster administrator has customized your cluster). Processes in containers inside pods can also contact the apiserver. When they do, they are authenticated as a particular Service Account (for example, default).

https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/


volumesOptional
public readonly volumes: Volume[];

List of volumes that can be mounted by containers belonging to the pod.

You can also add volumes later using podSpec.addVolume()

https://kubernetes.io/docs/concepts/storage/volumes


PodsAllOptions

Options for Pods.all.

Initializer

import { PodsAllOptions } from 'cdk8s-plus-24'

const podsAllOptions: PodsAllOptions = { ... }
namespacesOptional
public readonly namespaces: Namespaces;

Namespaces the pods are allowed to be in.

Use Namespaces.all() to allow all namespaces.


PodSchedulingAttractOptions

Options for PodScheduling.attract.

Initializer

import { PodSchedulingAttractOptions } from 'cdk8s-plus-24'

const podSchedulingAttractOptions: PodSchedulingAttractOptions = { ... }
weightOptional
public readonly weight: number;
  • Type: number
  • Default: no weight. assignment is assumed to be required (hard).

Indicates the attraction is optional (soft), with this weight score.


PodSchedulingColocateOptions

Options for PodScheduling.colocate.

Initializer

import { PodSchedulingColocateOptions } from 'cdk8s-plus-24'

const podSchedulingColocateOptions: PodSchedulingColocateOptions = { ... }
topologyOptional
public readonly topology: Topology;

Which topology to coloate on.


weightOptional
public readonly weight: number;
  • Type: number
  • Default: no weight. co-location is assumed to be required (hard).

Indicates the co-location is optional (soft), with this weight score.


PodSchedulingSeparateOptions

Options for PodScheduling.separate.

Initializer

import { PodSchedulingSeparateOptions } from 'cdk8s-plus-24'

const podSchedulingSeparateOptions: PodSchedulingSeparateOptions = { ... }
topologyOptional
public readonly topology: Topology;

Which topology to separate on.


weightOptional
public readonly weight: number;
  • Type: number
  • Default: no weight. separation is assumed to be required (hard).

Indicates the separation is optional (soft), with this weight score.


PodSecurityContextProps

Properties for PodSecurityContext.

Initializer

import { PodSecurityContextProps } from 'cdk8s-plus-24'

const podSecurityContextProps: PodSecurityContextProps = { ... }
ensureNonRootOptional
public readonly ensureNonRoot: boolean;
  • Type: boolean
  • Default: true

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


fsGroupOptional
public readonly fsGroup: number;
  • Type: number
  • Default: Volume ownership is not changed.

Modify the ownership and permissions of pod volumes to this GID.


fsGroupChangePolicyOptional
public readonly fsGroupChangePolicy: FsGroupChangePolicy;

Defines behavior of changing ownership and permission of the volume before being exposed inside Pod.

This field will only apply to volume types which support fsGroup based ownership(and permissions). It will have no effect on ephemeral volume types such as: secret, configmaps and emptydir.


groupOptional
public readonly group: number;
  • Type: number
  • Default: Group configured by container runtime

The GID to run the entrypoint of the container process.


sysctlsOptional
public readonly sysctls: Sysctl[];

Sysctls hold a list of namespaced sysctls used for the pod.

Pods with unsupported sysctls (by the container runtime) might fail to launch.


userOptional
public readonly user: number;
  • Type: number
  • Default: User specified in image metadata

The UID to run the entrypoint of the container process.


PodSelectorConfig

Configuration for selecting pods, optionally in particular namespaces.

Initializer

import { PodSelectorConfig } from 'cdk8s-plus-24'

const podSelectorConfig: PodSelectorConfig = { ... }
labelSelectorRequired
public readonly labelSelector: LabelSelector;

A selector to select pods by labels.


namespacesOptional
public readonly namespaces: NamespaceSelectorConfig;

Configuration for selecting which namepsaces are the pods allowed to be in.


PodsSelectOptions

Options for Pods.select.

Initializer

import { PodsSelectOptions } from 'cdk8s-plus-24'

const podsSelectOptions: PodsSelectOptions = { ... }
expressionsOptional
public readonly expressions: LabelExpression[];

Expressions the pods must satisify.


labelsOptional
public readonly labels: {[ key: string ]: string};
  • Type: {[ key: string ]: string}
  • Default: no strict labels requirements.

Labels the pods must have.


namespacesOptional
public readonly namespaces: Namespaces;

Namespaces the pods are allowed to be in.

Use Namespaces.all() to allow all namespaces.


ProbeOptions

Probe options.

Initializer

import { ProbeOptions } from 'cdk8s-plus-24'

const probeOptions: ProbeOptions = { ... }
failureThresholdOptional
public readonly failureThreshold: number;
  • Type: number
  • Default: 3

Minimum consecutive failures for the probe to be considered failed after having succeeded.

Defaults to 3. Minimum value is 1.


initialDelaySecondsOptional
public readonly initialDelaySeconds: Duration;

Number of seconds after the container has started before liveness probes are initiated.

https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes


periodSecondsOptional
public readonly periodSeconds: Duration;
  • Type: cdk8s.Duration
  • Default: Duration.seconds(10) Minimum value is 1.

How often (in seconds) to perform the probe.

Default to 10 seconds. Minimum value is 1.


successThresholdOptional
public readonly successThreshold: number;
  • Type: number
  • Default: 1 Must be 1 for liveness and startup. Minimum value is 1.

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.


timeoutSecondsOptional
public readonly timeoutSeconds: Duration;

Number of seconds after which the probe times out.

Defaults to 1 second. Minimum value is 1.

https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes


ResourceProps

Initialization properties for resources.

Initializer

import { ResourceProps } from 'cdk8s-plus-24'

const resourceProps: ResourceProps = { ... }
metadataOptional
public readonly metadata: ApiObjectMetadata;

Metadata that all persisted resources must have, which includes all objects users must create.


RoleBindingProps

Properties for RoleBinding.

Initializer

import { RoleBindingProps } from 'cdk8s-plus-24'

const roleBindingProps: RoleBindingProps = { ... }
metadataOptional
public readonly metadata: ApiObjectMetadata;

Metadata that all persisted resources must have, which includes all objects users must create.


roleRequired
public readonly role: IRole;

The role to bind to.

A RoleBinding can reference a Role or a ClusterRole.


RolePolicyRule

Policy rule of a `Role.

Initializer

import { RolePolicyRule } from 'cdk8s-plus-24'

const rolePolicyRule: RolePolicyRule = { ... }
resourcesRequired
public readonly resources: IApiResource[];

Resources this rule applies to.


verbsRequired
public readonly verbs: string[];
  • Type: string[]

Verbs to allow.

(e.g [‘get’, ‘watch’])


RoleProps

Properties for Role.

Initializer

import { RoleProps } from 'cdk8s-plus-24'

const roleProps: RoleProps = { ... }
metadataOptional
public readonly metadata: ApiObjectMetadata;

Metadata that all persisted resources must have, which includes all objects users must create.


rulesOptional
public readonly rules: RolePolicyRule[];

A list of rules the role should allow.


SecretProps

Options for Secret.

Initializer

import { SecretProps } from 'cdk8s-plus-24'

const secretProps: SecretProps = { ... }
metadataOptional
public readonly metadata: ApiObjectMetadata;

Metadata that all persisted resources must have, which includes all objects users must create.


immutableOptional
public readonly immutable: boolean;
  • Type: boolean
  • Default: false

If set to true, ensures that data stored in the Secret cannot be updated (only object metadata can be modified).

If not set to true, the field can be modified at any time.


stringDataOptional
public readonly stringData: {[ key: string ]: string};
  • Type: {[ key: string ]: string}

stringData allows specifying non-binary secret data in string form.

It is provided as a write-only convenience method. All keys and values are merged into the data field on write, overwriting any existing values. It is never output when reading from the API.


typeOptional
public readonly type: string;
  • Type: string
  • Default: undefined - Don’t set a type.

Optional type associated with the secret.

Used to facilitate programmatic handling of secret data by various controllers.


SecretValue

Represents a specific value in JSON secret.

Initializer

import { SecretValue } from 'cdk8s-plus-24'

const secretValue: SecretValue = { ... }
keyRequired
public readonly key: string;
  • Type: string

The JSON key.


secretRequired
public readonly secret: ISecret;

The secret.


SecretVolumeOptions

Options for the Secret-based volume.

Initializer

import { SecretVolumeOptions } from 'cdk8s-plus-24'

const secretVolumeOptions: SecretVolumeOptions = { ... }
defaultModeOptional
public readonly defaultMode: number;
  • Type: number
  • Default: 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

Mode bits to use on created files by default.

Must be a value between 0 and 0777. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.


itemsOptional
public readonly items: {[ key: string ]: PathMapping};

If unspecified, each key-value pair in the Data field of the referenced secret will be projected into the volume as a file whose name is the key and content is the value.

If specified, the listed keys will be projected into the specified paths, and unlisted keys will not be present. If a key is specified which is not present in the secret, the volume setup will error unless it is marked optional. Paths must be relative and may not contain the ‘..’ path or start with ‘..’.


nameOptional
public readonly name: string;
  • Type: string
  • Default: auto-generated

The volume name.


optionalOptional
public readonly optional: boolean;
  • Type: boolean
  • Default: undocumented

Specify whether the secret or its keys must be defined.


ServiceAccountProps

Properties for initialization of ServiceAccount.

Initializer

import { ServiceAccountProps } from 'cdk8s-plus-24'

const serviceAccountProps: ServiceAccountProps = { ... }
metadataOptional
public readonly metadata: ApiObjectMetadata;

Metadata that all persisted resources must have, which includes all objects users must create.


automountTokenOptional
public readonly automountToken: boolean;
  • Type: boolean
  • Default: false

Indicates whether pods running as this service account should have an API token automatically mounted.

Can be overridden at the pod level.

https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/#use-the-default-service-account-to-access-the-api-server


secretsOptional
public readonly secrets: ISecret[];

List of secrets allowed to be used by pods running using this ServiceAccount.

https://kubernetes.io/docs/concepts/configuration/secret


ServiceAccountTokenSecretProps

Options for ServiceAccountTokenSecret.

Initializer

import { ServiceAccountTokenSecretProps } from 'cdk8s-plus-24'

const serviceAccountTokenSecretProps: ServiceAccountTokenSecretProps = { ... }
metadataOptional
public readonly metadata: ApiObjectMetadata;

Metadata that all persisted resources must have, which includes all objects users must create.


immutableOptional
public readonly immutable: boolean;
  • Type: boolean
  • Default: false

If set to true, ensures that data stored in the Secret cannot be updated (only object metadata can be modified).

If not set to true, the field can be modified at any time.


serviceAccountRequired
public readonly serviceAccount: IServiceAccount;

The service account to store a secret for.


ServiceBindOptions

Options for Service.bind.

Initializer

import { ServiceBindOptions } from 'cdk8s-plus-24'

const serviceBindOptions: ServiceBindOptions = { ... }
nameOptional
public readonly name: string;
  • Type: string

The name of this port within the service.

This must be a DNS_LABEL. All ports within a ServiceSpec must have unique names. This maps to the ‘Name’ field in EndpointPort objects. Optional if only one ServicePort is defined on this service.


nodePortOptional
public readonly nodePort: number;
  • Type: number
  • Default: auto-allocate a port if the ServiceType of this Service requires one.

The port on each node on which this service is exposed when type=NodePort or LoadBalancer.

Usually assigned by the system. If specified, it will be allocated to the service if unused or else creation of the service will fail. Default is to auto-allocate a port if the ServiceType of this Service requires one.

https://kubernetes.io/docs/concepts/services-networking/service/#type-nodeport


protocolOptional
public readonly protocol: Protocol;

The IP protocol for this port.

Supports “TCP”, “UDP”, and “SCTP”. Default is TCP.


targetPortOptional
public readonly targetPort: number;
  • Type: number
  • Default: The value of port will be used.

The port number the service will redirect to.


ServiceIngressBackendOptions

Options for setting up backends for ingress rules.

Initializer

import { ServiceIngressBackendOptions } from 'cdk8s-plus-24'

const serviceIngressBackendOptions: ServiceIngressBackendOptions = { ... }
portOptional
public readonly port: number;
  • Type: number
  • Default: if the service exposes a single port, this port will be used.

The port to use to access the service.

This option will fail if the service does not expose any ports. - If the service exposes multiple ports, this option must be specified. - If the service exposes a single port, this option is optional and if specified, it must be the same port exposed by the service.


ServicePort

Definition of a service port.

Initializer

import { ServicePort } from 'cdk8s-plus-24'

const servicePort: ServicePort = { ... }
nameOptional
public readonly name: string;
  • Type: string

The name of this port within the service.

This must be a DNS_LABEL. All ports within a ServiceSpec must have unique names. This maps to the ‘Name’ field in EndpointPort objects. Optional if only one ServicePort is defined on this service.


nodePortOptional
public readonly nodePort: number;
  • Type: number
  • Default: auto-allocate a port if the ServiceType of this Service requires one.

The port on each node on which this service is exposed when type=NodePort or LoadBalancer.

Usually assigned by the system. If specified, it will be allocated to the service if unused or else creation of the service will fail. Default is to auto-allocate a port if the ServiceType of this Service requires one.

https://kubernetes.io/docs/concepts/services-networking/service/#type-nodeport


protocolOptional
public readonly protocol: Protocol;

The IP protocol for this port.

Supports “TCP”, “UDP”, and “SCTP”. Default is TCP.


targetPortOptional
public readonly targetPort: number;
  • Type: number
  • Default: The value of port will be used.

The port number the service will redirect to.


portRequired
public readonly port: number;
  • Type: number

The port number the service will bind to.


ServiceProps

Properties for Service.

Initializer

import { ServiceProps } from 'cdk8s-plus-24'

const serviceProps: ServiceProps = { ... }
metadataOptional
public readonly metadata: ApiObjectMetadata;

Metadata that all persisted resources must have, which includes all objects users must create.


clusterIPOptional
public readonly clusterIP: string;
  • Type: string
  • Default: Automatically assigned.

The IP address of the service and is usually assigned randomly by the master.

If an address is specified manually and is not in use by others, it will be allocated to the service; otherwise, creation of the service will fail. This field can not be changed through updates. Valid values are “None”, empty string (“”), or a valid IP address. “None” can be specified for headless services when proxying is not required. Only applies to types ClusterIP, NodePort, and LoadBalancer. Ignored if type is ExternalName.

https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies


externalIPsOptional
public readonly externalIPs: string[];
  • Type: string[]
  • Default: No external IPs.

A list of IP addresses for which nodes in the cluster will also accept traffic for this service.

These IPs are not managed by Kubernetes. The user is responsible for ensuring that traffic arrives at a node with this IP. A common example is external load-balancers that are not part of the Kubernetes system.


externalNameOptional
public readonly externalName: string;
  • Type: string
  • Default: No external name.

The externalName to be used when ServiceType.EXTERNAL_NAME is set.


loadBalancerSourceRangesOptional
public readonly loadBalancerSourceRanges: string[];
  • Type: string[]

A list of CIDR IP addresses, if specified and supported by the platform, will restrict traffic through the cloud-provider load-balancer to the specified client IPs.

More info: https://kubernetes.io/docs/tasks/access-application-cluster/configure-cloud-provider-firewall/


portsOptional
public readonly ports: ServicePort[];

The ports this service binds to.

If the selector of the service is a managed pod / workload, its ports will are automatically extracted and used as the default value. Otherwise, no ports are bound.


selectorOptional
public readonly selector: IPodSelector;
  • Type: cdk8s-plus-24.IPodSelector
  • Default: unset, the service is assumed to have an external process managing its endpoints, which Kubernetes will not modify.

Which pods should the service select and route to.

You can pass one of the following:

  • An instance of Pod or any workload resource (e.g Deployment, StatefulSet, …)
  • Pods selected by the Pods.select function. Note that in this case only labels can be specified.

typeOptional
public readonly type: ServiceType;

Determines how the Service is exposed.

More info: https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types


SshAuthSecretProps

Options for SshAuthSecret.

Initializer

import { SshAuthSecretProps } from 'cdk8s-plus-24'

const sshAuthSecretProps: SshAuthSecretProps = { ... }
metadataOptional
public readonly metadata: ApiObjectMetadata;

Metadata that all persisted resources must have, which includes all objects users must create.


immutableOptional
public readonly immutable: boolean;
  • Type: boolean
  • Default: false

If set to true, ensures that data stored in the Secret cannot be updated (only object metadata can be modified).

If not set to true, the field can be modified at any time.


sshPrivateKeyRequired
public readonly sshPrivateKey: string;
  • Type: string

The SSH private key to use.


StatefulSetProps

Properties for initialization of StatefulSet.

Initializer

import { StatefulSetProps } from 'cdk8s-plus-24'

const statefulSetProps: StatefulSetProps = { ... }
metadataOptional
public readonly metadata: ApiObjectMetadata;

Metadata that all persisted resources must have, which includes all objects users must create.


automountServiceAccountTokenOptional
public readonly automountServiceAccountToken: boolean;
  • Type: boolean
  • Default: false

Indicates whether a service account token should be automatically mounted.

https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/#use-the-default-service-account-to-access-the-api-server


containersOptional
public readonly containers: ContainerProps[];

List of containers belonging to the pod.

Containers cannot currently be added or removed. There must be at least one container in a Pod.

You can add additionnal containers using podSpec.addContainer()


dnsOptional
public readonly dns: PodDnsProps;

DNS settings for the pod.

https://kubernetes.io/docs/concepts/services-networking/dns-pod-service/


dockerRegistryAuthOptional
public readonly dockerRegistryAuth: DockerConfigSecret;

A secret containing docker credentials for authenticating to a registry.


hostAliasesOptional
public readonly hostAliases: HostAlias[];

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


initContainersOptional
public readonly initContainers: ContainerProps[];

List of initialization containers belonging to the pod.

Init containers are executed in order prior to containers being started. If any init container fails, the pod is considered to have failed and is handled according to its restartPolicy. The name for an init container or normal container must be unique among all containers. Init containers may not have Lifecycle actions, Readiness probes, Liveness probes, or Startup probes. The resourceRequirements of an init container are taken into account during scheduling by finding the highest request/limit for each resource type, and then using the max of of that value or the sum of the normal containers. Limits are applied to init containers in a similar fashion.

Init containers cannot currently be added ,removed or updated.

https://kubernetes.io/docs/concepts/workloads/pods/init-containers/


restartPolicyOptional
public readonly restartPolicy: RestartPolicy;

Restart policy for all containers within the pod.

https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#restart-policy


securityContextOptional
public readonly securityContext: PodSecurityContextProps;

SecurityContext holds pod-level security attributes and common container settings.


serviceAccountOptional
public readonly serviceAccount: IServiceAccount;

A service account provides an identity for processes that run in a Pod.

When you (a human) access the cluster (for example, using kubectl), you are authenticated by the apiserver as a particular User Account (currently this is usually admin, unless your cluster administrator has customized your cluster). Processes in containers inside pods can also contact the apiserver. When they do, they are authenticated as a particular Service Account (for example, default).

https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/


volumesOptional
public readonly volumes: Volume[];

List of volumes that can be mounted by containers belonging to the pod.

You can also add volumes later using podSpec.addVolume()

https://kubernetes.io/docs/concepts/storage/volumes


podMetadataOptional
public readonly podMetadata: ApiObjectMetadata;

The pod metadata of this workload.


selectOptional
public readonly select: boolean;
  • Type: boolean
  • Default: true

Automatically allocates a pod label selector for this workload and add it to the pod metadata.

This ensures this workload manages pods created by its pod template.


spreadOptional
public readonly spread: boolean;
  • Type: boolean
  • Default: false

Automatically spread pods across hostname and zones.

https://kubernetes.io/docs/concepts/scheduling-eviction/topology-spread-constraints/#internal-default-constraints


serviceRequired
public readonly service: Service;

Service to associate with the statefulset.


minReadyOptional
public readonly minReady: Duration;

Minimum duration for which a newly created pod should be ready without any of its container crashing, for it to be considered available.

Zero means the pod will be considered available as soon as it is ready.

This is an alpha field and requires enabling StatefulSetMinReadySeconds feature gate.

https://kubernetes.io/docs/concepts/workloads/controllers/deployment/#min-ready-seconds


podManagementPolicyOptional
public readonly podManagementPolicy: PodManagementPolicy;

Pod management policy to use for this statefulset.


replicasOptional
public readonly replicas: number;
  • Type: number
  • Default: 1

Number of desired pods.


strategyOptional
public readonly strategy: StatefulSetUpdateStrategy;

Indicates the StatefulSetUpdateStrategy that will be employed to update Pods in the StatefulSet when a revision is made to Template.


StatefulSetUpdateStrategyRollingUpdateOptions

Options for StatefulSetUpdateStrategy.rollingUpdate.

Initializer

import { StatefulSetUpdateStrategyRollingUpdateOptions } from 'cdk8s-plus-24'

const statefulSetUpdateStrategyRollingUpdateOptions: StatefulSetUpdateStrategyRollingUpdateOptions = { ... }
partitionOptional
public readonly partition: number;
  • Type: number
  • Default: 0

If specified, all Pods with an ordinal that is greater than or equal to the partition will be updated when the StatefulSet’s .spec.template is updated. All Pods with an ordinal that is less than the partition will not be updated, and, even if they are deleted, they will be recreated at the previous version.

If the partition is greater than replicas, updates to the pod template will not be propagated to Pods. In most cases you will not need to use a partition, but they are useful if you want to stage an update, roll out a canary, or perform a phased roll out.

https://kubernetes.io/docs/concepts/workloads/controllers/statefulset/#partitions


SubjectConfiguration

Subject contains a reference to the object or user identities a role binding applies to.

This can either hold a direct API object reference, or a value for non-objects such as user and group names.

Initializer

import { SubjectConfiguration } from 'cdk8s-plus-24'

const subjectConfiguration: SubjectConfiguration = { ... }
kindRequired
public readonly kind: string;
  • Type: string

Kind of object being referenced.

Values defined by this API group are “User”, “Group”, and “ServiceAccount”. If the Authorizer does not recognized the kind value, the Authorizer should report an error.


nameRequired
public readonly name: string;
  • Type: string

Name of the object being referenced.


apiGroupOptional
public readonly apiGroup: string;
  • Type: string

APIGroup holds the API group of the referenced subject.

Defaults to “” for ServiceAccount subjects. Defaults to “rbac.authorization.k8s.io” for User and Group subjects.


namespaceOptional
public readonly namespace: string;
  • Type: string

Namespace of the referenced object.

If the object kind is non-namespace, such as “User” or “Group”, and this value is not empty the Authorizer should report an error.


Sysctl

Sysctl defines a kernel parameter to be set.

Initializer

import { Sysctl } from 'cdk8s-plus-24'

const sysctl: Sysctl = { ... }
nameRequired
public readonly name: string;
  • Type: string

Name of a property to set.


valueRequired
public readonly value: string;
  • Type: string

Value of a property to set.


TcpSocketProbeOptions

Options for Probe.fromTcpSocket().

Initializer

import { TcpSocketProbeOptions } from 'cdk8s-plus-24'

const tcpSocketProbeOptions: TcpSocketProbeOptions = { ... }
failureThresholdOptional
public readonly failureThreshold: number;
  • Type: number
  • Default: 3

Minimum consecutive failures for the probe to be considered failed after having succeeded.

Defaults to 3. Minimum value is 1.


initialDelaySecondsOptional
public readonly initialDelaySeconds: Duration;

Number of seconds after the container has started before liveness probes are initiated.

https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes


periodSecondsOptional
public readonly periodSeconds: Duration;
  • Type: cdk8s.Duration
  • Default: Duration.seconds(10) Minimum value is 1.

How often (in seconds) to perform the probe.

Default to 10 seconds. Minimum value is 1.


successThresholdOptional
public readonly successThreshold: number;
  • Type: number
  • Default: 1 Must be 1 for liveness and startup. Minimum value is 1.

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.


timeoutSecondsOptional
public readonly timeoutSeconds: Duration;

Number of seconds after which the probe times out.

Defaults to 1 second. Minimum value is 1.

https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes


hostOptional
public readonly host: string;
  • Type: string
  • Default: defaults to the pod IP

The host name to connect to on the container.


portOptional
public readonly port: number;
  • Type: number
  • Default: defaults to container.port.

The TCP port to connect to on the container.


TlsSecretProps

Options for TlsSecret.

Initializer

import { TlsSecretProps } from 'cdk8s-plus-24'

const tlsSecretProps: TlsSecretProps = { ... }
metadataOptional
public readonly metadata: ApiObjectMetadata;

Metadata that all persisted resources must have, which includes all objects users must create.


immutableOptional
public readonly immutable: boolean;
  • Type: boolean
  • Default: false

If set to true, ensures that data stored in the Secret cannot be updated (only object metadata can be modified).

If not set to true, the field can be modified at any time.


tlsCertRequired
public readonly tlsCert: string;
  • Type: string

The TLS cert.


tlsKeyRequired
public readonly tlsKey: string;
  • Type: string

The TLS key.


VolumeMount

Mount a volume from the pod to the container.

Initializer

import { VolumeMount } from 'cdk8s-plus-24'

const volumeMount: VolumeMount = { ... }
propagationOptional
public readonly propagation: MountPropagation;

Determines how mounts are propagated from the host to container and the other way around.

When not set, MountPropagationNone is used.

Mount propagation allows for sharing volumes mounted by a Container to other Containers in the same Pod, or even to other Pods on the same node.


readOnlyOptional
public readonly readOnly: boolean;
  • Type: boolean
  • Default: false

Mounted read-only if true, read-write otherwise (false or unspecified).

Defaults to false.


subPathOptional
public readonly subPath: string;
  • Type: string
  • Default: “” the volume’s root

Path within the volume from which the container’s volume should be mounted.).


subPathExprOptional
public readonly subPathExpr: string;
  • Type: string
  • Default: “” volume’s root.

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 environment. Defaults to “” (volume’s root).

subPathExpr and subPath are mutually exclusive.


pathRequired
public readonly path: string;
  • Type: string

Path within the container at which the volume should be mounted.

Must not contain ‘:’.


volumeRequired
public readonly volume: Volume;

The volume to mount.


WorkloadProps

Properties for Workload.

Initializer

import { WorkloadProps } from 'cdk8s-plus-24'

const workloadProps: WorkloadProps = { ... }
metadataOptional
public readonly metadata: ApiObjectMetadata;

Metadata that all persisted resources must have, which includes all objects users must create.


automountServiceAccountTokenOptional
public readonly automountServiceAccountToken: boolean;
  • Type: boolean
  • Default: false

Indicates whether a service account token should be automatically mounted.

https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/#use-the-default-service-account-to-access-the-api-server


containersOptional
public readonly containers: ContainerProps[];

List of containers belonging to the pod.

Containers cannot currently be added or removed. There must be at least one container in a Pod.

You can add additionnal containers using podSpec.addContainer()


dnsOptional
public readonly dns: PodDnsProps;

DNS settings for the pod.

https://kubernetes.io/docs/concepts/services-networking/dns-pod-service/


dockerRegistryAuthOptional
public readonly dockerRegistryAuth: DockerConfigSecret;

A secret containing docker credentials for authenticating to a registry.


hostAliasesOptional
public readonly hostAliases: HostAlias[];

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


initContainersOptional
public readonly initContainers: ContainerProps[];

List of initialization containers belonging to the pod.

Init containers are executed in order prior to containers being started. If any init container fails, the pod is considered to have failed and is handled according to its restartPolicy. The name for an init container or normal container must be unique among all containers. Init containers may not have Lifecycle actions, Readiness probes, Liveness probes, or Startup probes. The resourceRequirements of an init container are taken into account during scheduling by finding the highest request/limit for each resource type, and then using the max of of that value or the sum of the normal containers. Limits are applied to init containers in a similar fashion.

Init containers cannot currently be added ,removed or updated.

https://kubernetes.io/docs/concepts/workloads/pods/init-containers/


restartPolicyOptional
public readonly restartPolicy: RestartPolicy;

Restart policy for all containers within the pod.

https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#restart-policy


securityContextOptional
public readonly securityContext: PodSecurityContextProps;

SecurityContext holds pod-level security attributes and common container settings.


serviceAccountOptional
public readonly serviceAccount: IServiceAccount;

A service account provides an identity for processes that run in a Pod.

When you (a human) access the cluster (for example, using kubectl), you are authenticated by the apiserver as a particular User Account (currently this is usually admin, unless your cluster administrator has customized your cluster). Processes in containers inside pods can also contact the apiserver. When they do, they are authenticated as a particular Service Account (for example, default).

https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/


volumesOptional
public readonly volumes: Volume[];

List of volumes that can be mounted by containers belonging to the pod.

You can also add volumes later using podSpec.addVolume()

https://kubernetes.io/docs/concepts/storage/volumes


podMetadataOptional
public readonly podMetadata: ApiObjectMetadata;

The pod metadata of this workload.


selectOptional
public readonly select: boolean;
  • Type: boolean
  • Default: true

Automatically allocates a pod label selector for this workload and add it to the pod metadata.

This ensures this workload manages pods created by its pod template.


spreadOptional
public readonly spread: boolean;
  • Type: boolean
  • Default: false

Automatically spread pods across hostname and zones.

https://kubernetes.io/docs/concepts/scheduling-eviction/topology-spread-constraints/#internal-default-constraints


WorkloadSchedulingSpreadOptions

Options for WorkloadScheduling.spread.

Initializer

import { WorkloadSchedulingSpreadOptions } from 'cdk8s-plus-24'

const workloadSchedulingSpreadOptions: WorkloadSchedulingSpreadOptions = { ... }
topologyOptional
public readonly topology: Topology;

Which topology to spread on.


weightOptional
public readonly weight: number;
  • Type: number
  • Default: no weight. spread is assumed to be required.

Indicates the spread is optional, with this weight score.


Classes

ApiResource

Represents information about an API resource type.

Methods

asApiResource
public asApiResource()
asNonApiResource
public asNonApiResource()

Static Functions

custom
import { ApiResource } from 'cdk8s-plus-24'

ApiResource.custom(options: ApiResourceOptions)
optionsRequired

Properties

apiGroupRequired
public readonly apiGroup: string;
  • Type: string

The group portion of the API version (e.g. authorization.k8s.io).


resourceTypeRequired
public readonly resourceType: string;
  • Type: string

The name of the resource type as it appears in the relevant API endpoint.

https://kubernetes.io/docs/reference/access-authn-authz/rbac/#referring-to-resources


Constants

API_SERVICES

API resource information for APIService.


BINDINGS

API resource information for Binding.


CERTIFICATE_SIGNING_REQUESTS

API resource information for CertificateSigningRequest.


CLUSTER_ROLE_BINDINGS

API resource information for ClusterRoleBinding.


CLUSTER_ROLES

API resource information for ClusterRole.


COMPONENT_STATUSES

API resource information for ComponentStatus.


CONFIG_MAPS

API resource information for ConfigMap.


CONTROLLER_REVISIONS

API resource information for ControllerRevision.


CRON_JOBS

API resource information for CronJob.


CSI_DRIVERS

API resource information for CSIDriver.


CSI_NODES

API resource information for CSINode.


CSI_STORAGE_CAPACITIES

API resource information for CSIStorageCapacity.


CUSTOM_RESOURCE_DEFINITIONS

API resource information for CustomResourceDefinition.


DAEMON_SETS

API resource information for DaemonSet.


DEPLOYMENTS

API resource information for Deployment.


ENDPOINT_SLICES

API resource information for EndpointSlice.


ENDPOINTS

API resource information for Endpoints.


EVENTS

API resource information for Event.


FLOW_SCHEMAS

API resource information for FlowSchema.


HORIZONTAL_POD_AUTOSCALERS

API resource information for HorizontalPodAutoscaler.


INGRESS_CLASSES

API resource information for IngressClass.


INGRESSES

API resource information for Ingress.


JOBS

API resource information for Job.


LEASES

API resource information for Lease.


LIMIT_RANGES

API resource information for LimitRange.


LOCAL_SUBJECT_ACCESS_REVIEWS

API resource information for LocalSubjectAccessReview.


MUTATING_WEBHOOK_CONFIGURATIONS

API resource information for MutatingWebhookConfiguration.


NAMESPACES

API resource information for Namespace.


NETWORK_POLICIES

API resource information for NetworkPolicy.


NODES

API resource information for Node.


PERSISTENT_VOLUME_CLAIMS

API resource information for PersistentVolumeClaim.


PERSISTENT_VOLUMES

API resource information for PersistentVolume.


POD_DISRUPTION_BUDGETS

API resource information for PodDisruptionBudget.


POD_SECURITY_POLICIES

API resource information for PodSecurityPolicy.


POD_TEMPLATES

API resource information for PodTemplate.


PODS

API resource information for Pod.


PRIORITY_CLASSES

API resource information for PriorityClass.


PRIORITY_LEVEL_CONFIGURATIONS

API resource information for PriorityLevelConfiguration.


REPLICA_SETS

API resource information for ReplicaSet.


REPLICATION_CONTROLLERS

API resource information for ReplicationController.


RESOURCE_QUOTAS

API resource information for ResourceQuota.


ROLE_BINDINGS

API resource information for RoleBinding.


ROLES

API resource information for Role.


RUNTIME_CLASSES

API resource information for RuntimeClass.


SECRETS

API resource information for Secret.


SELF_SUBJECT_ACCESS_REVIEWS

API resource information for SelfSubjectAccessReview.


SELF_SUBJECT_RULES_REVIEWS

API resource information for SelfSubjectRulesReview.


SERVICE_ACCOUNTS

API resource information for ServiceAccount.


SERVICES

API resource information for Service.


STATEFUL_SETS

API resource information for StatefulSet.


STORAGE_CLASSES

API resource information for StorageClass.


SUBJECT_ACCESS_REVIEWS

API resource information for SubjectAccessReview.


TOKEN_REVIEWS

API resource information for TokenReview.


VALIDATING_WEBHOOK_CONFIGURATIONS

API resource information for ValidatingWebhookConfiguration.


VOLUME_ATTACHMENTS

API resource information for VolumeAttachment.


Container

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

Initializers

import { Container } from 'cdk8s-plus-24'

new Container(props: ContainerProps)
propsRequired

Methods

addPort
public addPort(port: ContainerPort)
portRequired

mount
public mount(path: string, storage: IStorage, options?: MountOptions)
pathRequired
  • Type: string

The desired path in the container.


storageRequired

The storage to mount.


optionsOptional

Properties

envRequired
public readonly env: Env;

The environment of the container.


imageRequired
public readonly image: string;
  • Type: string

The container image.


imagePullPolicyRequired
public readonly imagePullPolicy: ImagePullPolicy;

Image pull policy for this container.


mountsRequired
public readonly mounts: VolumeMount[];

Volume mounts configured for this container.


nameRequired
public readonly name: string;
  • Type: string

The name of the container.


portsRequired
public readonly ports: ContainerPort[];

Ports exposed by this containers.

Returns a copy, use addPort to modify.


securityContextRequired
public readonly securityContext: ContainerSecurityContext;

The security context of the container.


argsOptional
public readonly args: string[];
  • Type: string[]

Arguments to the entrypoint.


commandOptional
public readonly command: string[];
  • Type: string[]

Entrypoint array (the command to execute when the container starts).


~~port~~Optional
  • Deprecated: - use portNumber.
public readonly port: number;
  • Type: number

portNumberOptional
public readonly portNumber: number;
  • Type: number

The port number that was configured for this container.

If undefined, either the container doesn’t expose a port, or its port configuration is stored in the ports field.


resourcesOptional
public readonly resources: ContainerResources;

Compute resources (CPU and memory requests and limits) required by the container.

https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/


workingDirOptional
public readonly workingDir: string;
  • Type: string

The working directory inside the container.


ContainerSecurityContext

Container security attributes and settings.

Initializers

import { ContainerSecurityContext } from 'cdk8s-plus-24'

new ContainerSecurityContext(props?: ContainerSecurityContextProps)
propsOptional

Properties

ensureNonRootRequired
public readonly ensureNonRoot: boolean;
  • Type: boolean

privilegedRequired
public readonly privileged: boolean;
  • Type: boolean

readOnlyRootFilesystemRequired
public readonly readOnlyRootFilesystem: boolean;
  • Type: boolean

allowPrivilegeEscalationOptional
public readonly allowPrivilegeEscalation: boolean;
  • Type: boolean

groupOptional
public readonly group: number;
  • Type: number

userOptional
public readonly user: number;
  • Type: number

Cpu

Represents the amount of CPU.

The amount can be passed as millis or units.

Static Functions

millis
import { Cpu } from 'cdk8s-plus-24'

Cpu.millis(amount: number)
amountRequired
  • Type: number

units
import { Cpu } from 'cdk8s-plus-24'

Cpu.units(amount: number)
amountRequired
  • Type: number

Properties

amountRequired
public readonly amount: string;
  • Type: string

DeploymentStrategy

Deployment strategies.

Static Functions

recreate
import { DeploymentStrategy } from 'cdk8s-plus-24'

DeploymentStrategy.recreate()
rollingUpdate
import { DeploymentStrategy } from 'cdk8s-plus-24'

DeploymentStrategy.rollingUpdate(options?: DeploymentStrategyRollingUpdateOptions)
optionsOptional

Env

Container environment variables.

Initializers

import { Env } from 'cdk8s-plus-24'

new Env(sources: EnvFrom[], variables: {[ key: string ]: EnvValue})
sourcesRequired

variablesRequired

Methods

addVariable
public addVariable(name: string, value: EnvValue)
nameRequired
  • Type: string

valueRequired

copyFrom
public copyFrom(from: EnvFrom)
fromRequired

Static Functions

fromConfigMap
import { Env } from 'cdk8s-plus-24'

Env.fromConfigMap(configMap: IConfigMap, prefix?: string)
configMapRequired

prefixOptional
  • Type: string

fromSecret
import { Env } from 'cdk8s-plus-24'

Env.fromSecret(secr: ISecret)
secrRequired

Properties

sourcesRequired
public readonly sources: EnvFrom[];

The list of sources used to populate the container environment, in addition to the variables.

Returns a copy. To add a source use container.env.copyFrom().


variablesRequired
public readonly variables: {[ key: string ]: EnvValue};

The environment variables for this container.

Returns a copy. To add environment variables use container.env.addVariable().


EnvFrom

A collection of env variables defined in other resources.

Initializers

import { EnvFrom } from 'cdk8s-plus-24'

new EnvFrom(configMap?: IConfigMap, prefix?: string, sec?: ISecret)
configMapOptional

prefixOptional
  • Type: string

secOptional

EnvValue

Utility class for creating reading env values from various sources.

Static Functions

fromConfigMap
import { EnvValue } from 'cdk8s-plus-24'

EnvValue.fromConfigMap(configMap: IConfigMap, key: string, options?: EnvValueFromConfigMapOptions)
configMapRequired

The config map.


keyRequired
  • Type: string

The key to extract the value from.


optionsOptional

Additional options.


fromFieldRef
import { EnvValue } from 'cdk8s-plus-24'

EnvValue.fromFieldRef(fieldPath: EnvFieldPaths, options?: EnvValueFromFieldRefOptions)
fieldPathRequired

: The field reference.


optionsOptional

: Additional options.


fromProcess
import { EnvValue } from 'cdk8s-plus-24'

EnvValue.fromProcess(key: string, options?: EnvValueFromProcessOptions)
keyRequired
  • Type: string

The key to read.


optionsOptional

Additional options.


fromResource
import { EnvValue } from 'cdk8s-plus-24'

EnvValue.fromResource(resource: ResourceFieldPaths, options?: EnvValueFromResourceOptions)
resourceRequired

: Resource to select the value from.


optionsOptional

: Additional options.


fromSecretValue
import { EnvValue } from 'cdk8s-plus-24'

EnvValue.fromSecretValue(secretValue: SecretValue, options?: EnvValueFromSecretOptions)
secretValueRequired

The secret value (secrent + key).


optionsOptional

Additional options.


fromValue
import { EnvValue } from 'cdk8s-plus-24'

EnvValue.fromValue(value: string)
valueRequired
  • Type: string

The value.


Properties

valueOptional
public readonly value: any;
  • Type: any

valueFromOptional
public readonly valueFrom: any;
  • Type: any

Handler

Defines a specific action that should be taken.

Static Functions

fromCommand
import { Handler } from 'cdk8s-plus-24'

Handler.fromCommand(command: string[])
commandRequired
  • Type: string[]

The command to execute.


fromHttpGet
import { Handler } from 'cdk8s-plus-24'

Handler.fromHttpGet(path: string, options?: HandlerFromHttpGetOptions)
pathRequired
  • Type: string

The URL path to hit.


optionsOptional

Options.


fromTcpSocket
import { Handler } from 'cdk8s-plus-24'

Handler.fromTcpSocket(options?: HandlerFromTcpSocketOptions)
optionsOptional

Options.


IngressBackend

The backend for an ingress path.

Static Functions

fromResource
import { IngressBackend } from 'cdk8s-plus-24'

IngressBackend.fromResource(resource: IResource)
resourceRequired

fromService
import { IngressBackend } from 'cdk8s-plus-24'

IngressBackend.fromService(serv: Service, options?: ServiceIngressBackendOptions)
servRequired

The service object.


optionsOptional

LabeledNode

A node that is matched by label selectors.

Initializers

import { LabeledNode } from 'cdk8s-plus-24'

new LabeledNode(labelSelector: NodeLabelQuery[])
labelSelectorRequired

Properties

labelSelectorRequired
public readonly labelSelector: NodeLabelQuery[];

LabelExpression

Represents a query that can be performed against resources with labels.

Static Functions

doesNotExist
import { LabelExpression } from 'cdk8s-plus-24'

LabelExpression.doesNotExist(key: string)
keyRequired
  • Type: string

exists
import { LabelExpression } from 'cdk8s-plus-24'

LabelExpression.exists(key: string)
keyRequired
  • Type: string

in
import { LabelExpression } from 'cdk8s-plus-24'

LabelExpression.in(key: string, values: string[])
keyRequired
  • Type: string

valuesRequired
  • Type: string[]

notIn
import { LabelExpression } from 'cdk8s-plus-24'

LabelExpression.notIn(key: string, values: string[])
keyRequired
  • Type: string

valuesRequired
  • Type: string[]

Properties

keyRequired
public readonly key: string;
  • Type: string

operatorRequired
public readonly operator: string;
  • Type: string

valuesOptional
public readonly values: string[];
  • Type: string[]

LabelSelector

Match a resource by labels.

Methods

isEmpty
public isEmpty()

Static Functions

of
import { LabelSelector } from 'cdk8s-plus-24'

LabelSelector.of(options?: LabelSelectorOptions)
optionsOptional

NamedNode

A node that is matched by its name.

Initializers

import { NamedNode } from 'cdk8s-plus-24'

new NamedNode(name: string)
nameRequired
  • Type: string

Properties

nameRequired
public readonly name: string;
  • Type: string

NetworkPolicyPort

Describes a port to allow traffic on.

Static Functions

allTcp
import { NetworkPolicyPort } from 'cdk8s-plus-24'

NetworkPolicyPort.allTcp()
allUdp
import { NetworkPolicyPort } from 'cdk8s-plus-24'

NetworkPolicyPort.allUdp()
of
import { NetworkPolicyPort } from 'cdk8s-plus-24'

NetworkPolicyPort.of(props: NetworkPolicyPortProps)
propsRequired

tcp
import { NetworkPolicyPort } from 'cdk8s-plus-24'

NetworkPolicyPort.tcp(port: number)
portRequired
  • Type: number

tcpRange
import { NetworkPolicyPort } from 'cdk8s-plus-24'

NetworkPolicyPort.tcpRange(startPort: number, endPort: number)
startPortRequired
  • Type: number

endPortRequired
  • Type: number

udp
import { NetworkPolicyPort } from 'cdk8s-plus-24'

NetworkPolicyPort.udp(port: number)
portRequired
  • Type: number

udpRange
import { NetworkPolicyPort } from 'cdk8s-plus-24'

NetworkPolicyPort.udpRange(startPort: number, endPort: number)
startPortRequired
  • Type: number

endPortRequired
  • Type: number

Node

Represents a node in the cluster.

Initializers

import { Node } from 'cdk8s-plus-24'

new Node()

Static Functions

labeled
import { Node } from 'cdk8s-plus-24'

Node.labeled(labelSelector: NodeLabelQuery)
labelSelectorRequired

named
import { Node } from 'cdk8s-plus-24'

Node.named(nodeName: string)
nodeNameRequired
  • Type: string

tainted
import { Node } from 'cdk8s-plus-24'

Node.tainted(taintSelector: NodeTaintQuery)
taintSelectorRequired

NodeLabelQuery

Represents a query that can be performed against nodes with labels.

Static Functions

doesNotExist
import { NodeLabelQuery } from 'cdk8s-plus-24'

NodeLabelQuery.doesNotExist(key: string)
keyRequired
  • Type: string

exists
import { NodeLabelQuery } from 'cdk8s-plus-24'

NodeLabelQuery.exists(key: string)
keyRequired
  • Type: string

gt
import { NodeLabelQuery } from 'cdk8s-plus-24'

NodeLabelQuery.gt(key: string, values: string[])
keyRequired
  • Type: string

valuesRequired
  • Type: string[]

in
import { NodeLabelQuery } from 'cdk8s-plus-24'

NodeLabelQuery.in(key: string, values: string[])
keyRequired
  • Type: string

valuesRequired
  • Type: string[]

is
import { NodeLabelQuery } from 'cdk8s-plus-24'

NodeLabelQuery.is(key: string, value: string)
keyRequired
  • Type: string

valueRequired