| Name | helm-hawk JSON |
| Version |
0.0.7
JSON |
| download |
| home_page | None |
| Summary | None |
| upload_time | 2024-09-18 11:21:28 |
| maintainer | None |
| docs_url | None |
| author | Ankit Singh |
| requires_python | >=3.8 |
| license | None |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
Control all your operations with helm-hawk!
===========================================
Introduction
------------
helm-hawk is build on top of helm. This CLI provides you with a set of commands to manage your resources. You can use the following commands:
* **diff**: Group of commands for comparing two versions of helm chart
* **get**: Group of commands to retrieve information from the server
* **history**: Command related to the history of changes in a project.
* **rollback**: This command rolls back a release to a previous revision.
* **status**: This command shows the status of a named release.
* **upgrade**: This command upgrades a release to a new version of a chart.
* **uninstall**: This command takes a release name and uninstalls the release.
Global Options
------------
* **\--context (-c)**: Specify the name of the context you want to use
* **\--namespace (-n)**: Indicate the namespace for which you want to see the resources
Requirements
------------
[Helm3](https://helm.sh/docs/intro/install/) \
[Kubectl](https://kubernetes.io/docs/tasks/tools/#kubectl)
## Installation
Install `helm-hawk` using pip:
```bash
pip install helm-hawk
```
## Usage
```bash
helm-hawk [OPTIONS] COMMAND [ARGS]...
```
### Options
- `-c, --context`: Name of the context you want to use
- `-n, --namespace`: Namespace for which you want to see the resources.
- `--help`: Show this message and exit.
### Commands
#### `diff`
Group of commands for comparing two versions of Helm chart
```bash
helm-hawk diff [OPTIONS] COMMAND [ARGS]...
```
##### Options
- `--help`: Show this message and exit.
##### Commands
- `revision`: Show a diff of a specific revision against the last known one.
- `upgrade`: Show a diff explaining what a Helm upgrade would change.
#### `get`
Group of commands to retrieve information from the server
```bash
helm-hawk get [OPTIONS] COMMAND [ARGS]...
```
##### Options
- `--help`: Show this message and exit.
##### Commands
- `values`: Fetches values for a specific release
#### `history`
Commands related to the history of changes in a project.
```bash
helm-hawk history [OPTIONS] RELEASE_NAME
```
##### Options
- `--max INTEGER`: Maximum number of revisions to include in history (default 256)
- `-c, --context TEXT`: Context that you want to use
- `-n, --namespace TEXT`: Namespace you want to use
- `--help`: Show this message and exit.
#### `rollback`
This command rolls back a release to a previous revision.
```bash
helm-hawk rollback [OPTIONS] RELEASE_NAME REVISION
```
##### Options
- `-c, --context TEXT`: Context that you want to use
- `-n, --namespace TEXT`: Namespace you want to use
- `--dry-run`: Simulate a rollback
- `--no-hooks`: Prevent hooks from running during rollback
- `--help`: Show this message and exit.
#### `status`
This command shows the status of a named release.
```bash
helm-hawk status [OPTIONS] RELEASE_NAME
```
##### Options
- `-c, --context TEXT`: Context that you want to use
- `-n, --namespace TEXT`: Namespace you want to use
- `--revision TEXT`: If set, display the status of the named release with revision
- `-o, --output TEXT`: Prints the output in the specified format. Allowed values: table, json, yaml (default table)
- `--show-desc`: If set, display the description message of the named release
- `--help`: Show this message and exit.
#### `uninstall`
This command takes a release name and uninstalls the release.
```bash
helm-hawk uninstall [OPTIONS] RELEASE_NAME
```
##### Options
- `-c, --context TEXT`: Context that you want to use
- `-n, --namespace TEXT`: Namespace you want to use
- `--dry-run`: Simulate the upgrade
- `--help`: Show this message and exit.
#### `upgrade`
This command upgrades a release to a new version of a chart.
```bash
helm-hawk upgrade [OPTIONS] RELEASE_NAME CHART_PATH
```
##### Options
- `-f, --values TEXT`: Specify values in a YAML file (can specify multiple)
- `-c, --context TEXT`: Context that you want to use
- `-n, --namespace TEXT`: Namespace you want to use
- `--dry-run`: Simulate the upgrade
- `--help`: Show this message and exit.
```
Raw data
{
"_id": null,
"home_page": null,
"name": "helm-hawk",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": null,
"author": "Ankit Singh",
"author_email": "as8356047@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/6a/ae/24f71f991d6d42e04821f386ae4274f5e5b720cb4448c74402e39bff757d/helm_hawk-0.0.7.tar.gz",
"platform": null,
"description": "Control all your operations with helm-hawk!\n===========================================\n\nIntroduction\n------------\n\nhelm-hawk is build on top of helm. This CLI provides you with a set of commands to manage your resources. You can use the following commands:\n\n* **diff**: Group of commands for comparing two versions of helm chart\n \n* **get**: Group of commands to retrieve information from the server\n \n* **history**: Command related to the history of changes in a project.\n \n* **rollback**: This command rolls back a release to a previous revision.\n \n* **status**: This command shows the status of a named release.\n \n* **upgrade**: This command upgrades a release to a new version of a chart.\n \n* **uninstall**: This command takes a release name and uninstalls the release.\n \n\nGlobal Options\n------------\n\n\n* **\\--context (-c)**: Specify the name of the context you want to use\n \n* **\\--namespace (-n)**: Indicate the namespace for which you want to see the resources\n \n\nRequirements\n------------\n\n[Helm3](https://helm.sh/docs/intro/install/) \\\n[Kubectl](https://kubernetes.io/docs/tasks/tools/#kubectl)\n\n\n\n## Installation\n\nInstall `helm-hawk` using pip:\n\n```bash\npip install helm-hawk\n```\n\n## Usage\n\n```bash\nhelm-hawk [OPTIONS] COMMAND [ARGS]...\n```\n\n### Options\n\n- `-c, --context`: Name of the context you want to use\n- `-n, --namespace`: Namespace for which you want to see the resources.\n- `--help`: Show this message and exit.\n\n### Commands\n\n#### `diff`\n\nGroup of commands for comparing two versions of Helm chart\n\n```bash\nhelm-hawk diff [OPTIONS] COMMAND [ARGS]...\n```\n\n##### Options\n\n- `--help`: Show this message and exit.\n\n##### Commands\n\n- `revision`: Show a diff of a specific revision against the last known one.\n- `upgrade`: Show a diff explaining what a Helm upgrade would change.\n\n#### `get`\n\nGroup of commands to retrieve information from the server\n\n```bash\nhelm-hawk get [OPTIONS] COMMAND [ARGS]...\n```\n\n##### Options\n\n- `--help`: Show this message and exit.\n\n##### Commands\n\n- `values`: Fetches values for a specific release\n\n#### `history`\n\nCommands related to the history of changes in a project.\n\n```bash\nhelm-hawk history [OPTIONS] RELEASE_NAME\n```\n\n##### Options\n\n- `--max INTEGER`: Maximum number of revisions to include in history (default 256)\n- `-c, --context TEXT`: Context that you want to use\n- `-n, --namespace TEXT`: Namespace you want to use\n- `--help`: Show this message and exit.\n\n#### `rollback`\n\nThis command rolls back a release to a previous revision.\n\n```bash\nhelm-hawk rollback [OPTIONS] RELEASE_NAME REVISION\n```\n\n##### Options\n\n- `-c, --context TEXT`: Context that you want to use\n- `-n, --namespace TEXT`: Namespace you want to use\n- `--dry-run`: Simulate a rollback\n- `--no-hooks`: Prevent hooks from running during rollback\n- `--help`: Show this message and exit.\n\n#### `status`\n\nThis command shows the status of a named release.\n\n```bash\nhelm-hawk status [OPTIONS] RELEASE_NAME\n```\n\n##### Options\n\n- `-c, --context TEXT`: Context that you want to use\n- `-n, --namespace TEXT`: Namespace you want to use\n- `--revision TEXT`: If set, display the status of the named release with revision\n- `-o, --output TEXT`: Prints the output in the specified format. Allowed values: table, json, yaml (default table)\n- `--show-desc`: If set, display the description message of the named release\n- `--help`: Show this message and exit.\n\n#### `uninstall`\n\nThis command takes a release name and uninstalls the release.\n\n```bash\nhelm-hawk uninstall [OPTIONS] RELEASE_NAME\n```\n\n##### Options\n\n- `-c, --context TEXT`: Context that you want to use\n- `-n, --namespace TEXT`: Namespace you want to use\n- `--dry-run`: Simulate the upgrade\n- `--help`: Show this message and exit.\n\n#### `upgrade`\n\nThis command upgrades a release to a new version of a chart.\n\n```bash\nhelm-hawk upgrade [OPTIONS] RELEASE_NAME CHART_PATH\n```\n\n##### Options\n\n- `-f, --values TEXT`: Specify values in a YAML file (can specify multiple)\n- `-c, --context TEXT`: Context that you want to use\n- `-n, --namespace TEXT`: Namespace you want to use\n- `--dry-run`: Simulate the upgrade\n- `--help`: Show this message and exit.\n\n```\n",
"bugtrack_url": null,
"license": null,
"summary": null,
"version": "0.0.7",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "114185cacb1950457f0dfa9385b8b73f445b9368c8f462d1a826267135fe971f",
"md5": "956b49b31caa7db4e74d5ebc81061bcc",
"sha256": "00d99b32ba95bbd059e89169ace9d93ec71cd09ea1c6a45811e8ab7685951339"
},
"downloads": -1,
"filename": "helm_hawk-0.0.7-py3-none-any.whl",
"has_sig": false,
"md5_digest": "956b49b31caa7db4e74d5ebc81061bcc",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 24117,
"upload_time": "2024-09-18T11:21:27",
"upload_time_iso_8601": "2024-09-18T11:21:27.021061Z",
"url": "https://files.pythonhosted.org/packages/11/41/85cacb1950457f0dfa9385b8b73f445b9368c8f462d1a826267135fe971f/helm_hawk-0.0.7-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "6aae24f71f991d6d42e04821f386ae4274f5e5b720cb4448c74402e39bff757d",
"md5": "3414a6fad6c69e569d191c903b0c1a83",
"sha256": "633b9a8b21db6956d7bac17dc5a47679ecf02f9029aff7c13125b98c2ed093fe"
},
"downloads": -1,
"filename": "helm_hawk-0.0.7.tar.gz",
"has_sig": false,
"md5_digest": "3414a6fad6c69e569d191c903b0c1a83",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 16899,
"upload_time": "2024-09-18T11:21:28",
"upload_time_iso_8601": "2024-09-18T11:21:28.510813Z",
"url": "https://files.pythonhosted.org/packages/6a/ae/24f71f991d6d42e04821f386ae4274f5e5b720cb4448c74402e39bff757d/helm_hawk-0.0.7.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-18 11:21:28",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "helm-hawk"
}
