2018-11-07 19:06:20 +01:00
|
|
|
## ct install
|
|
|
|
|
|
|
|
|
|
Install and test a chart
|
|
|
|
|
|
|
|
|
|
### Synopsis
|
|
|
|
|
|
2019-03-18 11:11:57 -04:00
|
|
|
Run 'helm install', 'helm test', and optionally 'helm upgrade' on
|
2018-11-07 19:06:20 +01:00
|
|
|
|
|
|
|
|
* changed charts (default)
|
|
|
|
|
* specific charts (--charts)
|
|
|
|
|
* all charts (--all)
|
|
|
|
|
|
2019-03-18 11:11:57 -04:00
|
|
|
in given chart directories. If upgrade (--upgrade) is true, then this
|
|
|
|
|
command will validate that 'helm test' passes for the following upgrade paths:
|
|
|
|
|
|
|
|
|
|
* previous chart revision => current chart version (if non-breaking SemVer change)
|
|
|
|
|
* current chart version => current chart version
|
2018-11-07 19:06:20 +01:00
|
|
|
|
|
|
|
|
Charts may have multiple custom values files matching the glob pattern
|
|
|
|
|
'*-values.yaml' in a directory named 'ci' in the root of the chart's
|
|
|
|
|
directory. The chart is installed and tested for each of these files.
|
|
|
|
|
If no custom values file is present, the chart is installed and
|
|
|
|
|
tested with defaults.
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
ct install [flags]
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### Options
|
|
|
|
|
|
|
|
|
|
```
|
2022-04-05 11:50:08 +02:00
|
|
|
--all Process all charts except those explicitly excluded.
|
|
|
|
|
Disables changed charts detection and version increment checking
|
|
|
|
|
--build-id string An optional, arbitrary identifier that is added to the name of the namespace a
|
|
|
|
|
chart is installed into. In a CI environment, this could be the build number or
|
|
|
|
|
the ID of a pull request. If not specified, the name of the chart is used
|
|
|
|
|
--chart-dirs strings Directories containing Helm charts. May be specified multiple times
|
|
|
|
|
or separate values with commas (default [charts])
|
|
|
|
|
--chart-repos strings Additional chart repositories for dependency resolutions.
|
|
|
|
|
Repositories should be formatted as 'name=url' (ex: local=http://127.0.0.1:8879/charts).
|
|
|
|
|
May be specified multiple times or separate values with commas
|
|
|
|
|
--charts strings Specific charts to test. Disables changed charts detection and
|
|
|
|
|
version increment checking. May be specified multiple times
|
|
|
|
|
or separate values with commas
|
|
|
|
|
--config string Config file
|
|
|
|
|
--debug Print CLI calls of external tools to stdout (caution: setting this may
|
|
|
|
|
expose sensitive data when helm-repo-extra-args contains passwords)
|
|
|
|
|
--exclude-deprecated Skip charts that are marked as deprecated
|
|
|
|
|
--excluded-charts strings Charts that should be skipped. May be specified multiple times
|
|
|
|
|
or separate values with commas
|
2023-05-27 05:46:24 -07:00
|
|
|
--github-groups Change the delimiters for github to create collapsible groups
|
|
|
|
|
for command output
|
2022-04-05 11:50:08 +02:00
|
|
|
--helm-dependency-extra-args strings Additional arguments for 'helm dependency build' (e.g. ["--skip-refresh"]
|
|
|
|
|
--helm-extra-args string Additional arguments for Helm. Must be passed as a single quoted string
|
2023-11-02 17:46:00 +01:00
|
|
|
(e.g. '--timeout 500s')
|
2022-04-05 11:50:08 +02:00
|
|
|
--helm-extra-set-args string Additional arguments for Helm. Must be passed as a single quoted string
|
|
|
|
|
(e.g. "--set=name=value"
|
2023-11-02 17:46:00 +01:00
|
|
|
--helm-lint-extra-args string Additional arguments for Helm lint subcommand. Must be passed as a single quoted string
|
|
|
|
|
(e.g. '--quiet')
|
2022-04-05 11:50:08 +02:00
|
|
|
--helm-repo-extra-args strings Additional arguments for the 'helm repo add' command to be
|
|
|
|
|
specified on a per-repo basis with an equals sign as delimiter
|
|
|
|
|
(e.g. 'myrepo=--username test --password secret'). May be specified
|
|
|
|
|
multiple times or separate values with commas
|
|
|
|
|
-h, --help help for install
|
|
|
|
|
--namespace string Namespace to install the release(s) into. If not specified, each release will be
|
|
|
|
|
installed in its own randomly generated namespace
|
|
|
|
|
--print-config Prints the configuration to stderr (caution: setting this may
|
|
|
|
|
expose sensitive data when helm-repo-extra-args contains passwords)
|
|
|
|
|
--release-label string The label to be used as a selector when inspecting resources created by charts.
|
|
|
|
|
This is only used if namespace is specified (default "app.kubernetes.io/instance")
|
2025-06-02 04:41:47 -04:00
|
|
|
--release-name string Name for the release. If not specified, is set to the chart name and a random
|
|
|
|
|
identifier.
|
2022-04-05 11:50:08 +02:00
|
|
|
--remote string The name of the Git remote used to identify changed charts (default "origin")
|
|
|
|
|
--since string The Git reference used to identify changed charts (default "HEAD")
|
2022-09-28 14:46:08 +02:00
|
|
|
--skip-clean-up Skip resources clean-up. Used if need to continue other flows or keep it around.
|
2022-04-05 11:50:08 +02:00
|
|
|
--skip-missing-values When --upgrade has been passed, this flag will skip testing CI values files from the
|
|
|
|
|
previous chart revision if they have been deleted or renamed at the current chart
|
|
|
|
|
revision
|
2023-11-19 13:33:01 +01:00
|
|
|
--target-branch string The name of the target branch used to identify changed charts (default "main")
|
2022-04-05 11:50:08 +02:00
|
|
|
--upgrade Whether to test an in-place upgrade of each chart from its previous revision if the
|
|
|
|
|
current version should not introduce a breaking change according to the SemVer spec
|
2024-05-22 10:17:39 +02:00
|
|
|
--use-helmignore Use .helmignore when identifying changed charts
|
2018-11-07 19:06:20 +01:00
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### SEE ALSO
|
|
|
|
|
|
|
|
|
|
* [ct](ct.md) - The Helm chart testing tool
|
|
|
|
|
|
