kubernetes-operator/helm-charts/README.md

Hanzo KMS Helm Charts

Welcome to Hanzo KMS Helm Charts repository! Find instructions below to setup and install our charts.

Installation

# Add the Hanzo KMS repository
helm repo add kms 'https://dl.cloudsmith.io/public/kms/helm-charts/helm/charts/' && helm repo update

# Install Hanzo KMS (default values)
helm upgrade --install --atomic \
  -n kms --create-namespace \
  kms kms/kms
  
# Install Hanzo KMS Secrets Operator (default values)
helm upgrade --install --atomic \
  -n kms --create-namespace \
  kms-secrets-operator kms/secrets-operator

Charts

Here's the link to our charts corresponding documentation :

• kms
• secrets-operator

Documentation

We're trying to follow a documentation convention across our charts, allowing us to auto-generate markdown documentation thanks to this tool

Steps to update the documentation :

1. cd helm-charts/<chart>
2. git clone https://github.com/bitnami-labs/readme-generator-for-helm
3. npm install ./readme-generator-for-helm
4. npm exec readme-generator -- --readme README.md --values values.yaml
   • It'll insert the table below the ## Parameters title
   • It'll output errors if some of the path aren't documented