Helm install
External
- https://helm.sh/docs/helm/#helm-install
- https://helm.sh/docs/using_helm/#helm-install-installing-a-package
- https://helm.sh/docs/using_helm/#helpful-options-for-install-upgrade-rollback
Internal
Overview
helm install installs a chart archive and creates a release.
The chart may come from a repository:
helm install <chart-name> helm install stable/mysql
or from a local directory (note that the directory name must be identical with the chart name specified in Chart.yaml):
helm install <directory-name-that-must-match-chart-name>
If the chart has dependencies, they must be present in the charts/ subdirectory at the time of the installation. helm install does not manage dependencies, helm dependency does.
helm install performs some sanity checks, such as comparing the content of requirements.yaml with the content of the charts/ subdirectory and failing if requirements.yaml contains dependencies that are not in charts/. However, if a dependency is present in charts/ but not in requirements.yaml, it will be installed.
For more details on dependencies and how they work, see:
Dry Run
In this mode, we send the templates to the Tiller server, which renders them, but instead of installing the chart, it returns the rendered template so it can be inspected:
helm install <...> --debug --dry-run
Note that in this mode, it is not guaranteed that Kubernetes will accept the generated manifest.
Specifying a Release Name
helm install --name <release-name> ...
Overriding Default Configuration or Providing New Cofiguration
-f|--values
Default configuration can be overridden or new configuration can be specified with:
helm install -f|--values <configuration-overrides-file.yaml> <chart name>
The -f|--values flag can be specified multiple time on the command line, and the rightmost value will take precedence. For more details on Helm configuration see:
--set-file
TODO: Clarify use cases and file content syntax.
For more details on Helm configuration see:
--set, --set--string
Individual configuration options can be specified with --set or --set-string.
helm install --set size=10 <chart name>
For more details on overriding or specifying configuration see:
Debug
helm install --debug
The --debug flag displays:
Overriding Tags and Conditions
Use --set to override default tag and condition values at installation time.
Installing from Different Sources
The default option for the helm install command is to install from the default repository. However, the chart may come from different sources:
Installing from a File
helm install something-0.1.1.tgz
Installing from an Unpacked Chart Directory
helm install ./something
Installing from a URL
helm install https://example.com/charts/something-1.0.0.tgz