@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 AbstractPodProps Properties for `AbstractPod`.AddDeploymentOptions Options to add a deployment to a service.AddDirectoryOptions Options for `configmap.addDirectory()`.ApiResourceOptions Options for `ApiResource`.AwsElasticBlockStorePersistentVolumeProps Properties for `AwsElasticBlockStorePersistentVolume`.AwsElasticBlockStoreVolumeOptions Options of `Volume.fromAwsElasticBlockStore`.AzureDiskPersistentVolumeProps Properties for `AzureDiskPersistentVolume`.AzureDiskVolumeOptions Options of `Volume.fromAzureDisk`.BasicAuthSecretProps Options for `BasicAuthSecret`.ClusterRoleBindingProps Properties for `ClusterRoleBinding`.ClusterRolePolicyRule Policy rule of a `ClusterRole.ClusterRoleProps Properties for `ClusterRole`.CommandProbeOptions Options for `Probe.fromCommand()`.CommonSecretProps Common properties for `Secret`.ConfigMapProps Properties for initialization of `ConfigMap`.ConfigMapVolumeOptions Options for the ConfigMap-based volume.ContainerLifecycle Container lifecycle properties.ContainerProps Properties for creating a container.ContainerResources CPU and memory compute resources.ContainerSecurityContextProps Properties for `ContainerSecurityContext`.CpuResources CPU request and limit.DaemonSetProps Properties for `DaemonSet`.DeploymentProps Properties for `Deployment`.DeploymentStrategyRollingUpdateOptions Options for `DeploymentStrategy.rollingUpdate`.DnsOption Custom DNS option.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`.GCEPersistentDiskVolumeOptions Options of `Volume.fromGcePersistentDisk`.GroupProps Properties for `Group`.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()`.IApiEndpoint An API Endpoint can either be a resource descriptor (e.g /pods) or a non resource url (e.g /healthz).IApiEndpoint.Jsii$Default Internal default implementation forIApiEndpoint.IApiResource Represents a resource or collection of resources.IApiResource.Jsii$Default Internal default implementation forIApiResource.IClusterRole Represents a cluster-level role.IClusterRole.Jsii$Default Internal default implementation forIClusterRole.IConfigMap Represents a config map.IConfigMap.Jsii$Default Internal default implementation forIConfigMap.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 forIPersistentVolume.IPersistentVolumeClaim Contract of a `PersistentVolumeClaim`.IPersistentVolumeClaim.Jsii$Default Internal default implementation forIPersistentVolumeClaim.IResource Represents a resource.IResource.Jsii$Default Internal default implementation forIResource.IRole A reference to any Role or ClusterRole.IRole.Jsii$Default Internal default implementation forIRole.ISecret ISecret.Jsii$Default Internal default implementation forISecret.IServiceAccount IServiceAccount.Jsii$Default Internal default implementation forIServiceAccount.IStorage Represents a piece of storage in the cluster.IStorage.Jsii$Default Internal default implementation forIStorage.ISubject Subject contains a reference to the object or user identities a role binding applies to.ISubject.Jsii$Default Internal default implementation forISubject.JobProps Properties for `Job`.LabelSelectorRequirement A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.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`.PodDnsProps Properties for `PodDns`.PodProps Properties for `Pod`.PodSecurityContextProps Properties for `PodSecurityContext`.ProbeOptions Probe options.ResourceProps Initialization properties for resources.RoleBindingProps Properties for `RoleBinding`.RolePolicyRule Policy rule of a `Role.RoleProps Properties for `Role`.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`.StatefulSetUpdateStrategyRollingUpdateOptions Options for `StatefulSetUpdateStrategy.rollingUpdate`.Sysctl Sysctl defines a kernel parameter to be set.TcpSocketProbeOptions Options for `Probe.fromTcpSocket()`.TlsSecretProps Options for `TlsSecret`.UserProps Properties for `User`.VolumeMount Mount a volume from the pod to the container.WorkloadProps Properties for `Workload`. -
Enum Summary Enum Description AzureDiskPersistentVolumeCachingMode Azure disk caching modes.AzureDiskPersistentVolumeKind Azure Disk kinds.DnsPolicy Pod DNS policies.EmptyDirMedium The medium on which to store the volume.EnvFieldPaths FsGroupChangePolicy ImagePullPolicy LabelSelectorRequirementOperator Possible operators.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.