| Name | cdk8s-cli JSON |
| Version |
0.1.0a3
JSON |
| download |
| home_page | None |
| Summary | A simple CLI for cdk8s |
| upload_time | 2024-10-06 16:56:44 |
| maintainer | None |
| docs_url | None |
| author | Matthew Cane |
| requires_python | <4.0,>=3.12 |
| license | None |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# 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
```bash
python3 main.py synth --all
```
#### Synth selected apps
```bash
python3 main.py synth --apps dev prod
```
### Options
```text
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](examples/simple)
A very basic example containing a chart with a few simple resources in a single file deployed as a single stage.
### [Complex Example](examples/complex)
A more complex example with multiple charts and multiple stages.
Raw data
{
"_id": null,
"home_page": null,
"name": "cdk8s-cli",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.12",
"maintainer_email": null,
"keywords": null,
"author": "Matthew Cane",
"author_email": "matthew.cane0@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/8d/eb/a2f4b182328293b281964901b7db77df6ebd45ee7e52a7277aa476c6f262/cdk8s_cli-0.1.0a3.tar.gz",
"platform": null,
"description": "# CDK8S CLI\n\n**A CLI extension to cdk8s.**\n\nThis is a work-in-progress project with no promise of continued support or development. This is not sutable for production applications.\n\n## Features\n\nThis provides extensions to standard cdk8s object to facilitate application deployments to a cluster without any external tooling using a simple CLI.\n\n## Usage\n\n### Example CLI Usage\n\n#### Synth all apps\n\n```bash\npython3 main.py synth --all\n```\n\n#### Synth selected apps\n\n```bash\npython3 main.py synth --apps dev prod\n```\n\n### Options\n\n```text\npositional arguments:\n {deploy,synth,list} The action to perform.\n\noptions:\n -h, --help show this help message and exit\n --apps APPS [APPS ...]\n the apps to deploy in a space seperated list\n --all deploy all apps\n --context CONTEXT The Kubernetes context to use. Defaults to minikube\n --kube-config-file KUBE_CONFIG_FILE\n the path to a kubeconfig file\n --verbose enable verbose output\n --unattended enable unattended mode. This will not prompt for confirmation before deploying.\n```\n\n## Development\n\nThis project is built using:\n\n- Poetry as the package manager\n- Ruff for formatting and linting\n\n### Features to be implemented\n\n- [ ] Unit tests\n- [ ] End-to-end tests\n- [ ] Complete documentation\n- [ ] Improve customisation\n- [ ] Diff functionality\n\n## Examples\n\nExamples can be run using `poetry run python3 examples/<example>/main.py synth --all`\n\n### [Simple Example](examples/simple)\n\nA very basic example containing a chart with a few simple resources in a single file deployed as a single stage.\n\n### [Complex Example](examples/complex)\n\nA more complex example with multiple charts and multiple stages.\n\n",
"bugtrack_url": null,
"license": null,
"summary": "A simple CLI for cdk8s",
"version": "0.1.0a3",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "fb7f04cbf6d9f8739c65df0389fff90f5415fab8a12ed457ef5be6c95be0d5f3",
"md5": "57676a1b35a4dcd1978ff7eb22912969",
"sha256": "5760accb71cacba8af823ca11492dc8e7afcf86d1c099e011ac39d560775576b"
},
"downloads": -1,
"filename": "cdk8s_cli-0.1.0a3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "57676a1b35a4dcd1978ff7eb22912969",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.12",
"size": 4805,
"upload_time": "2024-10-06T16:56:43",
"upload_time_iso_8601": "2024-10-06T16:56:43.457156Z",
"url": "https://files.pythonhosted.org/packages/fb/7f/04cbf6d9f8739c65df0389fff90f5415fab8a12ed457ef5be6c95be0d5f3/cdk8s_cli-0.1.0a3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "8deba2f4b182328293b281964901b7db77df6ebd45ee7e52a7277aa476c6f262",
"md5": "75b0bf43a63408b967a7a1f873e77551",
"sha256": "cda99f6683520cfece89713037d594278c96c384a69589be338c6649ba071831"
},
"downloads": -1,
"filename": "cdk8s_cli-0.1.0a3.tar.gz",
"has_sig": false,
"md5_digest": "75b0bf43a63408b967a7a1f873e77551",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.12",
"size": 4213,
"upload_time": "2024-10-06T16:56:44",
"upload_time_iso_8601": "2024-10-06T16:56:44.640684Z",
"url": "https://files.pythonhosted.org/packages/8d/eb/a2f4b182328293b281964901b7db77df6ebd45ee7e52a7277aa476c6f262/cdk8s_cli-0.1.0a3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-06 16:56:44",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "cdk8s-cli"
}
