Helm Template

helm template

locally render templates

Synopsis

Render chart templates locally and display the output.

Any values that would normally be looked up or retrieved in-cluster will be faked locally. Additionally, none of the server-side testing of chart validity (e.g. whether an API is supported) is done.

  1. helm template [NAME] [CHART] [flags]

Options

  1. -a, --api-versions strings Kubernetes api versions used for Capabilities.APIVersions
  2. --atomic if set, the installation process deletes the installation on failure. The --wait flag will be set automatically if --atomic is used
  3. --ca-file string verify certificates of HTTPS-enabled servers using this CA bundle
  4. --cert-file string identify HTTPS client using this SSL certificate file
  5. --create-namespace create the release namespace if not present
  6. --dependency-update update dependencies if they are missing before installing the chart
  7. --description string add a custom description
  8. --devel use development versions, too. Equivalent to version '>0.0.0-0'. If --version is set, this is ignored
  9. --disable-openapi-validation if set, the installation process will not validate rendered templates against the Kubernetes OpenAPI Schema
  10. --dry-run simulate an install
  11. --enable-dns enable DNS lookups when rendering templates
  12. --force force resource updates through a replacement strategy
  13. -g, --generate-name generate the name (and omit the NAME parameter)
  14. -h, --help help for template
  15. --include-crds include CRDs in the templated output
  16. --insecure-skip-tls-verify skip tls certificate checks for the chart download
  17. --is-upgrade set .Release.IsUpgrade instead of .Release.IsInstall
  18. --key-file string identify HTTPS client using this SSL key file
  19. --keyring string location of public keys used for verification (default "~/.gnupg/pubring.gpg")
  20. --kube-version string Kubernetes version used for Capabilities.KubeVersion
  21. --name-template string specify template used to name the release
  22. --no-hooks prevent hooks from running during install
  23. --output-dir string writes the executed templates to files in output-dir instead of stdout
  24. --pass-credentials pass credentials to all domains
  25. --password string chart repository password where to locate the requested chart
  26. --post-renderer postRendererString the path to an executable to be used for post rendering. If it exists in $PATH, the binary will be used, otherwise it will try to look for the executable at the given path
  27. --post-renderer-args postRendererArgsSlice an argument to the post-renderer (can specify multiple) (default [])
  28. --release-name use release name in the output-dir path.
  29. --render-subchart-notes if set, render subchart notes along with the parent
  30. --replace re-use the given name, only if that name is a deleted release which remains in the history. This is unsafe in production
  31. --repo string chart repository url where to locate the requested chart
  32. --set stringArray set values on the command line (can specify multiple or separate values with commas: key1=val1,key2=val2)
  33. --set-file stringArray set values from respective files specified via the command line (can specify multiple or separate values with commas: key1=path1,key2=path2)
  34. --set-json stringArray set JSON values on the command line (can specify multiple or separate values with commas: key1=jsonval1,key2=jsonval2)
  35. --set-literal stringArray set a literal STRING value on the command line
  36. --set-string stringArray set STRING values on the command line (can specify multiple or separate values with commas: key1=val1,key2=val2)
  37. -s, --show-only stringArray only show manifests rendered from the given templates
  38. --skip-crds if set, no CRDs will be installed. By default, CRDs are installed if not already present
  39. --skip-tests skip tests from templated output
  40. --timeout duration time to wait for any individual Kubernetes operation (like Jobs for hooks) (default 5m0s)
  41. --username string chart repository username where to locate the requested chart
  42. --validate validate your manifests against the Kubernetes cluster you are currently pointing at. This is the same validation performed on an install
  43. -f, --values strings specify values in a YAML file or a URL (can specify multiple)
  44. --verify verify the package before using it
  45. --version string specify a version constraint for the chart version to use. This constraint can be a specific tag (e.g. 1.1.1) or it may reference a valid range (e.g. ^2.0.0). If this is not specified, the latest version is used
  46. --wait if set, will wait until all Pods, PVCs, Services, and minimum number of Pods of a Deployment, StatefulSet, or ReplicaSet are in a ready state before marking the release as successful. It will wait for as long as --timeout
  47. --wait-for-jobs if set and --wait enabled, will wait until all Jobs have been completed before marking the release as successful. It will wait for as long as --timeout

Options inherited from parent commands

  1. --burst-limit int client-side default throttling limit (default 100)
  2. --debug enable verbose output
  3. --kube-apiserver string the address and the port for the Kubernetes API server
  4. --kube-as-group stringArray group to impersonate for the operation, this flag can be repeated to specify multiple groups.
  5. --kube-as-user string username to impersonate for the operation
  6. --kube-ca-file string the certificate authority file for the Kubernetes API server connection
  7. --kube-context string name of the kubeconfig context to use
  8. --kube-insecure-skip-tls-verify if true, the Kubernetes API server's certificate will not be checked for validity. This will make your HTTPS connections insecure
  9. --kube-tls-server-name string server name to use for Kubernetes API server certificate validation. If it is not provided, the hostname used to contact the server is used
  10. --kube-token string bearer token used for authentication
  11. --kubeconfig string path to the kubeconfig file
  12. -n, --namespace string namespace scope for this request
  13. --registry-config string path to the registry config file (default "~/.config/helm/registry/config.json")
  14. --repository-cache string path to the file containing cached repository indexes (default "~/.cache/helm/repository")
  15. --repository-config string path to the file containing repository names and URLs (default "~/.config/helm/repositories.yaml")

SEE ALSO

  • helm - The Helm package manager for Kubernetes.
Auto generated by spf13/cobra on 10-May-2023