Skip to main content

CDK construct library to deploy KubeSphere on AWS

Project description

NPM version PyPI version Release


cdk-kubesphere is a CDK construct library that allows you to create KubeSphere on AWS with CDK in TypeScript, JavaScript or Python.


import { KubeSphere } from 'cdk-kubesphere';

const app = new cdk.App();

const stack = new cdk.Stack(app, 'cdk-kubesphere-demo');

// deploy a default KubeSphere service on a new Amazon EKS cluster
new KubeSphere(stack, 'KubeSphere');

Behind the scene, the KubeSphere construct creates a default Amazon EKS cluster and KubeSphere serivce with helm chart(ks-installer) on it.

View helm command AWS CDK will helm install the `ks-installer` on the cluster:
helm install ks-installer \
--repo \
--namespace=kubesphere-system \
--generate-name \

KubeSphere App Store

Use appStore to enable the KubeSphere App Store support.

new KubeSphere(stack, 'KubeSphere', {
  appStore: true,
View helm command AWS CDK will helm install the `ks-installer` on the cluster:
helm install ks-installer \
--set openpitrix.enabled=true \
--repo \
--namespace=kubesphere-system \
--generate-name \

Using existing Amazon EKS clusters

You are allowed to deploy KubeSphere in any existing Amazon EKS cluster.

const cluster = eks.Cluster.fromClusterAttributes(this, 'MyCluster', {
  clusterName: 'my-cluster-name',
  kubectlRoleArn: 'arn:aws:iam::1111111:role/iam-role-that-has-masters-access',

// deploy a default KubeSphere service on the existing Amazon EKS cluster
new KubeSphere(stack, 'KubeSphere', { cluster });

See Using existing clusters to learn how to import existing cluster in AWS CDK.


Run the following command to create a port-forward from localhost:8888 to ks-console:80

kubectl -n kubesphere-system port-forward service/ks-console 8888:80

Open http://localhost:8888 and enter the default username/password(admin/P@88w0rd) to enter the admin console.

Project details

Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

cdk-kubesphere-2.0.143.tar.gz (31.4 kB view hashes)

Uploaded source

Built Distribution

cdk_kubesphere-2.0.143-py3-none-any.whl (29.9 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page