Skip to main content

CDK construct library to deploy KubeSphere on AWS

Project description

NPM version PyPI version Release

cdk-kubesphere

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

Sample

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 https://charts.kubesphere.io/test \
--namespace=kubesphere-system \
--generate-name \
--create-namespace

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 https://charts.kubesphere.io/test \
--namespace=kubesphere-system \
--generate-name \
--create-namespace

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.

Console

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

This version

2.0.4

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.4.tar.gz (30.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

cdk_kubesphere-2.0.4-py3-none-any.whl (28.9 kB view details)

Uploaded Python 3

File details

Details for the file cdk-kubesphere-2.0.4.tar.gz.

File metadata

  • Download URL: cdk-kubesphere-2.0.4.tar.gz
  • Upload date:
  • Size: 30.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.10.2

File hashes

Hashes for cdk-kubesphere-2.0.4.tar.gz
Algorithm Hash digest
SHA256 f3f9097e8a81d10b33c0d41896fcc96963f95b21443c5a527d312fe1b5c3d94c
MD5 82b81e29da7a310d230d55f8bd057b2d
BLAKE2b-256 b9600a3468a7e2bd97dbf3885d08de0779d2733e4ddc7fabc863caa64e6889e0

See more details on using hashes here.

File details

Details for the file cdk_kubesphere-2.0.4-py3-none-any.whl.

File metadata

  • Download URL: cdk_kubesphere-2.0.4-py3-none-any.whl
  • Upload date:
  • Size: 28.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.10.2

File hashes

Hashes for cdk_kubesphere-2.0.4-py3-none-any.whl
Algorithm Hash digest
SHA256 463fa3bf4025696824c5c2dd594986de2eff82daa24a04af2849060d02ce9cb9
MD5 163accf89301373819b6e140e8dcda2f
BLAKE2b-256 bf5d8dd7156426732cadcb20331f2837654007a126378bfd4d26b4370c150e34

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page