Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
rtpro committed Jul 9, 2022
1 parent ea2e641 commit ac3a154
Showing 1 changed file with 43 additions and 2 deletions.
45 changes: 43 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,43 @@
# helm-release-plugin
A helm3 plugin that can re-create helm Charts from releases and update values of deployed released without the chart
# `helm-release` Plugin
`helm-release` is a Helm 3 plugin that allows running operatins on Helm releases (deployment instances of elm charts).

`helm-release` plugin allows:

* Pull (re-create) Helm charts from a deployed helm release.
* Update values of deployed releases, without spesificing the Helm chart.

## Getting started
### Installation
To install the plugin:
```shell
$ helm plugin install https://github.com/JovianX/helm-release-plugin
```
Update to latest:
```shell
$ helm plugin update release
```
Verify it's been installed:
```shell
$ helm plugin list
```

### Usage
```
$ helm release
usage: ./release.sh [ pull ]
Available Commands:
pull Pulls (re-create) a Helm chart from a deployed Helm release
$ helm release pull
usage: helm release pull <RELEASE NAME>
Example:
$ helm --namespace nginx release pull nginx
```

## Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

## License
This Project is unser the Apache 2.0 lisence agreement, see [LICENSE](https://github.com/JovianX/helm-release-plugin/blob/main/LICENSE) file for more details.

0 comments on commit ac3a154

Please sign in to comment.