MCPcopy
hub / github.com/cdk8s-team/cdk8s

github.com/cdk8s-team/cdk8s @v0.33.0 sqlite

repository ↗ · DeepWiki ↗ · release v0.33.0 ↗
8,231 symbols 10,852 edges 140 files 3,552 documented · 43%
README

Cloud Development Kit for Kubernetes

Stability:Alpha Release npm version PyPI version NuGet version Maven Central homebrew

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

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.

At a glance

Getting Started

Choose your weapon:

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):

Examples

See our Examples Directory.

Roadmap

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

Community

See Awesome cdk8s.

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.

Join us for the cdk8s community meeting which takes place the 2nd Monday of the month at 9:00am Pacific Time.

License

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

Extension points exported contracts — how you extend this code

IPodSpec (Interface)
(no doc) [6 implementers]
packages/cdk8s-plus/src/pod.ts
IContainer (Interface)
(no doc) [2 implementers]
examples/typescript/podinfo/lib/deployment.ts
IAnyProducer (Interface)
(no doc) [1 implementers]
packages/cdk8s/src/lazy.ts
ImportSpec (Interface)
(no doc)
packages/cdk8s-cli/src/config.ts
ClusterInstallationOptions (Interface)
(no doc)
test/test-imports/typescript/expected-from-cli/mattermost.com/clusterinstallation.ts
IPodTemplate (Interface)
(no doc) [3 implementers]
packages/cdk8s-plus/src/pod.ts
ISelector (Interface)
(no doc) [1 implementers]
examples/typescript/podinfo/lib/service.ts
IncludeOptions (Interface)
(no doc)
packages/cdk8s/src/include.ts

Core symbols most depended-on inside this repo

items
called by 505
test/test-imports/python/expected-from-config/k8s/__init__.py
items
called by 134
test/test-imports/python/expected-from-config/jenkins/io/jenkins/__init__.py
synth
called by 91
packages/cdk8s/src/app.ts
chart
called by 76
packages/cdk8s/src/testing.ts
of
called by 67
packages/cdk8s/src/app.ts
app
called by 38
packages/cdk8s/src/testing.ts
_toKube
called by 33
packages/cdk8s-plus/src/job.ts
toJson
called by 32
packages/cdk8s/src/chart.ts

Shape

Method 5,564
Class 1,415
Interface 1,090
Function 149
Enum 13

Languages

Python70%
TypeScript29%
Java1%

Modules by API surface

test/test-imports/python/expected-from-config/k8s/__init__.py3,162 symbols
test/test-imports/python/expected-from-config/jenkins/io/jenkins/__init__.py1,174 symbols
test/test-imports/typescript/expected-from-config/k8s.ts673 symbols
packages/cdk8s-plus/src/imports/k8s.ts673 symbols
test/test-imports/python/expected-named-from-cli/mattermost/mattermost/com/clusterinstallation/__init__.py473 symbols
test/test-imports/python/expected-from-config/mattermost/mattermost/com/clusterinstallation/__init__.py473 symbols
test/test-imports/python/expected-from-cli/mattermost/com/clusterinstallation/__init__.py473 symbols
test/test-imports/typescript/expected-from-config/jenkins.io/jenkins.ts177 symbols
website/static/js/webflow.js93 symbols
test/test-imports/typescript/expected-named-from-cli/mattermost-mattermost.com/clusterinstallation.ts78 symbols
test/test-imports/typescript/expected-from-config/mattermost-mattermost.com/clusterinstallation.ts78 symbols
test/test-imports/typescript/expected-from-cli/mattermost.com/clusterinstallation.ts78 symbols

Dependencies from manifests, versioned

com.google.guava:guava29.0-jre · 1×
org.cdk8s:cdk8s{{ cdk8s_version }} · 1×
org.cdk8s:cdk8s-plus{{ cdk8s_version }} · 1×
software.constructs:constructs{{ constructs_versio · 1×
@types/follow-redirects1.8.0 · 1×
@types/fs-extra8.1.0 · 1×
@types/jest26.0.7 · 1×
@types/json-schema7.0.5 · 1×
@types/json-stable-stringify1.0.32 · 1×
@types/minimatch3.0.3 · 1×
@types/node10.17.0 · 1×
@types/yaml1.2.0 · 1×

For agents

$ claude mcp add cdk8s \
  -- python -m otcore.mcp_server <graph>

⬇ download graph artifact