Skip to main content

A simple CLI for cdk8s

Project description

CDK8S CLI

A CLI extension to cdk8s.

This is a work-in-progress project with no promise of continued support or development. This is not sutable for production applications.

Features

This provides extensions to standard cdk8s object to facilitate application deployments to a cluster without any external tooling using a simple CLI.

Usage

Example CLI Usage

Synth all apps

python3 main.py synth --all

Synth selected apps

python3 main.py synth --apps dev prod

Options

positional arguments:
  {deploy,synth,list}   The action to perform.

options:
  -h, --help            show this help message and exit
  --apps APPS [APPS ...]
                        the apps to deploy in a space seperated list
  --all                 deploy all apps
  --context CONTEXT     The Kubernetes context to use. Defaults to minikube
  --kube-config-file KUBE_CONFIG_FILE
                        the path to a kubeconfig file
  --verbose             enable verbose output
  --unattended          enable unattended mode. This will not prompt for confirmation before deploying.

Development

This project is built using:

  • Poetry as the package manager
  • Ruff for formatting and linting

Features to be implemented

  • Unit tests
  • End-to-end tests
  • Complete documentation
  • Improve customisation
  • Diff functionality

Examples

Examples can be run using poetry run python3 examples/<example>/main.py synth --all

Simple Example

A very basic example containing a chart with a few simple resources in a single file deployed as a single stage.

Complex Example

A more complex example with multiple charts and multiple stages.

Project details


Download files

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

Source Distribution

cdk8s_cli-0.1.0a2.tar.gz (3.7 kB view details)

Uploaded Source

Built Distribution

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

cdk8s_cli-0.1.0a2-py3-none-any.whl (4.4 kB view details)

Uploaded Python 3

File details

Details for the file cdk8s_cli-0.1.0a2.tar.gz.

File metadata

  • Download URL: cdk8s_cli-0.1.0a2.tar.gz
  • Upload date:
  • Size: 3.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for cdk8s_cli-0.1.0a2.tar.gz
Algorithm Hash digest
SHA256 487e3a6674ad491ebf8edf84576ac6a4799223c676c0859cd1c21935b2f85df1
MD5 2310fd02e679ad4fb504a85abc09572e
BLAKE2b-256 7bb21bfebe90cdcc910cabbe7fe84172649d94d6278585b427dbd1b84ba51da4

See more details on using hashes here.

File details

Details for the file cdk8s_cli-0.1.0a2-py3-none-any.whl.

File metadata

  • Download URL: cdk8s_cli-0.1.0a2-py3-none-any.whl
  • Upload date:
  • Size: 4.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for cdk8s_cli-0.1.0a2-py3-none-any.whl
Algorithm Hash digest
SHA256 15c3664eaf4af1f3492eecec17dafacb508ee0e0387e86e4768efc508673b8b6
MD5 d9baf40c55d2d20c1e29d017020d313c
BLAKE2b-256 b8f86602c020d642028e9f043d30d6ec54bb3392aa658e9d3318b82170f65390

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