yxh1990 / cdk8s

Define Kubernetes native apps and abstractions using object-oriented programming

cdk8s

Cloud Development Kit for Kubernetes

cdk8s is a software development framework for defining Kubernetes applications and reusable abstractions using familiar programming languages and rich object-oriented APIs. cdk8s generates pure Kubernetes YAML - you can use cdk8s to define applications for any Kubernetes cluster running anywhere.

This is an early-stage, experimental project built with ❤️ by AWS. We encourage you to try it out, leave feedback, and jump in to help!

Contents

• Overview
• Getting Started
• Examples
• Help & Feedback
• Contributing
• Roadmap
• License

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.

Getting Started

Choose your weapon:

• TypeScript
• Python

Examples

• Hello! - a basic Kubernetes deployment
• Web Service - an example of using constructs to template a web service
• Podinfo - an example of high-level APIs for Kubernetes objects.

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
• Mailing list: cdk8s
• Slack: cdk8s.slack.com

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.

Roadmap

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

License

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