https://github.com/softonic/helm-octopus
Helm plugin to reference value files packaged in dependency charts
https://github.com/softonic/helm-octopus
Last synced: 8 months ago
JSON representation
Helm plugin to reference value files packaged in dependency charts
- Host: GitHub
- URL: https://github.com/softonic/helm-octopus
- Owner: softonic
- License: apache-2.0
- Created: 2021-09-14T14:18:38.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2021-09-21T09:05:19.000Z (over 4 years ago)
- Last Synced: 2025-08-31T10:37:19.397Z (9 months ago)
- Language: Go
- Homepage:
- Size: 69.3 KB
- Stars: 3
- Watchers: 6
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Helm Octopus Plugin
[](https://goreportcard.com/report/github.com/softonic/helm-octopus)
[](https://godoc.org/github.com/softonic/helm-octopus)
[](https://github.com/softonic/helm-octopus/blob/master/LICENSE)
This Helm plugin allows to reference packaged value files (other than the default values.yaml).
### Install
```bash
helm plugin install https://github.com/softonic/helm-octopus
```
### Supported helm commands
Octopus will kick-in only with the following commands:
* upgrade
* install
* template
* lint
It can "handle" all other commands as well, but they will be proxied to helm binary.
### Usage
Octopus will read package value files, as long they have the following format:
`subchart:///`
Where `subchartId` is dependency chart `alias` or `name`, and filename is the file path
within its package.
#### Example
For example, this is our dependency tree structure:
```bash
mydep
├── charts
├── Chart.yaml
├── templates
│ ├── deployment.yaml
│ └── _helpers.tpl
├── values.yaml
└── values.custom.yaml
```
If we have the following chart:
```yaml
apiVersion: v2
name: mychart
version: 0.0.1
dependencies:
- name: mydep
alias: foobar
version: 1.0.0
repository: "@myrepo"
```
We could use octopus to reference `values.custom.yaml` for `mydep` chart.
`helm octopus template myrelease ./mychart -f subchart://foobar/values.custom.yaml`
#### Env vars
`HELM_OCTOPUS_TMP_DIR` can be used to define temporary directory where to save the package value files.
Defaults to `/tmp/octopus/`.