Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/JovianX/helm-release-plugin
Helm3 plugin that pulls(re-creates) helm Charts from deployed releases, and updates values of deployed releases without the chart.
https://github.com/JovianX/helm-release-plugin
helm kubernetes plugin
Last synced: 12 days ago
JSON representation
Helm3 plugin that pulls(re-creates) helm Charts from deployed releases, and updates values of deployed releases without the chart.
- Host: GitHub
- URL: https://github.com/JovianX/helm-release-plugin
- Owner: JovianX
- License: apache-2.0
- Created: 2022-07-04T12:10:47.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-02-22T20:01:27.000Z (over 1 year ago)
- Last Synced: 2024-04-18T20:50:03.485Z (7 months ago)
- Topics: helm, kubernetes, plugin
- Language: Shell
- Homepage:
- Size: 180 KB
- Stars: 92
- Watchers: 4
- Forks: 9
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
[](https://opensource.org/)
[](https://github.com/JovianX/helm-release-plugin)
[](https://artifacthub.io/packages/helm-plugin/helm-release/release)
[](https://github.com/JovianX/helm-release-plugin/stargazers)
| **Please star ⭐ the repo if you find it useful.** |
| --- |
# Helm3 Plugin `helm-release`
`helm-release` is a Helm 3 plugin that allows running operations on Helm releases (deployed Helm charts).
### ✨ Features:
* 📥 [PULL](#helm-release-pull) to pull (re-create) Helm charts from a deployed helm release.
* 📄 [UPGRADE](#helm-release-upgrade) to Update values of a deployed release, without providing the chart used for release deployment.
* ⏳ [TTL](#helm-release-ttl) to schedule an uninstallation/removal/deletion of a release. [Article](https://dev.to/rtpro/helm-release-time-to-livettl-for-temporary-environments-1239)
### 🫶 Common use-Cases:
* Redeploy a release on another cluster or namespace with the same helm chart.
* Update values of a release, when you are not sure what exact chart version was used, or you don't have access to the original helm chart (Contrary to the `helm upgrade` command which requires the chart).
* configure temporary or ephemeral helm releases so they are automatically deleted after some time and not forgotten on the cluster forever.
## Getting started
### Installation
To install the plugin:
```shell
helm plugin install https://github.com/JovianX/helm-release-plugin
```
>
> Dependencies: `helm-release` plugin depends on:
>> jq - a lightweight and flexible command-line JSON processor.
>> Install: https://stedolan.github.io/jq/download/
>
Update to the latest version:
```shell
$ helm plugin update release
```
Verify it's been installed:
```shell
$ helm plugin list
NAME VERSION DESCRIPTION
...
release 0.3.2 Update values of a release, pull charts from releases
...
```
### Usage
```
$ helm release
usage: helm release [ pull | upgrade ]
```
Available Commands:
* __pull__ - Pulls (re-create) the Helm chart from a deployed Helm release.
* __upgrade__ - Updates Helm release values without the Helm chart.
* __ttl__ - Sets release time to live(TTL) to schedule release automatic delete.
>
> Note: Setting Namespace and Context are supported via helm native flags
> ```
> -n, --namespace string namespace scope for this request`
> --kube-context string name of the kubeconfig context to use
> ```
>
### `helm release pull`
Pulls (re-create) a Helm chart from a deployed Helm release.
```
$ helm release pull
usage: helm release pull [-d | --destination ] [-o | --output [yaml | json | text]]
```
Example:
```
$ helm --namespace nginx release pull nginx --destination /home/me/helm-charts
Chart saved to nginx-ingress-0.13.2
$ ls /home/me/helm-charts/nginx-ingress-0.13.2/
Chart.yaml crds README.md templates values-icp.yaml values-nsm.yaml values-plus.yaml values.yaml
```
>
>Note: Setting namespace`[-n | --namespace ]` or context `[--context]` name as needed)
>
### `helm release upgrade`
Update the Helm release values, without specifying the helm chart. The `helm release upgrade` command accepts the same parameters as `helm upgrade` without specifying the helm chart. `--destination` is an optional parameter to set the directory where the chart is saved, defaults to `/tmp`. After the release is updated the chart is deleted. We recommend setting the `--reuse-values` flag to keep existing values and provide only the values you would like to change.
```
$ helm release upgrade
Update release values without specifying the Helm Chart. Usage: helm release upgrade [RELEASE NAME] [-d | --destination ] [helm upgrade arguments]
```
Example:
```
helm release upgrade rabbitmq --namespace=rabbitmq --set=key1=value1 --reuse-values
...
... standard helm upgrade output ...
Update Complete. ⎈Happy Helming!⎈
```
### `helm release ttl`
Sets release time-to-live(TTL) to schedule automatic release uninstallation. `release ttl` uses Kubernetes CronJob to schedule automatic uninstallation of releases. Helm release TTL supports actions: **set**, **unset** and **get** TTL for a helm release.
| Note: Helm release TTL feature uses `date` binary provided by `coreutils` package. |
| --- |
#### GET TTL
To get the current TTL of a release pass the ``.
```
helm release ttl
```
Supproted outputs: `text`(defaul), `yaml` and `json`.
For example, to see when `redis` release is scheduled for deletion, run:
```
helm release ttl redis
Scheduled release removal date: Tue Aug 30 20:12:00 EEST 2022
```
Same request with `json` output:
```
helm release ttl redis --output=json
{"scheduled_date": "2022-08-30 17:12"}
```
Same request with `yaml` output:
```
helm release ttl redis --output=yaml
scheduled_date: 2022-08-30 17:12
```
| Note: Dates returned in cluster timezone (default UTC). |
| --- |
#### SET TTL
Sets the TTL of a release, after which the release is deleted. Provide `` and `--set` to set the release TTL time using `date` format.
```
helm release ttl --set
```
For example to schedule deletion of a release in `five minutes, run:
```
helm release ttl redis --set='5 minutes'
cronjob.batch/redis-ttl created
```
> Refer to complete `` [documentation](https://www.gnu.org/software/ coreutils/manual/html_node/Relative-items-in-date-strings.html) for
> detailed description of possible time delta options.
If TTL is configured (CronJob exists) and the `--set` command is executed again the TTL(CronJob) will be rescheduled:
```
helm release ttl redis --set='5 minutes'
cronjob.batch/redis-ttl configured
```
#### UNSET TTL
To remove release TTL pass `` and `--unset` flag.
```
helm release ttl --unset
```
For example, to remove `redis` release TTL run:
```
helm release ttl redis --unset
cronjob.batch "redis-ttl" deleted
```
## Contributing
We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:
- Reporting a bug
- Submitting a fix
- Proposing new features
- All pull requests are welcome.
Please see the [CONTRIBUTING](CONTRIBUTING.md) guide.
## Users
Who is using helm-release-plugin:
- [JovianX ServiceHub](https://github.com/JovianX/Service-Hub)
## Contributors
## License
Copyright 2022 JovianX Ltd.
Licensed under the Apache License, Version 2.0 (the "[LICENSE](https://github.com/JovianX/helm-release-plugin/blob/main/LICENSE)")
