@Stability(Stable)
Package org.cdk8s.plus24
cdk8s+ (cdk8s-plus)
High level constructs for Kubernetes
| k8s version | npm (JS/TS) | PyPI (Python) | Maven (Java) | Go | | ----------- | --------------------------------------------------- | ----------------------------------------------- | ----------------------------------------------------------------- | --------------------------------------------------------------- | | 1.22.0 | Link | Link | Link | Link | | 1.23.0 | Link | Link | Link | Link | | 1.24.0 | 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 forAbstractPod
.AddDeploymentOptions Options to add a deployment to a service.AddDirectoryOptions Options forconfigmap.addDirectory()
.ApiResourceOptions Options forApiResource
.AwsElasticBlockStorePersistentVolumeProps Properties forAwsElasticBlockStorePersistentVolume
.AwsElasticBlockStoreVolumeOptions Options ofVolume.fromAwsElasticBlockStore
.AzureDiskPersistentVolumeProps Properties forAzureDiskPersistentVolume
.AzureDiskVolumeOptions Options ofVolume.fromAzureDisk
.BasicAuthSecretProps Options forBasicAuthSecret
.ClusterRoleBindingProps Properties forClusterRoleBinding
.ClusterRolePolicyRule Policy rule of a `ClusterRole.ClusterRoleProps Properties forClusterRole
.CommandProbeOptions Options forProbe.fromCommand()
.CommonSecretProps Common properties forSecret
.ConfigMapProps Properties for initialization ofConfigMap
.ConfigMapVolumeOptions Options for the ConfigMap-based volume.ContainerLifecycle Container lifecycle properties.ContainerOpts Optional properties of a container.ContainerPort Represents a network port in a single container.ContainerProps Properties for creating a container.ContainerResources CPU and memory compute resources.ContainerSecurityContextProps Properties forContainerSecurityContext
.CpuResources CPU request and limit.CronJobProps Properties forCronJob
.CsiVolumeOptions Options for the CSI driver based volume.DaemonSetProps Properties forDaemonSet
.DeploymentExposeViaServiceOptions Options forDeployment.exposeViaService
.DeploymentProps Properties forDeployment
.DeploymentStrategyRollingUpdateOptions Options forDeploymentStrategy.rollingUpdate
.DnsOption Custom DNS option.DockerConfigSecretProps Options forDockerConfigSecret
.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.EphemeralStorageResources Emphemeral storage request and limit.ExposeDeploymentViaIngressOptions Options for exposing a deployment via an ingress.ExposeServiceViaIngressOptions Options for exposing a service using an ingress.FromServiceAccountNameOptions GCEPersistentDiskPersistentVolumeProps Properties forGCEPersistentDiskPersistentVolume
.GCEPersistentDiskVolumeOptions Options ofVolume.fromGcePersistentDisk
.HandlerFromHttpGetOptions Options forHandler.fromHttpGet
.HandlerFromTcpSocketOptions Options forHandler.fromTcpSocket
.HorizontalPodAutoscalerProps Properties for HorizontalPodAutoscaler.HostAlias HostAlias holds the mapping between IP and hostnames that will be injected as an entry in the pod's /etc/hosts file.HostPathVolumeOptions Options for a HostPathVolume-based volume.HttpGetProbeOptions Options forProbe.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
.INamespaceSelector Represents an object that can select namespaces.INamespaceSelector.Jsii$Default Internal default implementation forINamespaceSelector
.INetworkPolicyPeer Describes a peer to allow traffic to/from.INetworkPolicyPeer.Jsii$Default Internal default implementation forINetworkPolicyPeer
.IngressProps Properties forIngress
.IngressRule Represents the rules mapping the paths under a specified host to the related backend services.IngressTls Represents the TLS configuration mapping that is passed to the ingress controller for SSL termination.IPersistentVolume Contract of aPersistentVolumeClaim
.IPersistentVolume.Jsii$Default Internal default implementation forIPersistentVolume
.IPersistentVolumeClaim Contract of aPersistentVolumeClaim
.IPersistentVolumeClaim.Jsii$Default Internal default implementation forIPersistentVolumeClaim
.IPodSelector Represents an object that can select pods.IPodSelector.Jsii$Default Internal default implementation forIPodSelector
.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
.IScalable Represents a scalable workload.IScalable.Jsii$Default Internal default implementation forIScalable
.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 Represents an object that can be used as a role binding subject.ISubject.Jsii$Default Internal default implementation forISubject
.JobProps Properties forJob
.LabelSelectorOptions Options forLabelSelector.of
.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.MetricContainerResourceOptions Options forMetric.containerResource()
.MetricObjectOptions Options forMetric.object()
.MetricOptions Base options for a Metric.MountOptions Options for mounts.NamespaceProps Properties forNamespace
.NamespaceSelectorConfig Configuration for selecting namespaces.NamespacesSelectOptions Options forNamespaces.select
.NetworkPolicyAddEgressRuleOptions Options forNetworkPolicy.addEgressRule
.NetworkPolicyPeerConfig Configuration for network peers.NetworkPolicyPortProps Properties forNetworkPolicyPort
.NetworkPolicyProps Properties forNetworkPolicy
.NetworkPolicyRule Describes a rule allowing traffic from / to pods matched by a network policy selector.NetworkPolicyTraffic Describes how the network policy should configure egress / ingress traffic.NodeTaintQueryOptions Options forNodeTaintQuery
.PathMapping Maps a string key to a path within a volume.PersistentVolumeClaimProps Properties forPersistentVolumeClaim
.PersistentVolumeClaimVolumeOptions Options for a PersistentVolumeClaim-based volume.PersistentVolumeProps Properties forPersistentVolume
.PodConnectionsAllowFromOptions Options forPodConnections.allowFrom
.PodConnectionsAllowToOptions Options forPodConnections.allowTo
.PodDnsProps Properties forPodDns
.PodProps Properties forPod
.PodsAllOptions Options forPods.all
.PodSchedulingAttractOptions Options forPodScheduling.attract
.PodSchedulingColocateOptions Options forPodScheduling.colocate
.PodSchedulingSeparateOptions Options forPodScheduling.separate
.PodSecurityContextProps Properties forPodSecurityContext
.PodSelectorConfig Configuration for selecting pods, optionally in particular namespaces.PodsSelectOptions Options forPods.select
.ProbeOptions Probe options.ResourceProps Initialization properties for resources.RoleBindingProps Properties forRoleBinding
.RolePolicyRule Policy rule of a `Role.RoleProps Properties forRole
.ScalingPolicy ScalingRules Defines the scaling behavior for one direction.ScalingTarget Properties used to configure the target of an Autoscaler.SecretProps Options forSecret
.SecretValue Represents a specific value in JSON secret.SecretVolumeOptions Options for the Secret-based volume.ServiceAccountProps Properties for initialization ofServiceAccount
.ServiceAccountTokenSecretProps Options forServiceAccountTokenSecret
.ServiceBindOptions Options forService.bind
.ServiceIngressBackendOptions Options for setting up backends for ingress rules.ServicePort Definition of a service port.ServiceProps Properties forService
.SshAuthSecretProps Options forSshAuthSecret
.StatefulSetProps Properties for initialization ofStatefulSet
.StatefulSetUpdateStrategyRollingUpdateOptions Options forStatefulSetUpdateStrategy.rollingUpdate
.SubjectConfiguration Subject contains a reference to the object or user identities a role binding applies to.Sysctl Sysctl defines a kernel parameter to be set.TcpSocketProbeOptions Options forProbe.fromTcpSocket()
.TlsSecretProps Options forTlsSecret
.VolumeMount Mount a volume from the pod to the container.WorkloadProps Properties forWorkload
.WorkloadSchedulingSpreadOptions Options forWorkloadScheduling.spread
. -
Enum Summary Enum Description AzureDiskPersistentVolumeCachingMode Azure disk caching modes.AzureDiskPersistentVolumeKind Azure Disk kinds.ConcurrencyPolicy Concurrency policy for CronJobs.ConnectionScheme DnsPolicy Pod DNS policies.EmptyDirMedium The medium on which to store the volume.EnvFieldPaths FsGroupChangePolicy HostPathVolumeType Host path types.HttpIngressPathType Specify how the path is matched against request paths.ImagePullPolicy MountPropagation NetworkPolicyTrafficDefault Default behaviors of network traffic in policies.NetworkProtocol Network protocols.PersistentVolumeAccessMode Access Modes.PersistentVolumeMode Volume Modes.PersistentVolumeReclaimPolicy Reclaim Policies.PodConnectionsIsolation Isolation determines which policies are created when allowing connections from a a pod / workload to peers.PodManagementPolicy Controls how pods are created during initial scale up, when replacing pods on nodes, or when scaling down.Protocol Network protocols.ResourceFieldPaths RestartPolicy Restart policy for all containers within the pod.ScalingStrategy 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.TaintEffect Taint effects.