https://github.com/afnanenayet/helm-renderer
Render your Helm charts locally and split up your files in a sane way
https://github.com/afnanenayet/helm-renderer
helm helm-charts kubernetes yaml-files
Last synced: 7 months ago
JSON representation
Render your Helm charts locally and split up your files in a sane way
- Host: GitHub
- URL: https://github.com/afnanenayet/helm-renderer
- Owner: afnanenayet
- License: bsd-3-clause
- Created: 2020-03-24T22:17:30.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-08-19T16:37:25.000Z (about 1 year ago)
- Last Synced: 2025-03-15T00:52:16.500Z (7 months ago)
- Topics: helm, helm-charts, kubernetes, yaml-files
- Language: Haskell
- Size: 771 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: ChangeLog.md
- License: LICENSE
Awesome Lists containing this project
README
# helm-renderer
Render Helm charts to YAML files that can be used directly with
`kubectl apply -f`. This provides some more functionality than using Helm to
render templates locally. This actually performs a dry-run with Helm so it
reaches out to the Kubernetes API server and fills in as many values in the
template as possible. This tool allows a user to provide a values yaml file
that overrides or fills in values for the Helm chart template.
The tool also splits up the massive YAML file that Helm provides into separate
YAML files for readability and maintainability while providing folder
structure.
For example, if you have a file of the form
```yaml
---
# Source: template/a/a.yaml
...
---
# Source: template/b/b.yaml
...
```
The tool will output:
```txt
out
--- a/a.yaml
--- b/b.yaml
```
which preserves the file structure from the actual Helm charts, so you can
mimic the Helm installation while having the charts be split up.
## Usage
```txt
helm-renderer: render Helm charts
Usage: helm-renderer CHARTNAME [-n|--namespace NAMESPACE] [-f|--values VALUES]
[--out OUTDIR]
Render Helm charts
Available options:
CHARTNAME The name of the chart in the form 'repo/chartname'
-n,--namespace NAMESPACE The namespace to pass to Helm
-f,--values VALUES The path to the optional values YAML
--out OUTDIR The output directory to write the generated files to
-h,--help Show this help text
```
## Installation
### Stack
If you want (or have) to build from source:
```sh
git clone https://github.com/afnanenayet/helm-renderer.git
cd helm-renderer
stack install --local-bin-path=/usr/local/bin # or whatever path you want
```
### Homebrew
To use the Homebrew tap:
```sh
brew tap afnanenayet/helm-renderer
brew install helm-renderer
```
## Development
This project uses stack for building and testing, so all of the usual stack
commands apply.