README.md.gotmpl 1.3 KB

1234567891011121314151617181920212223242526272829303132333435363738
  1. {{- $valuesYAML := "https://github.com/external-secrets/external-secrets/blob/master/deploy/charts/external-secrets/values.yaml" -}}
  2. {{- $chartRepo := "https://external-secrets.github.io/external-secrets" -}}
  3. {{- $org := "external-secrets" -}}
  4. {{ template "chart.header" . }}
  5. [//]: # (README.md generated by gotmpl. DO NOT EDIT.)
  6. {{ template "chart.typeBadge" . }}{{ template "chart.versionBadge" . }}{{ template "chart.appVersionBadge" . }}
  7. {{ template "chart.description" . }}
  8. ## TL;DR
  9. ```bash
  10. helm repo add {{ $org }} {{ $chartRepo }}
  11. helm install {{ $org }}/{{ template "chart.name" . }}
  12. ```
  13. ## Installing the Chart
  14. To install the chart with the release name `{{ template "chart.name" . }}`:
  15. ```bash
  16. helm install {{ template "chart.name" . }} {{ $org }}/{{ template "chart.name" . }}
  17. ```
  18. ### Custom Resources
  19. By default, the chart will install external-secrets CRDs, this can be controlled with `installCRDs` value.
  20. ## Uninstalling the Chart
  21. To uninstall the `{{ template "chart.name" . }}` deployment:
  22. ```bash
  23. helm uninstall {{ template "chart.name" . }}
  24. ```
  25. The command removes all the Kubernetes components associated with the chart and deletes the release.
  26. ## Configuration
  27. Read through the {{ template "chart.name" . }} [values.yaml]({{ $valuesYAML }})
  28. file. It has several commented out suggested values.
  29. {{ template "chart.valuesSection" . }}