VKS Helm Charts

Usage

Helm must be installed to use the charts. Please refer to Helm's documentation to get started.

Once Helm is set up properly, add the repo as follows:

helm repo add vks-helm-charts https://vngcloud.github.io/vks-helm-charts

If you had already added this repo earlier, run helm repo update to retrieve the latest versions of the packages.

You can then run helm search repo vks-helm-charts to see the charts.

Cert Manager

• The cert-manager chart is a wrapper around the upstream cert-manager chart. It adds some additional configuration options and a few extra resources.
• The upstream chart is available at GitHub.
• Clone this repo and run make release-manifests to generate the upstream chart.
• Rewrite the defalut repository in the values.yaml.

To install the chart:

helm install \
  cert-manager oci://vcr.vngcloud.vn/81-vks-public/vks-helm-charts/cert-manager \
  --namespace cert-manager \
  --create-namespace \
  --version v1.17.2 \
  --set crds.enabled=true

How to Copy Helm Charts from Community to this Repository

1. Add the community helm repository

   helm repo add <repo-name> <repo-url>
   helm repo update

   Example:

   helm repo add bitnami https://charts.bitnami.com/bitnami
   helm repo update

2. Search and identify the chart version

   helm search repo <repo-name>/<chart-name>

   Example:

   helm search repo bitnami/nginx

3. Pull the chart to local directory

   helm pull <repo-name>/<chart-name> --version <version> --untar --untardir ./charts/

   Example:

   helm pull bitnami/nginx --version 22.3.3 --untar --untardir ./charts/

4. Navigate to the chart directory

   cd ./charts/<chart-name>

5. Review and modify the chart

   • Check Chart.yaml for metadata
   • Review values.yaml for default configurations
   • Make a copy of docker image references to point to VCR if necessary
   • Should not modify the original chart structure significantly to ease future updates

6. Validate the chart

   helm lint .
   helm template . --debug

7. Test the chart locally

   helm install test-release . --dry-run --debug