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.0a0.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.0a0-py3-none-any.whl (4.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: cdk8s_cli-0.1.0a0.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.0a0.tar.gz
Algorithm Hash digest
SHA256 2edf0194153b7c371880e2ce23be470174e66b988a609048e4c0cc2b0a5ff509
MD5 3287c72b2182cbecad942817ca23c079
BLAKE2b-256 c512f0fbf20fb1c02feb2119e5bd76cafa5007055368daad205ea8bbc6ed1211

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cdk8s_cli-0.1.0a0-py3-none-any.whl
  • Upload date:
  • Size: 4.3 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.0a0-py3-none-any.whl
Algorithm Hash digest
SHA256 f732a52cb382b11874850f72de7115a2e3bdd85aa5e3dfe9132ed5966ba1f259
MD5 6bdc7ac5d3464763f371e8bf3d925994
BLAKE2b-256 315225935e57f9f4b3fd6ba8ea893b68695f754e2939e15339d223633b2eadc5

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