# API Reference ## Constructs ### AbstractPod - *Implements:* [`cdk8s-plus-21.IPodSelector`](#cdk8s-plus-21.IPodSelector) #### Initializers ```typescript import { AbstractPod } from 'cdk8s-plus-21' new AbstractPod(scope: Construct, id: string, props?: AbstractPodProps) ``` ##### `scope`Required - *Type:* [`constructs.Construct`](#constructs.Construct) --- ##### `id`Required - *Type:* `string` --- ##### `props`Optional - *Type:* [`cdk8s-plus-21.AbstractPodProps`](#cdk8s-plus-21.AbstractPodProps) --- #### Methods ##### `addContainer` ```typescript public addContainer(cont: ContainerProps) ``` ###### `cont`Required - *Type:* [`cdk8s-plus-21.ContainerProps`](#cdk8s-plus-21.ContainerProps) --- ##### `addHostAlias` ```typescript public addHostAlias(hostAlias: HostAlias) ``` ###### `hostAlias`Required - *Type:* [`cdk8s-plus-21.HostAlias`](#cdk8s-plus-21.HostAlias) --- ##### `addInitContainer` ```typescript public addInitContainer(cont: ContainerProps) ``` ###### `cont`Required - *Type:* [`cdk8s-plus-21.ContainerProps`](#cdk8s-plus-21.ContainerProps) --- ##### `addVolume` ```typescript public addVolume(vol: Volume) ``` ###### `vol`Required - *Type:* [`cdk8s-plus-21.Volume`](#cdk8s-plus-21.Volume) --- ##### `toPodSelectorConfig` ```typescript public toPodSelectorConfig() ``` #### Properties ##### `automountServiceAccountToken`Required ```typescript public readonly automountServiceAccountToken: boolean; ``` - *Type:* `boolean` --- ##### `containers`Required ```typescript public readonly containers: Container[]; ``` - *Type:* [`cdk8s-plus-21.Container`](#cdk8s-plus-21.Container)[] --- ##### `dns`Required ```typescript public readonly dns: PodDns; ``` - *Type:* [`cdk8s-plus-21.PodDns`](#cdk8s-plus-21.PodDns) --- ##### `hostAliases`Required ```typescript public readonly hostAliases: HostAlias[]; ``` - *Type:* [`cdk8s-plus-21.HostAlias`](#cdk8s-plus-21.HostAlias)[] --- ##### `initContainers`Required ```typescript public readonly initContainers: Container[]; ``` - *Type:* [`cdk8s-plus-21.Container`](#cdk8s-plus-21.Container)[] --- ##### `podMetadata`Required ```typescript public readonly podMetadata: ApiObjectMetadataDefinition; ``` - *Type:* [`cdk8s.ApiObjectMetadataDefinition`](#cdk8s.ApiObjectMetadataDefinition) --- ##### `securityContext`Required ```typescript public readonly securityContext: PodSecurityContext; ``` - *Type:* [`cdk8s-plus-21.PodSecurityContext`](#cdk8s-plus-21.PodSecurityContext) --- ##### `volumes`Required ```typescript public readonly volumes: Volume[]; ``` - *Type:* [`cdk8s-plus-21.Volume`](#cdk8s-plus-21.Volume)[] --- ##### `dockerRegistryAuth`Optional ```typescript public readonly dockerRegistryAuth: DockerConfigSecret; ``` - *Type:* [`cdk8s-plus-21.DockerConfigSecret`](#cdk8s-plus-21.DockerConfigSecret) --- ##### `restartPolicy`Optional ```typescript public readonly restartPolicy: RestartPolicy; ``` - *Type:* [`cdk8s-plus-21.RestartPolicy`](#cdk8s-plus-21.RestartPolicy) --- ##### `serviceAccount`Optional ```typescript public readonly serviceAccount: IServiceAccount; ``` - *Type:* [`cdk8s-plus-21.IServiceAccount`](#cdk8s-plus-21.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 ```typescript import { AwsElasticBlockStorePersistentVolume } from 'cdk8s-plus-21' new AwsElasticBlockStorePersistentVolume(scope: Construct, id: string, props: AwsElasticBlockStorePersistentVolumeProps) ``` ##### `scope`Required - *Type:* [`constructs.Construct`](#constructs.Construct) --- ##### `id`Required - *Type:* `string` --- ##### `props`Required - *Type:* [`cdk8s-plus-21.AwsElasticBlockStorePersistentVolumeProps`](#cdk8s-plus-21.AwsElasticBlockStorePersistentVolumeProps) --- #### Properties ##### `fsType`Required ```typescript public readonly fsType: string; ``` - *Type:* `string` File system type of this volume. --- ##### `readOnly`Required ```typescript public readonly readOnly: boolean; ``` - *Type:* `boolean` Whether or not it is mounted as a read-only volume. --- ##### `volumeId`Required ```typescript public readonly volumeId: string; ``` - *Type:* `string` Volume id of this volume. --- ##### `partition`Optional ```typescript 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 ```typescript import { AzureDiskPersistentVolume } from 'cdk8s-plus-21' new AzureDiskPersistentVolume(scope: Construct, id: string, props: AzureDiskPersistentVolumeProps) ``` ##### `scope`Required - *Type:* [`constructs.Construct`](#constructs.Construct) --- ##### `id`Required - *Type:* `string` --- ##### `props`Required - *Type:* [`cdk8s-plus-21.AzureDiskPersistentVolumeProps`](#cdk8s-plus-21.AzureDiskPersistentVolumeProps) --- #### Properties ##### `azureKind`Required ```typescript public readonly azureKind: AzureDiskPersistentVolumeKind; ``` - *Type:* [`cdk8s-plus-21.AzureDiskPersistentVolumeKind`](#cdk8s-plus-21.AzureDiskPersistentVolumeKind) Azure kind of this volume. --- ##### `cachingMode`Required ```typescript public readonly cachingMode: AzureDiskPersistentVolumeCachingMode; ``` - *Type:* [`cdk8s-plus-21.AzureDiskPersistentVolumeCachingMode`](#cdk8s-plus-21.AzureDiskPersistentVolumeCachingMode) Caching mode of this volume. --- ##### `diskName`Required ```typescript public readonly diskName: string; ``` - *Type:* `string` Disk name of this volume. --- ##### `diskUri`Required ```typescript public readonly diskUri: string; ``` - *Type:* `string` Disk URI of this volume. --- ##### `fsType`Required ```typescript public readonly fsType: string; ``` - *Type:* `string` File system type of this volume. --- ##### `readOnly`Required ```typescript 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 ```typescript import { BasicAuthSecret } from 'cdk8s-plus-21' new BasicAuthSecret(scope: Construct, id: string, props: BasicAuthSecretProps) ``` ##### `scope`Required - *Type:* [`constructs.Construct`](#constructs.Construct) --- ##### `id`Required - *Type:* `string` --- ##### `props`Required - *Type:* [`cdk8s-plus-21.BasicAuthSecretProps`](#cdk8s-plus-21.BasicAuthSecretProps) --- ### ClusterRole - *Implements:* [`cdk8s-plus-21.IClusterRole`](#cdk8s-plus-21.IClusterRole), [`cdk8s-plus-21.IRole`](#cdk8s-plus-21.IRole) ClusterRole is a cluster level, logical grouping of PolicyRules that can be referenced as a unit by a RoleBinding or ClusterRoleBinding. #### Initializers ```typescript import { ClusterRole } from 'cdk8s-plus-21' new ClusterRole(scope: Construct, id: string, props?: ClusterRoleProps) ``` ##### `scope`Required - *Type:* [`constructs.Construct`](#constructs.Construct) --- ##### `id`Required - *Type:* `string` --- ##### `props`Optional - *Type:* [`cdk8s-plus-21.ClusterRoleProps`](#cdk8s-plus-21.ClusterRoleProps) --- #### Methods ##### `aggregate` ```typescript public aggregate(key: string, value: string) ``` ###### `key`Required - *Type:* `string` --- ###### `value`Required - *Type:* `string` --- ##### `allow` ```typescript public allow(verbs: string[], endpoints: IApiEndpoint) ``` ###### `verbs`Required - *Type:* `string`[] --- ###### `endpoints`Required - *Type:* [`cdk8s-plus-21.IApiEndpoint`](#cdk8s-plus-21.IApiEndpoint) The endpoints(s) to apply to. --- ##### `allowCreate` ```typescript public allowCreate(endpoints: IApiEndpoint) ``` ###### `endpoints`Required - *Type:* [`cdk8s-plus-21.IApiEndpoint`](#cdk8s-plus-21.IApiEndpoint) The resource(s) to apply to. --- ##### `allowDelete` ```typescript public allowDelete(endpoints: IApiEndpoint) ``` ###### `endpoints`Required - *Type:* [`cdk8s-plus-21.IApiEndpoint`](#cdk8s-plus-21.IApiEndpoint) The resource(s) to apply to. --- ##### `allowDeleteCollection` ```typescript public allowDeleteCollection(endpoints: IApiEndpoint) ``` ###### `endpoints`Required - *Type:* [`cdk8s-plus-21.IApiEndpoint`](#cdk8s-plus-21.IApiEndpoint) The resource(s) to apply to. --- ##### `allowGet` ```typescript public allowGet(endpoints: IApiEndpoint) ``` ###### `endpoints`Required - *Type:* [`cdk8s-plus-21.IApiEndpoint`](#cdk8s-plus-21.IApiEndpoint) The resource(s) to apply to. --- ##### `allowList` ```typescript public allowList(endpoints: IApiEndpoint) ``` ###### `endpoints`Required - *Type:* [`cdk8s-plus-21.IApiEndpoint`](#cdk8s-plus-21.IApiEndpoint) The resource(s) to apply to. --- ##### `allowPatch` ```typescript public allowPatch(endpoints: IApiEndpoint) ``` ###### `endpoints`Required - *Type:* [`cdk8s-plus-21.IApiEndpoint`](#cdk8s-plus-21.IApiEndpoint) The resource(s) to apply to. --- ##### `allowRead` ```typescript public allowRead(endpoints: IApiEndpoint) ``` ###### `endpoints`Required - *Type:* [`cdk8s-plus-21.IApiEndpoint`](#cdk8s-plus-21.IApiEndpoint) The resource(s) to apply to. --- ##### `allowReadWrite` ```typescript public allowReadWrite(endpoints: IApiEndpoint) ``` ###### `endpoints`Required - *Type:* [`cdk8s-plus-21.IApiEndpoint`](#cdk8s-plus-21.IApiEndpoint) The resource(s) to apply to. --- ##### `allowUpdate` ```typescript public allowUpdate(endpoints: IApiEndpoint) ``` ###### `endpoints`Required - *Type:* [`cdk8s-plus-21.IApiEndpoint`](#cdk8s-plus-21.IApiEndpoint) The resource(s) to apply to. --- ##### `allowWatch` ```typescript public allowWatch(endpoints: IApiEndpoint) ``` ###### `endpoints`Required - *Type:* [`cdk8s-plus-21.IApiEndpoint`](#cdk8s-plus-21.IApiEndpoint) The resource(s) to apply to. --- ##### `bind` ```typescript public bind(subjects: ISubject) ``` ###### `subjects`Required - *Type:* [`cdk8s-plus-21.ISubject`](#cdk8s-plus-21.ISubject) a list of subjects to bind to. --- ##### `bindInNamespace` ```typescript public bindInNamespace(namespace: string, subjects: ISubject) ``` ###### `namespace`Required - *Type:* `string` the namespace to limit permissions to. --- ###### `subjects`Required - *Type:* [`cdk8s-plus-21.ISubject`](#cdk8s-plus-21.ISubject) a list of subjects to bind to. --- ##### `combine` ```typescript public combine(rol: ClusterRole) ``` ###### `rol`Required - *Type:* [`cdk8s-plus-21.ClusterRole`](#cdk8s-plus-21.ClusterRole) --- #### Static Functions ##### `fromClusterRoleName` ```typescript import { ClusterRole } from 'cdk8s-plus-21' ClusterRole.fromClusterRoleName(name: string) ``` ###### `name`Required - *Type:* `string` The name of the role resource. --- #### Properties ##### `resourceType`Required ```typescript public readonly resourceType: string; ``` - *Type:* `string` The name of a resource type as it appears in the relevant API endpoint. --- ##### `rules`Required ```typescript public readonly rules: ClusterRolePolicyRule[]; ``` - *Type:* [`cdk8s-plus-21.ClusterRolePolicyRule`](#cdk8s-plus-21.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 ```typescript import { ClusterRoleBinding } from 'cdk8s-plus-21' new ClusterRoleBinding(scope: Construct, id: string, props: ClusterRoleBindingProps) ``` ##### `scope`Required - *Type:* [`constructs.Construct`](#constructs.Construct) --- ##### `id`Required - *Type:* `string` --- ##### `props`Required - *Type:* [`cdk8s-plus-21.ClusterRoleBindingProps`](#cdk8s-plus-21.ClusterRoleBindingProps) --- #### Methods ##### `addSubjects` ```typescript public addSubjects(subjects: ISubject) ``` ###### `subjects`Required - *Type:* [`cdk8s-plus-21.ISubject`](#cdk8s-plus-21.ISubject) The subjects to add. --- #### Properties ##### `resourceType`Required ```typescript public readonly resourceType: string; ``` - *Type:* `string` The name of a resource type as it appears in the relevant API endpoint. --- ##### `role`Required ```typescript public readonly role: IClusterRole; ``` - *Type:* [`cdk8s-plus-21.IClusterRole`](#cdk8s-plus-21.IClusterRole) --- ##### `subjects`Required ```typescript public readonly subjects: ISubject[]; ``` - *Type:* [`cdk8s-plus-21.ISubject`](#cdk8s-plus-21.ISubject)[] --- ### ConfigMap - *Implements:* [`cdk8s-plus-21.IConfigMap`](#cdk8s-plus-21.IConfigMap) ConfigMap holds configuration data for pods to consume. #### Initializers ```typescript import { ConfigMap } from 'cdk8s-plus-21' new ConfigMap(scope: Construct, id: string, props?: ConfigMapProps) ``` ##### `scope`Required - *Type:* [`constructs.Construct`](#constructs.Construct) --- ##### `id`Required - *Type:* `string` --- ##### `props`Optional - *Type:* [`cdk8s-plus-21.ConfigMapProps`](#cdk8s-plus-21.ConfigMapProps) --- #### Methods ##### `addBinaryData` ```typescript public addBinaryData(key: string, value: string) ``` ###### `key`Required - *Type:* `string` The key. --- ###### `value`Required - *Type:* `string` The value. --- ##### `addData` ```typescript public addData(key: string, value: string) ``` ###### `key`Required - *Type:* `string` The key. --- ###### `value`Required - *Type:* `string` The value. --- ##### `addDirectory` ```typescript public addDirectory(localDir: string, options?: AddDirectoryOptions) ``` ###### `localDir`Required - *Type:* `string` A path to a local directory. --- ###### `options`Optional - *Type:* [`cdk8s-plus-21.AddDirectoryOptions`](#cdk8s-plus-21.AddDirectoryOptions) Options. --- ##### `addFile` ```typescript public addFile(localFile: string, key?: string) ``` ###### `localFile`Required - *Type:* `string` The path to the local file. --- ###### `key`Optional - *Type:* `string` The ConfigMap key (default to the file name). --- #### Static Functions ##### `fromConfigMapName` ```typescript import { ConfigMap } from 'cdk8s-plus-21' ConfigMap.fromConfigMapName(name: string) ``` ###### `name`Required - *Type:* `string` The name of the config map to import. --- #### Properties ##### `binaryData`Required ```typescript 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()`. --- ##### `data`Required ```typescript 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()`. --- ##### `immutable`Required ```typescript public readonly immutable: boolean; ``` - *Type:* `boolean` Whether or not this config map is immutable. --- ##### `resourceType`Required ```typescript public readonly resourceType: string; ``` - *Type:* `string` The name of a resource type as it appears in the relevant API endpoint. --- ### 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 ```typescript import { DaemonSet } from 'cdk8s-plus-21' new DaemonSet(scope: Construct, id: string, props?: DaemonSetProps) ``` ##### `scope`Required - *Type:* [`constructs.Construct`](#constructs.Construct) --- ##### `id`Required - *Type:* `string` --- ##### `props`Optional - *Type:* [`cdk8s-plus-21.DaemonSetProps`](#cdk8s-plus-21.DaemonSetProps) --- #### Properties ##### `minReadySeconds`Required ```typescript public readonly minReadySeconds: number; ``` - *Type:* `number` --- ##### `resourceType`Required ```typescript 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 ```typescript import { Deployment } from 'cdk8s-plus-21' new Deployment(scope: Construct, id: string, props?: DeploymentProps) ``` ##### `scope`Required - *Type:* [`constructs.Construct`](#constructs.Construct) --- ##### `id`Required - *Type:* `string` --- ##### `props`Optional - *Type:* [`cdk8s-plus-21.DeploymentProps`](#cdk8s-plus-21.DeploymentProps) --- #### Methods ##### `exposeViaIngress` ```typescript public exposeViaIngress(path: string, options?: ExposeDeploymentViaIngressOptions) ``` ###### `path`Required - *Type:* `string` The ingress path to register under. --- ###### `options`Optional - *Type:* [`cdk8s-plus-21.ExposeDeploymentViaIngressOptions`](#cdk8s-plus-21.ExposeDeploymentViaIngressOptions) Additional options. --- ##### `exposeViaService` ```typescript public exposeViaService(options?: ExposeDeploymentViaServiceOptions) ``` ###### `options`Optional - *Type:* [`cdk8s-plus-21.ExposeDeploymentViaServiceOptions`](#cdk8s-plus-21.ExposeDeploymentViaServiceOptions) Options to determine details of the service and port exposed. --- #### Properties ##### `minReady`Required ```typescript public readonly minReady: Duration; ``` - *Type:* [`cdk8s.Duration`](#cdk8s.Duration) Minimum duration for which a newly created pod should be ready without any of its container crashing, for it to be considered available. --- ##### `progressDeadline`Required ```typescript public readonly progressDeadline: Duration; ``` - *Type:* [`cdk8s.Duration`](#cdk8s.Duration) The maximum duration for a deployment to make progress before it is considered to be failed. --- ##### `replicas`Required ```typescript public readonly replicas: number; ``` - *Type:* `number` Number of desired pods. --- ##### `resourceType`Required ```typescript public readonly resourceType: string; ``` - *Type:* `string` The name of a resource type as it appears in the relevant API endpoint. --- ##### `strategy`Required ```typescript public readonly strategy: DeploymentStrategy; ``` - *Type:* [`cdk8s-plus-21.DeploymentStrategy`](#cdk8s-plus-21.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 ```typescript import { DockerConfigSecret } from 'cdk8s-plus-21' new DockerConfigSecret(scope: Construct, id: string, props: DockerConfigSecretProps) ``` ##### `scope`Required - *Type:* [`constructs.Construct`](#constructs.Construct) --- ##### `id`Required - *Type:* `string` --- ##### `props`Required - *Type:* [`cdk8s-plus-21.DockerConfigSecretProps`](#cdk8s-plus-21.DockerConfigSecretProps) --- ### 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 ```typescript import { GCEPersistentDiskPersistentVolume } from 'cdk8s-plus-21' new GCEPersistentDiskPersistentVolume(scope: Construct, id: string, props: GCEPersistentDiskPersistentVolumeProps) ``` ##### `scope`Required - *Type:* [`constructs.Construct`](#constructs.Construct) --- ##### `id`Required - *Type:* `string` --- ##### `props`Required - *Type:* [`cdk8s-plus-21.GCEPersistentDiskPersistentVolumeProps`](#cdk8s-plus-21.GCEPersistentDiskPersistentVolumeProps) --- #### Properties ##### `fsType`Required ```typescript public readonly fsType: string; ``` - *Type:* `string` File system type of this volume. --- ##### `pdName`Required ```typescript public readonly pdName: string; ``` - *Type:* `string` PD resource in GCE of this volume. --- ##### `readOnly`Required ```typescript public readonly readOnly: boolean; ``` - *Type:* `boolean` Whether or not it is mounted as a read-only volume. --- ##### `partition`Optional ```typescript public readonly partition: number; ``` - *Type:* `number` Partition of this volume. --- ### IngressV1Beta1 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 ```typescript import { IngressV1Beta1 } from 'cdk8s-plus-21' new IngressV1Beta1(scope: Construct, id: string, props?: IngressV1Beta1Props) ``` ##### `scope`Required - *Type:* [`constructs.Construct`](#constructs.Construct) --- ##### `id`Required - *Type:* `string` --- ##### `props`Optional - *Type:* [`cdk8s-plus-21.IngressV1Beta1Props`](#cdk8s-plus-21.IngressV1Beta1Props) --- #### Methods ##### `addDefaultBackend` ```typescript public addDefaultBackend(backend: IngressV1Beta1Backend) ``` ###### `backend`Required - *Type:* [`cdk8s-plus-21.IngressV1Beta1Backend`](#cdk8s-plus-21.IngressV1Beta1Backend) The backend to use for requests that do not match any rule. --- ##### `addHostDefaultBackend` ```typescript public addHostDefaultBackend(host: string, backend: IngressV1Beta1Backend) ``` ###### `host`Required - *Type:* `string` The host name to match. --- ###### `backend`Required - *Type:* [`cdk8s-plus-21.IngressV1Beta1Backend`](#cdk8s-plus-21.IngressV1Beta1Backend) The backend to route to. --- ##### `addHostRule` ```typescript public addHostRule(host: string, path: string, backend: IngressV1Beta1Backend) ``` ###### `host`Required - *Type:* `string` The host name. --- ###### `path`Required - *Type:* `string` The HTTP path. --- ###### `backend`Required - *Type:* [`cdk8s-plus-21.IngressV1Beta1Backend`](#cdk8s-plus-21.IngressV1Beta1Backend) The backend to route requests to. --- ##### `addRule` ```typescript public addRule(path: string, backend: IngressV1Beta1Backend) ``` ###### `path`Required - *Type:* `string` The HTTP path. --- ###### `backend`Required - *Type:* [`cdk8s-plus-21.IngressV1Beta1Backend`](#cdk8s-plus-21.IngressV1Beta1Backend) The backend to route requests to. --- ##### `addRules` ```typescript public addRules(rules: IngressV1Beta1Rule) ``` ###### `rules`Required - *Type:* [`cdk8s-plus-21.IngressV1Beta1Rule`](#cdk8s-plus-21.IngressV1Beta1Rule) The rules to add. --- ##### `addTls` ```typescript public addTls(tls: IngressV1Beta1Tls[]) ``` ###### `tls`Required - *Type:* [`cdk8s-plus-21.IngressV1Beta1Tls`](#cdk8s-plus-21.IngressV1Beta1Tls)[] --- #### Properties ##### `resourceType`Required ```typescript 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 ```typescript import { Job } from 'cdk8s-plus-21' new Job(scope: Construct, id: string, props?: JobProps) ``` ##### `scope`Required - *Type:* [`constructs.Construct`](#constructs.Construct) --- ##### `id`Required - *Type:* `string` --- ##### `props`Optional - *Type:* [`cdk8s-plus-21.JobProps`](#cdk8s-plus-21.JobProps) --- #### Properties ##### `resourceType`Required ```typescript public readonly resourceType: string; ``` - *Type:* `string` The name of a resource type as it appears in the relevant API endpoint. --- ##### `activeDeadline`Optional ```typescript public readonly activeDeadline: Duration; ``` - *Type:* [`cdk8s.Duration`](#cdk8s.Duration) Duration before job is terminated. If undefined, there is no deadline. --- ##### `backoffLimit`Optional ```typescript public readonly backoffLimit: number; ``` - *Type:* `number` Number of retries before marking failed. --- ##### `ttlAfterFinished`Optional ```typescript public readonly ttlAfterFinished: Duration; ``` - *Type:* [`cdk8s.Duration`](#cdk8s.Duration) TTL before the job is deleted after it is finished. --- ### Namespace - *Implements:* [`cdk8s-plus-21.INamespaceSelector`](#cdk8s-plus-21.INamespaceSelector) 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 ```typescript import { Namespace } from 'cdk8s-plus-21' new Namespace(scope: Construct, id: string, props?: NamespaceProps) ``` ##### `scope`Required - *Type:* [`constructs.Construct`](#constructs.Construct) --- ##### `id`Required - *Type:* `string` --- ##### `props`Optional - *Type:* [`cdk8s-plus-21.NamespaceProps`](#cdk8s-plus-21.NamespaceProps) --- #### Methods ##### `toNamespaceSelectorConfig` ```typescript public toNamespaceSelectorConfig() ``` #### Properties ##### `resourceType`Required ```typescript 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 --- ### PersistentVolume - *Implements:* [`cdk8s-plus-21.IPersistentVolume`](#cdk8s-plus-21.IPersistentVolume), [`cdk8s-plus-21.IStorage`](#cdk8s-plus-21.IStorage) 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 ```typescript import { PersistentVolume } from 'cdk8s-plus-21' new PersistentVolume(scope: Construct, id: string, props?: PersistentVolumeProps) ``` ##### `scope`Required - *Type:* [`constructs.Construct`](#constructs.Construct) --- ##### `id`Required - *Type:* `string` --- ##### `props`Optional - *Type:* [`cdk8s-plus-21.PersistentVolumeProps`](#cdk8s-plus-21.PersistentVolumeProps) --- #### Methods ##### `asVolume` ```typescript public asVolume() ``` ##### `bind` ```typescript public bind(claim: IPersistentVolumeClaim) ``` ###### `claim`Required - *Type:* [`cdk8s-plus-21.IPersistentVolumeClaim`](#cdk8s-plus-21.IPersistentVolumeClaim) The PVC to bind to. --- ##### `reserve` ```typescript public reserve() ``` #### Static Functions ##### `fromPersistentVolumeName` ```typescript import { PersistentVolume } from 'cdk8s-plus-21' PersistentVolume.fromPersistentVolumeName(volumeName: string) ``` ###### `volumeName`Required - *Type:* `string` The name of the pv to reference. --- #### Properties ##### `mode`Required ```typescript public readonly mode: PersistentVolumeMode; ``` - *Type:* [`cdk8s-plus-21.PersistentVolumeMode`](#cdk8s-plus-21.PersistentVolumeMode) Volume mode of this volume. --- ##### `reclaimPolicy`Required ```typescript public readonly reclaimPolicy: PersistentVolumeReclaimPolicy; ``` - *Type:* [`cdk8s-plus-21.PersistentVolumeReclaimPolicy`](#cdk8s-plus-21.PersistentVolumeReclaimPolicy) Reclaim policy of this volume. --- ##### `resourceType`Required ```typescript public readonly resourceType: string; ``` - *Type:* `string` The name of a resource type as it appears in the relevant API endpoint. --- ##### `accessModes`Optional ```typescript public readonly accessModes: PersistentVolumeAccessMode[]; ``` - *Type:* [`cdk8s-plus-21.PersistentVolumeAccessMode`](#cdk8s-plus-21.PersistentVolumeAccessMode)[] Access modes requirement of this claim. --- ##### `claim`Optional ```typescript public readonly claim: IPersistentVolumeClaim; ``` - *Type:* [`cdk8s-plus-21.IPersistentVolumeClaim`](#cdk8s-plus-21.IPersistentVolumeClaim) PVC this volume is bound to. Undefined means this volume is not yet claimed by any PVC. --- ##### `mountOptions`Optional ```typescript public readonly mountOptions: string[]; ``` - *Type:* `string`[] Mount options of this volume. --- ##### `storage`Optional ```typescript public readonly storage: Size; ``` - *Type:* [`cdk8s.Size`](#cdk8s.Size) Storage size of this volume. --- ##### `storageClassName`Optional ```typescript public readonly storageClassName: string; ``` - *Type:* `string` Storage class this volume belongs to. --- ### PersistentVolumeClaim - *Implements:* [`cdk8s-plus-21.IPersistentVolumeClaim`](#cdk8s-plus-21.IPersistentVolumeClaim) 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 ```typescript import { PersistentVolumeClaim } from 'cdk8s-plus-21' new PersistentVolumeClaim(scope: Construct, id: string, props?: PersistentVolumeClaimProps) ``` ##### `scope`Required - *Type:* [`constructs.Construct`](#constructs.Construct) --- ##### `id`Required - *Type:* `string` --- ##### `props`Optional - *Type:* [`cdk8s-plus-21.PersistentVolumeClaimProps`](#cdk8s-plus-21.PersistentVolumeClaimProps) --- #### Methods ##### `bind` ```typescript public bind(vol: IPersistentVolume) ``` ###### `vol`Required - *Type:* [`cdk8s-plus-21.IPersistentVolume`](#cdk8s-plus-21.IPersistentVolume) The PV to bind to. --- #### Static Functions ##### `fromClaimName` ```typescript import { PersistentVolumeClaim } from 'cdk8s-plus-21' PersistentVolumeClaim.fromClaimName(claimName: string) ``` ###### `claimName`Required - *Type:* `string` The name of the pvc to reference. --- #### Properties ##### `resourceType`Required ```typescript public readonly resourceType: string; ``` - *Type:* `string` The name of a resource type as it appears in the relevant API endpoint. --- ##### `volumeMode`Required ```typescript public readonly volumeMode: PersistentVolumeMode; ``` - *Type:* [`cdk8s-plus-21.PersistentVolumeMode`](#cdk8s-plus-21.PersistentVolumeMode) Volume mode requirement of this claim. --- ##### `accessModes`Optional ```typescript public readonly accessModes: PersistentVolumeAccessMode[]; ``` - *Type:* [`cdk8s-plus-21.PersistentVolumeAccessMode`](#cdk8s-plus-21.PersistentVolumeAccessMode)[] Access modes requirement of this claim. --- ##### `storage`Optional ```typescript public readonly storage: Size; ``` - *Type:* [`cdk8s.Size`](#cdk8s.Size) Storage requirement of this claim. --- ##### `storageClassName`Optional ```typescript public readonly storageClassName: string; ``` - *Type:* `string` Storage class requirment of this claim. --- ##### `volume`Optional ```typescript public readonly volume: IPersistentVolume; ``` - *Type:* [`cdk8s-plus-21.IPersistentVolume`](#cdk8s-plus-21.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 ```typescript import { Pod } from 'cdk8s-plus-21' new Pod(scope: Construct, id: string, props?: PodProps) ``` ##### `scope`Required - *Type:* [`constructs.Construct`](#constructs.Construct) --- ##### `id`Required - *Type:* `string` --- ##### `props`Optional - *Type:* [`cdk8s-plus-21.PodProps`](#cdk8s-plus-21.PodProps) --- #### Properties ##### `podMetadata`Required ```typescript public readonly podMetadata: ApiObjectMetadataDefinition; ``` - *Type:* [`cdk8s.ApiObjectMetadataDefinition`](#cdk8s.ApiObjectMetadataDefinition) --- ##### `resourceType`Required ```typescript public readonly resourceType: string; ``` - *Type:* `string` The name of a resource type as it appears in the relevant API endpoint. --- ##### `scheduling`Required ```typescript public readonly scheduling: PodScheduling; ``` - *Type:* [`cdk8s-plus-21.PodScheduling`](#cdk8s-plus-21.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. --- ### Resource - *Implements:* [`cdk8s-plus-21.IResource`](#cdk8s-plus-21.IResource), [`cdk8s-plus-21.IApiResource`](#cdk8s-plus-21.IApiResource), [`cdk8s-plus-21.IApiEndpoint`](#cdk8s-plus-21.IApiEndpoint) Base class for all Kubernetes objects in stdk8s. Represents a single resource. #### Initializers ```typescript import { Resource } from 'cdk8s-plus-21' new Resource(scope: Construct, id: string) ``` ##### `scope`Required - *Type:* [`constructs.Construct`](#constructs.Construct) The scope in which to define this construct. --- ##### `id`Required - *Type:* `string` The scoped construct ID. Must be unique amongst siblings. If the ID includes a path separator (`/`), then it will be replaced by double dash `--`. --- #### Methods ##### `asApiResource` ```typescript public asApiResource() ``` ##### `asNonApiResource` ```typescript public asNonApiResource() ``` #### Properties ##### `apiGroup`Required ```typescript public readonly apiGroup: string; ``` - *Type:* `string` The group portion of the API version (e.g. "authorization.k8s.io"). --- ##### `apiVersion`Required ```typescript public readonly apiVersion: string; ``` - *Type:* `string` The object's API version (e.g. "authorization.k8s.io/v1"). --- ##### `kind`Required ```typescript public readonly kind: string; ``` - *Type:* `string` The object kind (e.g. "Deployment"). --- ##### `metadata`Required ```typescript public readonly metadata: ApiObjectMetadataDefinition; ``` - *Type:* [`cdk8s.ApiObjectMetadataDefinition`](#cdk8s.ApiObjectMetadataDefinition) --- ##### `name`Required ```typescript public readonly name: string; ``` - *Type:* `string` The name of this API object. --- ##### `resourceType`Required ```typescript public readonly resourceType: string; ``` - *Type:* `string` The name of a resource type as it appears in the relevant API endpoint. --- ##### `resourceName`Optional ```typescript 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 - *Implements:* [`cdk8s-plus-21.IRole`](#cdk8s-plus-21.IRole) Role is a namespaced, logical grouping of PolicyRules that can be referenced as a unit by a RoleBinding. #### Initializers ```typescript import { Role } from 'cdk8s-plus-21' new Role(scope: Construct, id: string, props?: RoleProps) ``` ##### `scope`Required - *Type:* [`constructs.Construct`](#constructs.Construct) --- ##### `id`Required - *Type:* `string` --- ##### `props`Optional - *Type:* [`cdk8s-plus-21.RoleProps`](#cdk8s-plus-21.RoleProps) --- #### Methods ##### `allow` ```typescript public allow(verbs: string[], resources: IApiResource) ``` ###### `verbs`Required - *Type:* `string`[] --- ###### `resources`Required - *Type:* [`cdk8s-plus-21.IApiResource`](#cdk8s-plus-21.IApiResource) The resource(s) to apply to. --- ##### `allowCreate` ```typescript public allowCreate(resources: IApiResource) ``` ###### `resources`Required - *Type:* [`cdk8s-plus-21.IApiResource`](#cdk8s-plus-21.IApiResource) The resource(s) to apply to. --- ##### `allowDelete` ```typescript public allowDelete(resources: IApiResource) ``` ###### `resources`Required - *Type:* [`cdk8s-plus-21.IApiResource`](#cdk8s-plus-21.IApiResource) The resource(s) to apply to. --- ##### `allowDeleteCollection` ```typescript public allowDeleteCollection(resources: IApiResource) ``` ###### `resources`Required - *Type:* [`cdk8s-plus-21.IApiResource`](#cdk8s-plus-21.IApiResource) The resource(s) to apply to. --- ##### `allowGet` ```typescript public allowGet(resources: IApiResource) ``` ###### `resources`Required - *Type:* [`cdk8s-plus-21.IApiResource`](#cdk8s-plus-21.IApiResource) The resource(s) to apply to. --- ##### `allowList` ```typescript public allowList(resources: IApiResource) ``` ###### `resources`Required - *Type:* [`cdk8s-plus-21.IApiResource`](#cdk8s-plus-21.IApiResource) The resource(s) to apply to. --- ##### `allowPatch` ```typescript public allowPatch(resources: IApiResource) ``` ###### `resources`Required - *Type:* [`cdk8s-plus-21.IApiResource`](#cdk8s-plus-21.IApiResource) The resource(s) to apply to. --- ##### `allowRead` ```typescript public allowRead(resources: IApiResource) ``` ###### `resources`Required - *Type:* [`cdk8s-plus-21.IApiResource`](#cdk8s-plus-21.IApiResource) The resource(s) to apply to. --- ##### `allowReadWrite` ```typescript public allowReadWrite(resources: IApiResource) ``` ###### `resources`Required - *Type:* [`cdk8s-plus-21.IApiResource`](#cdk8s-plus-21.IApiResource) The resource(s) to apply to. --- ##### `allowUpdate` ```typescript public allowUpdate(resources: IApiResource) ``` ###### `resources`Required - *Type:* [`cdk8s-plus-21.IApiResource`](#cdk8s-plus-21.IApiResource) The resource(s) to apply to. --- ##### `allowWatch` ```typescript public allowWatch(resources: IApiResource) ``` ###### `resources`Required - *Type:* [`cdk8s-plus-21.IApiResource`](#cdk8s-plus-21.IApiResource) The resource(s) to apply to. --- ##### `bind` ```typescript public bind(subjects: ISubject) ``` ###### `subjects`Required - *Type:* [`cdk8s-plus-21.ISubject`](#cdk8s-plus-21.ISubject) a list of subjects to bind to. --- #### Static Functions ##### `fromRoleName` ```typescript import { Role } from 'cdk8s-plus-21' Role.fromRoleName(name: string) ``` ###### `name`Required - *Type:* `string` The name of the role resource. --- #### Properties ##### `resourceType`Required ```typescript public readonly resourceType: string; ``` - *Type:* `string` The name of a resource type as it appears in the relevant API endpoint. --- ##### `rules`Required ```typescript public readonly rules: RolePolicyRule[]; ``` - *Type:* [`cdk8s-plus-21.RolePolicyRule`](#cdk8s-plus-21.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 ```typescript import { RoleBinding } from 'cdk8s-plus-21' new RoleBinding(scope: Construct, id: string, props: RoleBindingProps) ``` ##### `scope`Required - *Type:* [`constructs.Construct`](#constructs.Construct) --- ##### `id`Required - *Type:* `string` --- ##### `props`Required - *Type:* [`cdk8s-plus-21.RoleBindingProps`](#cdk8s-plus-21.RoleBindingProps) --- #### Methods ##### `addSubjects` ```typescript public addSubjects(subjects: ISubject) ``` ###### `subjects`Required - *Type:* [`cdk8s-plus-21.ISubject`](#cdk8s-plus-21.ISubject) The subjects to add. --- #### Properties ##### `resourceType`Required ```typescript public readonly resourceType: string; ``` - *Type:* `string` The name of a resource type as it appears in the relevant API endpoint. --- ##### `role`Required ```typescript public readonly role: IRole; ``` - *Type:* [`cdk8s-plus-21.IRole`](#cdk8s-plus-21.IRole) --- ##### `subjects`Required ```typescript public readonly subjects: ISubject[]; ``` - *Type:* [`cdk8s-plus-21.ISubject`](#cdk8s-plus-21.ISubject)[] --- ### Secret - *Implements:* [`cdk8s-plus-21.ISecret`](#cdk8s-plus-21.ISecret) 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 ```typescript import { Secret } from 'cdk8s-plus-21' new Secret(scope: Construct, id: string, props?: SecretProps) ``` ##### `scope`Required - *Type:* [`constructs.Construct`](#constructs.Construct) --- ##### `id`Required - *Type:* `string` --- ##### `props`Optional - *Type:* [`cdk8s-plus-21.SecretProps`](#cdk8s-plus-21.SecretProps) --- #### Methods ##### `addStringData` ```typescript public addStringData(key: string, value: string) ``` ###### `key`Required - *Type:* `string` Key. --- ###### `value`Required - *Type:* `string` Value. --- ##### `getStringData` ```typescript public getStringData(key: string) ``` ###### `key`Required - *Type:* `string` Key. --- #### Static Functions ##### `fromSecretName` ```typescript import { Secret } from 'cdk8s-plus-21' Secret.fromSecretName(name: string) ``` ###### `name`Required - *Type:* `string` The name of the secret to reference. --- #### Properties ##### `immutable`Required ```typescript public readonly immutable: boolean; ``` - *Type:* `boolean` Whether or not the secret is immutable. --- ##### `resourceType`Required ```typescript 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 ```typescript import { Service } from 'cdk8s-plus-21' new Service(scope: Construct, id: string, props?: ServiceProps) ``` ##### `scope`Required - *Type:* [`constructs.Construct`](#constructs.Construct) --- ##### `id`Required - *Type:* `string` --- ##### `props`Optional - *Type:* [`cdk8s-plus-21.ServiceProps`](#cdk8s-plus-21.ServiceProps) --- #### Methods ##### `addDeployment` ```typescript public addDeployment(depl: Deployment, options?: AddDeploymentOptions) ``` ###### `depl`Required - *Type:* [`cdk8s-plus-21.Deployment`](#cdk8s-plus-21.Deployment) The deployment to expose. --- ###### `options`Optional - *Type:* [`cdk8s-plus-21.AddDeploymentOptions`](#cdk8s-plus-21.AddDeploymentOptions) Optional settings for the port. --- ##### `addSelector` ```typescript public addSelector(label: string, value: string) ``` ###### `label`Required - *Type:* `string` The label key. --- ###### `value`Required - *Type:* `string` The label value. --- ##### `exposeViaIngress` ```typescript public exposeViaIngress(path: string, options?: ExposeServiceViaIngressOptions) ``` ###### `path`Required - *Type:* `string` The path to expose the service under. --- ###### `options`Optional - *Type:* [`cdk8s-plus-21.ExposeServiceViaIngressOptions`](#cdk8s-plus-21.ExposeServiceViaIngressOptions) Additional options. --- ##### `serve` ```typescript public serve(port: number, options?: ServicePortOptions) ``` ###### `port`Required - *Type:* `number` The port definition. --- ###### `options`Optional - *Type:* [`cdk8s-plus-21.ServicePortOptions`](#cdk8s-plus-21.ServicePortOptions) --- #### Properties ##### `ports`Required ```typescript public readonly ports: ServicePort[]; ``` - *Type:* [`cdk8s-plus-21.ServicePort`](#cdk8s-plus-21.ServicePort)[] Ports for this service. Use `serve()` to expose additional service ports. --- ##### `resourceType`Required ```typescript public readonly resourceType: string; ``` - *Type:* `string` The name of a resource type as it appears in the relevant API endpoint. --- ##### `selector`Required ```typescript public readonly selector: {[ key: string ]: string}; ``` - *Type:* {[ key: string ]: `string`} Returns the labels which are used to select pods for this service. --- ##### `type`Required ```typescript public readonly type: ServiceType; ``` - *Type:* [`cdk8s-plus-21.ServiceType`](#cdk8s-plus-21.ServiceType) Determines how the Service is exposed. --- ##### `clusterIP`Optional ```typescript public readonly clusterIP: string; ``` - *Type:* `string` The IP address of the service and is usually assigned randomly by the master. --- ##### `externalName`Optional ```typescript public readonly externalName: string; ``` - *Type:* `string` The externalName to be used for EXTERNAL_NAME types. --- ### ServiceAccount - *Implements:* [`cdk8s-plus-21.IServiceAccount`](#cdk8s-plus-21.IServiceAccount), [`cdk8s-plus-21.ISubject`](#cdk8s-plus-21.ISubject) 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 ```typescript import { ServiceAccount } from 'cdk8s-plus-21' new ServiceAccount(scope: Construct, id: string, props?: ServiceAccountProps) ``` ##### `scope`Required - *Type:* [`constructs.Construct`](#constructs.Construct) --- ##### `id`Required - *Type:* `string` --- ##### `props`Optional - *Type:* [`cdk8s-plus-21.ServiceAccountProps`](#cdk8s-plus-21.ServiceAccountProps) --- #### Methods ##### `addSecret` ```typescript public addSecret(secr: ISecret) ``` ###### `secr`Required - *Type:* [`cdk8s-plus-21.ISecret`](#cdk8s-plus-21.ISecret) The secret. --- #### Static Functions ##### `fromServiceAccountName` ```typescript import { ServiceAccount } from 'cdk8s-plus-21' ServiceAccount.fromServiceAccountName(name: string) ``` ###### `name`Required - *Type:* `string` The name of the service account resource. --- #### Properties ##### `automountToken`Required ```typescript public readonly automountToken: boolean; ``` - *Type:* `boolean` Whether or not a token is automatically mounted for this service account. --- ##### `resourceType`Required ```typescript public readonly resourceType: string; ``` - *Type:* `string` The name of a resource type as it appears in the relevant API endpoint. --- ##### `secrets`Required ```typescript public readonly secrets: ISecret[]; ``` - *Type:* [`cdk8s-plus-21.ISecret`](#cdk8s-plus-21.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 ```typescript import { ServiceAccountTokenSecret } from 'cdk8s-plus-21' new ServiceAccountTokenSecret(scope: Construct, id: string, props: ServiceAccountTokenSecretProps) ``` ##### `scope`Required - *Type:* [`constructs.Construct`](#constructs.Construct) --- ##### `id`Required - *Type:* `string` --- ##### `props`Required - *Type:* [`cdk8s-plus-21.ServiceAccountTokenSecretProps`](#cdk8s-plus-21.ServiceAccountTokenSecretProps) --- ### SshAuthSecret Create a secret for ssh authentication. > https://kubernetes.io/docs/concepts/configuration/secret/#ssh-authentication-secrets #### Initializers ```typescript import { SshAuthSecret } from 'cdk8s-plus-21' new SshAuthSecret(scope: Construct, id: string, props: SshAuthSecretProps) ``` ##### `scope`Required - *Type:* [`constructs.Construct`](#constructs.Construct) --- ##### `id`Required - *Type:* `string` --- ##### `props`Required - *Type:* [`cdk8s-plus-21.SshAuthSecretProps`](#cdk8s-plus-21.SshAuthSecretProps) --- ### 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 ```typescript import { StatefulSet } from 'cdk8s-plus-21' new StatefulSet(scope: Construct, id: string, props: StatefulSetProps) ``` ##### `scope`Required - *Type:* [`constructs.Construct`](#constructs.Construct) --- ##### `id`Required - *Type:* `string` --- ##### `props`Required - *Type:* [`cdk8s-plus-21.StatefulSetProps`](#cdk8s-plus-21.StatefulSetProps) --- #### Properties ##### `podManagementPolicy`Required ```typescript public readonly podManagementPolicy: PodManagementPolicy; ``` - *Type:* [`cdk8s-plus-21.PodManagementPolicy`](#cdk8s-plus-21.PodManagementPolicy) Management policy to use for the set. --- ##### `replicas`Required ```typescript public readonly replicas: number; ``` - *Type:* `number` Number of desired pods. --- ##### `resourceType`Required ```typescript public readonly resourceType: string; ``` - *Type:* `string` The name of a resource type as it appears in the relevant API endpoint. --- ##### `strategy`Required ```typescript public readonly strategy: StatefulSetUpdateStrategy; ``` - *Type:* [`cdk8s-plus-21.StatefulSetUpdateStrategy`](#cdk8s-plus-21.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 ```typescript import { TlsSecret } from 'cdk8s-plus-21' new TlsSecret(scope: Construct, id: string, props: TlsSecretProps) ``` ##### `scope`Required - *Type:* [`constructs.Construct`](#constructs.Construct) --- ##### `id`Required - *Type:* `string` --- ##### `props`Required - *Type:* [`cdk8s-plus-21.TlsSecretProps`](#cdk8s-plus-21.TlsSecretProps) --- ### 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 ```typescript import { Workload } from 'cdk8s-plus-21' new Workload(scope: Construct, id: string, props?: WorkloadProps) ``` ##### `scope`Required - *Type:* [`constructs.Construct`](#constructs.Construct) --- ##### `id`Required - *Type:* `string` --- ##### `props`Optional - *Type:* [`cdk8s-plus-21.WorkloadProps`](#cdk8s-plus-21.WorkloadProps) --- #### Methods ##### `select` ```typescript public select(selectors: LabelSelector) ``` ###### `selectors`Required - *Type:* [`cdk8s-plus-21.LabelSelector`](#cdk8s-plus-21.LabelSelector) --- #### Properties ##### `matchExpressions`Required ```typescript public readonly matchExpressions: LabelSelectorRequirement[]; ``` - *Type:* [`cdk8s-plus-21.LabelSelectorRequirement`](#cdk8s-plus-21.LabelSelectorRequirement)[] The expression matchers this workload will use in order to select pods. Returns a a copy. Use `select()` to add expression matchers. --- ##### `matchLabels`Required ```typescript 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. --- ##### `podMetadata`Required ```typescript public readonly podMetadata: ApiObjectMetadataDefinition; ``` - *Type:* [`cdk8s.ApiObjectMetadataDefinition`](#cdk8s.ApiObjectMetadataDefinition) The metadata of pods in this workload. --- ##### `scheduling`Required ```typescript public readonly scheduling: WorkloadScheduling; ``` - *Type:* [`cdk8s-plus-21.WorkloadScheduling`](#cdk8s-plus-21.WorkloadScheduling) --- ## Structs ### AbstractPodProps Properties for `AbstractPod`. #### Initializer ```typescript import { AbstractPodProps } from 'cdk8s-plus-21' const abstractPodProps: AbstractPodProps = { ... } ``` ##### `metadata`Optional ```typescript public readonly metadata: ApiObjectMetadata; ``` - *Type:* [`cdk8s.ApiObjectMetadata`](#cdk8s.ApiObjectMetadata) Metadata that all persisted resources must have, which includes all objects users must create. --- ##### `automountServiceAccountToken`Optional ```typescript public readonly automountServiceAccountToken: boolean; ``` - *Type:* `boolean` - *Default:* true 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 --- ##### `containers`Optional ```typescript public readonly containers: ContainerProps[]; ``` - *Type:* [`cdk8s-plus-21.ContainerProps`](#cdk8s-plus-21.ContainerProps)[] - *Default:* No containers. Note that a pod spec must include at least one container. 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()` --- ##### `dns`Optional ```typescript public readonly dns: PodDnsProps; ``` - *Type:* [`cdk8s-plus-21.PodDnsProps`](#cdk8s-plus-21.PodDnsProps) - *Default:* policy: DnsPolicy.CLUSTER_FIRST hostnameAsFQDN: false DNS settings for the pod. > https://kubernetes.io/docs/concepts/services-networking/dns-pod-service/ --- ##### `dockerRegistryAuth`Optional ```typescript public readonly dockerRegistryAuth: DockerConfigSecret; ``` - *Type:* [`cdk8s-plus-21.DockerConfigSecret`](#cdk8s-plus-21.DockerConfigSecret) - *Default:* No auth. Images are assumed to be publicly available. A secret containing docker credentials for authenticating to a registry. --- ##### `hostAliases`Optional ```typescript public readonly hostAliases: HostAlias[]; ``` - *Type:* [`cdk8s-plus-21.HostAlias`](#cdk8s-plus-21.HostAlias)[] HostAlias holds the mapping between IP and hostnames that will be injected as an entry in the pod's hosts file. --- ##### `initContainers`Optional ```typescript public readonly initContainers: ContainerProps[]; ``` - *Type:* [`cdk8s-plus-21.ContainerProps`](#cdk8s-plus-21.ContainerProps)[] - *Default:* No init containers. 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/ --- ##### `restartPolicy`Optional ```typescript public readonly restartPolicy: RestartPolicy; ``` - *Type:* [`cdk8s-plus-21.RestartPolicy`](#cdk8s-plus-21.RestartPolicy) - *Default:* RestartPolicy.ALWAYS Restart policy for all containers within the pod. > https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#restart-policy --- ##### `securityContext`Optional ```typescript public readonly securityContext: PodSecurityContextProps; ``` - *Type:* [`cdk8s-plus-21.PodSecurityContextProps`](#cdk8s-plus-21.PodSecurityContextProps) - *Default:* fsGroupChangePolicy: FsGroupChangePolicy.FsGroupChangePolicy.ALWAYS ensureNonRoot: false SecurityContext holds pod-level security attributes and common container settings. --- ##### `serviceAccount`Optional ```typescript public readonly serviceAccount: IServiceAccount; ``` - *Type:* [`cdk8s-plus-21.IServiceAccount`](#cdk8s-plus-21.IServiceAccount) - *Default:* No service account. 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/ --- ##### `volumes`Optional ```typescript public readonly volumes: Volume[]; ``` - *Type:* [`cdk8s-plus-21.Volume`](#cdk8s-plus-21.Volume)[] - *Default:* No volumes. 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 ```typescript import { AddDeploymentOptions } from 'cdk8s-plus-21' const addDeploymentOptions: AddDeploymentOptions = { ... } ``` ##### `name`Optional ```typescript 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. --- ##### `nodePort`Optional ```typescript 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 --- ##### `protocol`Optional ```typescript public readonly protocol: Protocol; ``` - *Type:* [`cdk8s-plus-21.Protocol`](#cdk8s-plus-21.Protocol) - *Default:* Protocol.TCP The IP protocol for this port. Supports "TCP", "UDP", and "SCTP". Default is TCP. --- ##### `targetPort`Optional ```typescript public readonly targetPort: number; ``` - *Type:* `number` - *Default:* The value of `port` will be used. The port number the service will redirect to. --- ##### `port`Optional ```typescript 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 ```typescript import { AddDirectoryOptions } from 'cdk8s-plus-21' const addDirectoryOptions: AddDirectoryOptions = { ... } ``` ##### `exclude`Optional ```typescript public readonly exclude: string[]; ``` - *Type:* `string`[] - *Default:* include all files Glob patterns to exclude when adding files. --- ##### `keyPrefix`Optional ```typescript public readonly keyPrefix: string; ``` - *Type:* `string` - *Default:* "" A prefix to add to all keys in the config map. --- ### ApiResourceOptions Options for `ApiResource`. #### Initializer ```typescript import { ApiResourceOptions } from 'cdk8s-plus-21' const apiResourceOptions: ApiResourceOptions = { ... } ``` ##### `apiGroup`Required ```typescript public readonly apiGroup: string; ``` - *Type:* `string` The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `resourceType`Required ```typescript 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 ```typescript import { AwsElasticBlockStorePersistentVolumeProps } from 'cdk8s-plus-21' const awsElasticBlockStorePersistentVolumeProps: AwsElasticBlockStorePersistentVolumeProps = { ... } ``` ##### `metadata`Optional ```typescript public readonly metadata: ApiObjectMetadata; ``` - *Type:* [`cdk8s.ApiObjectMetadata`](#cdk8s.ApiObjectMetadata) Metadata that all persisted resources must have, which includes all objects users must create. --- ##### `accessModes`Optional ```typescript public readonly accessModes: PersistentVolumeAccessMode[]; ``` - *Type:* [`cdk8s-plus-21.PersistentVolumeAccessMode`](#cdk8s-plus-21.PersistentVolumeAccessMode)[] - *Default:* No access modes. Contains all ways the volume can be mounted. > https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes --- ##### `claim`Optional ```typescript public readonly claim: IPersistentVolumeClaim; ``` - *Type:* [`cdk8s-plus-21.IPersistentVolumeClaim`](#cdk8s-plus-21.IPersistentVolumeClaim) - *Default:* Not bound to a specific claim. 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 --- ##### `mountOptions`Optional ```typescript 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 --- ##### `reclaimPolicy`Optional ```typescript public readonly reclaimPolicy: PersistentVolumeReclaimPolicy; ``` - *Type:* [`cdk8s-plus-21.PersistentVolumeReclaimPolicy`](#cdk8s-plus-21.PersistentVolumeReclaimPolicy) - *Default:* PersistentVolumeReclaimPolicy.RETAIN 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 --- ##### `storage`Optional ```typescript public readonly storage: Size; ``` - *Type:* [`cdk8s.Size`](#cdk8s.Size) - *Default:* No specified. What is the storage capacity of this volume. > https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources --- ##### `storageClassName`Optional ```typescript public readonly storageClassName: string; ``` - *Type:* `string` - *Default:* Volume does not belong to any storage class. Name of StorageClass to which this persistent volume belongs. --- ##### `volumeMode`Optional ```typescript public readonly volumeMode: PersistentVolumeMode; ``` - *Type:* [`cdk8s-plus-21.PersistentVolumeMode`](#cdk8s-plus-21.PersistentVolumeMode) - *Default:* VolumeMode.FILE_SYSTEM Defines what type of volume is required by the claim. --- ##### `volumeId`Required ```typescript 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 --- ##### `fsType`Optional ```typescript 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 --- ##### `partition`Optional ```typescript 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). --- ##### `readOnly`Optional ```typescript 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 ```typescript import { AwsElasticBlockStoreVolumeOptions } from 'cdk8s-plus-21' const awsElasticBlockStoreVolumeOptions: AwsElasticBlockStoreVolumeOptions = { ... } ``` ##### `fsType`Optional ```typescript 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 --- ##### `name`Optional ```typescript public readonly name: string; ``` - *Type:* `string` - *Default:* auto-generated The volume name. --- ##### `partition`Optional ```typescript 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). --- ##### `readOnly`Optional ```typescript 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 ```typescript import { AzureDiskPersistentVolumeProps } from 'cdk8s-plus-21' const azureDiskPersistentVolumeProps: AzureDiskPersistentVolumeProps = { ... } ``` ##### `metadata`Optional ```typescript public readonly metadata: ApiObjectMetadata; ``` - *Type:* [`cdk8s.ApiObjectMetadata`](#cdk8s.ApiObjectMetadata) Metadata that all persisted resources must have, which includes all objects users must create. --- ##### `accessModes`Optional ```typescript public readonly accessModes: PersistentVolumeAccessMode[]; ``` - *Type:* [`cdk8s-plus-21.PersistentVolumeAccessMode`](#cdk8s-plus-21.PersistentVolumeAccessMode)[] - *Default:* No access modes. Contains all ways the volume can be mounted. > https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes --- ##### `claim`Optional ```typescript public readonly claim: IPersistentVolumeClaim; ``` - *Type:* [`cdk8s-plus-21.IPersistentVolumeClaim`](#cdk8s-plus-21.IPersistentVolumeClaim) - *Default:* Not bound to a specific claim. 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 --- ##### `mountOptions`Optional ```typescript 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 --- ##### `reclaimPolicy`Optional ```typescript public readonly reclaimPolicy: PersistentVolumeReclaimPolicy; ``` - *Type:* [`cdk8s-plus-21.PersistentVolumeReclaimPolicy`](#cdk8s-plus-21.PersistentVolumeReclaimPolicy) - *Default:* PersistentVolumeReclaimPolicy.RETAIN 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 --- ##### `storage`Optional ```typescript public readonly storage: Size; ``` - *Type:* [`cdk8s.Size`](#cdk8s.Size) - *Default:* No specified. What is the storage capacity of this volume. > https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources --- ##### `storageClassName`Optional ```typescript public readonly storageClassName: string; ``` - *Type:* `string` - *Default:* Volume does not belong to any storage class. Name of StorageClass to which this persistent volume belongs. --- ##### `volumeMode`Optional ```typescript public readonly volumeMode: PersistentVolumeMode; ``` - *Type:* [`cdk8s-plus-21.PersistentVolumeMode`](#cdk8s-plus-21.PersistentVolumeMode) - *Default:* VolumeMode.FILE_SYSTEM Defines what type of volume is required by the claim. --- ##### `diskName`Required ```typescript public readonly diskName: string; ``` - *Type:* `string` The Name of the data disk in the blob storage. --- ##### `diskUri`Required ```typescript public readonly diskUri: string; ``` - *Type:* `string` The URI the data disk in the blob storage. --- ##### `cachingMode`Optional ```typescript public readonly cachingMode: AzureDiskPersistentVolumeCachingMode; ``` - *Type:* [`cdk8s-plus-21.AzureDiskPersistentVolumeCachingMode`](#cdk8s-plus-21.AzureDiskPersistentVolumeCachingMode) - *Default:* AzureDiskPersistentVolumeCachingMode.NONE. Host Caching mode. --- ##### `fsType`Optional ```typescript public readonly fsType: string; ``` - *Type:* `string` - *Default:* 'ext4' Filesystem type to mount. Must be a filesystem type supported by the host operating system. --- ##### `kind`Optional ```typescript public readonly kind: AzureDiskPersistentVolumeKind; ``` - *Type:* [`cdk8s-plus-21.AzureDiskPersistentVolumeKind`](#cdk8s-plus-21.AzureDiskPersistentVolumeKind) - *Default:* AzureDiskPersistentVolumeKind.SHARED Kind of disk. --- ##### `readOnly`Optional ```typescript public readonly readOnly: boolean; ``` - *Type:* `boolean` - *Default:* false Force the ReadOnly setting in VolumeMounts. --- ### AzureDiskVolumeOptions Options of `Volume.fromAzureDisk`. #### Initializer ```typescript import { AzureDiskVolumeOptions } from 'cdk8s-plus-21' const azureDiskVolumeOptions: AzureDiskVolumeOptions = { ... } ``` ##### `cachingMode`Optional ```typescript public readonly cachingMode: AzureDiskPersistentVolumeCachingMode; ``` - *Type:* [`cdk8s-plus-21.AzureDiskPersistentVolumeCachingMode`](#cdk8s-plus-21.AzureDiskPersistentVolumeCachingMode) - *Default:* AzureDiskPersistentVolumeCachingMode.NONE. Host Caching mode. --- ##### `fsType`Optional ```typescript public readonly fsType: string; ``` - *Type:* `string` - *Default:* 'ext4' Filesystem type to mount. Must be a filesystem type supported by the host operating system. --- ##### `kind`Optional ```typescript public readonly kind: AzureDiskPersistentVolumeKind; ``` - *Type:* [`cdk8s-plus-21.AzureDiskPersistentVolumeKind`](#cdk8s-plus-21.AzureDiskPersistentVolumeKind) - *Default:* AzureDiskPersistentVolumeKind.SHARED Kind of disk. --- ##### `name`Optional ```typescript public readonly name: string; ``` - *Type:* `string` - *Default:* auto-generated The volume name. --- ##### `readOnly`Optional ```typescript public readonly readOnly: boolean; ``` - *Type:* `boolean` - *Default:* false Force the ReadOnly setting in VolumeMounts. --- ### BasicAuthSecretProps Options for `BasicAuthSecret`. #### Initializer ```typescript import { BasicAuthSecretProps } from 'cdk8s-plus-21' const basicAuthSecretProps: BasicAuthSecretProps = { ... } ``` ##### `metadata`Optional ```typescript public readonly metadata: ApiObjectMetadata; ``` - *Type:* [`cdk8s.ApiObjectMetadata`](#cdk8s.ApiObjectMetadata) Metadata that all persisted resources must have, which includes all objects users must create. --- ##### `immutable`Optional ```typescript 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. --- ##### `password`Required ```typescript public readonly password: string; ``` - *Type:* `string` The password or token for authentication. --- ##### `username`Required ```typescript public readonly username: string; ``` - *Type:* `string` The user name for authentication. --- ### ClusterRoleBindingProps Properties for `ClusterRoleBinding`. #### Initializer ```typescript import { ClusterRoleBindingProps } from 'cdk8s-plus-21' const clusterRoleBindingProps: ClusterRoleBindingProps = { ... } ``` ##### `metadata`Optional ```typescript public readonly metadata: ApiObjectMetadata; ``` - *Type:* [`cdk8s.ApiObjectMetadata`](#cdk8s.ApiObjectMetadata) Metadata that all persisted resources must have, which includes all objects users must create. --- ##### `role`Required ```typescript public readonly role: IClusterRole; ``` - *Type:* [`cdk8s-plus-21.IClusterRole`](#cdk8s-plus-21.IClusterRole) The role to bind to. --- ### ClusterRolePolicyRule Policy rule of a `ClusterRole. #### Initializer ```typescript import { ClusterRolePolicyRule } from 'cdk8s-plus-21' const clusterRolePolicyRule: ClusterRolePolicyRule = { ... } ``` ##### `endpoints`Required ```typescript public readonly endpoints: IApiEndpoint[]; ``` - *Type:* [`cdk8s-plus-21.IApiEndpoint`](#cdk8s-plus-21.IApiEndpoint)[] Endpoints this rule applies to. Can be either api resources or non api resources. --- ##### `verbs`Required ```typescript public readonly verbs: string[]; ``` - *Type:* `string`[] Verbs to allow. (e.g ['get', 'watch']) --- ### ClusterRoleProps Properties for `ClusterRole`. #### Initializer ```typescript import { ClusterRoleProps } from 'cdk8s-plus-21' const clusterRoleProps: ClusterRoleProps = { ... } ``` ##### `metadata`Optional ```typescript public readonly metadata: ApiObjectMetadata; ``` - *Type:* [`cdk8s.ApiObjectMetadata`](#cdk8s.ApiObjectMetadata) Metadata that all persisted resources must have, which includes all objects users must create. --- ##### `aggregationLabels`Optional ```typescript 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. --- ##### `rules`Optional ```typescript public readonly rules: ClusterRolePolicyRule[]; ``` - *Type:* [`cdk8s-plus-21.ClusterRolePolicyRule`](#cdk8s-plus-21.ClusterRolePolicyRule)[] - *Default:* [] A list of rules the role should allow. --- ### CommandProbeOptions Options for `Probe.fromCommand()`. #### Initializer ```typescript import { CommandProbeOptions } from 'cdk8s-plus-21' const commandProbeOptions: CommandProbeOptions = { ... } ``` ##### `failureThreshold`Optional ```typescript 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. --- ##### `initialDelaySeconds`Optional ```typescript public readonly initialDelaySeconds: Duration; ``` - *Type:* [`cdk8s.Duration`](#cdk8s.Duration) - *Default:* immediate Number of seconds after the container has started before liveness probes are initiated. > https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes --- ##### `periodSeconds`Optional ```typescript public readonly periodSeconds: Duration; ``` - *Type:* [`cdk8s.Duration`](#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. --- ##### `successThreshold`Optional ```typescript 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. --- ##### `timeoutSeconds`Optional ```typescript public readonly timeoutSeconds: Duration; ``` - *Type:* [`cdk8s.Duration`](#cdk8s.Duration) - *Default:* Duration.seconds(1) 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 ```typescript import { CommonSecretProps } from 'cdk8s-plus-21' const commonSecretProps: CommonSecretProps = { ... } ``` ##### `metadata`Optional ```typescript public readonly metadata: ApiObjectMetadata; ``` - *Type:* [`cdk8s.ApiObjectMetadata`](#cdk8s.ApiObjectMetadata) Metadata that all persisted resources must have, which includes all objects users must create. --- ##### `immutable`Optional ```typescript 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 ```typescript import { ConfigMapProps } from 'cdk8s-plus-21' const configMapProps: ConfigMapProps = { ... } ``` ##### `metadata`Optional ```typescript public readonly metadata: ApiObjectMetadata; ``` - *Type:* [`cdk8s.ApiObjectMetadata`](#cdk8s.ApiObjectMetadata) Metadata that all persisted resources must have, which includes all objects users must create. --- ##### `binaryData`Optional ```typescript 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()`. --- ##### `data`Optional ```typescript 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()`. --- ##### `immutable`Optional ```typescript 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 ```typescript import { ConfigMapVolumeOptions } from 'cdk8s-plus-21' const configMapVolumeOptions: ConfigMapVolumeOptions = { ... } ``` ##### `defaultMode`Optional ```typescript 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. --- ##### `items`Optional ```typescript public readonly items: {[ key: string ]: PathMapping}; ``` - *Type:* {[ key: string ]: [`cdk8s-plus-21.PathMapping`](#cdk8s-plus-21.PathMapping)} - *Default:* no mapping 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 '..'. --- ##### `name`Optional ```typescript public readonly name: string; ``` - *Type:* `string` - *Default:* auto-generated The volume name. --- ##### `optional`Optional ```typescript public readonly optional: boolean; ``` - *Type:* `boolean` - *Default:* undocumented Specify whether the ConfigMap or its keys must be defined. --- ### ContainerLifecycle Container lifecycle properties. #### Initializer ```typescript import { ContainerLifecycle } from 'cdk8s-plus-21' const containerLifecycle: ContainerLifecycle = { ... } ``` ##### `postStart`Optional ```typescript public readonly postStart: Handler; ``` - *Type:* [`cdk8s-plus-21.Handler`](#cdk8s-plus-21.Handler) - *Default:* No post start 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. --- ##### `preStop`Optional ```typescript public readonly preStop: Handler; ``` - *Type:* [`cdk8s-plus-21.Handler`](#cdk8s-plus-21.Handler) - *Default:* No pre stop 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 --- ### ContainerProps Properties for creating a container. #### Initializer ```typescript import { ContainerProps } from 'cdk8s-plus-21' const containerProps: ContainerProps = { ... } ``` ##### `image`Required ```typescript public readonly image: string; ``` - *Type:* `string` Docker image name. --- ##### `args`Optional ```typescript 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 --- ##### `command`Optional ```typescript 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 --- ##### `envFrom`Optional ```typescript public readonly envFrom: EnvFrom[]; ``` - *Type:* [`cdk8s-plus-21.EnvFrom`](#cdk8s-plus-21.EnvFrom)[] - *Default:* No sources. 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. --- ##### `envVariables`Optional ```typescript public readonly envVariables: {[ key: string ]: EnvValue}; ``` - *Type:* {[ key: string ]: [`cdk8s-plus-21.EnvValue`](#cdk8s-plus-21.EnvValue)} - *Default:* No environment variables. Environment variables to set in the container. --- ##### `imagePullPolicy`Optional ```typescript public readonly imagePullPolicy: ImagePullPolicy; ``` - *Type:* [`cdk8s-plus-21.ImagePullPolicy`](#cdk8s-plus-21.ImagePullPolicy) - *Default:* ImagePullPolicy.ALWAYS Image pull policy for this container. --- ##### `lifecycle`Optional ```typescript public readonly lifecycle: ContainerLifecycle; ``` - *Type:* [`cdk8s-plus-21.ContainerLifecycle`](#cdk8s-plus-21.ContainerLifecycle) Describes actions that the management system should take in response to container lifecycle events. --- ##### `liveness`Optional ```typescript public readonly liveness: Probe; ``` - *Type:* [`cdk8s-plus-21.Probe`](#cdk8s-plus-21.Probe) - *Default:* no liveness probe is defined Periodic probe of container liveness. Container will be restarted if the probe fails. --- ##### `name`Optional ```typescript 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 ```typescript public readonly port: number; ``` - *Type:* `number` - *Default:* No port is exposed. Number of port to expose on the pod's IP address. This must be a valid port number, 0 < x < 65536. --- ##### `readiness`Optional ```typescript public readonly readiness: Probe; ``` - *Type:* [`cdk8s-plus-21.Probe`](#cdk8s-plus-21.Probe) - *Default:* no readiness probe is defined Determines when the container is ready to serve traffic. --- ##### `resources`Optional ```typescript public readonly resources: ContainerResources; ``` - *Type:* [`cdk8s-plus-21.ContainerResources`](#cdk8s-plus-21.ContainerResources) Compute resources (CPU and memory requests and limits) required by the container. > https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ --- ##### `securityContext`Optional ```typescript public readonly securityContext: ContainerSecurityContextProps; ``` - *Type:* [`cdk8s-plus-21.ContainerSecurityContextProps`](#cdk8s-plus-21.ContainerSecurityContextProps) - *Default:* ensureNonRoot: false privileged: false readOnlyRootFilesystem: false 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/ --- ##### `startup`Optional ```typescript public readonly startup: Probe; ``` - *Type:* [`cdk8s-plus-21.Probe`](#cdk8s-plus-21.Probe) - *Default:* no startup probe is defined. StartupProbe indicates that the Pod has successfully initialized. If specified, no other probes are executed until this completes successfully --- ##### `volumeMounts`Optional ```typescript public readonly volumeMounts: VolumeMount[]; ``` - *Type:* [`cdk8s-plus-21.VolumeMount`](#cdk8s-plus-21.VolumeMount)[] Pod volumes to mount into the container's filesystem. Cannot be updated. --- ##### `workingDir`Optional ```typescript 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 ```typescript import { ContainerResources } from 'cdk8s-plus-21' const containerResources: ContainerResources = { ... } ``` ##### `cpu`Required ```typescript public readonly cpu: CpuResources; ``` - *Type:* [`cdk8s-plus-21.CpuResources`](#cdk8s-plus-21.CpuResources) --- ##### `memory`Required ```typescript public readonly memory: MemoryResources; ``` - *Type:* [`cdk8s-plus-21.MemoryResources`](#cdk8s-plus-21.MemoryResources) --- ### ContainerSecurityContextProps Properties for `ContainerSecurityContext`. #### Initializer ```typescript import { ContainerSecurityContextProps } from 'cdk8s-plus-21' const containerSecurityContextProps: ContainerSecurityContextProps = { ... } ``` ##### `ensureNonRoot`Optional ```typescript public readonly ensureNonRoot: boolean; ``` - *Type:* `boolean` - *Default:* false 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. --- ##### `group`Optional ```typescript public readonly group: number; ``` - *Type:* `number` - *Default:* Group configured by container runtime The GID to run the entrypoint of the container process. --- ##### `privileged`Optional ```typescript 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. --- ##### `readOnlyRootFilesystem`Optional ```typescript public readonly readOnlyRootFilesystem: boolean; ``` - *Type:* `boolean` - *Default:* false Whether this container has a read-only root filesystem. --- ##### `user`Optional ```typescript public readonly user: number; ``` - *Type:* `number` - *Default:* User specified in image metadata The UID to run the entrypoint of the container process. --- ### CpuResources CPU request and limit. #### Initializer ```typescript import { CpuResources } from 'cdk8s-plus-21' const cpuResources: CpuResources = { ... } ``` ##### `limit`Required ```typescript public readonly limit: Cpu; ``` - *Type:* [`cdk8s-plus-21.Cpu`](#cdk8s-plus-21.Cpu) --- ##### `request`Required ```typescript public readonly request: Cpu; ``` - *Type:* [`cdk8s-plus-21.Cpu`](#cdk8s-plus-21.Cpu) --- ### DaemonSetProps Properties for `DaemonSet`. #### Initializer ```typescript import { DaemonSetProps } from 'cdk8s-plus-21' const daemonSetProps: DaemonSetProps = { ... } ``` ##### `metadata`Optional ```typescript public readonly metadata: ApiObjectMetadata; ``` - *Type:* [`cdk8s.ApiObjectMetadata`](#cdk8s.ApiObjectMetadata) Metadata that all persisted resources must have, which includes all objects users must create. --- ##### `automountServiceAccountToken`Optional ```typescript public readonly automountServiceAccountToken: boolean; ``` - *Type:* `boolean` - *Default:* true 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 --- ##### `containers`Optional ```typescript public readonly containers: ContainerProps[]; ``` - *Type:* [`cdk8s-plus-21.ContainerProps`](#cdk8s-plus-21.ContainerProps)[] - *Default:* No containers. Note that a pod spec must include at least one container. 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()` --- ##### `dns`Optional ```typescript public readonly dns: PodDnsProps; ``` - *Type:* [`cdk8s-plus-21.PodDnsProps`](#cdk8s-plus-21.PodDnsProps) - *Default:* policy: DnsPolicy.CLUSTER_FIRST hostnameAsFQDN: false DNS settings for the pod. > https://kubernetes.io/docs/concepts/services-networking/dns-pod-service/ --- ##### `dockerRegistryAuth`Optional ```typescript public readonly dockerRegistryAuth: DockerConfigSecret; ``` - *Type:* [`cdk8s-plus-21.DockerConfigSecret`](#cdk8s-plus-21.DockerConfigSecret) - *Default:* No auth. Images are assumed to be publicly available. A secret containing docker credentials for authenticating to a registry. --- ##### `hostAliases`Optional ```typescript public readonly hostAliases: HostAlias[]; ``` - *Type:* [`cdk8s-plus-21.HostAlias`](#cdk8s-plus-21.HostAlias)[] HostAlias holds the mapping between IP and hostnames that will be injected as an entry in the pod's hosts file. --- ##### `initContainers`Optional ```typescript public readonly initContainers: ContainerProps[]; ``` - *Type:* [`cdk8s-plus-21.ContainerProps`](#cdk8s-plus-21.ContainerProps)[] - *Default:* No init containers. 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/ --- ##### `restartPolicy`Optional ```typescript public readonly restartPolicy: RestartPolicy; ``` - *Type:* [`cdk8s-plus-21.RestartPolicy`](#cdk8s-plus-21.RestartPolicy) - *Default:* RestartPolicy.ALWAYS Restart policy for all containers within the pod. > https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#restart-policy --- ##### `securityContext`Optional ```typescript public readonly securityContext: PodSecurityContextProps; ``` - *Type:* [`cdk8s-plus-21.PodSecurityContextProps`](#cdk8s-plus-21.PodSecurityContextProps) - *Default:* fsGroupChangePolicy: FsGroupChangePolicy.FsGroupChangePolicy.ALWAYS ensureNonRoot: false SecurityContext holds pod-level security attributes and common container settings. --- ##### `serviceAccount`Optional ```typescript public readonly serviceAccount: IServiceAccount; ``` - *Type:* [`cdk8s-plus-21.IServiceAccount`](#cdk8s-plus-21.IServiceAccount) - *Default:* No service account. 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/ --- ##### `volumes`Optional ```typescript public readonly volumes: Volume[]; ``` - *Type:* [`cdk8s-plus-21.Volume`](#cdk8s-plus-21.Volume)[] - *Default:* No volumes. 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 --- ##### `podMetadata`Optional ```typescript public readonly podMetadata: ApiObjectMetadata; ``` - *Type:* [`cdk8s.ApiObjectMetadata`](#cdk8s.ApiObjectMetadata) The pod metadata of this workload. --- ##### `select`Optional ```typescript 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. --- ##### `minReadySeconds`Optional ```typescript 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. --- ### DeploymentProps Properties for `Deployment`. #### Initializer ```typescript import { DeploymentProps } from 'cdk8s-plus-21' const deploymentProps: DeploymentProps = { ... } ``` ##### `metadata`Optional ```typescript public readonly metadata: ApiObjectMetadata; ``` - *Type:* [`cdk8s.ApiObjectMetadata`](#cdk8s.ApiObjectMetadata) Metadata that all persisted resources must have, which includes all objects users must create. --- ##### `automountServiceAccountToken`Optional ```typescript public readonly automountServiceAccountToken: boolean; ``` - *Type:* `boolean` - *Default:* true 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 --- ##### `containers`Optional ```typescript public readonly containers: ContainerProps[]; ``` - *Type:* [`cdk8s-plus-21.ContainerProps`](#cdk8s-plus-21.ContainerProps)[] - *Default:* No containers. Note that a pod spec must include at least one container. 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()` --- ##### `dns`Optional ```typescript public readonly dns: PodDnsProps; ``` - *Type:* [`cdk8s-plus-21.PodDnsProps`](#cdk8s-plus-21.PodDnsProps) - *Default:* policy: DnsPolicy.CLUSTER_FIRST hostnameAsFQDN: false DNS settings for the pod. > https://kubernetes.io/docs/concepts/services-networking/dns-pod-service/ --- ##### `dockerRegistryAuth`Optional ```typescript public readonly dockerRegistryAuth: DockerConfigSecret; ``` - *Type:* [`cdk8s-plus-21.DockerConfigSecret`](#cdk8s-plus-21.DockerConfigSecret) - *Default:* No auth. Images are assumed to be publicly available. A secret containing docker credentials for authenticating to a registry. --- ##### `hostAliases`Optional ```typescript public readonly hostAliases: HostAlias[]; ``` - *Type:* [`cdk8s-plus-21.HostAlias`](#cdk8s-plus-21.HostAlias)[] HostAlias holds the mapping between IP and hostnames that will be injected as an entry in the pod's hosts file. --- ##### `initContainers`Optional ```typescript public readonly initContainers: ContainerProps[]; ``` - *Type:* [`cdk8s-plus-21.ContainerProps`](#cdk8s-plus-21.ContainerProps)[] - *Default:* No init containers. 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/ --- ##### `restartPolicy`Optional ```typescript public readonly restartPolicy: RestartPolicy; ``` - *Type:* [`cdk8s-plus-21.RestartPolicy`](#cdk8s-plus-21.RestartPolicy) - *Default:* RestartPolicy.ALWAYS Restart policy for all containers within the pod. > https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#restart-policy --- ##### `securityContext`Optional ```typescript public readonly securityContext: PodSecurityContextProps; ``` - *Type:* [`cdk8s-plus-21.PodSecurityContextProps`](#cdk8s-plus-21.PodSecurityContextProps) - *Default:* fsGroupChangePolicy: FsGroupChangePolicy.FsGroupChangePolicy.ALWAYS ensureNonRoot: false SecurityContext holds pod-level security attributes and common container settings. --- ##### `serviceAccount`Optional ```typescript public readonly serviceAccount: IServiceAccount; ``` - *Type:* [`cdk8s-plus-21.IServiceAccount`](#cdk8s-plus-21.IServiceAccount) - *Default:* No service account. 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/ --- ##### `volumes`Optional ```typescript public readonly volumes: Volume[]; ``` - *Type:* [`cdk8s-plus-21.Volume`](#cdk8s-plus-21.Volume)[] - *Default:* No volumes. 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 --- ##### `podMetadata`Optional ```typescript public readonly podMetadata: ApiObjectMetadata; ``` - *Type:* [`cdk8s.ApiObjectMetadata`](#cdk8s.ApiObjectMetadata) The pod metadata of this workload. --- ##### `select`Optional ```typescript 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. --- ##### `minReady`Optional ```typescript public readonly minReady: Duration; ``` - *Type:* [`cdk8s.Duration`](#cdk8s.Duration) - *Default:* Duration.seconds(0) 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 --- ##### `progressDeadline`Optional ```typescript public readonly progressDeadline: Duration; ``` - *Type:* [`cdk8s.Duration`](#cdk8s.Duration) - *Default:* Duration.seconds(600) 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 --- ##### `replicas`Optional ```typescript public readonly replicas: number; ``` - *Type:* `number` - *Default:* 1 Number of desired pods. --- ##### `strategy`Optional ```typescript public readonly strategy: DeploymentStrategy; ``` - *Type:* [`cdk8s-plus-21.DeploymentStrategy`](#cdk8s-plus-21.DeploymentStrategy) - *Default:* RollingUpdate with maxSurge and maxUnavailable set to 25%. Specifies the strategy used to replace old Pods by new ones. --- ### DeploymentStrategyRollingUpdateOptions Options for `DeploymentStrategy.rollingUpdate`. #### Initializer ```typescript import { DeploymentStrategyRollingUpdateOptions } from 'cdk8s-plus-21' const deploymentStrategyRollingUpdateOptions: DeploymentStrategyRollingUpdateOptions = { ... } ``` ##### `maxSurge`Optional ```typescript public readonly maxSurge: PercentOrAbsolute; ``` - *Type:* [`cdk8s-plus-21.PercentOrAbsolute`](#cdk8s-plus-21.PercentOrAbsolute) - *Default:* '25%' 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. --- ##### `maxUnavailable`Optional ```typescript public readonly maxUnavailable: PercentOrAbsolute; ``` - *Type:* [`cdk8s-plus-21.PercentOrAbsolute`](#cdk8s-plus-21.PercentOrAbsolute) - *Default:* '25%' 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 ```typescript import { DnsOption } from 'cdk8s-plus-21' const dnsOption: DnsOption = { ... } ``` ##### `name`Required ```typescript public readonly name: string; ``` - *Type:* `string` Option name. --- ##### `value`Optional ```typescript public readonly value: string; ``` - *Type:* `string` - *Default:* No value. Option value. --- ### DockerConfigSecretProps Options for `DockerConfigSecret`. #### Initializer ```typescript import { DockerConfigSecretProps } from 'cdk8s-plus-21' const dockerConfigSecretProps: DockerConfigSecretProps = { ... } ``` ##### `metadata`Optional ```typescript public readonly metadata: ApiObjectMetadata; ``` - *Type:* [`cdk8s.ApiObjectMetadata`](#cdk8s.ApiObjectMetadata) Metadata that all persisted resources must have, which includes all objects users must create. --- ##### `immutable`Optional ```typescript 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. --- ##### `data`Required ```typescript 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 ```typescript import { EmptyDirVolumeOptions } from 'cdk8s-plus-21' const emptyDirVolumeOptions: EmptyDirVolumeOptions = { ... } ``` ##### `medium`Optional ```typescript public readonly medium: EmptyDirMedium; ``` - *Type:* [`cdk8s-plus-21.EmptyDirMedium`](#cdk8s-plus-21.EmptyDirMedium) - *Default:* EmptyDirMedium.DEFAULT 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. --- ##### `sizeLimit`Optional ```typescript public readonly sizeLimit: Size; ``` - *Type:* [`cdk8s.Size`](#cdk8s.Size) - *Default:* limit is undefined 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 ```typescript import { EnvValueFromConfigMapOptions } from 'cdk8s-plus-21' const envValueFromConfigMapOptions: EnvValueFromConfigMapOptions = { ... } ``` ##### `optional`Optional ```typescript 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 ```typescript import { EnvValueFromFieldRefOptions } from 'cdk8s-plus-21' const envValueFromFieldRefOptions: EnvValueFromFieldRefOptions = { ... } ``` ##### `apiVersion`Optional ```typescript public readonly apiVersion: string; ``` - *Type:* `string` Version of the schema the FieldPath is written in terms of. --- ##### `key`Optional ```typescript 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 ```typescript import { EnvValueFromProcessOptions } from 'cdk8s-plus-21' const envValueFromProcessOptions: EnvValueFromProcessOptions = { ... } ``` ##### `required`Optional ```typescript 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 ```typescript import { EnvValueFromResourceOptions } from 'cdk8s-plus-21' const envValueFromResourceOptions: EnvValueFromResourceOptions = { ... } ``` ##### `container`Optional ```typescript public readonly container: Container; ``` - *Type:* [`cdk8s-plus-21.Container`](#cdk8s-plus-21.Container) The container to select the value from. --- ##### `divisor`Optional ```typescript 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 ```typescript import { EnvValueFromSecretOptions } from 'cdk8s-plus-21' const envValueFromSecretOptions: EnvValueFromSecretOptions = { ... } ``` ##### `optional`Optional ```typescript public readonly optional: boolean; ``` - *Type:* `boolean` - *Default:* false Specify whether the Secret or its key must be defined. --- ### ExposeDeploymentViaIngressOptions Options for exposing a deployment via an ingress. #### Initializer ```typescript import { ExposeDeploymentViaIngressOptions } from 'cdk8s-plus-21' const exposeDeploymentViaIngressOptions: ExposeDeploymentViaIngressOptions = { ... } ``` ##### `name`Optional ```typescript public readonly name: string; ``` - *Type:* `string` - *Default:* undefined Uses the system generated name. The name of the service to expose. This will be set on the Service.metadata and must be a DNS_LABEL --- ##### `port`Optional ```typescript public readonly port: number; ``` - *Type:* `number` - *Default:* Copied from the container of the deployment. If a port could not be determined, throws an error. The port that the service should serve on. --- ##### `protocol`Optional ```typescript public readonly protocol: Protocol; ``` - *Type:* [`cdk8s-plus-21.Protocol`](#cdk8s-plus-21.Protocol) - *Default:* Protocol.TCP The IP protocol for this port. Supports "TCP", "UDP", and "SCTP". Default is TCP. --- ##### `serviceType`Optional ```typescript public readonly serviceType: ServiceType; ``` - *Type:* [`cdk8s-plus-21.ServiceType`](#cdk8s-plus-21.ServiceType) - *Default:* ClusterIP. The type of the exposed service. --- ##### `targetPort`Optional ```typescript public readonly targetPort: number; ``` - *Type:* `number` - *Default:* The port of the first container in the deployment (ie. containers[0].port) The port number the service will redirect to. --- ##### `ingress`Optional ```typescript public readonly ingress: IngressV1Beta1; ``` - *Type:* [`cdk8s-plus-21.IngressV1Beta1`](#cdk8s-plus-21.IngressV1Beta1) - *Default:* An ingress will be automatically created. The ingress to add rules to. --- ### ExposeDeploymentViaServiceOptions Options for exposing a deployment via a service. #### Initializer ```typescript import { ExposeDeploymentViaServiceOptions } from 'cdk8s-plus-21' const exposeDeploymentViaServiceOptions: ExposeDeploymentViaServiceOptions = { ... } ``` ##### `name`Optional ```typescript public readonly name: string; ``` - *Type:* `string` - *Default:* undefined Uses the system generated name. The name of the service to expose. This will be set on the Service.metadata and must be a DNS_LABEL --- ##### `port`Optional ```typescript public readonly port: number; ``` - *Type:* `number` - *Default:* Copied from the container of the deployment. If a port could not be determined, throws an error. The port that the service should serve on. --- ##### `protocol`Optional ```typescript public readonly protocol: Protocol; ``` - *Type:* [`cdk8s-plus-21.Protocol`](#cdk8s-plus-21.Protocol) - *Default:* Protocol.TCP The IP protocol for this port. Supports "TCP", "UDP", and "SCTP". Default is TCP. --- ##### `serviceType`Optional ```typescript public readonly serviceType: ServiceType; ``` - *Type:* [`cdk8s-plus-21.ServiceType`](#cdk8s-plus-21.ServiceType) - *Default:* ClusterIP. The type of the exposed service. --- ##### `targetPort`Optional ```typescript public readonly targetPort: number; ``` - *Type:* `number` - *Default:* The port of the first container in the deployment (ie. containers[0].port) The port number the service will redirect to. --- ### ExposeServiceViaIngressOptions Options for exposing a service using an ingress. #### Initializer ```typescript import { ExposeServiceViaIngressOptions } from 'cdk8s-plus-21' const exposeServiceViaIngressOptions: ExposeServiceViaIngressOptions = { ... } ``` ##### `ingress`Optional ```typescript public readonly ingress: IngressV1Beta1; ``` - *Type:* [`cdk8s-plus-21.IngressV1Beta1`](#cdk8s-plus-21.IngressV1Beta1) - *Default:* An ingress will be automatically created. The ingress to add rules to. --- ### GCEPersistentDiskPersistentVolumeProps Properties for `GCEPersistentDiskPersistentVolume`. #### Initializer ```typescript import { GCEPersistentDiskPersistentVolumeProps } from 'cdk8s-plus-21' const gCEPersistentDiskPersistentVolumeProps: GCEPersistentDiskPersistentVolumeProps = { ... } ``` ##### `metadata`Optional ```typescript public readonly metadata: ApiObjectMetadata; ``` - *Type:* [`cdk8s.ApiObjectMetadata`](#cdk8s.ApiObjectMetadata) Metadata that all persisted resources must have, which includes all objects users must create. --- ##### `accessModes`Optional ```typescript public readonly accessModes: PersistentVolumeAccessMode[]; ``` - *Type:* [`cdk8s-plus-21.PersistentVolumeAccessMode`](#cdk8s-plus-21.PersistentVolumeAccessMode)[] - *Default:* No access modes. Contains all ways the volume can be mounted. > https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes --- ##### `claim`Optional ```typescript public readonly claim: IPersistentVolumeClaim; ``` - *Type:* [`cdk8s-plus-21.IPersistentVolumeClaim`](#cdk8s-plus-21.IPersistentVolumeClaim) - *Default:* Not bound to a specific claim. 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 --- ##### `mountOptions`Optional ```typescript 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 --- ##### `reclaimPolicy`Optional ```typescript public readonly reclaimPolicy: PersistentVolumeReclaimPolicy; ``` - *Type:* [`cdk8s-plus-21.PersistentVolumeReclaimPolicy`](#cdk8s-plus-21.PersistentVolumeReclaimPolicy) - *Default:* PersistentVolumeReclaimPolicy.RETAIN 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 --- ##### `storage`Optional ```typescript public readonly storage: Size; ``` - *Type:* [`cdk8s.Size`](#cdk8s.Size) - *Default:* No specified. What is the storage capacity of this volume. > https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources --- ##### `storageClassName`Optional ```typescript public readonly storageClassName: string; ``` - *Type:* `string` - *Default:* Volume does not belong to any storage class. Name of StorageClass to which this persistent volume belongs. --- ##### `volumeMode`Optional ```typescript public readonly volumeMode: PersistentVolumeMode; ``` - *Type:* [`cdk8s-plus-21.PersistentVolumeMode`](#cdk8s-plus-21.PersistentVolumeMode) - *Default:* VolumeMode.FILE_SYSTEM Defines what type of volume is required by the claim. --- ##### `pdName`Required ```typescript 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 --- ##### `fsType`Optional ```typescript 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 --- ##### `partition`Optional ```typescript 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). --- ##### `readOnly`Optional ```typescript 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 ```typescript import { GCEPersistentDiskVolumeOptions } from 'cdk8s-plus-21' const gCEPersistentDiskVolumeOptions: GCEPersistentDiskVolumeOptions = { ... } ``` ##### `fsType`Optional ```typescript 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 --- ##### `name`Optional ```typescript public readonly name: string; ``` - *Type:* `string` - *Default:* auto-generated The volume name. --- ##### `partition`Optional ```typescript 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). --- ##### `readOnly`Optional ```typescript 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 --- ### GroupProps Properties for `Group`. #### Initializer ```typescript import { GroupProps } from 'cdk8s-plus-21' const groupProps: GroupProps = { ... } ``` ##### `name`Required ```typescript public readonly name: string; ``` - *Type:* `string` The name of the group. --- ### HandlerFromHttpGetOptions Options for `Handler.fromHttpGet`. #### Initializer ```typescript import { HandlerFromHttpGetOptions } from 'cdk8s-plus-21' const handlerFromHttpGetOptions: HandlerFromHttpGetOptions = { ... } ``` ##### `port`Optional ```typescript 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 ```typescript import { HandlerFromTcpSocketOptions } from 'cdk8s-plus-21' const handlerFromTcpSocketOptions: HandlerFromTcpSocketOptions = { ... } ``` ##### `host`Optional ```typescript public readonly host: string; ``` - *Type:* `string` - *Default:* defaults to the pod IP The host name to connect to on the container. --- ##### `port`Optional ```typescript 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 ```typescript import { HostAlias } from 'cdk8s-plus-21' const hostAlias: HostAlias = { ... } ``` ##### `hostnames`Required ```typescript public readonly hostnames: string[]; ``` - *Type:* `string`[] Hostnames for the chosen IP address. --- ##### `ip`Required ```typescript public readonly ip: string; ``` - *Type:* `string` IP address of the host file entry. --- ### HttpGetProbeOptions Options for `Probe.fromHttpGet()`. #### Initializer ```typescript import { HttpGetProbeOptions } from 'cdk8s-plus-21' const httpGetProbeOptions: HttpGetProbeOptions = { ... } ``` ##### `failureThreshold`Optional ```typescript 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. --- ##### `initialDelaySeconds`Optional ```typescript public readonly initialDelaySeconds: Duration; ``` - *Type:* [`cdk8s.Duration`](#cdk8s.Duration) - *Default:* immediate Number of seconds after the container has started before liveness probes are initiated. > https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes --- ##### `periodSeconds`Optional ```typescript public readonly periodSeconds: Duration; ``` - *Type:* [`cdk8s.Duration`](#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. --- ##### `successThreshold`Optional ```typescript 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. --- ##### `timeoutSeconds`Optional ```typescript public readonly timeoutSeconds: Duration; ``` - *Type:* [`cdk8s.Duration`](#cdk8s.Duration) - *Default:* Duration.seconds(1) 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 --- ##### `port`Optional ```typescript public readonly port: number; ``` - *Type:* `number` - *Default:* defaults to `container.port`. The TCP port to use when sending the GET request. --- ### IngressV1Beta1Props Properties for `Ingress`. #### Initializer ```typescript import { IngressV1Beta1Props } from 'cdk8s-plus-21' const ingressV1Beta1Props: IngressV1Beta1Props = { ... } ``` ##### `metadata`Optional ```typescript public readonly metadata: ApiObjectMetadata; ``` - *Type:* [`cdk8s.ApiObjectMetadata`](#cdk8s.ApiObjectMetadata) Metadata that all persisted resources must have, which includes all objects users must create. --- ##### `defaultBackend`Optional ```typescript public readonly defaultBackend: IngressV1Beta1Backend; ``` - *Type:* [`cdk8s-plus-21.IngressV1Beta1Backend`](#cdk8s-plus-21.IngressV1Beta1Backend) 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. --- ##### `rules`Optional ```typescript public readonly rules: IngressV1Beta1Rule[]; ``` - *Type:* [`cdk8s-plus-21.IngressV1Beta1Rule`](#cdk8s-plus-21.IngressV1Beta1Rule)[] 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()`. --- ##### `tls`Optional ```typescript public readonly tls: IngressV1Beta1Tls[]; ``` - *Type:* [`cdk8s-plus-21.IngressV1Beta1Tls`](#cdk8s-plus-21.IngressV1Beta1Tls)[] 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. --- ### IngressV1Beta1Rule 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 ```typescript import { IngressV1Beta1Rule } from 'cdk8s-plus-21' const ingressV1Beta1Rule: IngressV1Beta1Rule = { ... } ``` ##### `backend`Required ```typescript public readonly backend: IngressV1Beta1Backend; ``` - *Type:* [`cdk8s-plus-21.IngressV1Beta1Backend`](#cdk8s-plus-21.IngressV1Beta1Backend) Backend defines the referenced service endpoint to which the traffic will be forwarded to. --- ##### `host`Optional ```typescript 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. --- ##### `path`Optional ```typescript 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 '/'. --- ### IngressV1Beta1Tls Represents the TLS configuration mapping that is passed to the ingress controller for SSL termination. #### Initializer ```typescript import { IngressV1Beta1Tls } from 'cdk8s-plus-21' const ingressV1Beta1Tls: IngressV1Beta1Tls = { ... } ``` ##### `hosts`Optional ```typescript 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. --- ##### `secret`Optional ```typescript public readonly secret: ISecret; ``` - *Type:* [`cdk8s-plus-21.ISecret`](#cdk8s-plus-21.ISecret) - *Default:* If unspecified, it allows SSL routing based on SNI hostname. 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 ```typescript import { JobProps } from 'cdk8s-plus-21' const jobProps: JobProps = { ... } ``` ##### `metadata`Optional ```typescript public readonly metadata: ApiObjectMetadata; ``` - *Type:* [`cdk8s.ApiObjectMetadata`](#cdk8s.ApiObjectMetadata) Metadata that all persisted resources must have, which includes all objects users must create. --- ##### `automountServiceAccountToken`Optional ```typescript public readonly automountServiceAccountToken: boolean; ``` - *Type:* `boolean` - *Default:* true 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 --- ##### `containers`Optional ```typescript public readonly containers: ContainerProps[]; ``` - *Type:* [`cdk8s-plus-21.ContainerProps`](#cdk8s-plus-21.ContainerProps)[] - *Default:* No containers. Note that a pod spec must include at least one container. 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()` --- ##### `dns`Optional ```typescript public readonly dns: PodDnsProps; ``` - *Type:* [`cdk8s-plus-21.PodDnsProps`](#cdk8s-plus-21.PodDnsProps) - *Default:* policy: DnsPolicy.CLUSTER_FIRST hostnameAsFQDN: false DNS settings for the pod. > https://kubernetes.io/docs/concepts/services-networking/dns-pod-service/ --- ##### `dockerRegistryAuth`Optional ```typescript public readonly dockerRegistryAuth: DockerConfigSecret; ``` - *Type:* [`cdk8s-plus-21.DockerConfigSecret`](#cdk8s-plus-21.DockerConfigSecret) - *Default:* No auth. Images are assumed to be publicly available. A secret containing docker credentials for authenticating to a registry. --- ##### `hostAliases`Optional ```typescript public readonly hostAliases: HostAlias[]; ``` - *Type:* [`cdk8s-plus-21.HostAlias`](#cdk8s-plus-21.HostAlias)[] HostAlias holds the mapping between IP and hostnames that will be injected as an entry in the pod's hosts file. --- ##### `initContainers`Optional ```typescript public readonly initContainers: ContainerProps[]; ``` - *Type:* [`cdk8s-plus-21.ContainerProps`](#cdk8s-plus-21.ContainerProps)[] - *Default:* No init containers. 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/ --- ##### `restartPolicy`Optional ```typescript public readonly restartPolicy: RestartPolicy; ``` - *Type:* [`cdk8s-plus-21.RestartPolicy`](#cdk8s-plus-21.RestartPolicy) - *Default:* RestartPolicy.ALWAYS Restart policy for all containers within the pod. > https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#restart-policy --- ##### `securityContext`Optional ```typescript public readonly securityContext: PodSecurityContextProps; ``` - *Type:* [`cdk8s-plus-21.PodSecurityContextProps`](#cdk8s-plus-21.PodSecurityContextProps) - *Default:* fsGroupChangePolicy: FsGroupChangePolicy.FsGroupChangePolicy.ALWAYS ensureNonRoot: false SecurityContext holds pod-level security attributes and common container settings. --- ##### `serviceAccount`Optional ```typescript public readonly serviceAccount: IServiceAccount; ``` - *Type:* [`cdk8s-plus-21.IServiceAccount`](#cdk8s-plus-21.IServiceAccount) - *Default:* No service account. 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/ --- ##### `volumes`Optional ```typescript public readonly volumes: Volume[]; ``` - *Type:* [`cdk8s-plus-21.Volume`](#cdk8s-plus-21.Volume)[] - *Default:* No volumes. 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 --- ##### `podMetadata`Optional ```typescript public readonly podMetadata: ApiObjectMetadata; ``` - *Type:* [`cdk8s.ApiObjectMetadata`](#cdk8s.ApiObjectMetadata) The pod metadata of this workload. --- ##### `select`Optional ```typescript 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. --- ##### `activeDeadline`Optional ```typescript public readonly activeDeadline: Duration; ``` - *Type:* [`cdk8s.Duration`](#cdk8s.Duration) - *Default:* If unset, then there is no deadline. Specifies the duration the job may be active before the system tries to terminate it. --- ##### `backoffLimit`Optional ```typescript public readonly backoffLimit: number; ``` - *Type:* `number` - *Default:* If not set, system defaults to 6. Specifies the number of retries before marking this job failed. --- ##### `ttlAfterFinished`Optional ```typescript public readonly ttlAfterFinished: Duration; ``` - *Type:* [`cdk8s.Duration`](#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. --- ### LabelSelectorRequirement A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. #### Initializer ```typescript import { LabelSelectorRequirement } from 'cdk8s-plus-21' const labelSelectorRequirement: LabelSelectorRequirement = { ... } ``` ##### `key`Required ```typescript public readonly key: string; ``` - *Type:* `string` The label key that the selector applies to. --- ##### `operator`Required ```typescript public readonly operator: string; ``` - *Type:* `string` Represents a key's relationship to a set of values. --- ##### `values`Optional ```typescript 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 ```typescript import { MemoryResources } from 'cdk8s-plus-21' const memoryResources: MemoryResources = { ... } ``` ##### `limit`Required ```typescript public readonly limit: Size; ``` - *Type:* [`cdk8s.Size`](#cdk8s.Size) --- ##### `request`Required ```typescript public readonly request: Size; ``` - *Type:* [`cdk8s.Size`](#cdk8s.Size) --- ### MountOptions Options for mounts. #### Initializer ```typescript import { MountOptions } from 'cdk8s-plus-21' const mountOptions: MountOptions = { ... } ``` ##### `propagation`Optional ```typescript public readonly propagation: MountPropagation; ``` - *Type:* [`cdk8s-plus-21.MountPropagation`](#cdk8s-plus-21.MountPropagation) - *Default:* MountPropagation.NONE 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. --- ##### `readOnly`Optional ```typescript public readonly readOnly: boolean; ``` - *Type:* `boolean` - *Default:* false Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false. --- ##### `subPath`Optional ```typescript public readonly subPath: string; ``` - *Type:* `string` - *Default:* "" the volume's root Path within the volume from which the container's volume should be mounted.). --- ##### `subPathExpr`Optional ```typescript 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 ```typescript import { NamespaceProps } from 'cdk8s-plus-21' const namespaceProps: NamespaceProps = { ... } ``` ##### `metadata`Optional ```typescript public readonly metadata: ApiObjectMetadata; ``` - *Type:* [`cdk8s.ApiObjectMetadata`](#cdk8s.ApiObjectMetadata) Metadata that all persisted resources must have, which includes all objects users must create. --- ### NamespaceSelectorConfig Configuration for selecting namespaces. #### Initializer ```typescript import { NamespaceSelectorConfig } from 'cdk8s-plus-21' const namespaceSelectorConfig: NamespaceSelectorConfig = { ... } ``` ##### `labelSelector`Optional ```typescript public readonly labelSelector: LabelSelector; ``` - *Type:* [`cdk8s-plus-21.LabelSelector`](#cdk8s-plus-21.LabelSelector) A selector to select namespaces by labels. --- ##### `names`Optional ```typescript public readonly names: string[]; ``` - *Type:* `string`[] A list of names to select namespaces by names. --- ### NamespacesSelectOptions Options for `Namespaces.select`. #### Initializer ```typescript import { NamespacesSelectOptions } from 'cdk8s-plus-21' const namespacesSelectOptions: NamespacesSelectOptions = { ... } ``` ##### `expressions`Optional ```typescript public readonly expressions: LabelExpression[]; ``` - *Type:* [`cdk8s-plus-21.LabelExpression`](#cdk8s-plus-21.LabelExpression)[] - *Default:* no selector requirements. Namespaces must satisfy these selectors. The selectors query labels, just like the `labels` property, but they provide a more advanced matching mechanism. --- ##### `labels`Optional ```typescript 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. --- ##### `names`Optional ```typescript public readonly names: string[]; ``` - *Type:* `string`[] - *Default:* no name requirements. Namespaces names must be one of these. --- ### NodeTaintQueryOptions Options for `NodeTaintQuery`. #### Initializer ```typescript import { NodeTaintQueryOptions } from 'cdk8s-plus-21' const nodeTaintQueryOptions: NodeTaintQueryOptions = { ... } ``` ##### `effect`Optional ```typescript public readonly effect: TaintEffect; ``` - *Type:* [`cdk8s-plus-21.TaintEffect`](#cdk8s-plus-21.TaintEffect) - *Default:* all effects are matched. The taint effect to match. --- ##### `evictAfter`Optional ```typescript public readonly evictAfter: Duration; ``` - *Type:* [`cdk8s.Duration`](#cdk8s.Duration) - *Default:* bound forever. 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 ```typescript import { PathMapping } from 'cdk8s-plus-21' const pathMapping: PathMapping = { ... } ``` ##### `path`Required ```typescript 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 '..'. --- ##### `mode`Optional ```typescript 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 ```typescript import { PersistentVolumeClaimProps } from 'cdk8s-plus-21' const persistentVolumeClaimProps: PersistentVolumeClaimProps = { ... } ``` ##### `metadata`Optional ```typescript public readonly metadata: ApiObjectMetadata; ``` - *Type:* [`cdk8s.ApiObjectMetadata`](#cdk8s.ApiObjectMetadata) Metadata that all persisted resources must have, which includes all objects users must create. --- ##### `accessModes`Optional ```typescript public readonly accessModes: PersistentVolumeAccessMode[]; ``` - *Type:* [`cdk8s-plus-21.PersistentVolumeAccessMode`](#cdk8s-plus-21.PersistentVolumeAccessMode)[] - *Default:* No access modes requirement. Contains the access modes the volume should support. > https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1 --- ##### `storage`Optional ```typescript public readonly storage: Size; ``` - *Type:* [`cdk8s.Size`](#cdk8s.Size) - *Default:* No storage requirement. Minimum storage size the volume should have. > https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources --- ##### `storageClassName`Optional ```typescript 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 --- ##### `volume`Optional ```typescript public readonly volume: IPersistentVolume; ``` - *Type:* [`cdk8s-plus-21.IPersistentVolume`](#cdk8s-plus-21.IPersistentVolume) - *Default:* No specific volume binding. 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. --- ##### `volumeMode`Optional ```typescript public readonly volumeMode: PersistentVolumeMode; ``` - *Type:* [`cdk8s-plus-21.PersistentVolumeMode`](#cdk8s-plus-21.PersistentVolumeMode) - *Default:* VolumeMode.FILE_SYSTEM Defines what type of volume is required by the claim. --- ### PersistentVolumeClaimVolumeOptions Options for a PersistentVolumeClaim-based volume. #### Initializer ```typescript import { PersistentVolumeClaimVolumeOptions } from 'cdk8s-plus-21' const persistentVolumeClaimVolumeOptions: PersistentVolumeClaimVolumeOptions = { ... } ``` ##### `name`Optional ```typescript public readonly name: string; ``` - *Type:* `string` - *Default:* Derived from the PVC name. The volume name. --- ##### `readOnly`Optional ```typescript public readonly readOnly: boolean; ``` - *Type:* `boolean` - *Default:* false Will force the ReadOnly setting in VolumeMounts. --- ### PersistentVolumeProps Properties for `PersistentVolume`. #### Initializer ```typescript import { PersistentVolumeProps } from 'cdk8s-plus-21' const persistentVolumeProps: PersistentVolumeProps = { ... } ``` ##### `metadata`Optional ```typescript public readonly metadata: ApiObjectMetadata; ``` - *Type:* [`cdk8s.ApiObjectMetadata`](#cdk8s.ApiObjectMetadata) Metadata that all persisted resources must have, which includes all objects users must create. --- ##### `accessModes`Optional ```typescript public readonly accessModes: PersistentVolumeAccessMode[]; ``` - *Type:* [`cdk8s-plus-21.PersistentVolumeAccessMode`](#cdk8s-plus-21.PersistentVolumeAccessMode)[] - *Default:* No access modes. Contains all ways the volume can be mounted. > https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes --- ##### `claim`Optional ```typescript public readonly claim: IPersistentVolumeClaim; ``` - *Type:* [`cdk8s-plus-21.IPersistentVolumeClaim`](#cdk8s-plus-21.IPersistentVolumeClaim) - *Default:* Not bound to a specific claim. 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 --- ##### `mountOptions`Optional ```typescript 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 --- ##### `reclaimPolicy`Optional ```typescript public readonly reclaimPolicy: PersistentVolumeReclaimPolicy; ``` - *Type:* [`cdk8s-plus-21.PersistentVolumeReclaimPolicy`](#cdk8s-plus-21.PersistentVolumeReclaimPolicy) - *Default:* PersistentVolumeReclaimPolicy.RETAIN 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 --- ##### `storage`Optional ```typescript public readonly storage: Size; ``` - *Type:* [`cdk8s.Size`](#cdk8s.Size) - *Default:* No specified. What is the storage capacity of this volume. > https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources --- ##### `storageClassName`Optional ```typescript public readonly storageClassName: string; ``` - *Type:* `string` - *Default:* Volume does not belong to any storage class. Name of StorageClass to which this persistent volume belongs. --- ##### `volumeMode`Optional ```typescript public readonly volumeMode: PersistentVolumeMode; ``` - *Type:* [`cdk8s-plus-21.PersistentVolumeMode`](#cdk8s-plus-21.PersistentVolumeMode) - *Default:* VolumeMode.FILE_SYSTEM Defines what type of volume is required by the claim. --- ### PodDnsProps Properties for `PodDns`. #### Initializer ```typescript import { PodDnsProps } from 'cdk8s-plus-21' const podDnsProps: PodDnsProps = { ... } ``` ##### `hostname`Optional ```typescript public readonly hostname: string; ``` - *Type:* `string` - *Default:* Set to a system-defined value. Specifies the hostname of the Pod. --- ##### `hostnameAsFQDN`Optional ```typescript 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. --- ##### `nameservers`Optional ```typescript 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. --- ##### `options`Optional ```typescript public readonly options: DnsOption[]; ``` - *Type:* [`cdk8s-plus-21.DnsOption`](#cdk8s-plus-21.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. --- ##### `policy`Optional ```typescript public readonly policy: DnsPolicy; ``` - *Type:* [`cdk8s-plus-21.DnsPolicy`](#cdk8s-plus-21.DnsPolicy) - *Default:* DnsPolicy.CLUSTER_FIRST Set DNS policy for the pod. If policy is set to `None`, other configuration must be supplied. --- ##### `searches`Optional ```typescript 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. --- ##### `subdomain`Optional ```typescript public readonly subdomain: string; ``` - *Type:* `string` - *Default:* No subdomain. If specified, the fully qualified Pod hostname will be "...svc.". --- ### PodProps Properties for `Pod`. #### Initializer ```typescript import { PodProps } from 'cdk8s-plus-21' const podProps: PodProps = { ... } ``` ##### `metadata`Optional ```typescript public readonly metadata: ApiObjectMetadata; ``` - *Type:* [`cdk8s.ApiObjectMetadata`](#cdk8s.ApiObjectMetadata) Metadata that all persisted resources must have, which includes all objects users must create. --- ##### `automountServiceAccountToken`Optional ```typescript public readonly automountServiceAccountToken: boolean; ``` - *Type:* `boolean` - *Default:* true 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 --- ##### `containers`Optional ```typescript public readonly containers: ContainerProps[]; ``` - *Type:* [`cdk8s-plus-21.ContainerProps`](#cdk8s-plus-21.ContainerProps)[] - *Default:* No containers. Note that a pod spec must include at least one container. 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()` --- ##### `dns`Optional ```typescript public readonly dns: PodDnsProps; ``` - *Type:* [`cdk8s-plus-21.PodDnsProps`](#cdk8s-plus-21.PodDnsProps) - *Default:* policy: DnsPolicy.CLUSTER_FIRST hostnameAsFQDN: false DNS settings for the pod. > https://kubernetes.io/docs/concepts/services-networking/dns-pod-service/ --- ##### `dockerRegistryAuth`Optional ```typescript public readonly dockerRegistryAuth: DockerConfigSecret; ``` - *Type:* [`cdk8s-plus-21.DockerConfigSecret`](#cdk8s-plus-21.DockerConfigSecret) - *Default:* No auth. Images are assumed to be publicly available. A secret containing docker credentials for authenticating to a registry. --- ##### `hostAliases`Optional ```typescript public readonly hostAliases: HostAlias[]; ``` - *Type:* [`cdk8s-plus-21.HostAlias`](#cdk8s-plus-21.HostAlias)[] HostAlias holds the mapping between IP and hostnames that will be injected as an entry in the pod's hosts file. --- ##### `initContainers`Optional ```typescript public readonly initContainers: ContainerProps[]; ``` - *Type:* [`cdk8s-plus-21.ContainerProps`](#cdk8s-plus-21.ContainerProps)[] - *Default:* No init containers. 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/ --- ##### `restartPolicy`Optional ```typescript public readonly restartPolicy: RestartPolicy; ``` - *Type:* [`cdk8s-plus-21.RestartPolicy`](#cdk8s-plus-21.RestartPolicy) - *Default:* RestartPolicy.ALWAYS Restart policy for all containers within the pod. > https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#restart-policy --- ##### `securityContext`Optional ```typescript public readonly securityContext: PodSecurityContextProps; ``` - *Type:* [`cdk8s-plus-21.PodSecurityContextProps`](#cdk8s-plus-21.PodSecurityContextProps) - *Default:* fsGroupChangePolicy: FsGroupChangePolicy.FsGroupChangePolicy.ALWAYS ensureNonRoot: false SecurityContext holds pod-level security attributes and common container settings. --- ##### `serviceAccount`Optional ```typescript public readonly serviceAccount: IServiceAccount; ``` - *Type:* [`cdk8s-plus-21.IServiceAccount`](#cdk8s-plus-21.IServiceAccount) - *Default:* No service account. 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/ --- ##### `volumes`Optional ```typescript public readonly volumes: Volume[]; ``` - *Type:* [`cdk8s-plus-21.Volume`](#cdk8s-plus-21.Volume)[] - *Default:* No volumes. 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 --- ### PodSchedulingAttractOptions Options for `PodScheduling.attract`. #### Initializer ```typescript import { PodSchedulingAttractOptions } from 'cdk8s-plus-21' const podSchedulingAttractOptions: PodSchedulingAttractOptions = { ... } ``` ##### `weight`Optional ```typescript 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 ```typescript import { PodSchedulingColocateOptions } from 'cdk8s-plus-21' const podSchedulingColocateOptions: PodSchedulingColocateOptions = { ... } ``` ##### `topology`Optional ```typescript public readonly topology: Topology; ``` - *Type:* [`cdk8s-plus-21.Topology`](#cdk8s-plus-21.Topology) - *Default:* Topology.HOSTNAME Which topology to coloate on. --- ##### `weight`Optional ```typescript 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 ```typescript import { PodSchedulingSeparateOptions } from 'cdk8s-plus-21' const podSchedulingSeparateOptions: PodSchedulingSeparateOptions = { ... } ``` ##### `topology`Optional ```typescript public readonly topology: Topology; ``` - *Type:* [`cdk8s-plus-21.Topology`](#cdk8s-plus-21.Topology) - *Default:* Topology.HOSTNAME Which topology to separate on. --- ##### `weight`Optional ```typescript 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 ```typescript import { PodSecurityContextProps } from 'cdk8s-plus-21' const podSecurityContextProps: PodSecurityContextProps = { ... } ``` ##### `ensureNonRoot`Optional ```typescript public readonly ensureNonRoot: boolean; ``` - *Type:* `boolean` - *Default:* false 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. --- ##### `fsGroup`Optional ```typescript public readonly fsGroup: number; ``` - *Type:* `number` - *Default:* Volume ownership is not changed. Modify the ownership and permissions of pod volumes to this GID. --- ##### `fsGroupChangePolicy`Optional ```typescript public readonly fsGroupChangePolicy: FsGroupChangePolicy; ``` - *Type:* [`cdk8s-plus-21.FsGroupChangePolicy`](#cdk8s-plus-21.FsGroupChangePolicy) - *Default:* FsGroupChangePolicy.ALWAYS 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. --- ##### `group`Optional ```typescript public readonly group: number; ``` - *Type:* `number` - *Default:* Group configured by container runtime The GID to run the entrypoint of the container process. --- ##### `sysctls`Optional ```typescript public readonly sysctls: Sysctl[]; ``` - *Type:* [`cdk8s-plus-21.Sysctl`](#cdk8s-plus-21.Sysctl)[] - *Default:* No sysctls Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported sysctls (by the container runtime) might fail to launch. --- ##### `user`Optional ```typescript public readonly user: number; ``` - *Type:* `number` - *Default:* User specified in image metadata The UID to run the entrypoint of the container process. --- ### PodSelectOptions Options for `Pods.select`. #### Initializer ```typescript import { PodSelectOptions } from 'cdk8s-plus-21' const podSelectOptions: PodSelectOptions = { ... } ``` ##### `expressions`Optional ```typescript public readonly expressions: LabelExpression[]; ``` - *Type:* [`cdk8s-plus-21.LabelExpression`](#cdk8s-plus-21.LabelExpression)[] - *Default:* no expressions requirements. Expressions the pods must satisify. --- ##### `labels`Optional ```typescript public readonly labels: {[ key: string ]: string}; ``` - *Type:* {[ key: string ]: `string`} - *Default:* no strict labels requirements. Labels the pods must have. --- ##### `namespaces`Optional ```typescript public readonly namespaces: Namespaces; ``` - *Type:* [`cdk8s-plus-21.Namespaces`](#cdk8s-plus-21.Namespaces) - *Default:* unset, implies the namespace of the resource this selection is used in. Namespaces the pods are allowed to be in. Use `Namespaces.all()` to allow all namespaces. --- ### PodSelectorConfig Configuration for selecting pods, optionally in particular namespaces. #### Initializer ```typescript import { PodSelectorConfig } from 'cdk8s-plus-21' const podSelectorConfig: PodSelectorConfig = { ... } ``` ##### `labelSelector`Required ```typescript public readonly labelSelector: LabelSelector; ``` - *Type:* [`cdk8s-plus-21.LabelSelector`](#cdk8s-plus-21.LabelSelector) A selector to select pods by labels. --- ##### `namespaces`Optional ```typescript public readonly namespaces: NamespaceSelectorConfig; ``` - *Type:* [`cdk8s-plus-21.NamespaceSelectorConfig`](#cdk8s-plus-21.NamespaceSelectorConfig) Configuration for selecting which namepsaces are the pods allowed to be in. --- ### ProbeOptions Probe options. #### Initializer ```typescript import { ProbeOptions } from 'cdk8s-plus-21' const probeOptions: ProbeOptions = { ... } ``` ##### `failureThreshold`Optional ```typescript 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. --- ##### `initialDelaySeconds`Optional ```typescript public readonly initialDelaySeconds: Duration; ``` - *Type:* [`cdk8s.Duration`](#cdk8s.Duration) - *Default:* immediate Number of seconds after the container has started before liveness probes are initiated. > https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes --- ##### `periodSeconds`Optional ```typescript public readonly periodSeconds: Duration; ``` - *Type:* [`cdk8s.Duration`](#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. --- ##### `successThreshold`Optional ```typescript 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. --- ##### `timeoutSeconds`Optional ```typescript public readonly timeoutSeconds: Duration; ``` - *Type:* [`cdk8s.Duration`](#cdk8s.Duration) - *Default:* Duration.seconds(1) 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 ```typescript import { ResourceProps } from 'cdk8s-plus-21' const resourceProps: ResourceProps = { ... } ``` ##### `metadata`Optional ```typescript public readonly metadata: ApiObjectMetadata; ``` - *Type:* [`cdk8s.ApiObjectMetadata`](#cdk8s.ApiObjectMetadata) Metadata that all persisted resources must have, which includes all objects users must create. --- ### RoleBindingProps Properties for `RoleBinding`. #### Initializer ```typescript import { RoleBindingProps } from 'cdk8s-plus-21' const roleBindingProps: RoleBindingProps = { ... } ``` ##### `metadata`Optional ```typescript public readonly metadata: ApiObjectMetadata; ``` - *Type:* [`cdk8s.ApiObjectMetadata`](#cdk8s.ApiObjectMetadata) Metadata that all persisted resources must have, which includes all objects users must create. --- ##### `role`Required ```typescript public readonly role: IRole; ``` - *Type:* [`cdk8s-plus-21.IRole`](#cdk8s-plus-21.IRole) The role to bind to. A RoleBinding can reference a Role or a ClusterRole. --- ### RolePolicyRule Policy rule of a `Role. #### Initializer ```typescript import { RolePolicyRule } from 'cdk8s-plus-21' const rolePolicyRule: RolePolicyRule = { ... } ``` ##### `resources`Required ```typescript public readonly resources: IApiResource[]; ``` - *Type:* [`cdk8s-plus-21.IApiResource`](#cdk8s-plus-21.IApiResource)[] Resources this rule applies to. --- ##### `verbs`Required ```typescript public readonly verbs: string[]; ``` - *Type:* `string`[] Verbs to allow. (e.g ['get', 'watch']) --- ### RoleProps Properties for `Role`. #### Initializer ```typescript import { RoleProps } from 'cdk8s-plus-21' const roleProps: RoleProps = { ... } ``` ##### `metadata`Optional ```typescript public readonly metadata: ApiObjectMetadata; ``` - *Type:* [`cdk8s.ApiObjectMetadata`](#cdk8s.ApiObjectMetadata) Metadata that all persisted resources must have, which includes all objects users must create. --- ##### `rules`Optional ```typescript public readonly rules: RolePolicyRule[]; ``` - *Type:* [`cdk8s-plus-21.RolePolicyRule`](#cdk8s-plus-21.RolePolicyRule)[] - *Default:* [] A list of rules the role should allow. --- ### SecretProps Options for `Secret`. #### Initializer ```typescript import { SecretProps } from 'cdk8s-plus-21' const secretProps: SecretProps = { ... } ``` ##### `metadata`Optional ```typescript public readonly metadata: ApiObjectMetadata; ``` - *Type:* [`cdk8s.ApiObjectMetadata`](#cdk8s.ApiObjectMetadata) Metadata that all persisted resources must have, which includes all objects users must create. --- ##### `immutable`Optional ```typescript 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. --- ##### `stringData`Optional ```typescript 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. --- ##### `type`Optional ```typescript 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 ```typescript import { SecretValue } from 'cdk8s-plus-21' const secretValue: SecretValue = { ... } ``` ##### `key`Required ```typescript public readonly key: string; ``` - *Type:* `string` The JSON key. --- ##### `secret`Required ```typescript public readonly secret: ISecret; ``` - *Type:* [`cdk8s-plus-21.ISecret`](#cdk8s-plus-21.ISecret) The secret. --- ### SecretVolumeOptions Options for the Secret-based volume. #### Initializer ```typescript import { SecretVolumeOptions } from 'cdk8s-plus-21' const secretVolumeOptions: SecretVolumeOptions = { ... } ``` ##### `defaultMode`Optional ```typescript 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. --- ##### `items`Optional ```typescript public readonly items: {[ key: string ]: PathMapping}; ``` - *Type:* {[ key: string ]: [`cdk8s-plus-21.PathMapping`](#cdk8s-plus-21.PathMapping)} - *Default:* no mapping 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 '..'. --- ##### `name`Optional ```typescript public readonly name: string; ``` - *Type:* `string` - *Default:* auto-generated The volume name. --- ##### `optional`Optional ```typescript 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 ```typescript import { ServiceAccountProps } from 'cdk8s-plus-21' const serviceAccountProps: ServiceAccountProps = { ... } ``` ##### `metadata`Optional ```typescript public readonly metadata: ApiObjectMetadata; ``` - *Type:* [`cdk8s.ApiObjectMetadata`](#cdk8s.ApiObjectMetadata) Metadata that all persisted resources must have, which includes all objects users must create. --- ##### `automountToken`Optional ```typescript public readonly automountToken: boolean; ``` - *Type:* `boolean` - *Default:* true 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 --- ##### `secrets`Optional ```typescript public readonly secrets: ISecret[]; ``` - *Type:* [`cdk8s-plus-21.ISecret`](#cdk8s-plus-21.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 ```typescript import { ServiceAccountTokenSecretProps } from 'cdk8s-plus-21' const serviceAccountTokenSecretProps: ServiceAccountTokenSecretProps = { ... } ``` ##### `metadata`Optional ```typescript public readonly metadata: ApiObjectMetadata; ``` - *Type:* [`cdk8s.ApiObjectMetadata`](#cdk8s.ApiObjectMetadata) Metadata that all persisted resources must have, which includes all objects users must create. --- ##### `immutable`Optional ```typescript 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. --- ##### `serviceAccount`Required ```typescript public readonly serviceAccount: IServiceAccount; ``` - *Type:* [`cdk8s-plus-21.IServiceAccount`](#cdk8s-plus-21.IServiceAccount) The service account to store a secret for. --- ### ServiceIngressV1BetaBackendOptions Options for setting up backends for ingress rules. #### Initializer ```typescript import { ServiceIngressV1BetaBackendOptions } from 'cdk8s-plus-21' const serviceIngressV1BetaBackendOptions: ServiceIngressV1BetaBackendOptions = { ... } ``` ##### `port`Optional ```typescript 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 ```typescript import { ServicePort } from 'cdk8s-plus-21' const servicePort: ServicePort = { ... } ``` ##### `name`Optional ```typescript 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. --- ##### `nodePort`Optional ```typescript 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 --- ##### `protocol`Optional ```typescript public readonly protocol: Protocol; ``` - *Type:* [`cdk8s-plus-21.Protocol`](#cdk8s-plus-21.Protocol) - *Default:* Protocol.TCP The IP protocol for this port. Supports "TCP", "UDP", and "SCTP". Default is TCP. --- ##### `targetPort`Optional ```typescript public readonly targetPort: number; ``` - *Type:* `number` - *Default:* The value of `port` will be used. The port number the service will redirect to. --- ##### `port`Required ```typescript public readonly port: number; ``` - *Type:* `number` The port number the service will bind to. --- ### ServicePortOptions #### Initializer ```typescript import { ServicePortOptions } from 'cdk8s-plus-21' const servicePortOptions: ServicePortOptions = { ... } ``` ##### `name`Optional ```typescript 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. --- ##### `nodePort`Optional ```typescript 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 --- ##### `protocol`Optional ```typescript public readonly protocol: Protocol; ``` - *Type:* [`cdk8s-plus-21.Protocol`](#cdk8s-plus-21.Protocol) - *Default:* Protocol.TCP The IP protocol for this port. Supports "TCP", "UDP", and "SCTP". Default is TCP. --- ##### `targetPort`Optional ```typescript public readonly targetPort: number; ``` - *Type:* `number` - *Default:* The value of `port` will be used. The port number the service will redirect to. --- ### ServiceProps Properties for initialization of `Service`. #### Initializer ```typescript import { ServiceProps } from 'cdk8s-plus-21' const serviceProps: ServiceProps = { ... } ``` ##### `metadata`Optional ```typescript public readonly metadata: ApiObjectMetadata; ``` - *Type:* [`cdk8s.ApiObjectMetadata`](#cdk8s.ApiObjectMetadata) Metadata that all persisted resources must have, which includes all objects users must create. --- ##### `clusterIP`Optional ```typescript 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 --- ##### `externalIPs`Optional ```typescript 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. --- ##### `externalName`Optional ```typescript public readonly externalName: string; ``` - *Type:* `string` - *Default:* No external name. The externalName to be used when ServiceType.EXTERNAL_NAME is set. --- ##### `loadBalancerSourceRanges`Optional ```typescript 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/ --- ##### `ports`Optional ```typescript public readonly ports: ServicePort[]; ``` - *Type:* [`cdk8s-plus-21.ServicePort`](#cdk8s-plus-21.ServicePort)[] The port exposed by this service. More info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies --- ##### `type`Optional ```typescript public readonly type: ServiceType; ``` - *Type:* [`cdk8s-plus-21.ServiceType`](#cdk8s-plus-21.ServiceType) - *Default:* ServiceType.ClusterIP 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 ```typescript import { SshAuthSecretProps } from 'cdk8s-plus-21' const sshAuthSecretProps: SshAuthSecretProps = { ... } ``` ##### `metadata`Optional ```typescript public readonly metadata: ApiObjectMetadata; ``` - *Type:* [`cdk8s.ApiObjectMetadata`](#cdk8s.ApiObjectMetadata) Metadata that all persisted resources must have, which includes all objects users must create. --- ##### `immutable`Optional ```typescript 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. --- ##### `sshPrivateKey`Required ```typescript public readonly sshPrivateKey: string; ``` - *Type:* `string` The SSH private key to use. --- ### StatefulSetProps Properties for initialization of `StatefulSet`. #### Initializer ```typescript import { StatefulSetProps } from 'cdk8s-plus-21' const statefulSetProps: StatefulSetProps = { ... } ``` ##### `metadata`Optional ```typescript public readonly metadata: ApiObjectMetadata; ``` - *Type:* [`cdk8s.ApiObjectMetadata`](#cdk8s.ApiObjectMetadata) Metadata that all persisted resources must have, which includes all objects users must create. --- ##### `automountServiceAccountToken`Optional ```typescript public readonly automountServiceAccountToken: boolean; ``` - *Type:* `boolean` - *Default:* true 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 --- ##### `containers`Optional ```typescript public readonly containers: ContainerProps[]; ``` - *Type:* [`cdk8s-plus-21.ContainerProps`](#cdk8s-plus-21.ContainerProps)[] - *Default:* No containers. Note that a pod spec must include at least one container. 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()` --- ##### `dns`Optional ```typescript public readonly dns: PodDnsProps; ``` - *Type:* [`cdk8s-plus-21.PodDnsProps`](#cdk8s-plus-21.PodDnsProps) - *Default:* policy: DnsPolicy.CLUSTER_FIRST hostnameAsFQDN: false DNS settings for the pod. > https://kubernetes.io/docs/concepts/services-networking/dns-pod-service/ --- ##### `dockerRegistryAuth`Optional ```typescript public readonly dockerRegistryAuth: DockerConfigSecret; ``` - *Type:* [`cdk8s-plus-21.DockerConfigSecret`](#cdk8s-plus-21.DockerConfigSecret) - *Default:* No auth. Images are assumed to be publicly available. A secret containing docker credentials for authenticating to a registry. --- ##### `hostAliases`Optional ```typescript public readonly hostAliases: HostAlias[]; ``` - *Type:* [`cdk8s-plus-21.HostAlias`](#cdk8s-plus-21.HostAlias)[] HostAlias holds the mapping between IP and hostnames that will be injected as an entry in the pod's hosts file. --- ##### `initContainers`Optional ```typescript public readonly initContainers: ContainerProps[]; ``` - *Type:* [`cdk8s-plus-21.ContainerProps`](#cdk8s-plus-21.ContainerProps)[] - *Default:* No init containers. 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/ --- ##### `restartPolicy`Optional ```typescript public readonly restartPolicy: RestartPolicy; ``` - *Type:* [`cdk8s-plus-21.RestartPolicy`](#cdk8s-plus-21.RestartPolicy) - *Default:* RestartPolicy.ALWAYS Restart policy for all containers within the pod. > https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#restart-policy --- ##### `securityContext`Optional ```typescript public readonly securityContext: PodSecurityContextProps; ``` - *Type:* [`cdk8s-plus-21.PodSecurityContextProps`](#cdk8s-plus-21.PodSecurityContextProps) - *Default:* fsGroupChangePolicy: FsGroupChangePolicy.FsGroupChangePolicy.ALWAYS ensureNonRoot: false SecurityContext holds pod-level security attributes and common container settings. --- ##### `serviceAccount`Optional ```typescript public readonly serviceAccount: IServiceAccount; ``` - *Type:* [`cdk8s-plus-21.IServiceAccount`](#cdk8s-plus-21.IServiceAccount) - *Default:* No service account. 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/ --- ##### `volumes`Optional ```typescript public readonly volumes: Volume[]; ``` - *Type:* [`cdk8s-plus-21.Volume`](#cdk8s-plus-21.Volume)[] - *Default:* No volumes. 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 --- ##### `podMetadata`Optional ```typescript public readonly podMetadata: ApiObjectMetadata; ``` - *Type:* [`cdk8s.ApiObjectMetadata`](#cdk8s.ApiObjectMetadata) The pod metadata of this workload. --- ##### `select`Optional ```typescript 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. --- ##### `service`Required ```typescript public readonly service: Service; ``` - *Type:* [`cdk8s-plus-21.Service`](#cdk8s-plus-21.Service) Service to associate with the statefulset. --- ##### `podManagementPolicy`Optional ```typescript public readonly podManagementPolicy: PodManagementPolicy; ``` - *Type:* [`cdk8s-plus-21.PodManagementPolicy`](#cdk8s-plus-21.PodManagementPolicy) - *Default:* PodManagementPolicy.ORDERED_READY Pod management policy to use for this statefulset. --- ##### `replicas`Optional ```typescript public readonly replicas: number; ``` - *Type:* `number` - *Default:* 1 Number of desired pods. --- ##### `strategy`Optional ```typescript public readonly strategy: StatefulSetUpdateStrategy; ``` - *Type:* [`cdk8s-plus-21.StatefulSetUpdateStrategy`](#cdk8s-plus-21.StatefulSetUpdateStrategy) - *Default:* RollingUpdate with partition set to 0 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 ```typescript import { StatefulSetUpdateStrategyRollingUpdateOptions } from 'cdk8s-plus-21' const statefulSetUpdateStrategyRollingUpdateOptions: StatefulSetUpdateStrategyRollingUpdateOptions = { ... } ``` ##### `partition`Optional ```typescript 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 --- ### Sysctl Sysctl defines a kernel parameter to be set. #### Initializer ```typescript import { Sysctl } from 'cdk8s-plus-21' const sysctl: Sysctl = { ... } ``` ##### `name`Required ```typescript public readonly name: string; ``` - *Type:* `string` Name of a property to set. --- ##### `value`Required ```typescript public readonly value: string; ``` - *Type:* `string` Value of a property to set. --- ### TcpSocketProbeOptions Options for `Probe.fromTcpSocket()`. #### Initializer ```typescript import { TcpSocketProbeOptions } from 'cdk8s-plus-21' const tcpSocketProbeOptions: TcpSocketProbeOptions = { ... } ``` ##### `failureThreshold`Optional ```typescript 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. --- ##### `initialDelaySeconds`Optional ```typescript public readonly initialDelaySeconds: Duration; ``` - *Type:* [`cdk8s.Duration`](#cdk8s.Duration) - *Default:* immediate Number of seconds after the container has started before liveness probes are initiated. > https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes --- ##### `periodSeconds`Optional ```typescript public readonly periodSeconds: Duration; ``` - *Type:* [`cdk8s.Duration`](#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. --- ##### `successThreshold`Optional ```typescript 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. --- ##### `timeoutSeconds`Optional ```typescript public readonly timeoutSeconds: Duration; ``` - *Type:* [`cdk8s.Duration`](#cdk8s.Duration) - *Default:* Duration.seconds(1) 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 --- ##### `host`Optional ```typescript public readonly host: string; ``` - *Type:* `string` - *Default:* defaults to the pod IP The host name to connect to on the container. --- ##### `port`Optional ```typescript 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 ```typescript import { TlsSecretProps } from 'cdk8s-plus-21' const tlsSecretProps: TlsSecretProps = { ... } ``` ##### `metadata`Optional ```typescript public readonly metadata: ApiObjectMetadata; ``` - *Type:* [`cdk8s.ApiObjectMetadata`](#cdk8s.ApiObjectMetadata) Metadata that all persisted resources must have, which includes all objects users must create. --- ##### `immutable`Optional ```typescript 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. --- ##### `tlsCert`Required ```typescript public readonly tlsCert: string; ``` - *Type:* `string` The TLS cert. --- ##### `tlsKey`Required ```typescript public readonly tlsKey: string; ``` - *Type:* `string` The TLS key. --- ### UserProps Properties for `User`. #### Initializer ```typescript import { UserProps } from 'cdk8s-plus-21' const userProps: UserProps = { ... } ``` ##### `name`Required ```typescript public readonly name: string; ``` - *Type:* `string` The name of the user. --- ### VolumeMount Mount a volume from the pod to the container. #### Initializer ```typescript import { VolumeMount } from 'cdk8s-plus-21' const volumeMount: VolumeMount = { ... } ``` ##### `propagation`Optional ```typescript public readonly propagation: MountPropagation; ``` - *Type:* [`cdk8s-plus-21.MountPropagation`](#cdk8s-plus-21.MountPropagation) - *Default:* MountPropagation.NONE 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. --- ##### `readOnly`Optional ```typescript public readonly readOnly: boolean; ``` - *Type:* `boolean` - *Default:* false Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false. --- ##### `subPath`Optional ```typescript public readonly subPath: string; ``` - *Type:* `string` - *Default:* "" the volume's root Path within the volume from which the container's volume should be mounted.). --- ##### `subPathExpr`Optional ```typescript 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. --- ##### `path`Required ```typescript public readonly path: string; ``` - *Type:* `string` Path within the container at which the volume should be mounted. Must not contain ':'. --- ##### `volume`Required ```typescript public readonly volume: Volume; ``` - *Type:* [`cdk8s-plus-21.Volume`](#cdk8s-plus-21.Volume) The volume to mount. --- ### WorkloadProps Properties for `Workload`. #### Initializer ```typescript import { WorkloadProps } from 'cdk8s-plus-21' const workloadProps: WorkloadProps = { ... } ``` ##### `metadata`Optional ```typescript public readonly metadata: ApiObjectMetadata; ``` - *Type:* [`cdk8s.ApiObjectMetadata`](#cdk8s.ApiObjectMetadata) Metadata that all persisted resources must have, which includes all objects users must create. --- ##### `automountServiceAccountToken`Optional ```typescript public readonly automountServiceAccountToken: boolean; ``` - *Type:* `boolean` - *Default:* true 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 --- ##### `containers`Optional ```typescript public readonly containers: ContainerProps[]; ``` - *Type:* [`cdk8s-plus-21.ContainerProps`](#cdk8s-plus-21.ContainerProps)[] - *Default:* No containers. Note that a pod spec must include at least one container. 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()` --- ##### `dns`Optional ```typescript public readonly dns: PodDnsProps; ``` - *Type:* [`cdk8s-plus-21.PodDnsProps`](#cdk8s-plus-21.PodDnsProps) - *Default:* policy: DnsPolicy.CLUSTER_FIRST hostnameAsFQDN: false DNS settings for the pod. > https://kubernetes.io/docs/concepts/services-networking/dns-pod-service/ --- ##### `dockerRegistryAuth`Optional ```typescript public readonly dockerRegistryAuth: DockerConfigSecret; ``` - *Type:* [`cdk8s-plus-21.DockerConfigSecret`](#cdk8s-plus-21.DockerConfigSecret) - *Default:* No auth. Images are assumed to be publicly available. A secret containing docker credentials for authenticating to a registry. --- ##### `hostAliases`Optional ```typescript public readonly hostAliases: HostAlias[]; ``` - *Type:* [`cdk8s-plus-21.HostAlias`](#cdk8s-plus-21.HostAlias)[] HostAlias holds the mapping between IP and hostnames that will be injected as an entry in the pod's hosts file. --- ##### `initContainers`Optional ```typescript public readonly initContainers: ContainerProps[]; ``` - *Type:* [`cdk8s-plus-21.ContainerProps`](#cdk8s-plus-21.ContainerProps)[] - *Default:* No init containers. 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/ --- ##### `restartPolicy`Optional ```typescript public readonly restartPolicy: RestartPolicy; ``` - *Type:* [`cdk8s-plus-21.RestartPolicy`](#cdk8s-plus-21.RestartPolicy) - *Default:* RestartPolicy.ALWAYS Restart policy for all containers within the pod. > https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#restart-policy --- ##### `securityContext`Optional ```typescript public readonly securityContext: PodSecurityContextProps; ``` - *Type:* [`cdk8s-plus-21.PodSecurityContextProps`](#cdk8s-plus-21.PodSecurityContextProps) - *Default:* fsGroupChangePolicy: FsGroupChangePolicy.FsGroupChangePolicy.ALWAYS ensureNonRoot: false SecurityContext holds pod-level security attributes and common container settings. --- ##### `serviceAccount`Optional ```typescript public readonly serviceAccount: IServiceAccount; ``` - *Type:* [`cdk8s-plus-21.IServiceAccount`](#cdk8s-plus-21.IServiceAccount) - *Default:* No service account. 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/ --- ##### `volumes`Optional ```typescript public readonly volumes: Volume[]; ``` - *Type:* [`cdk8s-plus-21.Volume`](#cdk8s-plus-21.Volume)[] - *Default:* No volumes. 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 --- ##### `podMetadata`Optional ```typescript public readonly podMetadata: ApiObjectMetadata; ``` - *Type:* [`cdk8s.ApiObjectMetadata`](#cdk8s.ApiObjectMetadata) The pod metadata of this workload. --- ##### `select`Optional ```typescript 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. --- ### WorkloadSchedulingSpreadOptions Options for `WorkloadScheduling.spread`. #### Initializer ```typescript import { WorkloadSchedulingSpreadOptions } from 'cdk8s-plus-21' const workloadSchedulingSpreadOptions: WorkloadSchedulingSpreadOptions = { ... } ``` ##### `topology`Optional ```typescript public readonly topology: Topology; ``` - *Type:* [`cdk8s-plus-21.Topology`](#cdk8s-plus-21.Topology) - *Default:* Topology.HOSTNAME Which topology to spread on. --- ##### `weight`Optional ```typescript 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 - *Implements:* [`cdk8s-plus-21.IApiResource`](#cdk8s-plus-21.IApiResource), [`cdk8s-plus-21.IApiEndpoint`](#cdk8s-plus-21.IApiEndpoint) Represents information about an API resource type. #### Methods ##### `asApiResource` ```typescript public asApiResource() ``` ##### `asNonApiResource` ```typescript public asNonApiResource() ``` #### Static Functions ##### `custom` ```typescript import { ApiResource } from 'cdk8s-plus-21' ApiResource.custom(options: ApiResourceOptions) ``` ###### `options`Required - *Type:* [`cdk8s-plus-21.ApiResourceOptions`](#cdk8s-plus-21.ApiResourceOptions) --- #### Properties ##### `apiGroup`Required ```typescript public readonly apiGroup: string; ``` - *Type:* `string` The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `resourceType`Required ```typescript 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` - *Type:* [`cdk8s-plus-21.ApiResource`](#cdk8s-plus-21.ApiResource) API resource information for APIService. --- ##### `BINDINGS` - *Type:* [`cdk8s-plus-21.ApiResource`](#cdk8s-plus-21.ApiResource) API resource information for Binding. --- ##### `CERTIFICATE_SIGNING_REQUESTS` - *Type:* [`cdk8s-plus-21.ApiResource`](#cdk8s-plus-21.ApiResource) API resource information for CertificateSigningRequest. --- ##### `CLUSTER_ROLE_BINDINGS` - *Type:* [`cdk8s-plus-21.ApiResource`](#cdk8s-plus-21.ApiResource) API resource information for ClusterRoleBinding. --- ##### `CLUSTER_ROLES` - *Type:* [`cdk8s-plus-21.ApiResource`](#cdk8s-plus-21.ApiResource) API resource information for ClusterRole. --- ##### `COMPONENT_STATUSES` - *Type:* [`cdk8s-plus-21.ApiResource`](#cdk8s-plus-21.ApiResource) API resource information for ComponentStatus. --- ##### `CONFIG_MAPS` - *Type:* [`cdk8s-plus-21.ApiResource`](#cdk8s-plus-21.ApiResource) API resource information for ConfigMap. --- ##### `CONTROLLER_REVISIONS` - *Type:* [`cdk8s-plus-21.ApiResource`](#cdk8s-plus-21.ApiResource) API resource information for ControllerRevision. --- ##### `CRON_JOBS` - *Type:* [`cdk8s-plus-21.ApiResource`](#cdk8s-plus-21.ApiResource) API resource information for CronJob. --- ##### `CSI_DRIVERS` - *Type:* [`cdk8s-plus-21.ApiResource`](#cdk8s-plus-21.ApiResource) API resource information for CSIDriver. --- ##### `CSI_NODES` - *Type:* [`cdk8s-plus-21.ApiResource`](#cdk8s-plus-21.ApiResource) API resource information for CSINode. --- ##### `CSI_STORAGE_CAPACITIES` - *Type:* [`cdk8s-plus-21.ApiResource`](#cdk8s-plus-21.ApiResource) API resource information for CSIStorageCapacity. --- ##### `CUSTOM_RESOURCE_DEFINITIONS` - *Type:* [`cdk8s-plus-21.ApiResource`](#cdk8s-plus-21.ApiResource) API resource information for CustomResourceDefinition. --- ##### `DAEMON_SETS` - *Type:* [`cdk8s-plus-21.ApiResource`](#cdk8s-plus-21.ApiResource) API resource information for DaemonSet. --- ##### `DEPLOYMENTS` - *Type:* [`cdk8s-plus-21.ApiResource`](#cdk8s-plus-21.ApiResource) API resource information for Deployment. --- ##### `ENDPOINT_SLICES` - *Type:* [`cdk8s-plus-21.ApiResource`](#cdk8s-plus-21.ApiResource) API resource information for EndpointSlice. --- ##### `ENDPOINTS` - *Type:* [`cdk8s-plus-21.ApiResource`](#cdk8s-plus-21.ApiResource) API resource information for Endpoints. --- ##### `EVENTS` - *Type:* [`cdk8s-plus-21.ApiResource`](#cdk8s-plus-21.ApiResource) API resource information for Event. --- ##### `FLOW_SCHEMAS` - *Type:* [`cdk8s-plus-21.ApiResource`](#cdk8s-plus-21.ApiResource) API resource information for FlowSchema. --- ##### `HORIZONTAL_POD_AUTOSCALERS` - *Type:* [`cdk8s-plus-21.ApiResource`](#cdk8s-plus-21.ApiResource) API resource information for HorizontalPodAutoscaler. --- ##### `INGRESS_CLASSES` - *Type:* [`cdk8s-plus-21.ApiResource`](#cdk8s-plus-21.ApiResource) API resource information for IngressClass. --- ##### `INGRESSES` - *Type:* [`cdk8s-plus-21.ApiResource`](#cdk8s-plus-21.ApiResource) API resource information for Ingress. --- ##### `JOBS` - *Type:* [`cdk8s-plus-21.ApiResource`](#cdk8s-plus-21.ApiResource) API resource information for Job. --- ##### `LEASES` - *Type:* [`cdk8s-plus-21.ApiResource`](#cdk8s-plus-21.ApiResource) API resource information for Lease. --- ##### `LIMIT_RANGES` - *Type:* [`cdk8s-plus-21.ApiResource`](#cdk8s-plus-21.ApiResource) API resource information for LimitRange. --- ##### `LOCAL_SUBJECT_ACCESS_REVIEWS` - *Type:* [`cdk8s-plus-21.ApiResource`](#cdk8s-plus-21.ApiResource) API resource information for LocalSubjectAccessReview. --- ##### `MUTATING_WEBHOOK_CONFIGURATIONS` - *Type:* [`cdk8s-plus-21.ApiResource`](#cdk8s-plus-21.ApiResource) API resource information for MutatingWebhookConfiguration. --- ##### `NAMESPACES` - *Type:* [`cdk8s-plus-21.ApiResource`](#cdk8s-plus-21.ApiResource) API resource information for Namespace. --- ##### `NETWORK_POLICIES` - *Type:* [`cdk8s-plus-21.ApiResource`](#cdk8s-plus-21.ApiResource) API resource information for NetworkPolicy. --- ##### `NODES` - *Type:* [`cdk8s-plus-21.ApiResource`](#cdk8s-plus-21.ApiResource) API resource information for Node. --- ##### `PERSISTENT_VOLUME_CLAIMS` - *Type:* [`cdk8s-plus-21.ApiResource`](#cdk8s-plus-21.ApiResource) API resource information for PersistentVolumeClaim. --- ##### `PERSISTENT_VOLUMES` - *Type:* [`cdk8s-plus-21.ApiResource`](#cdk8s-plus-21.ApiResource) API resource information for PersistentVolume. --- ##### `POD_DISRUPTION_BUDGETS` - *Type:* [`cdk8s-plus-21.ApiResource`](#cdk8s-plus-21.ApiResource) API resource information for PodDisruptionBudget. --- ##### `POD_SECURITY_POLICIES` - *Type:* [`cdk8s-plus-21.ApiResource`](#cdk8s-plus-21.ApiResource) API resource information for PodSecurityPolicy. --- ##### `POD_TEMPLATES` - *Type:* [`cdk8s-plus-21.ApiResource`](#cdk8s-plus-21.ApiResource) API resource information for PodTemplate. --- ##### `PODS` - *Type:* [`cdk8s-plus-21.ApiResource`](#cdk8s-plus-21.ApiResource) API resource information for Pod. --- ##### `PRIORITY_CLASSES` - *Type:* [`cdk8s-plus-21.ApiResource`](#cdk8s-plus-21.ApiResource) API resource information for PriorityClass. --- ##### `PRIORITY_LEVEL_CONFIGURATIONS` - *Type:* [`cdk8s-plus-21.ApiResource`](#cdk8s-plus-21.ApiResource) API resource information for PriorityLevelConfiguration. --- ##### `REPLICA_SETS` - *Type:* [`cdk8s-plus-21.ApiResource`](#cdk8s-plus-21.ApiResource) API resource information for ReplicaSet. --- ##### `REPLICATION_CONTROLLERS` - *Type:* [`cdk8s-plus-21.ApiResource`](#cdk8s-plus-21.ApiResource) API resource information for ReplicationController. --- ##### `RESOURCE_QUOTAS` - *Type:* [`cdk8s-plus-21.ApiResource`](#cdk8s-plus-21.ApiResource) API resource information for ResourceQuota. --- ##### `ROLE_BINDINGS` - *Type:* [`cdk8s-plus-21.ApiResource`](#cdk8s-plus-21.ApiResource) API resource information for RoleBinding. --- ##### `ROLES` - *Type:* [`cdk8s-plus-21.ApiResource`](#cdk8s-plus-21.ApiResource) API resource information for Role. --- ##### `RUNTIME_CLASSES` - *Type:* [`cdk8s-plus-21.ApiResource`](#cdk8s-plus-21.ApiResource) API resource information for RuntimeClass. --- ##### `SECRETS` - *Type:* [`cdk8s-plus-21.ApiResource`](#cdk8s-plus-21.ApiResource) API resource information for Secret. --- ##### `SELF_SUBJECT_ACCESS_REVIEWS` - *Type:* [`cdk8s-plus-21.ApiResource`](#cdk8s-plus-21.ApiResource) API resource information for SelfSubjectAccessReview. --- ##### `SELF_SUBJECT_RULES_REVIEWS` - *Type:* [`cdk8s-plus-21.ApiResource`](#cdk8s-plus-21.ApiResource) API resource information for SelfSubjectRulesReview. --- ##### `SERVICE_ACCOUNTS` - *Type:* [`cdk8s-plus-21.ApiResource`](#cdk8s-plus-21.ApiResource) API resource information for ServiceAccount. --- ##### `SERVICES` - *Type:* [`cdk8s-plus-21.ApiResource`](#cdk8s-plus-21.ApiResource) API resource information for Service. --- ##### `STATEFUL_SETS` - *Type:* [`cdk8s-plus-21.ApiResource`](#cdk8s-plus-21.ApiResource) API resource information for StatefulSet. --- ##### `STORAGE_CLASSES` - *Type:* [`cdk8s-plus-21.ApiResource`](#cdk8s-plus-21.ApiResource) API resource information for StorageClass. --- ##### `SUBJECT_ACCESS_REVIEWS` - *Type:* [`cdk8s-plus-21.ApiResource`](#cdk8s-plus-21.ApiResource) API resource information for SubjectAccessReview. --- ##### `TOKEN_REVIEWS` - *Type:* [`cdk8s-plus-21.ApiResource`](#cdk8s-plus-21.ApiResource) API resource information for TokenReview. --- ##### `VALIDATING_WEBHOOK_CONFIGURATIONS` - *Type:* [`cdk8s-plus-21.ApiResource`](#cdk8s-plus-21.ApiResource) API resource information for ValidatingWebhookConfiguration. --- ##### `VOLUME_ATTACHMENTS` - *Type:* [`cdk8s-plus-21.ApiResource`](#cdk8s-plus-21.ApiResource) API resource information for VolumeAttachment. --- ### Container A single application container that you want to run within a pod. #### Initializers ```typescript import { Container } from 'cdk8s-plus-21' new Container(props: ContainerProps) ``` ##### `props`Required - *Type:* [`cdk8s-plus-21.ContainerProps`](#cdk8s-plus-21.ContainerProps) --- #### Methods ##### `mount` ```typescript public mount(path: string, storage: IStorage, options?: MountOptions) ``` ###### `path`Required - *Type:* `string` The desired path in the container. --- ###### `storage`Required - *Type:* [`cdk8s-plus-21.IStorage`](#cdk8s-plus-21.IStorage) The storage to mount. --- ###### `options`Optional - *Type:* [`cdk8s-plus-21.MountOptions`](#cdk8s-plus-21.MountOptions) --- #### Properties ##### `env`Required ```typescript public readonly env: Env; ``` - *Type:* [`cdk8s-plus-21.Env`](#cdk8s-plus-21.Env) The environment of the container. --- ##### `image`Required ```typescript public readonly image: string; ``` - *Type:* `string` The container image. --- ##### `imagePullPolicy`Required ```typescript public readonly imagePullPolicy: ImagePullPolicy; ``` - *Type:* [`cdk8s-plus-21.ImagePullPolicy`](#cdk8s-plus-21.ImagePullPolicy) Image pull policy for this container. --- ##### `mounts`Required ```typescript public readonly mounts: VolumeMount[]; ``` - *Type:* [`cdk8s-plus-21.VolumeMount`](#cdk8s-plus-21.VolumeMount)[] Volume mounts configured for this container. --- ##### `name`Required ```typescript public readonly name: string; ``` - *Type:* `string` The name of the container. --- ##### `securityContext`Required ```typescript public readonly securityContext: ContainerSecurityContext; ``` - *Type:* [`cdk8s-plus-21.ContainerSecurityContext`](#cdk8s-plus-21.ContainerSecurityContext) The security context of the container. --- ##### `args`Optional ```typescript public readonly args: string[]; ``` - *Type:* `string`[] Arguments to the entrypoint. --- ##### `command`Optional ```typescript public readonly command: string[]; ``` - *Type:* `string`[] Entrypoint array (the command to execute when the container starts). --- ##### `port`Optional ```typescript public readonly port: number; ``` - *Type:* `number` The port this container exposes. --- ##### `resources`Optional ```typescript public readonly resources: ContainerResources; ``` - *Type:* [`cdk8s-plus-21.ContainerResources`](#cdk8s-plus-21.ContainerResources) Compute resources (CPU and memory requests and limits) required by the container. > https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ --- ##### `workingDir`Optional ```typescript public readonly workingDir: string; ``` - *Type:* `string` The working directory inside the container. --- ### ContainerSecurityContext Container security attributes and settings. #### Initializers ```typescript import { ContainerSecurityContext } from 'cdk8s-plus-21' new ContainerSecurityContext(props?: ContainerSecurityContextProps) ``` ##### `props`Optional - *Type:* [`cdk8s-plus-21.ContainerSecurityContextProps`](#cdk8s-plus-21.ContainerSecurityContextProps) --- #### Properties ##### `ensureNonRoot`Required ```typescript public readonly ensureNonRoot: boolean; ``` - *Type:* `boolean` --- ##### `privileged`Required ```typescript public readonly privileged: boolean; ``` - *Type:* `boolean` --- ##### `readOnlyRootFilesystem`Required ```typescript public readonly readOnlyRootFilesystem: boolean; ``` - *Type:* `boolean` --- ##### `group`Optional ```typescript public readonly group: number; ``` - *Type:* `number` --- ##### `user`Optional ```typescript public readonly user: number; ``` - *Type:* `number` --- ### Cpu Represents the amount of CPU. The amount can be passed as millis or units. #### Static Functions ##### `millis` ```typescript import { Cpu } from 'cdk8s-plus-21' Cpu.millis(amount: number) ``` ###### `amount`Required - *Type:* `number` --- ##### `units` ```typescript import { Cpu } from 'cdk8s-plus-21' Cpu.units(amount: number) ``` ###### `amount`Required - *Type:* `number` --- #### Properties ##### `amount`Required ```typescript public readonly amount: string; ``` - *Type:* `string` --- ### DeploymentStrategy Deployment strategies. #### Static Functions ##### `recreate` ```typescript import { DeploymentStrategy } from 'cdk8s-plus-21' DeploymentStrategy.recreate() ``` ##### `rollingUpdate` ```typescript import { DeploymentStrategy } from 'cdk8s-plus-21' DeploymentStrategy.rollingUpdate(options?: DeploymentStrategyRollingUpdateOptions) ``` ###### `options`Optional - *Type:* [`cdk8s-plus-21.DeploymentStrategyRollingUpdateOptions`](#cdk8s-plus-21.DeploymentStrategyRollingUpdateOptions) --- ### Env Container environment variables. #### Initializers ```typescript import { Env } from 'cdk8s-plus-21' new Env(sources: EnvFrom[], variables: {[ key: string ]: EnvValue}) ``` ##### `sources`Required - *Type:* [`cdk8s-plus-21.EnvFrom`](#cdk8s-plus-21.EnvFrom)[] --- ##### `variables`Required - *Type:* {[ key: string ]: [`cdk8s-plus-21.EnvValue`](#cdk8s-plus-21.EnvValue)} --- #### Methods ##### `addVariable` ```typescript public addVariable(name: string, value: EnvValue) ``` ###### `name`Required - *Type:* `string` --- ###### `value`Required - *Type:* [`cdk8s-plus-21.EnvValue`](#cdk8s-plus-21.EnvValue) --- ##### `copyFrom` ```typescript public copyFrom(from: EnvFrom) ``` ###### `from`Required - *Type:* [`cdk8s-plus-21.EnvFrom`](#cdk8s-plus-21.EnvFrom) --- #### Static Functions ##### `fromConfigMap` ```typescript import { Env } from 'cdk8s-plus-21' Env.fromConfigMap(configMap: IConfigMap, prefix?: string) ``` ###### `configMap`Required - *Type:* [`cdk8s-plus-21.IConfigMap`](#cdk8s-plus-21.IConfigMap) --- ###### `prefix`Optional - *Type:* `string` --- ##### `fromSecret` ```typescript import { Env } from 'cdk8s-plus-21' Env.fromSecret(secr: ISecret) ``` ###### `secr`Required - *Type:* [`cdk8s-plus-21.ISecret`](#cdk8s-plus-21.ISecret) --- #### Properties ##### `sources`Required ```typescript public readonly sources: EnvFrom[]; ``` - *Type:* [`cdk8s-plus-21.EnvFrom`](#cdk8s-plus-21.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()`. --- ##### `variables`Required ```typescript public readonly variables: {[ key: string ]: EnvValue}; ``` - *Type:* {[ key: string ]: [`cdk8s-plus-21.EnvValue`](#cdk8s-plus-21.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 ```typescript import { EnvFrom } from 'cdk8s-plus-21' new EnvFrom(configMap?: IConfigMap, prefix?: string, sec?: ISecret) ``` ##### `configMap`Optional - *Type:* [`cdk8s-plus-21.IConfigMap`](#cdk8s-plus-21.IConfigMap) --- ##### `prefix`Optional - *Type:* `string` --- ##### `sec`Optional - *Type:* [`cdk8s-plus-21.ISecret`](#cdk8s-plus-21.ISecret) --- ### EnvValue Utility class for creating reading env values from various sources. #### Static Functions ##### `fromConfigMap` ```typescript import { EnvValue } from 'cdk8s-plus-21' EnvValue.fromConfigMap(configMap: IConfigMap, key: string, options?: EnvValueFromConfigMapOptions) ``` ###### `configMap`Required - *Type:* [`cdk8s-plus-21.IConfigMap`](#cdk8s-plus-21.IConfigMap) The config map. --- ###### `key`Required - *Type:* `string` The key to extract the value from. --- ###### `options`Optional - *Type:* [`cdk8s-plus-21.EnvValueFromConfigMapOptions`](#cdk8s-plus-21.EnvValueFromConfigMapOptions) Additional options. --- ##### `fromFieldRef` ```typescript import { EnvValue } from 'cdk8s-plus-21' EnvValue.fromFieldRef(fieldPath: EnvFieldPaths, options?: EnvValueFromFieldRefOptions) ``` ###### `fieldPath`Required - *Type:* [`cdk8s-plus-21.EnvFieldPaths`](#cdk8s-plus-21.EnvFieldPaths) : The field reference. --- ###### `options`Optional - *Type:* [`cdk8s-plus-21.EnvValueFromFieldRefOptions`](#cdk8s-plus-21.EnvValueFromFieldRefOptions) : Additional options. --- ##### `fromProcess` ```typescript import { EnvValue } from 'cdk8s-plus-21' EnvValue.fromProcess(key: string, options?: EnvValueFromProcessOptions) ``` ###### `key`Required - *Type:* `string` The key to read. --- ###### `options`Optional - *Type:* [`cdk8s-plus-21.EnvValueFromProcessOptions`](#cdk8s-plus-21.EnvValueFromProcessOptions) Additional options. --- ##### `fromResource` ```typescript import { EnvValue } from 'cdk8s-plus-21' EnvValue.fromResource(resource: ResourceFieldPaths, options?: EnvValueFromResourceOptions) ``` ###### `resource`Required - *Type:* [`cdk8s-plus-21.ResourceFieldPaths`](#cdk8s-plus-21.ResourceFieldPaths) : Resource to select the value from. --- ###### `options`Optional - *Type:* [`cdk8s-plus-21.EnvValueFromResourceOptions`](#cdk8s-plus-21.EnvValueFromResourceOptions) : Additional options. --- ##### `fromSecretValue` ```typescript import { EnvValue } from 'cdk8s-plus-21' EnvValue.fromSecretValue(secretValue: SecretValue, options?: EnvValueFromSecretOptions) ``` ###### `secretValue`Required - *Type:* [`cdk8s-plus-21.SecretValue`](#cdk8s-plus-21.SecretValue) The secret value (secrent + key). --- ###### `options`Optional - *Type:* [`cdk8s-plus-21.EnvValueFromSecretOptions`](#cdk8s-plus-21.EnvValueFromSecretOptions) Additional options. --- ##### `fromValue` ```typescript import { EnvValue } from 'cdk8s-plus-21' EnvValue.fromValue(value: string) ``` ###### `value`Required - *Type:* `string` The value. --- #### Properties ##### `value`Optional ```typescript public readonly value: any; ``` - *Type:* `any` --- ##### `valueFrom`Optional ```typescript public readonly valueFrom: any; ``` - *Type:* `any` --- ### Group - *Implements:* [`cdk8s-plus-21.ISubject`](#cdk8s-plus-21.ISubject) Represents a group. #### Initializers ```typescript import { Group } from 'cdk8s-plus-21' new Group(props: GroupProps) ``` ##### `props`Required - *Type:* [`cdk8s-plus-21.GroupProps`](#cdk8s-plus-21.GroupProps) --- #### Properties ##### `kind`Required ```typescript 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. --- ##### `name`Required ```typescript public readonly name: string; ``` - *Type:* `string` Name of the object being referenced. --- ##### `apiGroup`Optional ```typescript 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. --- ### Handler Defines a specific action that should be taken. #### Static Functions ##### `fromCommand` ```typescript import { Handler } from 'cdk8s-plus-21' Handler.fromCommand(command: string[]) ``` ###### `command`Required - *Type:* `string`[] The command to execute. --- ##### `fromHttpGet` ```typescript import { Handler } from 'cdk8s-plus-21' Handler.fromHttpGet(path: string, options?: HandlerFromHttpGetOptions) ``` ###### `path`Required - *Type:* `string` The URL path to hit. --- ###### `options`Optional - *Type:* [`cdk8s-plus-21.HandlerFromHttpGetOptions`](#cdk8s-plus-21.HandlerFromHttpGetOptions) Options. --- ##### `fromTcpSocket` ```typescript import { Handler } from 'cdk8s-plus-21' Handler.fromTcpSocket(options?: HandlerFromTcpSocketOptions) ``` ###### `options`Optional - *Type:* [`cdk8s-plus-21.HandlerFromTcpSocketOptions`](#cdk8s-plus-21.HandlerFromTcpSocketOptions) Options. --- ### IngressV1Beta1Backend The backend for an ingress path. #### Static Functions ##### `fromResource` ```typescript import { IngressV1Beta1Backend } from 'cdk8s-plus-21' IngressV1Beta1Backend.fromResource(resource: IResource) ``` ###### `resource`Required - *Type:* [`cdk8s-plus-21.IResource`](#cdk8s-plus-21.IResource) --- ##### `fromService` ```typescript import { IngressV1Beta1Backend } from 'cdk8s-plus-21' IngressV1Beta1Backend.fromService(serv: Service, options?: ServiceIngressV1BetaBackendOptions) ``` ###### `serv`Required - *Type:* [`cdk8s-plus-21.Service`](#cdk8s-plus-21.Service) The service object. --- ###### `options`Optional - *Type:* [`cdk8s-plus-21.ServiceIngressV1BetaBackendOptions`](#cdk8s-plus-21.ServiceIngressV1BetaBackendOptions) --- ### LabeledNode A node that is matched by label selectors. #### Initializers ```typescript import { LabeledNode } from 'cdk8s-plus-21' new LabeledNode(labelSelector: NodeLabelQuery[]) ``` ##### `labelSelector`Required - *Type:* [`cdk8s-plus-21.NodeLabelQuery`](#cdk8s-plus-21.NodeLabelQuery)[] --- #### Properties ##### `labelSelector`Required ```typescript public readonly labelSelector: NodeLabelQuery[]; ``` - *Type:* [`cdk8s-plus-21.NodeLabelQuery`](#cdk8s-plus-21.NodeLabelQuery)[] --- ### LabelExpression Represents a query that can be performed against resources with labels. #### Static Functions ##### `doesNotExist` ```typescript import { LabelExpression } from 'cdk8s-plus-21' LabelExpression.doesNotExist(key: string) ``` ###### `key`Required - *Type:* `string` --- ##### `exists` ```typescript import { LabelExpression } from 'cdk8s-plus-21' LabelExpression.exists(key: string) ``` ###### `key`Required - *Type:* `string` --- ##### `in` ```typescript import { LabelExpression } from 'cdk8s-plus-21' LabelExpression.in(key: string, values: string[]) ``` ###### `key`Required - *Type:* `string` --- ###### `values`Required - *Type:* `string`[] --- ##### `notIn` ```typescript import { LabelExpression } from 'cdk8s-plus-21' LabelExpression.notIn(key: string, values: string[]) ``` ###### `key`Required - *Type:* `string` --- ###### `values`Required - *Type:* `string`[] --- #### Properties ##### `key`Required ```typescript public readonly key: string; ``` - *Type:* `string` --- ##### `operator`Required ```typescript public readonly operator: string; ``` - *Type:* `string` --- ##### `values`Optional ```typescript public readonly values: string[]; ``` - *Type:* `string`[] --- ### LabelSelector Match a resource by labels. #### Static Functions ##### `of` ```typescript import { LabelSelector } from 'cdk8s-plus-21' LabelSelector.of(options?: LabelSelectorOptions) ``` ###### `options`Optional - *Type:* [`cdk8s-plus-21.LabelSelectorOptions`](#cdk8s-plus-21.LabelSelectorOptions) --- ### LabelSelectorOptions Options for `LabelSelector.of`. #### Initializers ```typescript import { LabelSelectorOptions } from 'cdk8s-plus-21' new LabelSelectorOptions() ``` #### Properties ##### `expressions`Optional ```typescript public readonly expressions: LabelExpression[]; ``` - *Type:* [`cdk8s-plus-21.LabelExpression`](#cdk8s-plus-21.LabelExpression)[] Expression based label matchers. --- ##### `labels`Optional ```typescript public readonly labels: {[ key: string ]: string}; ``` - *Type:* {[ key: string ]: `string`} Strict label matchers. --- ### NamedNode A node that is matched by its name. #### Initializers ```typescript import { NamedNode } from 'cdk8s-plus-21' new NamedNode(name: string) ``` ##### `name`Required - *Type:* `string` --- #### Properties ##### `name`Required ```typescript public readonly name: string; ``` - *Type:* `string` --- ### Namespaces - *Implements:* [`cdk8s-plus-21.INamespaceSelector`](#cdk8s-plus-21.INamespaceSelector) Represents a group of namespaces. #### Initializers ```typescript import { Namespaces } from 'cdk8s-plus-21' new Namespaces(expressions?: LabelExpression[], names?: string[], labels?: {[ key: string ]: string}) ``` ##### `expressions`Optional - *Type:* [`cdk8s-plus-21.LabelExpression`](#cdk8s-plus-21.LabelExpression)[] --- ##### `names`Optional - *Type:* `string`[] --- ##### `labels`Optional - *Type:* {[ key: string ]: `string`} --- #### Methods ##### `toNamespaceSelectorConfig` ```typescript public toNamespaceSelectorConfig() ``` #### Static Functions ##### `all` ```typescript import { Namespaces } from 'cdk8s-plus-21' Namespaces.all() ``` ##### `select` ```typescript import { Namespaces } from 'cdk8s-plus-21' Namespaces.select(options: NamespacesSelectOptions) ``` ###### `options`Required - *Type:* [`cdk8s-plus-21.NamespacesSelectOptions`](#cdk8s-plus-21.NamespacesSelectOptions) --- ### Node Represents a node in the cluster. #### Initializers ```typescript import { Node } from 'cdk8s-plus-21' new Node() ``` #### Static Functions ##### `labeled` ```typescript import { Node } from 'cdk8s-plus-21' Node.labeled(labelSelector: NodeLabelQuery) ``` ###### `labelSelector`Required - *Type:* [`cdk8s-plus-21.NodeLabelQuery`](#cdk8s-plus-21.NodeLabelQuery) --- ##### `named` ```typescript import { Node } from 'cdk8s-plus-21' Node.named(nodeName: string) ``` ###### `nodeName`Required - *Type:* `string` --- ##### `tainted` ```typescript import { Node } from 'cdk8s-plus-21' Node.tainted(taintSelector: NodeTaintQuery) ``` ###### `taintSelector`Required - *Type:* [`cdk8s-plus-21.NodeTaintQuery`](#cdk8s-plus-21.NodeTaintQuery) --- ### NodeLabelQuery Represents a query that can be performed against nodes with labels. #### Static Functions ##### `doesNotExist` ```typescript import { NodeLabelQuery } from 'cdk8s-plus-21' NodeLabelQuery.doesNotExist(key: string) ``` ###### `key`Required - *Type:* `string` --- ##### `exists` ```typescript import { NodeLabelQuery } from 'cdk8s-plus-21' NodeLabelQuery.exists(key: string) ``` ###### `key`Required - *Type:* `string` --- ##### `gt` ```typescript import { NodeLabelQuery } from 'cdk8s-plus-21' NodeLabelQuery.gt(key: string, values: string[]) ``` ###### `key`Required - *Type:* `string` --- ###### `values`Required - *Type:* `string`[] --- ##### `in` ```typescript import { NodeLabelQuery } from 'cdk8s-plus-21' NodeLabelQuery.in(key: string, values: string[]) ``` ###### `key`Required - *Type:* `string` --- ###### `values`Required - *Type:* `string`[] --- ##### `is` ```typescript import { NodeLabelQuery } from 'cdk8s-plus-21' NodeLabelQuery.is(key: string, value: string) ``` ###### `key`Required - *Type:* `string` --- ###### `value`Required - *Type:* `string` --- ##### `lt` ```typescript import { NodeLabelQuery } from 'cdk8s-plus-21' NodeLabelQuery.lt(key: string, values: string[]) ``` ###### `key`Required - *Type:* `string` --- ###### `values`Required - *Type:* `string`[] --- ##### `notIn` ```typescript import { NodeLabelQuery } from 'cdk8s-plus-21' NodeLabelQuery.notIn(key: string, values: string[]) ``` ###### `key`Required - *Type:* `string` --- ###### `values`Required - *Type:* `string`[] --- #### Properties ##### `key`Required ```typescript public readonly key: string; ``` - *Type:* `string` --- ##### `operator`Required ```typescript public readonly operator: string; ``` - *Type:* `string` --- ##### `values`Optional ```typescript public readonly values: string[]; ``` - *Type:* `string`[] --- ### NodeTaintQuery Taint queries that can be perfomed against nodes. #### Static Functions ##### `any` ```typescript import { NodeTaintQuery } from 'cdk8s-plus-21' NodeTaintQuery.any() ``` ##### `exists` ```typescript import { NodeTaintQuery } from 'cdk8s-plus-21' NodeTaintQuery.exists(key: string, options?: NodeTaintQueryOptions) ``` ###### `key`Required - *Type:* `string` --- ###### `options`Optional - *Type:* [`cdk8s-plus-21.NodeTaintQueryOptions`](#cdk8s-plus-21.NodeTaintQueryOptions) --- ##### `is` ```typescript import { NodeTaintQuery } from 'cdk8s-plus-21' NodeTaintQuery.is(key: string, value: string, options?: NodeTaintQueryOptions) ``` ###### `key`Required - *Type:* `string` --- ###### `value`Required - *Type:* `string` --- ###### `options`Optional - *Type:* [`cdk8s-plus-21.NodeTaintQueryOptions`](#cdk8s-plus-21.NodeTaintQueryOptions) --- #### Properties ##### `operator`Required ```typescript public readonly operator: string; ``` - *Type:* `string` --- ##### `effect`Optional ```typescript public readonly effect: string; ``` - *Type:* `string` --- ##### `evictAfter`Optional ```typescript public readonly evictAfter: Duration; ``` - *Type:* [`cdk8s.Duration`](#cdk8s.Duration) --- ##### `key`Optional ```typescript public readonly key: string; ``` - *Type:* `string` --- ##### `value`Optional ```typescript public readonly value: string; ``` - *Type:* `string` --- ### NonApiResource - *Implements:* [`cdk8s-plus-21.IApiEndpoint`](#cdk8s-plus-21.IApiEndpoint) Factory for creating non api resources. #### Methods ##### `asApiResource` ```typescript public asApiResource() ``` ##### `asNonApiResource` ```typescript public asNonApiResource() ``` #### Static Functions ##### `of` ```typescript import { NonApiResource } from 'cdk8s-plus-21' NonApiResource.of(url: string) ``` ###### `url`Required - *Type:* `string` --- ### PercentOrAbsolute Union like class repsenting either a ration in percents or an absolute number. #### Methods ##### `isZero` ```typescript public isZero() ``` #### Static Functions ##### `absolute` ```typescript import { PercentOrAbsolute } from 'cdk8s-plus-21' PercentOrAbsolute.absolute(num: number) ``` ###### `num`Required - *Type:* `number` --- ##### `percent` ```typescript import { PercentOrAbsolute } from 'cdk8s-plus-21' PercentOrAbsolute.percent(percent: number) ``` ###### `percent`Required - *Type:* `number` --- #### Properties ##### `value`Required ```typescript public readonly value: any; ``` - *Type:* `any` --- ### PodDns Holds dns settings of the pod. #### Initializers ```typescript import { PodDns } from 'cdk8s-plus-21' new PodDns(props?: PodDnsProps) ``` ##### `props`Optional - *Type:* [`cdk8s-plus-21.PodDnsProps`](#cdk8s-plus-21.PodDnsProps) --- #### Methods ##### `addNameserver` ```typescript public addNameserver(nameservers: string) ``` ###### `nameservers`Required - *Type:* `string` --- ##### `addOption` ```typescript public addOption(options: DnsOption) ``` ###### `options`Required - *Type:* [`cdk8s-plus-21.DnsOption`](#cdk8s-plus-21.DnsOption) --- ##### `addSearch` ```typescript public addSearch(searches: string) ``` ###### `searches`Required - *Type:* `string` --- #### Properties ##### `hostnameAsFQDN`Required ```typescript public readonly hostnameAsFQDN: boolean; ``` - *Type:* `boolean` Whether or not the pods hostname is set to its FQDN. --- ##### `nameservers`Required ```typescript public readonly nameservers: string[]; ``` - *Type:* `string`[] Nameservers defined for this pod. --- ##### `options`Required ```typescript public readonly options: DnsOption[]; ``` - *Type:* [`cdk8s-plus-21.DnsOption`](#cdk8s-plus-21.DnsOption)[] Custom dns options defined for this pod. --- ##### `policy`Required ```typescript public readonly policy: DnsPolicy; ``` - *Type:* [`cdk8s-plus-21.DnsPolicy`](#cdk8s-plus-21.DnsPolicy) The DNS policy of this pod. --- ##### `searches`Required ```typescript public readonly searches: string[]; ``` - *Type:* `string`[] Search domains defined for this pod. --- ##### `hostname`Optional ```typescript public readonly hostname: string; ``` - *Type:* `string` The configured hostname of the pod. Undefined means its set to a system-defined value. --- ##### `subdomain`Optional ```typescript public readonly subdomain: string; ``` - *Type:* `string` The configured subdomain of the pod. --- ### Pods - *Implements:* [`cdk8s-plus-21.IPodSelector`](#cdk8s-plus-21.IPodSelector) Represents a group of pods. #### Initializers ```typescript import { Pods } from 'cdk8s-plus-21' new Pods(expressions?: LabelExpression[], labels?: {[ key: string ]: string}, namespaces?: INamespaceSelector) ``` ##### `expressions`Optional - *Type:* [`cdk8s-plus-21.LabelExpression`](#cdk8s-plus-21.LabelExpression)[] --- ##### `labels`Optional - *Type:* {[ key: string ]: `string`} --- ##### `namespaces`Optional - *Type:* [`cdk8s-plus-21.INamespaceSelector`](#cdk8s-plus-21.INamespaceSelector) --- #### Methods ##### `toPodSelectorConfig` ```typescript public toPodSelectorConfig() ``` #### Static Functions ##### `select` ```typescript import { Pods } from 'cdk8s-plus-21' Pods.select(options: PodSelectOptions) ``` ###### `options`Required - *Type:* [`cdk8s-plus-21.PodSelectOptions`](#cdk8s-plus-21.PodSelectOptions) --- ### PodScheduling Controls the pod scheduling strategy. #### Initializers ```typescript import { PodScheduling } from 'cdk8s-plus-21' new PodScheduling(instance: AbstractPod) ``` ##### `instance`Required - *Type:* [`cdk8s-plus-21.AbstractPod`](#cdk8s-plus-21.AbstractPod) --- #### Methods ##### `assign` ```typescript public assign(node: NamedNode) ``` ###### `node`Required - *Type:* [`cdk8s-plus-21.NamedNode`](#cdk8s-plus-21.NamedNode) --- ##### `attract` ```typescript public attract(node: LabeledNode, options?: PodSchedulingAttractOptions) ``` ###### `node`Required - *Type:* [`cdk8s-plus-21.LabeledNode`](#cdk8s-plus-21.LabeledNode) --- ###### `options`Optional - *Type:* [`cdk8s-plus-21.PodSchedulingAttractOptions`](#cdk8s-plus-21.PodSchedulingAttractOptions) --- ##### `colocate` ```typescript public colocate(selector: IPodSelector, options?: PodSchedulingColocateOptions) ``` ###### `selector`Required - *Type:* [`cdk8s-plus-21.IPodSelector`](#cdk8s-plus-21.IPodSelector) --- ###### `options`Optional - *Type:* [`cdk8s-plus-21.PodSchedulingColocateOptions`](#cdk8s-plus-21.PodSchedulingColocateOptions) --- ##### `separate` ```typescript public separate(selector: IPodSelector, options?: PodSchedulingSeparateOptions) ``` ###### `selector`Required - *Type:* [`cdk8s-plus-21.IPodSelector`](#cdk8s-plus-21.IPodSelector) --- ###### `options`Optional - *Type:* [`cdk8s-plus-21.PodSchedulingSeparateOptions`](#cdk8s-plus-21.PodSchedulingSeparateOptions) --- ##### `tolerate` ```typescript public tolerate(node: TaintedNode) ``` ###### `node`Required - *Type:* [`cdk8s-plus-21.TaintedNode`](#cdk8s-plus-21.TaintedNode) --- ### PodSecurityContext Holds pod-level security attributes and common container settings. #### Initializers ```typescript import { PodSecurityContext } from 'cdk8s-plus-21' new PodSecurityContext(props?: PodSecurityContextProps) ``` ##### `props`Optional - *Type:* [`cdk8s-plus-21.PodSecurityContextProps`](#cdk8s-plus-21.PodSecurityContextProps) --- #### Properties ##### `ensureNonRoot`Required ```typescript public readonly ensureNonRoot: boolean; ``` - *Type:* `boolean` --- ##### `fsGroupChangePolicy`Required ```typescript public readonly fsGroupChangePolicy: FsGroupChangePolicy; ``` - *Type:* [`cdk8s-plus-21.FsGroupChangePolicy`](#cdk8s-plus-21.FsGroupChangePolicy) --- ##### `sysctls`Required ```typescript public readonly sysctls: Sysctl[]; ``` - *Type:* [`cdk8s-plus-21.Sysctl`](#cdk8s-plus-21.Sysctl)[] --- ##### `fsGroup`Optional ```typescript public readonly fsGroup: number; ``` - *Type:* `number` --- ##### `group`Optional ```typescript public readonly group: number; ``` - *Type:* `number` --- ##### `user`Optional ```typescript public readonly user: number; ``` - *Type:* `number` --- ### Probe Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. #### Static Functions ##### `fromCommand` ```typescript import { Probe } from 'cdk8s-plus-21' Probe.fromCommand(command: string[], options?: CommandProbeOptions) ``` ###### `command`Required - *Type:* `string`[] The command to execute. --- ###### `options`Optional - *Type:* [`cdk8s-plus-21.CommandProbeOptions`](#cdk8s-plus-21.CommandProbeOptions) Options. --- ##### `fromHttpGet` ```typescript import { Probe } from 'cdk8s-plus-21' Probe.fromHttpGet(path: string, options?: HttpGetProbeOptions) ``` ###### `path`Required - *Type:* `string` The URL path to hit. --- ###### `options`Optional - *Type:* [`cdk8s-plus-21.HttpGetProbeOptions`](#cdk8s-plus-21.HttpGetProbeOptions) Options. --- ##### `fromTcpSocket` ```typescript import { Probe } from 'cdk8s-plus-21' Probe.fromTcpSocket(options?: TcpSocketProbeOptions) ``` ###### `options`Optional - *Type:* [`cdk8s-plus-21.TcpSocketProbeOptions`](#cdk8s-plus-21.TcpSocketProbeOptions) Options. --- ### StatefulSetUpdateStrategy StatefulSet update strategies. #### Static Functions ##### `onDelete` ```typescript import { StatefulSetUpdateStrategy } from 'cdk8s-plus-21' StatefulSetUpdateStrategy.onDelete() ``` ##### `rollingUpdate` ```typescript import { StatefulSetUpdateStrategy } from 'cdk8s-plus-21' StatefulSetUpdateStrategy.rollingUpdate(options?: StatefulSetUpdateStrategyRollingUpdateOptions) ``` ###### `options`Optional - *Type:* [`cdk8s-plus-21.StatefulSetUpdateStrategyRollingUpdateOptions`](#cdk8s-plus-21.StatefulSetUpdateStrategyRollingUpdateOptions) --- ### TaintedNode A node that is matched by taint selectors. #### Initializers ```typescript import { TaintedNode } from 'cdk8s-plus-21' new TaintedNode(taintSelector: NodeTaintQuery[]) ``` ##### `taintSelector`Required - *Type:* [`cdk8s-plus-21.NodeTaintQuery`](#cdk8s-plus-21.NodeTaintQuery)[] --- #### Properties ##### `taintSelector`Required ```typescript public readonly taintSelector: NodeTaintQuery[]; ``` - *Type:* [`cdk8s-plus-21.NodeTaintQuery`](#cdk8s-plus-21.NodeTaintQuery)[] --- ### Topology Available topology domains. #### Static Functions ##### `custom` ```typescript import { Topology } from 'cdk8s-plus-21' Topology.custom(key: string) ``` ###### `key`Required - *Type:* `string` --- #### Properties ##### `key`Required ```typescript public readonly key: string; ``` - *Type:* `string` --- #### Constants ##### `HOSTNAME` - *Type:* [`cdk8s-plus-21.Topology`](#cdk8s-plus-21.Topology) A hostname represents a single node in the cluster. > https://kubernetes.io/docs/reference/labels-annotations-taints/#kubernetesiohostname --- ##### `REGION` - *Type:* [`cdk8s-plus-21.Topology`](#cdk8s-plus-21.Topology) A region represents a larger domain, made up of one or more zones. It is uncommon for Kubernetes clusters to span multiple regions. While the exact definition of a zone or region is left to infrastructure implementations, common properties of a region include higher network latency between them than within them, non-zero cost for network traffic between them, and failure independence from other zones or regions. For example, nodes within a region might share power infrastructure (e.g. a UPS or generator), but nodes in different regions typically would not. > https://kubernetes.io/docs/reference/labels-annotations-taints/#topologykubernetesioregion --- ##### `ZONE` - *Type:* [`cdk8s-plus-21.Topology`](#cdk8s-plus-21.Topology) A zone represents a logical failure domain. It is common for Kubernetes clusters to span multiple zones for increased availability. While the exact definition of a zone is left to infrastructure implementations, common properties of a zone include very low network latency within a zone, no-cost network traffic within a zone, and failure independence from other zones. For example, nodes within a zone might share a network switch, but nodes in different zones should not. > https://kubernetes.io/docs/reference/labels-annotations-taints/#topologykubernetesiozone --- ### User - *Implements:* [`cdk8s-plus-21.ISubject`](#cdk8s-plus-21.ISubject) Represents a user. #### Initializers ```typescript import { User } from 'cdk8s-plus-21' new User(props: UserProps) ``` ##### `props`Required - *Type:* [`cdk8s-plus-21.UserProps`](#cdk8s-plus-21.UserProps) --- #### Properties ##### `kind`Required ```typescript 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. --- ##### `name`Required ```typescript public readonly name: string; ``` - *Type:* `string` Name of the object being referenced. --- ##### `apiGroup`Optional ```typescript 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. --- ### Volume - *Implements:* [`cdk8s-plus-21.IStorage`](#cdk8s-plus-21.IStorage) 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` ```typescript public asVolume() ``` #### Static Functions ##### `fromAwsElasticBlockStore` ```typescript import { Volume } from 'cdk8s-plus-21' Volume.fromAwsElasticBlockStore(volumeId: string, options?: AwsElasticBlockStoreVolumeOptions) ``` ###### `volumeId`Required - *Type:* `string` --- ###### `options`Optional - *Type:* [`cdk8s-plus-21.AwsElasticBlockStoreVolumeOptions`](#cdk8s-plus-21.AwsElasticBlockStoreVolumeOptions) --- ##### `fromAzureDisk` ```typescript import { Volume } from 'cdk8s-plus-21' Volume.fromAzureDisk(diskName: string, diskUri: string, options?: AzureDiskVolumeOptions) ``` ###### `diskName`Required - *Type:* `string` --- ###### `diskUri`Required - *Type:* `string` --- ###### `options`Optional - *Type:* [`cdk8s-plus-21.AzureDiskVolumeOptions`](#cdk8s-plus-21.AzureDiskVolumeOptions) --- ##### `fromConfigMap` ```typescript import { Volume } from 'cdk8s-plus-21' Volume.fromConfigMap(configMap: IConfigMap, options?: ConfigMapVolumeOptions) ``` ###### `configMap`Required - *Type:* [`cdk8s-plus-21.IConfigMap`](#cdk8s-plus-21.IConfigMap) The config map to use to populate the volume. --- ###### `options`Optional - *Type:* [`cdk8s-plus-21.ConfigMapVolumeOptions`](#cdk8s-plus-21.ConfigMapVolumeOptions) Options. --- ##### `fromEmptyDir` ```typescript import { Volume } from 'cdk8s-plus-21' Volume.fromEmptyDir(name: string, options?: EmptyDirVolumeOptions) ``` ###### `name`Required - *Type:* `string` --- ###### `options`Optional - *Type:* [`cdk8s-plus-21.EmptyDirVolumeOptions`](#cdk8s-plus-21.EmptyDirVolumeOptions) Additional options. --- ##### `fromGcePersistentDisk` ```typescript import { Volume } from 'cdk8s-plus-21' Volume.fromGcePersistentDisk(pdName: string, options?: GCEPersistentDiskVolumeOptions) ``` ###### `pdName`Required - *Type:* `string` --- ###### `options`Optional - *Type:* [`cdk8s-plus-21.GCEPersistentDiskVolumeOptions`](#cdk8s-plus-21.GCEPersistentDiskVolumeOptions) --- ##### `fromPersistentVolumeClaim` ```typescript import { Volume } from 'cdk8s-plus-21' Volume.fromPersistentVolumeClaim(claim: IPersistentVolumeClaim, options?: PersistentVolumeClaimVolumeOptions) ``` ###### `claim`Required - *Type:* [`cdk8s-plus-21.IPersistentVolumeClaim`](#cdk8s-plus-21.IPersistentVolumeClaim) --- ###### `options`Optional - *Type:* [`cdk8s-plus-21.PersistentVolumeClaimVolumeOptions`](#cdk8s-plus-21.PersistentVolumeClaimVolumeOptions) --- ##### `fromSecret` ```typescript import { Volume } from 'cdk8s-plus-21' Volume.fromSecret(secr: ISecret, options?: SecretVolumeOptions) ``` ###### `secr`Required - *Type:* [`cdk8s-plus-21.ISecret`](#cdk8s-plus-21.ISecret) The secret to use to populate the volume. --- ###### `options`Optional - *Type:* [`cdk8s-plus-21.SecretVolumeOptions`](#cdk8s-plus-21.SecretVolumeOptions) Options. --- #### Properties ##### `name`Required ```typescript public readonly name: string; ``` - *Type:* `string` --- ### WorkloadScheduling Controls the pod scheduling strategy of this workload. It offers some additional API's on top of the core pod scheduling. #### Initializers ```typescript import { WorkloadScheduling } from 'cdk8s-plus-21' new WorkloadScheduling(instance: AbstractPod) ``` ##### `instance`Required - *Type:* [`cdk8s-plus-21.AbstractPod`](#cdk8s-plus-21.AbstractPod) --- #### Methods ##### `spread` ```typescript public spread(options?: WorkloadSchedulingSpreadOptions) ``` ###### `options`Optional - *Type:* [`cdk8s-plus-21.WorkloadSchedulingSpreadOptions`](#cdk8s-plus-21.WorkloadSchedulingSpreadOptions) --- ## Protocols ### IApiEndpoint - *Implemented By:* [`cdk8s-plus-21.AbstractPod`](#cdk8s-plus-21.AbstractPod), [`cdk8s-plus-21.ApiResource`](#cdk8s-plus-21.ApiResource), [`cdk8s-plus-21.AwsElasticBlockStorePersistentVolume`](#cdk8s-plus-21.AwsElasticBlockStorePersistentVolume), [`cdk8s-plus-21.AzureDiskPersistentVolume`](#cdk8s-plus-21.AzureDiskPersistentVolume), [`cdk8s-plus-21.BasicAuthSecret`](#cdk8s-plus-21.BasicAuthSecret), [`cdk8s-plus-21.ClusterRole`](#cdk8s-plus-21.ClusterRole), [`cdk8s-plus-21.ClusterRoleBinding`](#cdk8s-plus-21.ClusterRoleBinding), [`cdk8s-plus-21.ConfigMap`](#cdk8s-plus-21.ConfigMap), [`cdk8s-plus-21.DaemonSet`](#cdk8s-plus-21.DaemonSet), [`cdk8s-plus-21.Deployment`](#cdk8s-plus-21.Deployment), [`cdk8s-plus-21.DockerConfigSecret`](#cdk8s-plus-21.DockerConfigSecret), [`cdk8s-plus-21.GCEPersistentDiskPersistentVolume`](#cdk8s-plus-21.GCEPersistentDiskPersistentVolume), [`cdk8s-plus-21.IngressV1Beta1`](#cdk8s-plus-21.IngressV1Beta1), [`cdk8s-plus-21.Job`](#cdk8s-plus-21.Job), [`cdk8s-plus-21.Namespace`](#cdk8s-plus-21.Namespace), [`cdk8s-plus-21.NonApiResource`](#cdk8s-plus-21.NonApiResource), [`cdk8s-plus-21.PersistentVolume`](#cdk8s-plus-21.PersistentVolume), [`cdk8s-plus-21.PersistentVolumeClaim`](#cdk8s-plus-21.PersistentVolumeClaim), [`cdk8s-plus-21.Pod`](#cdk8s-plus-21.Pod), [`cdk8s-plus-21.Resource`](#cdk8s-plus-21.Resource), [`cdk8s-plus-21.Role`](#cdk8s-plus-21.Role), [`cdk8s-plus-21.RoleBinding`](#cdk8s-plus-21.RoleBinding), [`cdk8s-plus-21.Secret`](#cdk8s-plus-21.Secret), [`cdk8s-plus-21.Service`](#cdk8s-plus-21.Service), [`cdk8s-plus-21.ServiceAccount`](#cdk8s-plus-21.ServiceAccount), [`cdk8s-plus-21.ServiceAccountTokenSecret`](#cdk8s-plus-21.ServiceAccountTokenSecret), [`cdk8s-plus-21.SshAuthSecret`](#cdk8s-plus-21.SshAuthSecret), [`cdk8s-plus-21.StatefulSet`](#cdk8s-plus-21.StatefulSet), [`cdk8s-plus-21.TlsSecret`](#cdk8s-plus-21.TlsSecret), [`cdk8s-plus-21.Workload`](#cdk8s-plus-21.Workload), [`cdk8s-plus-21.IApiEndpoint`](#cdk8s-plus-21.IApiEndpoint) An API Endpoint can either be a resource descriptor (e.g /pods) or a non resource url (e.g /healthz). It must be one or the other, and not both. #### Methods ##### `asApiResource` ```typescript public asApiResource() ``` ##### `asNonApiResource` ```typescript public asNonApiResource() ``` ### IApiResource - *Implemented By:* [`cdk8s-plus-21.AbstractPod`](#cdk8s-plus-21.AbstractPod), [`cdk8s-plus-21.ApiResource`](#cdk8s-plus-21.ApiResource), [`cdk8s-plus-21.AwsElasticBlockStorePersistentVolume`](#cdk8s-plus-21.AwsElasticBlockStorePersistentVolume), [`cdk8s-plus-21.AzureDiskPersistentVolume`](#cdk8s-plus-21.AzureDiskPersistentVolume), [`cdk8s-plus-21.BasicAuthSecret`](#cdk8s-plus-21.BasicAuthSecret), [`cdk8s-plus-21.ClusterRole`](#cdk8s-plus-21.ClusterRole), [`cdk8s-plus-21.ClusterRoleBinding`](#cdk8s-plus-21.ClusterRoleBinding), [`cdk8s-plus-21.ConfigMap`](#cdk8s-plus-21.ConfigMap), [`cdk8s-plus-21.DaemonSet`](#cdk8s-plus-21.DaemonSet), [`cdk8s-plus-21.Deployment`](#cdk8s-plus-21.Deployment), [`cdk8s-plus-21.DockerConfigSecret`](#cdk8s-plus-21.DockerConfigSecret), [`cdk8s-plus-21.GCEPersistentDiskPersistentVolume`](#cdk8s-plus-21.GCEPersistentDiskPersistentVolume), [`cdk8s-plus-21.IngressV1Beta1`](#cdk8s-plus-21.IngressV1Beta1), [`cdk8s-plus-21.Job`](#cdk8s-plus-21.Job), [`cdk8s-plus-21.Namespace`](#cdk8s-plus-21.Namespace), [`cdk8s-plus-21.PersistentVolume`](#cdk8s-plus-21.PersistentVolume), [`cdk8s-plus-21.PersistentVolumeClaim`](#cdk8s-plus-21.PersistentVolumeClaim), [`cdk8s-plus-21.Pod`](#cdk8s-plus-21.Pod), [`cdk8s-plus-21.Resource`](#cdk8s-plus-21.Resource), [`cdk8s-plus-21.Role`](#cdk8s-plus-21.Role), [`cdk8s-plus-21.RoleBinding`](#cdk8s-plus-21.RoleBinding), [`cdk8s-plus-21.Secret`](#cdk8s-plus-21.Secret), [`cdk8s-plus-21.Service`](#cdk8s-plus-21.Service), [`cdk8s-plus-21.ServiceAccount`](#cdk8s-plus-21.ServiceAccount), [`cdk8s-plus-21.ServiceAccountTokenSecret`](#cdk8s-plus-21.ServiceAccountTokenSecret), [`cdk8s-plus-21.SshAuthSecret`](#cdk8s-plus-21.SshAuthSecret), [`cdk8s-plus-21.StatefulSet`](#cdk8s-plus-21.StatefulSet), [`cdk8s-plus-21.TlsSecret`](#cdk8s-plus-21.TlsSecret), [`cdk8s-plus-21.Workload`](#cdk8s-plus-21.Workload), [`cdk8s-plus-21.IApiResource`](#cdk8s-plus-21.IApiResource) Represents a resource or collection of resources. #### Properties ##### `apiGroup`Required ```typescript public readonly apiGroup: string; ``` - *Type:* `string` The group portion of the API version (e.g. `authorization.k8s.io`). --- ##### `resourceType`Required ```typescript public readonly resourceType: string; ``` - *Type:* `string` The name of a resource type as it appears in the relevant API endpoint. > https://kubernetes.io/docs/reference/access-authn-authz/rbac/#referring-to-resources --- ##### `resourceName`Optional ```typescript 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. --- ### IClusterRole - *Extends:* [`cdk8s-plus-21.IResource`](#cdk8s-plus-21.IResource) - *Implemented By:* [`cdk8s-plus-21.ClusterRole`](#cdk8s-plus-21.ClusterRole), [`cdk8s-plus-21.IClusterRole`](#cdk8s-plus-21.IClusterRole) Represents a cluster-level role. #### Properties ##### `apiGroup`Required ```typescript public readonly apiGroup: string; ``` - *Type:* `string` The group portion of the API version (e.g. "authorization.k8s.io"). --- ##### `apiVersion`Required ```typescript public readonly apiVersion: string; ``` - *Type:* `string` The object's API version (e.g. "authorization.k8s.io/v1"). --- ##### `kind`Required ```typescript public readonly kind: string; ``` - *Type:* `string` The object kind (e.g. "Deployment"). --- ##### `name`Required ```typescript public readonly name: string; ``` - *Type:* `string` The Kubernetes name of this resource. --- ### IConfigMap - *Extends:* [`cdk8s-plus-21.IResource`](#cdk8s-plus-21.IResource) - *Implemented By:* [`cdk8s-plus-21.ConfigMap`](#cdk8s-plus-21.ConfigMap), [`cdk8s-plus-21.IConfigMap`](#cdk8s-plus-21.IConfigMap) Represents a config map. #### Properties ##### `apiGroup`Required ```typescript public readonly apiGroup: string; ``` - *Type:* `string` The group portion of the API version (e.g. "authorization.k8s.io"). --- ##### `apiVersion`Required ```typescript public readonly apiVersion: string; ``` - *Type:* `string` The object's API version (e.g. "authorization.k8s.io/v1"). --- ##### `kind`Required ```typescript public readonly kind: string; ``` - *Type:* `string` The object kind (e.g. "Deployment"). --- ##### `name`Required ```typescript public readonly name: string; ``` - *Type:* `string` The Kubernetes name of this resource. --- ### INamespaceSelector - *Implemented By:* [`cdk8s-plus-21.Namespace`](#cdk8s-plus-21.Namespace), [`cdk8s-plus-21.Namespaces`](#cdk8s-plus-21.Namespaces), [`cdk8s-plus-21.INamespaceSelector`](#cdk8s-plus-21.INamespaceSelector) Represents an object that can select namespaces. #### Methods ##### `toNamespaceSelectorConfig` ```typescript public toNamespaceSelectorConfig() ``` ### IPersistentVolume - *Extends:* [`cdk8s-plus-21.IResource`](#cdk8s-plus-21.IResource) - *Implemented By:* [`cdk8s-plus-21.AwsElasticBlockStorePersistentVolume`](#cdk8s-plus-21.AwsElasticBlockStorePersistentVolume), [`cdk8s-plus-21.AzureDiskPersistentVolume`](#cdk8s-plus-21.AzureDiskPersistentVolume), [`cdk8s-plus-21.GCEPersistentDiskPersistentVolume`](#cdk8s-plus-21.GCEPersistentDiskPersistentVolume), [`cdk8s-plus-21.PersistentVolume`](#cdk8s-plus-21.PersistentVolume), [`cdk8s-plus-21.IPersistentVolume`](#cdk8s-plus-21.IPersistentVolume) Contract of a `PersistentVolumeClaim`. #### Properties ##### `apiGroup`Required ```typescript public readonly apiGroup: string; ``` - *Type:* `string` The group portion of the API version (e.g. "authorization.k8s.io"). --- ##### `apiVersion`Required ```typescript public readonly apiVersion: string; ``` - *Type:* `string` The object's API version (e.g. "authorization.k8s.io/v1"). --- ##### `kind`Required ```typescript public readonly kind: string; ``` - *Type:* `string` The object kind (e.g. "Deployment"). --- ##### `name`Required ```typescript public readonly name: string; ``` - *Type:* `string` The Kubernetes name of this resource. --- ### IPersistentVolumeClaim - *Extends:* [`cdk8s-plus-21.IResource`](#cdk8s-plus-21.IResource) - *Implemented By:* [`cdk8s-plus-21.PersistentVolumeClaim`](#cdk8s-plus-21.PersistentVolumeClaim), [`cdk8s-plus-21.IPersistentVolumeClaim`](#cdk8s-plus-21.IPersistentVolumeClaim) Contract of a `PersistentVolumeClaim`. #### Properties ##### `apiGroup`Required ```typescript public readonly apiGroup: string; ``` - *Type:* `string` The group portion of the API version (e.g. "authorization.k8s.io"). --- ##### `apiVersion`Required ```typescript public readonly apiVersion: string; ``` - *Type:* `string` The object's API version (e.g. "authorization.k8s.io/v1"). --- ##### `kind`Required ```typescript public readonly kind: string; ``` - *Type:* `string` The object kind (e.g. "Deployment"). --- ##### `name`Required ```typescript public readonly name: string; ``` - *Type:* `string` The Kubernetes name of this resource. --- ### IPodSelector - *Implemented By:* [`cdk8s-plus-21.AbstractPod`](#cdk8s-plus-21.AbstractPod), [`cdk8s-plus-21.DaemonSet`](#cdk8s-plus-21.DaemonSet), [`cdk8s-plus-21.Deployment`](#cdk8s-plus-21.Deployment), [`cdk8s-plus-21.Job`](#cdk8s-plus-21.Job), [`cdk8s-plus-21.Pod`](#cdk8s-plus-21.Pod), [`cdk8s-plus-21.Pods`](#cdk8s-plus-21.Pods), [`cdk8s-plus-21.StatefulSet`](#cdk8s-plus-21.StatefulSet), [`cdk8s-plus-21.Workload`](#cdk8s-plus-21.Workload), [`cdk8s-plus-21.IPodSelector`](#cdk8s-plus-21.IPodSelector) Represents an object that can select pods. #### Methods ##### `toPodSelectorConfig` ```typescript public toPodSelectorConfig() ``` ### IResource - *Implemented By:* [`cdk8s-plus-21.AbstractPod`](#cdk8s-plus-21.AbstractPod), [`cdk8s-plus-21.AwsElasticBlockStorePersistentVolume`](#cdk8s-plus-21.AwsElasticBlockStorePersistentVolume), [`cdk8s-plus-21.AzureDiskPersistentVolume`](#cdk8s-plus-21.AzureDiskPersistentVolume), [`cdk8s-plus-21.BasicAuthSecret`](#cdk8s-plus-21.BasicAuthSecret), [`cdk8s-plus-21.ClusterRole`](#cdk8s-plus-21.ClusterRole), [`cdk8s-plus-21.ClusterRoleBinding`](#cdk8s-plus-21.ClusterRoleBinding), [`cdk8s-plus-21.ConfigMap`](#cdk8s-plus-21.ConfigMap), [`cdk8s-plus-21.DaemonSet`](#cdk8s-plus-21.DaemonSet), [`cdk8s-plus-21.Deployment`](#cdk8s-plus-21.Deployment), [`cdk8s-plus-21.DockerConfigSecret`](#cdk8s-plus-21.DockerConfigSecret), [`cdk8s-plus-21.GCEPersistentDiskPersistentVolume`](#cdk8s-plus-21.GCEPersistentDiskPersistentVolume), [`cdk8s-plus-21.IngressV1Beta1`](#cdk8s-plus-21.IngressV1Beta1), [`cdk8s-plus-21.Job`](#cdk8s-plus-21.Job), [`cdk8s-plus-21.Namespace`](#cdk8s-plus-21.Namespace), [`cdk8s-plus-21.PersistentVolume`](#cdk8s-plus-21.PersistentVolume), [`cdk8s-plus-21.PersistentVolumeClaim`](#cdk8s-plus-21.PersistentVolumeClaim), [`cdk8s-plus-21.Pod`](#cdk8s-plus-21.Pod), [`cdk8s-plus-21.Resource`](#cdk8s-plus-21.Resource), [`cdk8s-plus-21.Role`](#cdk8s-plus-21.Role), [`cdk8s-plus-21.RoleBinding`](#cdk8s-plus-21.RoleBinding), [`cdk8s-plus-21.Secret`](#cdk8s-plus-21.Secret), [`cdk8s-plus-21.Service`](#cdk8s-plus-21.Service), [`cdk8s-plus-21.ServiceAccount`](#cdk8s-plus-21.ServiceAccount), [`cdk8s-plus-21.ServiceAccountTokenSecret`](#cdk8s-plus-21.ServiceAccountTokenSecret), [`cdk8s-plus-21.SshAuthSecret`](#cdk8s-plus-21.SshAuthSecret), [`cdk8s-plus-21.StatefulSet`](#cdk8s-plus-21.StatefulSet), [`cdk8s-plus-21.TlsSecret`](#cdk8s-plus-21.TlsSecret), [`cdk8s-plus-21.Workload`](#cdk8s-plus-21.Workload), [`cdk8s-plus-21.IClusterRole`](#cdk8s-plus-21.IClusterRole), [`cdk8s-plus-21.IConfigMap`](#cdk8s-plus-21.IConfigMap), [`cdk8s-plus-21.IPersistentVolume`](#cdk8s-plus-21.IPersistentVolume), [`cdk8s-plus-21.IPersistentVolumeClaim`](#cdk8s-plus-21.IPersistentVolumeClaim), [`cdk8s-plus-21.IResource`](#cdk8s-plus-21.IResource), [`cdk8s-plus-21.IRole`](#cdk8s-plus-21.IRole), [`cdk8s-plus-21.ISecret`](#cdk8s-plus-21.ISecret), [`cdk8s-plus-21.IServiceAccount`](#cdk8s-plus-21.IServiceAccount) Represents a resource. #### Properties ##### `apiGroup`Required ```typescript public readonly apiGroup: string; ``` - *Type:* `string` The group portion of the API version (e.g. "authorization.k8s.io"). --- ##### `apiVersion`Required ```typescript public readonly apiVersion: string; ``` - *Type:* `string` The object's API version (e.g. "authorization.k8s.io/v1"). --- ##### `kind`Required ```typescript public readonly kind: string; ``` - *Type:* `string` The object kind (e.g. "Deployment"). --- ##### `name`Required ```typescript public readonly name: string; ``` - *Type:* `string` The Kubernetes name of this resource. --- ### IRole - *Extends:* [`cdk8s-plus-21.IResource`](#cdk8s-plus-21.IResource) - *Implemented By:* [`cdk8s-plus-21.ClusterRole`](#cdk8s-plus-21.ClusterRole), [`cdk8s-plus-21.Role`](#cdk8s-plus-21.Role), [`cdk8s-plus-21.IRole`](#cdk8s-plus-21.IRole) A reference to any Role or ClusterRole. #### Properties ##### `apiGroup`Required ```typescript public readonly apiGroup: string; ``` - *Type:* `string` The group portion of the API version (e.g. "authorization.k8s.io"). --- ##### `apiVersion`Required ```typescript public readonly apiVersion: string; ``` - *Type:* `string` The object's API version (e.g. "authorization.k8s.io/v1"). --- ##### `kind`Required ```typescript public readonly kind: string; ``` - *Type:* `string` The object kind (e.g. "Deployment"). --- ##### `name`Required ```typescript public readonly name: string; ``` - *Type:* `string` The Kubernetes name of this resource. --- ### ISecret - *Extends:* [`cdk8s-plus-21.IResource`](#cdk8s-plus-21.IResource) - *Implemented By:* [`cdk8s-plus-21.BasicAuthSecret`](#cdk8s-plus-21.BasicAuthSecret), [`cdk8s-plus-21.DockerConfigSecret`](#cdk8s-plus-21.DockerConfigSecret), [`cdk8s-plus-21.Secret`](#cdk8s-plus-21.Secret), [`cdk8s-plus-21.ServiceAccountTokenSecret`](#cdk8s-plus-21.ServiceAccountTokenSecret), [`cdk8s-plus-21.SshAuthSecret`](#cdk8s-plus-21.SshAuthSecret), [`cdk8s-plus-21.TlsSecret`](#cdk8s-plus-21.TlsSecret), [`cdk8s-plus-21.ISecret`](#cdk8s-plus-21.ISecret) #### Properties ##### `apiGroup`Required ```typescript public readonly apiGroup: string; ``` - *Type:* `string` The group portion of the API version (e.g. "authorization.k8s.io"). --- ##### `apiVersion`Required ```typescript public readonly apiVersion: string; ``` - *Type:* `string` The object's API version (e.g. "authorization.k8s.io/v1"). --- ##### `kind`Required ```typescript public readonly kind: string; ``` - *Type:* `string` The object kind (e.g. "Deployment"). --- ##### `name`Required ```typescript public readonly name: string; ``` - *Type:* `string` The Kubernetes name of this resource. --- ### IServiceAccount - *Extends:* [`cdk8s-plus-21.IResource`](#cdk8s-plus-21.IResource) - *Implemented By:* [`cdk8s-plus-21.ServiceAccount`](#cdk8s-plus-21.ServiceAccount), [`cdk8s-plus-21.IServiceAccount`](#cdk8s-plus-21.IServiceAccount) #### Properties ##### `apiGroup`Required ```typescript public readonly apiGroup: string; ``` - *Type:* `string` The group portion of the API version (e.g. "authorization.k8s.io"). --- ##### `apiVersion`Required ```typescript public readonly apiVersion: string; ``` - *Type:* `string` The object's API version (e.g. "authorization.k8s.io/v1"). --- ##### `kind`Required ```typescript public readonly kind: string; ``` - *Type:* `string` The object kind (e.g. "Deployment"). --- ##### `name`Required ```typescript public readonly name: string; ``` - *Type:* `string` The Kubernetes name of this resource. --- ### IStorage - *Implemented By:* [`cdk8s-plus-21.AwsElasticBlockStorePersistentVolume`](#cdk8s-plus-21.AwsElasticBlockStorePersistentVolume), [`cdk8s-plus-21.AzureDiskPersistentVolume`](#cdk8s-plus-21.AzureDiskPersistentVolume), [`cdk8s-plus-21.GCEPersistentDiskPersistentVolume`](#cdk8s-plus-21.GCEPersistentDiskPersistentVolume), [`cdk8s-plus-21.PersistentVolume`](#cdk8s-plus-21.PersistentVolume), [`cdk8s-plus-21.Volume`](#cdk8s-plus-21.Volume), [`cdk8s-plus-21.IStorage`](#cdk8s-plus-21.IStorage) Represents a piece of storage in the cluster. #### Methods ##### `asVolume` ```typescript public asVolume() ``` ### ISubject - *Implemented By:* [`cdk8s-plus-21.Group`](#cdk8s-plus-21.Group), [`cdk8s-plus-21.ServiceAccount`](#cdk8s-plus-21.ServiceAccount), [`cdk8s-plus-21.User`](#cdk8s-plus-21.User), [`cdk8s-plus-21.ISubject`](#cdk8s-plus-21.ISubject) 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. #### Properties ##### `kind`Required ```typescript 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. --- ##### `name`Required ```typescript public readonly name: string; ``` - *Type:* `string` Name of the object being referenced. --- ##### `apiGroup`Optional ```typescript 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. --- ##### `namespace`Optional ```typescript 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. --- ## Enums ### AzureDiskPersistentVolumeCachingMode Azure disk caching modes. #### `NONE` None. --- #### `READ_ONLY` ReadOnly. --- #### `READ_WRITE` ReadWrite. --- ### AzureDiskPersistentVolumeKind Azure Disk kinds. #### `SHARED` Multiple blob disks per storage account. --- #### `DEDICATED` Single blob disk per storage account. --- #### `MANAGED` Azure managed data disk. --- ### DnsPolicy Pod DNS policies. #### `CLUSTER_FIRST` Any DNS query that does not match the configured cluster domain suffix, such as "www.kubernetes.io", is forwarded to the upstream nameserver inherited from the node. Cluster administrators may have extra stub-domain and upstream DNS servers configured. --- #### `CLUSTER_FIRST_WITH_HOST_NET` For Pods running with hostNetwork, you should explicitly set its DNS policy "ClusterFirstWithHostNet". --- #### `DEFAULT` The Pod inherits the name resolution configuration from the node that the pods run on. --- #### `NONE` It allows a Pod to ignore DNS settings from the Kubernetes environment. All DNS settings are supposed to be provided using the dnsConfig field in the Pod Spec. --- ### EmptyDirMedium The medium on which to store the volume. #### `DEFAULT` The default volume of the backing node. --- #### `MEMORY` 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. --- ### EnvFieldPaths #### `POD_NAME` The name of the pod. --- #### `POD_NAMESPACE` The namespace of the pod. --- #### `POD_UID` The uid of the pod. --- #### `POD_LABEL` The labels of the pod. --- #### `POD_ANNOTATION` The annotations of the pod. --- #### `POD_IP` The ipAddress of the pod. --- #### `SERVICE_ACCOUNT_NAME` The service account name of the pod. --- #### `NODE_NAME` The name of the node. --- #### `NODE_IP` The ipAddress of the node. --- #### `POD_IPS` The ipAddresess of the pod. --- ### FsGroupChangePolicy #### `ON_ROOT_MISMATCH` Only change permissions and ownership if permission and ownership of root directory does not match with expected permissions of the volume. This could help shorten the time it takes to change ownership and permission of a volume --- #### `ALWAYS` Always change permission and ownership of the volume when volume is mounted. --- ### ImagePullPolicy #### `ALWAYS` Every time the kubelet launches a container, the kubelet queries the container image registry to resolve the name to an image digest. If the kubelet has a container image with that exact digest cached locally, the kubelet uses its cached image; otherwise, the kubelet downloads (pulls) the image with the resolved digest, and uses that image to launch the container. Default is Always if ImagePullPolicy is omitted and either the image tag is :latest or the image tag is omitted. --- #### `IF_NOT_PRESENT` The image is pulled only if it is not already present locally. Default is IfNotPresent if ImagePullPolicy is omitted and the image tag is present but not :latest --- #### `NEVER` The image is assumed to exist locally. No attempt is made to pull the image. --- ### MountPropagation #### `NONE` This volume mount will not receive any subsequent mounts that are mounted to this volume or any of its subdirectories by the host. In similar fashion, no mounts created by the Container will be visible on the host. This is the default mode. This mode is equal to `private` mount propagation as described in the Linux kernel documentation --- #### `HOST_TO_CONTAINER` This volume mount will receive all subsequent mounts that are mounted to this volume or any of its subdirectories. In other words, if the host mounts anything inside the volume mount, the Container will see it mounted there. Similarly, if any Pod with Bidirectional mount propagation to the same volume mounts anything there, the Container with HostToContainer mount propagation will see it. This mode is equal to `rslave` mount propagation as described in the Linux kernel documentation --- #### `BIDIRECTIONAL` This volume mount behaves the same the HostToContainer mount. In addition, all volume mounts created by the Container will be propagated back to the host and to all Containers of all Pods that use the same volume A typical use case for this mode is a Pod with a FlexVolume or CSI driver or a Pod that needs to mount something on the host using a hostPath volume. This mode is equal to `rshared` mount propagation as described in the Linux kernel documentation Caution: Bidirectional mount propagation can be dangerous. It can damage the host operating system and therefore it is allowed only in privileged Containers. Familiarity with Linux kernel behavior is strongly recommended. In addition, any volume mounts created by Containers in Pods must be destroyed (unmounted) by the Containers on termination. --- ### PersistentVolumeAccessMode Access Modes. #### `READ_WRITE_ONCE` The volume can be mounted as read-write by a single node. ReadWriteOnce access mode still can allow multiple pods to access the volume when the pods are running on the same node. --- #### `READ_ONLY_MANY` The volume can be mounted as read-only by many nodes. --- #### `READ_WRITE_MANY` The volume can be mounted as read-write by many nodes. --- #### `READ_WRITE_ONCE_POD` The volume can be mounted as read-write by a single Pod. Use ReadWriteOncePod access mode if you want to ensure that only one pod across whole cluster can read that PVC or write to it. This is only supported for CSI volumes and Kubernetes version 1.22+. --- ### PersistentVolumeMode Volume Modes. #### `FILE_SYSTEM` Volume is ounted into Pods into a directory. If the volume is backed by a block device and the device is empty, Kubernetes creates a filesystem on the device before mounting it for the first time. --- #### `BLOCK` Use a volume as a raw block device. Such volume is presented into a Pod as a block device, without any filesystem on it. This mode is useful to provide a Pod the fastest possible way to access a volume, without any filesystem layer between the Pod and the volume. On the other hand, the application running in the Pod must know how to handle a raw block device --- ### PersistentVolumeReclaimPolicy Reclaim Policies. #### `RETAIN` The Retain reclaim policy allows for manual reclamation of the resource. When the PersistentVolumeClaim is deleted, the PersistentVolume still exists and the volume is considered "released". But it is not yet available for another claim because the previous claimant's data remains on the volume. An administrator can manually reclaim the volume with the following steps: 1. Delete the PersistentVolume. The associated storage asset in external infrastructure (such as an AWS EBS, GCE PD, Azure Disk, or Cinder volume) still exists after the PV is deleted. 2. Manually clean up the data on the associated storage asset accordingly. 3. Manually delete the associated storage asset. If you want to reuse the same storage asset, create a new PersistentVolume with the same storage asset definition. --- #### `DELETE` For volume plugins that support the Delete reclaim policy, deletion removes both the PersistentVolume object from Kubernetes, as well as the associated storage asset in the external infrastructure, such as an AWS EBS, GCE PD, Azure Disk, or Cinder volume. Volumes that were dynamically provisioned inherit the reclaim policy of their StorageClass, which defaults to Delete. The administrator should configure the StorageClass according to users' expectations; otherwise, the PV must be edited or patched after it is created --- ### PodManagementPolicy Controls how pods are created during initial scale up, when replacing pods on nodes, or when scaling down. The default policy is `OrderedReady`, where pods are created in increasing order (pod-0, then pod-1, etc) and the controller will wait until each pod is ready before continuing. When scaling down, the pods are removed in the opposite order. The alternative policy is `Parallel` which will create pods in parallel to match the desired scale without waiting, and on scale down will delete all pods at once. #### `ORDERED_READY` --- #### `PARALLEL` --- ### Protocol #### `TCP` --- #### `UDP` --- #### `SCTP` --- ### ResourceFieldPaths #### `CPU_LIMIT` CPU limit of the container. --- #### `MEMORY_LIMIT` Memory limit of the container. --- #### `CPU_REQUEST` CPU request of the container. --- #### `MEMORY_REQUEST` Memory request of the container. --- #### `STORAGE_LIMIT` Ephemeral storage limit of the container. --- #### `STORAGE_REQUEST` Ephemeral storage request of the container. --- ### RestartPolicy Restart policy for all containers within the pod. #### `ALWAYS` Always restart the pod after it exits. --- #### `ON_FAILURE` Only restart if the pod exits with a non-zero exit code. --- #### `NEVER` Never restart the pod. --- ### ServiceType For some parts of your application (for example, frontends) you may want to expose a Service onto an external IP address, that's outside of your cluster. Kubernetes ServiceTypes allow you to specify what kind of Service you want. The default is ClusterIP. #### `CLUSTER_IP` Exposes the Service on a cluster-internal IP. Choosing this value makes the Service only reachable from within the cluster. This is the default ServiceType --- #### `NODE_PORT` Exposes the Service on each Node's IP at a static port (the NodePort). A ClusterIP Service, to which the NodePort Service routes, is automatically created. You'll be able to contact the NodePort Service, from outside the cluster, by requesting :. --- #### `LOAD_BALANCER` Exposes the Service externally using a cloud provider's load balancer. NodePort and ClusterIP Services, to which the external load balancer routes, are automatically created. --- #### `EXTERNAL_NAME` Maps the Service to the contents of the externalName field (e.g. foo.bar.example.com), by returning a CNAME record with its value. No proxying of any kind is set up. > Note: You need either kube-dns version 1.7 or CoreDNS version 0.0.8 or higher to use the ExternalName type. --- ### TaintEffect Taint effects. #### `NO_SCHEDULE` This means that no pod will be able to schedule onto the node unless it has a matching toleration. --- #### `PREFER_NO_SCHEDULE` This is a "preference" or "soft" version of `NO_SCHEDULE` -- the system will try to avoid placing a pod that does not tolerate the taint on the node, but it is not required. --- #### `NO_EXECUTE` This affects pods that are already running on the node as follows:. Pods that do not tolerate the taint are evicted immediately. - Pods that tolerate the taint without specifying `duration` remain bound forever. - Pods that tolerate the taint with a specified `duration` remain bound for the specified amount of time. ---