Repository of Wharf's Helm charts.
Chart | Description |
---|---|
wharf-helm | Deploy Wharf to Kubernetes using Helm |
wharf-cmd | Deploy wharf-cmd, Wharf's execution engine, to Kubernetes |
wharf-aino | All-in-One Wharf deployment, including Postgres |
To start using, add the Wharf Helm chart repository:
helm repo add iver-wharf https://wharf.iver.com/wharf-helm
The README.md
files in each chart is generated using
norwoodj/helm-docs.
-
Install
helm-docs
. Installation instructions can be found at: https://github.com/norwoodj/helm-docs#installationIf you have Go installed, you may run:
go install github.com/norwoodj/helm-docs/cmd/[email protected]
-
Run
helm-docs
, preferrably before you create your pull requests:helm-docs
-
Commit the changes on the
README.md
files.
The charts in this repository are published automatically using
helm/chart-releaser. No further
action is required except getting your change into the master
branch.
If you need to group changes into a single release, it's suggested to instead follow git-flow and create a release branch, like so:
git checkout master
git pull
git checkout -b release/wharf-helm/v1.2.0
Then target all your grouped changes and PRs to that release branch.
Once you're ready to deploy it you create a pull request from that release
branch over to master
, where it will be published automatically as soon as
it's merged.
make deps # download linting dependencies
make lint
make lint-helm # only lint Helm charts
make lint-md # only lint Markdown files
Some errors can be fixed automatically. Keep in mind that this updates the files in place.
make lint-fix
#make lint-fix-helm # Helm linter does not support fixes
make lint-fix-md # only lint and fix Markdown files
Maintained by Iver. Licensed under the MIT license.