Cloud Development Kit for Kubernetes

cdk8s is an open-source software development framework for defining Kubernetes applications and reusable abstractions using familiar programming languages and rich object-oriented APIs. cdk8s apps synthesize into standard Kubernetes manifests which can be applied to any Kubernetes cluster.

cdk8s is a Cloud Native Computing Foundation Sandbox Project, built with ❤️ at AWS. We encourage you to try it out, leave feedback, and jump in to help!

Contents:

• Repositories
• Overview
• Getting Started
• Help & Feedback
• Documentation
• Examples
• Roadmap
• Community
• Contributing
• CDK8s.io website
• License

Repositories

This project consists of multiple packages, maintained and released via the following repositories:

• cdk8s - Core library. For historical reasons note that the cdk8s package is maintained in the cdk8s-team/cdk8s-core repository.
• cdk8s-cli - Command-Line interface.
• cdk8s-plus - High-Level constructs for Kubernetes core.

The current repository acts as an umbrella repository for cross module concerns, as well as the deployment of cdk8s.io

Overview

cdk8s apps are programs written in one of the supported programming languages. They are structured as a tree of constructs.

The root of the tree is an App construct. Within an app, users define any number of charts (classes that extend the Chart class). Each chart is synthesized into a separate Kubernetes manifest file. Charts are, in turn, composed of any number of constructs, and eventually from resources, which represent any Kubernetes resource, such as Pod, Service, Deployment, ReplicaSet, etc.

cdk8s apps only define Kubernetes applications, they don't actually apply them to the cluster. When an app is executed, it synthesizes all the charts defined within the app into the dist directory, and then those charts can be applied to any Kubernetes cluster using kubectl apply -f dist/chart.k8s.yaml or a GitOps tool like Flux.

cdk8s is based on the design concepts and technologies behind the AWS Cloud Development Kit, and can interoperate with AWS CDK constructs to define cloud-native applications that include both Kubernetes resources and other CDK constructs as first class citizens.

Read our blog or watch our CNCF webinar to learn more and see a live demo of cdk8s in action.

Getting Started

See the Getting Started guide in cdk8s Documentation.

Help & Feedback

Interacting with the community and the development team is a great way to contribute to the project. Please consider the following venues (in order):

• Search open issues
• Stack Overflow: cdk8s
• File a new issue
• Slack: #cdk8s channel in cdk.dev

Documentation

See cdk8s Documentation.

Examples

See our Examples Directory.

Roadmap

See our roadmap for details about our plans for the project.

Community

See Awesome cdk8s.

If you're a cdk8s user please consider adding your name to the ADOPTERS file.

Contributing

The cdk8s project adheres to the CNCF Code of Conduct.

We welcome community contributions and pull requests. See our contribution guide for more information on how to report issues, set up a development environment and submit code.

CDK8s.io website

See Docs Directory.

License

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