@Stability(Stable)

Package org.cdk8s

cdk8s

Cloud Development Kit for Kubernetes

cdk8s is a software development framework for defining Kubernetes applications using rich object-oriented APIs. It allows developers to leverage the full power of software in order to define abstract components called "constructs" which compose Kubernetes resources or other constructs into higher-level abstractions.

Note: This repository is the "core library" of cdk8s, with logic for synthesizing Kubernetes manifests using the constructs framework. It is published to NPM as cdk8s and should not be confused with the cdk8s command-line tool cdk8s-cli. For more general information about cdk8s, please see cdk8s.io, or visit the umbrella repository located at cdk8s-team/cdk8s.

Documentation

See cdk8s.io.

License

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

This module is part of the cdk8s project.

Interface Summary

Interface	Description
ApiObjectMetadata	Metadata associated with this object.
ApiObjectMetadataDefinitionOptions	Options for ApiObjectMetadataDefinition.
ApiObjectProps	Options for defining API objects.
AppProps
ChartProps
CronOptions	Options to configure a cron expression.
GroupVersionKind
HelmProps	Options for Helm.
IAnyProducer
IAnyProducer.Jsii$Default	Internal default implementation for IAnyProducer.
IncludeProps
IResolver	Contract for resolver objects.
IResolver.Jsii$Default	Internal default implementation for IResolver.
NameOptions	Options for name generation.
OwnerReference	OwnerReference contains enough information to let you identify an owning object.
SizeConversionOptions	Options for how to convert time to a different unit.
TimeConversionOptions	Options for how to convert time to a different unit.

Class Summary

Class	Description
ApiObject
ApiObject.Builder	A fluent builder for ApiObject.
ApiObjectMetadata.Builder	A builder for ApiObjectMetadata
ApiObjectMetadata.Jsii$Proxy	An implementation for ApiObjectMetadata
ApiObjectMetadataDefinition	Object metadata.
ApiObjectMetadataDefinition.Builder	A fluent builder for ApiObjectMetadataDefinition.
ApiObjectMetadataDefinitionOptions.Builder	A builder for ApiObjectMetadataDefinitionOptions
ApiObjectMetadataDefinitionOptions.Jsii$Proxy	An implementation for ApiObjectMetadataDefinitionOptions
ApiObjectProps.Builder	A builder for ApiObjectProps
ApiObjectProps.Jsii$Proxy	An implementation for ApiObjectProps
App	Represents a cdk8s application.
App.Builder	A fluent builder for App.
AppProps.Builder	A builder for AppProps
AppProps.Jsii$Proxy	An implementation for AppProps
Chart
Chart.Builder	A fluent builder for Chart.
ChartProps.Builder	A builder for ChartProps
ChartProps.Jsii$Proxy	An implementation for ChartProps
Cron	Represents a cron schedule.
Cron.Builder	A fluent builder for Cron.
CronOptions.Builder	A builder for CronOptions
CronOptions.Jsii$Proxy	An implementation for CronOptions
DependencyGraph	Represents the dependency graph for a given Node.
DependencyVertex	Represents a vertex in the graph.
Duration	Represents a length of time.
GroupVersionKind.Builder	A builder for GroupVersionKind
GroupVersionKind.Jsii$Proxy	An implementation for GroupVersionKind
Helm	Represents a Helm deployment.
Helm.Builder	A fluent builder for Helm.
HelmProps.Builder	A builder for HelmProps
HelmProps.Jsii$Proxy	An implementation for HelmProps
IAnyProducer.Jsii$Proxy	A proxy class which represents a concrete javascript instance of this type.
ImplicitTokenResolver	Resolves implicit tokens.
Include	Reads a YAML manifest from a file or a URL and defines all resources as API objects within the defined scope.
Include.Builder	A fluent builder for Include.
IncludeProps.Builder	A builder for IncludeProps
IncludeProps.Jsii$Proxy	An implementation for IncludeProps
IResolver.Jsii$Proxy	A proxy class which represents a concrete javascript instance of this type.
JsonPatch	Utility for applying RFC-6902 JSON-Patch to a document.
Lazy
LazyResolver	Resolvers instanecs of Lazy.
NameOptions.Builder	A builder for NameOptions
NameOptions.Jsii$Proxy	An implementation for NameOptions
Names	Utilities for generating unique and stable names.
NumberStringUnionResolver	Resolves union types that allow using either number or string (as generated by the CLI).
OwnerReference.Builder	A builder for OwnerReference
OwnerReference.Jsii$Proxy	An implementation for OwnerReference
ResolutionContext	Context object for a specific resolution process.
Size	Represents the amount of digital storage.
SizeConversionOptions.Builder	A builder for SizeConversionOptions
SizeConversionOptions.Jsii$Proxy	An implementation for SizeConversionOptions
Testing	Testing utilities for cdk8s applications.
TimeConversionOptions.Builder	A builder for TimeConversionOptions
TimeConversionOptions.Jsii$Proxy	An implementation for TimeConversionOptions
Yaml	YAML utilities.

Enum Summary

Enum	Description
SizeRoundingBehavior	Rounding behaviour when converting between units of Size.
YamlOutputType	The method to divide YAML output into files.