@Stability(Stable)

Package org.cdk8s.plus20

cdk8s+ (cdk8s-plus)

High level constructs for Kubernetes

| k8s version | npm (JS/TS) | PyPI (Python) | NuGet (C#) | Maven (Java) | Go | | --- | --- | --- | --- | --- | --- | | 1.20.0 | Link | Link | Link | Link | Link | | 1.21.0 | Link | Link | Link | Link | Link | | 1.22.0 | Link | Link | Link | Link | Link |

cdk8s+ is a software development framework that provides high level abstractions for authoring Kubernetes applications. Built on top of the auto generated building blocks provided by cdk8s, this library includes a hand crafted construct for each native kubernetes object, exposing richer API's with reduced complexity.

:books: Documentation

See cdk8s.io.

:raised_hand: Contributing

If you'd like to add a new feature or fix a bug, please visit CONTRIBUTING.md!

:balance_scale: License

This project is distributed under the Apache License, Version 2.0.

This module is part of the cdk8s project.

Interface Summary

Interface	Description
AddDeploymentOptions	Options to add a deployment to a service.
AddDirectoryOptions	Options for `configmap.addDirectory()`.
AwsElasticBlockStorePersistentVolumeProps	Properties for `AwsElasticBlockStorePersistentVolume`.
AzureDiskPersistentVolumeProps	Properties for `AzureDiskPersistentVolume`.
BasicAuthSecretProps	Options for `BasicAuthSecret`.
CommandProbeOptions	Options for `Probe.fromCommand()`.
ConfigMapProps	Properties for initialization of `ConfigMap`.
ConfigMapVolumeOptions	Options for the ConfigMap-based volume.
ContainerLifecycle	Container lifecycle properties.
ContainerProps	Properties for creating a container.
ContainerSecurityContextProps	Properties for `ContainerSecurityContext`.
CpuResources	CPU request and limit.
DeploymentProps	Properties for initialization of `Deployment`.
DockerConfigSecretProps	Options for `DockerConfigSecret`.
EmptyDirVolumeOptions	Options for volumes populated with an empty directory.
EnvValueFromConfigMapOptions	Options to specify an envionment variable value from a ConfigMap key.
EnvValueFromFieldRefOptions	Options to specify an environment variable value from a field reference.
EnvValueFromProcessOptions	Options to specify an environment variable value from the process environment.
EnvValueFromResourceOptions	Options to specify an environment variable value from a resource.
EnvValueFromSecretOptions	Options to specify an environment variable value from a Secret.
ExposeDeploymentViaIngressOptions	Options for exposing a deployment via an ingress.
ExposeDeploymentViaServiceOptions	Options for exposing a deployment via a service.
ExposeServiceViaIngressOptions	Options for exposing a service using an ingress.
GCEPersistentDiskPersistentVolumeProps	Properties for `GCEPersistentDiskPersistentVolume`.
HandlerFromHttpGetOptions	Options for `Handler.fromHttpGet`.
HandlerFromTcpSocketOptions	Options for `Handler.fromTcpSocket`.
HostAlias	HostAlias holds the mapping between IP and hostnames that will be injected as an entry in the pod's /etc/hosts file.
HttpGetProbeOptions	Options for `Probe.fromHttpGet()`.
IConfigMap	Represents a config map.
IConfigMap.Jsii$Default	Internal default implementation for IConfigMap.
IngressV1Beta1Props	Properties for `Ingress`.
IngressV1Beta1Rule	Represents the rules mapping the paths under a specified host to the related backend services.
IngressV1Beta1Tls	Represents the TLS configuration mapping that is passed to the ingress controller for SSL termination.
IPersistentVolume	Contract of a `PersistentVolumeClaim`.
IPersistentVolume.Jsii$Default	Internal default implementation for IPersistentVolume.
IPersistentVolumeClaim	Contract of a `PersistentVolumeClaim`.
IPersistentVolumeClaim.Jsii$Default	Internal default implementation for IPersistentVolumeClaim.
IPodSpec	Represents a resource that can be configured with a kuberenets pod spec.
IPodSpec.Jsii$Default	Internal default implementation for IPodSpec.
IPodTemplate	Represents a resource that can be configured with a kuberenets pod template.
IPodTemplate.Jsii$Default	Internal default implementation for IPodTemplate.
IResource	Represents a resource.
IResource.Jsii$Default	Internal default implementation for IResource.
ISecret
ISecret.Jsii$Default	Internal default implementation for ISecret.
IServiceAccount
IServiceAccount.Jsii$Default	Internal default implementation for IServiceAccount.
IStorage	Represents a piece of storage in the cluster.
IStorage.Jsii$Default	Internal default implementation for IStorage.
JobProps	Properties for initialization of `Job`.
MemoryResources	Memory request and limit.
MountOptions	Options for mounts.
PathMapping	Maps a string key to a path within a volume.
PersistentVolumeClaimProps	Properties for `PersistentVolumeClaim`.
PersistentVolumeClaimVolumeOptions	Options for a PersistentVolumeClaim-based volume.
PersistentVolumeProps	Properties for `PersistentVolume`.
PodProps	Properties for initialization of `Pod`.
PodSecurityContextProps	Properties for `PodSecurityContext`.
PodSpecProps	Properties of a `PodSpec`.
PodTemplateProps	Properties of a `PodTemplate`.
ProbeOptions	Probe options.
ResourceProps	Initialization properties for resources.
Resources	CPU and memory compute resources.
SecretProps	Options for `Secret`.
SecretValue	Represents a specific value in JSON secret.
SecretVolumeOptions	Options for the Secret-based volume.
ServiceAccountProps	Properties for initialization of `ServiceAccount`.
ServiceAccountTokenSecretProps	Options for `ServiceAccountTokenSecret`.
ServiceIngressV1BetaBackendOptions	Options for setting up backends for ingress rules.
ServicePort	Definition of a service port.
ServicePortOptions
ServiceProps	Properties for initialization of `Service`.
SshAuthSecretProps	Options for `SshAuthSecret`.
StatefulSetProps	Properties for initialization of `StatefulSet`.
Sysctl	Sysctl defines a kernel parameter to be set.
TcpSocketProbeOptions	Options for `Probe.fromTcpSocket()`.
TlsSecretProps	Options for `TlsSecret`.
VolumeMount	Mount a volume from the pod to the container.

Class Summary

Class	Description
AddDeploymentOptions.Builder	A builder for AddDeploymentOptions
AddDeploymentOptions.Jsii$Proxy	An implementation for AddDeploymentOptions
AddDirectoryOptions.Builder	A builder for AddDirectoryOptions
AddDirectoryOptions.Jsii$Proxy	An implementation for AddDirectoryOptions
AwsElasticBlockStorePersistentVolume	Represents an AWS Disk resource that is attached to a kubelet's host machine and then exposed to the pod.
AwsElasticBlockStorePersistentVolume.Builder	A fluent builder for AwsElasticBlockStorePersistentVolume.
AwsElasticBlockStorePersistentVolumeProps.Builder	A builder for AwsElasticBlockStorePersistentVolumeProps
AwsElasticBlockStorePersistentVolumeProps.Jsii$Proxy	An implementation for AwsElasticBlockStorePersistentVolumeProps
AzureDiskPersistentVolume	AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.
AzureDiskPersistentVolume.Builder	A fluent builder for AzureDiskPersistentVolume.
AzureDiskPersistentVolumeProps.Builder	A builder for AzureDiskPersistentVolumeProps
AzureDiskPersistentVolumeProps.Jsii$Proxy	An implementation for AzureDiskPersistentVolumeProps
BasicAuthSecret	Create a secret for basic authentication.
BasicAuthSecret.Builder	A fluent builder for BasicAuthSecret.
BasicAuthSecretProps.Builder	A builder for BasicAuthSecretProps
BasicAuthSecretProps.Jsii$Proxy	An implementation for BasicAuthSecretProps
CommandProbeOptions.Builder	A builder for CommandProbeOptions
CommandProbeOptions.Jsii$Proxy	An implementation for CommandProbeOptions
ConfigMap	ConfigMap holds configuration data for pods to consume.
ConfigMap.Builder	A fluent builder for ConfigMap.
ConfigMapProps.Builder	A builder for ConfigMapProps
ConfigMapProps.Jsii$Proxy	An implementation for ConfigMapProps
ConfigMapVolumeOptions.Builder	A builder for ConfigMapVolumeOptions
ConfigMapVolumeOptions.Jsii$Proxy	An implementation for ConfigMapVolumeOptions
Container	A single application container that you want to run within a pod.
Container.Builder	A fluent builder for Container.
ContainerLifecycle.Builder	A builder for ContainerLifecycle
ContainerLifecycle.Jsii$Proxy	An implementation for ContainerLifecycle
ContainerProps.Builder	A builder for ContainerProps
ContainerProps.Jsii$Proxy	An implementation for ContainerProps
ContainerSecurityContext	Container security attributes and settings.
ContainerSecurityContext.Builder	A fluent builder for ContainerSecurityContext.
ContainerSecurityContextProps.Builder	A builder for ContainerSecurityContextProps
ContainerSecurityContextProps.Jsii$Proxy	An implementation for ContainerSecurityContextProps
Cpu	Represents the amount of CPU.
CpuResources.Builder	A builder for CpuResources
CpuResources.Jsii$Proxy	An implementation for CpuResources
Deployment	A Deployment provides declarative updates for Pods and ReplicaSets.
Deployment.Builder	A fluent builder for Deployment.
DeploymentProps.Builder	A builder for DeploymentProps
DeploymentProps.Jsii$Proxy	An implementation for DeploymentProps
DockerConfigSecret	Create a secret for storing credentials for accessing a container image registry.
DockerConfigSecret.Builder	A fluent builder for DockerConfigSecret.
DockerConfigSecretProps.Builder	A builder for DockerConfigSecretProps
DockerConfigSecretProps.Jsii$Proxy	An implementation for DockerConfigSecretProps
EmptyDirVolumeOptions.Builder	A builder for EmptyDirVolumeOptions
EmptyDirVolumeOptions.Jsii$Proxy	An implementation for EmptyDirVolumeOptions
EnvValue	Utility class for creating reading env values from various sources.
EnvValueFromConfigMapOptions.Builder	A builder for EnvValueFromConfigMapOptions
EnvValueFromConfigMapOptions.Jsii$Proxy	An implementation for EnvValueFromConfigMapOptions
EnvValueFromFieldRefOptions.Builder	A builder for EnvValueFromFieldRefOptions
EnvValueFromFieldRefOptions.Jsii$Proxy	An implementation for EnvValueFromFieldRefOptions
EnvValueFromProcessOptions.Builder	A builder for EnvValueFromProcessOptions
EnvValueFromProcessOptions.Jsii$Proxy	An implementation for EnvValueFromProcessOptions
EnvValueFromResourceOptions.Builder	A builder for EnvValueFromResourceOptions
EnvValueFromResourceOptions.Jsii$Proxy	An implementation for EnvValueFromResourceOptions
EnvValueFromSecretOptions.Builder	A builder for EnvValueFromSecretOptions
EnvValueFromSecretOptions.Jsii$Proxy	An implementation for EnvValueFromSecretOptions
ExposeDeploymentViaIngressOptions.Builder	A builder for ExposeDeploymentViaIngressOptions
ExposeDeploymentViaIngressOptions.Jsii$Proxy	An implementation for ExposeDeploymentViaIngressOptions
ExposeDeploymentViaServiceOptions.Builder	A builder for ExposeDeploymentViaServiceOptions
ExposeDeploymentViaServiceOptions.Jsii$Proxy	An implementation for ExposeDeploymentViaServiceOptions
ExposeServiceViaIngressOptions.Builder	A builder for ExposeServiceViaIngressOptions
ExposeServiceViaIngressOptions.Jsii$Proxy	An implementation for ExposeServiceViaIngressOptions
GCEPersistentDiskPersistentVolume	GCEPersistentDisk represents a GCE Disk resource that is attached to a kubelet's host machine and then exposed to the pod.
GCEPersistentDiskPersistentVolume.Builder	A fluent builder for GCEPersistentDiskPersistentVolume.
GCEPersistentDiskPersistentVolumeProps.Builder	A builder for GCEPersistentDiskPersistentVolumeProps
GCEPersistentDiskPersistentVolumeProps.Jsii$Proxy	An implementation for GCEPersistentDiskPersistentVolumeProps
Handler	Defines a specific action that should be taken.
HandlerFromHttpGetOptions.Builder	A builder for HandlerFromHttpGetOptions
HandlerFromHttpGetOptions.Jsii$Proxy	An implementation for HandlerFromHttpGetOptions
HandlerFromTcpSocketOptions.Builder	A builder for HandlerFromTcpSocketOptions
HandlerFromTcpSocketOptions.Jsii$Proxy	An implementation for HandlerFromTcpSocketOptions
HostAlias.Builder	A builder for HostAlias
HostAlias.Jsii$Proxy	An implementation for HostAlias
HttpGetProbeOptions.Builder	A builder for HttpGetProbeOptions
HttpGetProbeOptions.Jsii$Proxy	An implementation for HttpGetProbeOptions
IConfigMap.Jsii$Proxy	A proxy class which represents a concrete javascript instance of this type.
IngressV1Beta1	Ingress is a collection of rules that allow inbound connections to reach the endpoints defined by a backend.
IngressV1Beta1.Builder	A fluent builder for IngressV1Beta1.
IngressV1Beta1Backend	The backend for an ingress path.
IngressV1Beta1Props.Builder	A builder for IngressV1Beta1Props
IngressV1Beta1Props.Jsii$Proxy	An implementation for IngressV1Beta1Props
IngressV1Beta1Rule.Builder	A builder for IngressV1Beta1Rule
IngressV1Beta1Rule.Jsii$Proxy	An implementation for IngressV1Beta1Rule
IngressV1Beta1Tls.Builder	A builder for IngressV1Beta1Tls
IngressV1Beta1Tls.Jsii$Proxy	An implementation for IngressV1Beta1Tls
IPersistentVolume.Jsii$Proxy	A proxy class which represents a concrete javascript instance of this type.
IPersistentVolumeClaim.Jsii$Proxy	A proxy class which represents a concrete javascript instance of this type.
IPodSpec.Jsii$Proxy	A proxy class which represents a concrete javascript instance of this type.
IPodTemplate.Jsii$Proxy	A proxy class which represents a concrete javascript instance of this type.
IResource.Jsii$Proxy	A proxy class which represents a concrete javascript instance of this type.
ISecret.Jsii$Proxy	A proxy class which represents a concrete javascript instance of this type.
IServiceAccount.Jsii$Proxy	A proxy class which represents a concrete javascript instance of this type.
IStorage.Jsii$Proxy	A proxy class which represents a concrete javascript instance of this type.
Job	A Job creates one or more Pods and ensures that a specified number of them successfully terminate.
Job.Builder	A fluent builder for Job.
JobProps.Builder	A builder for JobProps
JobProps.Jsii$Proxy	An implementation for JobProps
MemoryResources.Builder	A builder for MemoryResources
MemoryResources.Jsii$Proxy	An implementation for MemoryResources
MountOptions.Builder	A builder for MountOptions
MountOptions.Jsii$Proxy	An implementation for MountOptions
PathMapping.Builder	A builder for PathMapping
PathMapping.Jsii$Proxy	An implementation for PathMapping
PersistentVolume	A PersistentVolume (PV) is a piece of storage in the cluster that has been provisioned by an administrator or dynamically provisioned using Storage Classes.
PersistentVolumeClaim	A PersistentVolumeClaim (PVC) is a request for storage by a user.
PersistentVolumeClaim.Builder	A fluent builder for PersistentVolumeClaim.
PersistentVolumeClaimProps.Builder	A builder for PersistentVolumeClaimProps
PersistentVolumeClaimProps.Jsii$Proxy	An implementation for PersistentVolumeClaimProps
PersistentVolumeClaimVolumeOptions.Builder	A builder for PersistentVolumeClaimVolumeOptions
PersistentVolumeClaimVolumeOptions.Jsii$Proxy	An implementation for PersistentVolumeClaimVolumeOptions
PersistentVolumeProps.Builder	A builder for PersistentVolumeProps
PersistentVolumeProps.Jsii$Proxy	An implementation for PersistentVolumeProps
Pod	Pod is a collection of containers that can run on a host.
Pod.Builder	A fluent builder for Pod.
PodProps.Builder	A builder for PodProps
PodProps.Jsii$Proxy	An implementation for PodProps
PodSecurityContext	Holds pod-level security attributes and common container settings.
PodSecurityContext.Builder	A fluent builder for PodSecurityContext.
PodSecurityContextProps.Builder	A builder for PodSecurityContextProps
PodSecurityContextProps.Jsii$Proxy	An implementation for PodSecurityContextProps
PodSpec	Provides read/write capabilities ontop of a `PodSpecProps`.
PodSpec.Builder	A fluent builder for PodSpec.
PodSpecProps.Builder	A builder for PodSpecProps
PodSpecProps.Jsii$Proxy	An implementation for PodSpecProps
PodTemplate	Provides read/write capabilities ontop of a `PodTemplateProps`.
PodTemplate.Builder	A fluent builder for PodTemplate.
PodTemplateProps.Builder	A builder for PodTemplateProps
PodTemplateProps.Jsii$Proxy	An implementation for PodTemplateProps
Probe	Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.
ProbeOptions.Builder	A builder for ProbeOptions
ProbeOptions.Jsii$Proxy	An implementation for ProbeOptions
Resource	Base class for all Kubernetes objects in stdk8s.
ResourceProps.Builder	A builder for ResourceProps
ResourceProps.Jsii$Proxy	An implementation for ResourceProps
Resources.Builder	A builder for Resources
Resources.Jsii$Proxy	An implementation for Resources
Secret	Kubernetes Secrets let you store and manage sensitive information, such as passwords, OAuth tokens, and ssh keys.
Secret.Builder	A fluent builder for Secret.
SecretProps.Builder	A builder for SecretProps
SecretProps.Jsii$Proxy	An implementation for SecretProps
SecretValue.Builder	A builder for SecretValue
SecretValue.Jsii$Proxy	An implementation for SecretValue
SecretVolumeOptions.Builder	A builder for SecretVolumeOptions
SecretVolumeOptions.Jsii$Proxy	An implementation for SecretVolumeOptions
Service	An abstract way to expose an application running on a set of Pods as a network service.
Service.Builder	A fluent builder for Service.
ServiceAccount	A service account provides an identity for processes that run in a Pod.
ServiceAccount.Builder	A fluent builder for ServiceAccount.
ServiceAccountProps.Builder	A builder for ServiceAccountProps
ServiceAccountProps.Jsii$Proxy	An implementation for ServiceAccountProps
ServiceAccountTokenSecret	Create a secret for a service account token.
ServiceAccountTokenSecret.Builder	A fluent builder for ServiceAccountTokenSecret.
ServiceAccountTokenSecretProps.Builder	A builder for ServiceAccountTokenSecretProps
ServiceAccountTokenSecretProps.Jsii$Proxy	An implementation for ServiceAccountTokenSecretProps
ServiceIngressV1BetaBackendOptions.Builder	A builder for ServiceIngressV1BetaBackendOptions
ServiceIngressV1BetaBackendOptions.Jsii$Proxy	An implementation for ServiceIngressV1BetaBackendOptions
ServicePort.Builder	A builder for ServicePort
ServicePort.Jsii$Proxy	An implementation for ServicePort
ServicePortOptions.Builder	A builder for ServicePortOptions
ServicePortOptions.Jsii$Proxy	An implementation for ServicePortOptions
ServiceProps.Builder	A builder for ServiceProps
ServiceProps.Jsii$Proxy	An implementation for ServiceProps
SshAuthSecret	Create a secret for ssh authentication.
SshAuthSecret.Builder	A fluent builder for SshAuthSecret.
SshAuthSecretProps.Builder	A builder for SshAuthSecretProps
SshAuthSecretProps.Jsii$Proxy	An implementation for SshAuthSecretProps
StatefulSet	StatefulSet is the workload API object used to manage stateful applications.
StatefulSet.Builder	A fluent builder for StatefulSet.
StatefulSetProps.Builder	A builder for StatefulSetProps
StatefulSetProps.Jsii$Proxy	An implementation for StatefulSetProps
Sysctl.Builder	A builder for Sysctl
Sysctl.Jsii$Proxy	An implementation for Sysctl
TcpSocketProbeOptions.Builder	A builder for TcpSocketProbeOptions
TcpSocketProbeOptions.Jsii$Proxy	An implementation for TcpSocketProbeOptions
TlsSecret	Create a secret for storing a TLS certificate and its associated key.
TlsSecret.Builder	A fluent builder for TlsSecret.
TlsSecretProps.Builder	A builder for TlsSecretProps
TlsSecretProps.Jsii$Proxy	An implementation for TlsSecretProps
Volume	Volume represents a named volume in a pod that may be accessed by any container in the pod.
VolumeMount.Builder	A builder for VolumeMount
VolumeMount.Jsii$Proxy	An implementation for VolumeMount

Enum Summary

Enum	Description
AzureDiskPersistentVolumeCachingMode	Azure disk caching modes.
AzureDiskPersistentVolumeKind	Azure Disk kinds.
EmptyDirMedium	The medium on which to store the volume.
EnvFieldPaths
FsGroupChangePolicy
ImagePullPolicy
MountPropagation
PersistentVolumeAccessMode	Access Modes.
PersistentVolumeMode	Volume Modes.
PersistentVolumeReclaimPolicy	Reclaim Policies.
PodManagementPolicy	Controls how pods are created during initial scale up, when replacing pods on nodes, or when scaling down.
Protocol
ResourceFieldPaths
RestartPolicy	Restart policy for all containers within 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.