1
0
mirror of https://github.com/helm/chart-testing.git synced 2026-02-05 09:45:14 +01:00
Files
chart-testing/doc/ct_install.md

81 lines
5.0 KiB
Markdown
Raw Normal View History

Re-write it in Go (#35) * Re-write it in Go Signed-off-by: Reinhard Nägele <unguiculus@gmail.com> * Fix loading config from home dir Signed-off-by: Reinhard Nägele <unguiculus@gmail.com> * Print config Signed-off-by: Reinhard Nägele <unguiculus@gmail.com> * Remove git gc test code Signed-off-by: Reinhard Nägele <unguiculus@gmail.com> * Remove year in copyright header Signed-off-by: Reinhard Nägele <unguiculus@gmail.com> * Add alias for lint-and-install Signed-off-by: Reinhard Nägele <unguiculus@gmail.com> * Fix examples Signed-off-by: Reinhard Nägele <unguiculus@gmail.com> * Remove OWNERS file Signed-off-by: Reinhard Nägele <unguiculus@gmail.com> * Add docs generation Signed-off-by: Reinhard Nägele <unguiculus@gmail.com> * Update CircleCI Signed-off-by: Reinhard Nägele <unguiculus@gmail.com> * Update readme Signed-off-by: Reinhard Nägele <unguiculus@gmail.com> * Document building and releasing Signed-off-by: Reinhard Nägele <unguiculus@gmail.com> Signed-off-by: Reinhard Nägele <unguiculus@gmail.com> * Remove Makefile Signed-off-by: Reinhard Nägele <unguiculus@gmail.com> * Hide doc-gen command Signed-off-by: Reinhard Nägele <unguiculus@gmail.com> * Add support for Helm extra args Signed-off-by: Reinhard Nägele <unguiculus@gmail.com> * Update tool dependencies Signed-off-by: Reinhard Nägele <unguiculus@gmail.com> * Update Goreleaser Signed-off-by: Reinhard Nägele <unguiculus@gmail.com> * Upgrade pip Signed-off-by: Reinhard Nägele <unguiculus@gmail.com> * Update Gopkg.lock Signed-off-by: Reinhard Nägele <unguiculus@gmail.com> * Add log messages Signed-off-by: Reinhard Nägele <unguiculus@gmail.com> * Fix CircleCI env var for tag Signed-off-by: Reinhard Nägele <unguiculus@gmail.com> * Add Docker login Signed-off-by: Reinhard Nägele <unguiculus@gmail.com> * Readme update for MacOS (#1) * Add build.sh mac prerequisites, and README markdown linting fixes Signed-off-by: Scott Rigby <scott@r6by.com> * Update README.md Signed-off-by: Reinhard Nägele <unguiculus@gmail.com> Signed-off-by: Reinhard Nägele <unguiculus@gmail.com> * Update Gopkg.lock Signed-off-by: Reinhard Nägele <unguiculus@gmail.com> * Update config search locations Signed-off-by: Reinhard Nägele <unguiculus@gmail.com> * Add config files to distro Signed-off-by: Reinhard Nägele <unguiculus@gmail.com> * Add debug flag Signed-off-by: Reinhard Nägele <unguiculus@gmail.com> * Add note on config files for linting Signed-off-by: Reinhard Nägele <unguiculus@gmail.com> * Fix link Signed-off-by: Reinhard Nägele <unguiculus@gmail.com> * Revert "Update Gopkg.lock" This reverts commit fcbfbdc9db7b3573fdec8eee1c3e172dcb880820. Signed-off-by: Reinhard Nägele <unguiculus@gmail.com> * Fix link Signed-off-by: Reinhard Nägele <unguiculus@gmail.com> * Fix readme Signed-off-by: Reinhard Nägele <unguiculus@gmail.com>
2018-11-07 19:06:20 +01:00
## ct install
Install and test a chart
### Synopsis
Run 'helm install', 'helm test', and optionally 'helm upgrade' on
Re-write it in Go (#35) * Re-write it in Go Signed-off-by: Reinhard Nägele <unguiculus@gmail.com> * Fix loading config from home dir Signed-off-by: Reinhard Nägele <unguiculus@gmail.com> * Print config Signed-off-by: Reinhard Nägele <unguiculus@gmail.com> * Remove git gc test code Signed-off-by: Reinhard Nägele <unguiculus@gmail.com> * Remove year in copyright header Signed-off-by: Reinhard Nägele <unguiculus@gmail.com> * Add alias for lint-and-install Signed-off-by: Reinhard Nägele <unguiculus@gmail.com> * Fix examples Signed-off-by: Reinhard Nägele <unguiculus@gmail.com> * Remove OWNERS file Signed-off-by: Reinhard Nägele <unguiculus@gmail.com> * Add docs generation Signed-off-by: Reinhard Nägele <unguiculus@gmail.com> * Update CircleCI Signed-off-by: Reinhard Nägele <unguiculus@gmail.com> * Update readme Signed-off-by: Reinhard Nägele <unguiculus@gmail.com> * Document building and releasing Signed-off-by: Reinhard Nägele <unguiculus@gmail.com> Signed-off-by: Reinhard Nägele <unguiculus@gmail.com> * Remove Makefile Signed-off-by: Reinhard Nägele <unguiculus@gmail.com> * Hide doc-gen command Signed-off-by: Reinhard Nägele <unguiculus@gmail.com> * Add support for Helm extra args Signed-off-by: Reinhard Nägele <unguiculus@gmail.com> * Update tool dependencies Signed-off-by: Reinhard Nägele <unguiculus@gmail.com> * Update Goreleaser Signed-off-by: Reinhard Nägele <unguiculus@gmail.com> * Upgrade pip Signed-off-by: Reinhard Nägele <unguiculus@gmail.com> * Update Gopkg.lock Signed-off-by: Reinhard Nägele <unguiculus@gmail.com> * Add log messages Signed-off-by: Reinhard Nägele <unguiculus@gmail.com> * Fix CircleCI env var for tag Signed-off-by: Reinhard Nägele <unguiculus@gmail.com> * Add Docker login Signed-off-by: Reinhard Nägele <unguiculus@gmail.com> * Readme update for MacOS (#1) * Add build.sh mac prerequisites, and README markdown linting fixes Signed-off-by: Scott Rigby <scott@r6by.com> * Update README.md Signed-off-by: Reinhard Nägele <unguiculus@gmail.com> Signed-off-by: Reinhard Nägele <unguiculus@gmail.com> * Update Gopkg.lock Signed-off-by: Reinhard Nägele <unguiculus@gmail.com> * Update config search locations Signed-off-by: Reinhard Nägele <unguiculus@gmail.com> * Add config files to distro Signed-off-by: Reinhard Nägele <unguiculus@gmail.com> * Add debug flag Signed-off-by: Reinhard Nägele <unguiculus@gmail.com> * Add note on config files for linting Signed-off-by: Reinhard Nägele <unguiculus@gmail.com> * Fix link Signed-off-by: Reinhard Nägele <unguiculus@gmail.com> * Revert "Update Gopkg.lock" This reverts commit fcbfbdc9db7b3573fdec8eee1c3e172dcb880820. Signed-off-by: Reinhard Nägele <unguiculus@gmail.com> * Fix link Signed-off-by: Reinhard Nägele <unguiculus@gmail.com> * Fix readme Signed-off-by: Reinhard Nägele <unguiculus@gmail.com>
2018-11-07 19:06:20 +01:00
* changed charts (default)
* specific charts (--charts)
* all charts (--all)
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
Re-write it in Go (#35) * Re-write it in Go Signed-off-by: Reinhard Nägele <unguiculus@gmail.com> * Fix loading config from home dir Signed-off-by: Reinhard Nägele <unguiculus@gmail.com> * Print config Signed-off-by: Reinhard Nägele <unguiculus@gmail.com> * Remove git gc test code Signed-off-by: Reinhard Nägele <unguiculus@gmail.com> * Remove year in copyright header Signed-off-by: Reinhard Nägele <unguiculus@gmail.com> * Add alias for lint-and-install Signed-off-by: Reinhard Nägele <unguiculus@gmail.com> * Fix examples Signed-off-by: Reinhard Nägele <unguiculus@gmail.com> * Remove OWNERS file Signed-off-by: Reinhard Nägele <unguiculus@gmail.com> * Add docs generation Signed-off-by: Reinhard Nägele <unguiculus@gmail.com> * Update CircleCI Signed-off-by: Reinhard Nägele <unguiculus@gmail.com> * Update readme Signed-off-by: Reinhard Nägele <unguiculus@gmail.com> * Document building and releasing Signed-off-by: Reinhard Nägele <unguiculus@gmail.com> Signed-off-by: Reinhard Nägele <unguiculus@gmail.com> * Remove Makefile Signed-off-by: Reinhard Nägele <unguiculus@gmail.com> * Hide doc-gen command Signed-off-by: Reinhard Nägele <unguiculus@gmail.com> * Add support for Helm extra args Signed-off-by: Reinhard Nägele <unguiculus@gmail.com> * Update tool dependencies Signed-off-by: Reinhard Nägele <unguiculus@gmail.com> * Update Goreleaser Signed-off-by: Reinhard Nägele <unguiculus@gmail.com> * Upgrade pip Signed-off-by: Reinhard Nägele <unguiculus@gmail.com> * Update Gopkg.lock Signed-off-by: Reinhard Nägele <unguiculus@gmail.com> * Add log messages Signed-off-by: Reinhard Nägele <unguiculus@gmail.com> * Fix CircleCI env var for tag Signed-off-by: Reinhard Nägele <unguiculus@gmail.com> * Add Docker login Signed-off-by: Reinhard Nägele <unguiculus@gmail.com> * Readme update for MacOS (#1) * Add build.sh mac prerequisites, and README markdown linting fixes Signed-off-by: Scott Rigby <scott@r6by.com> * Update README.md Signed-off-by: Reinhard Nägele <unguiculus@gmail.com> Signed-off-by: Reinhard Nägele <unguiculus@gmail.com> * Update Gopkg.lock Signed-off-by: Reinhard Nägele <unguiculus@gmail.com> * Update config search locations Signed-off-by: Reinhard Nägele <unguiculus@gmail.com> * Add config files to distro Signed-off-by: Reinhard Nägele <unguiculus@gmail.com> * Add debug flag Signed-off-by: Reinhard Nägele <unguiculus@gmail.com> * Add note on config files for linting Signed-off-by: Reinhard Nägele <unguiculus@gmail.com> * Fix link Signed-off-by: Reinhard Nägele <unguiculus@gmail.com> * Revert "Update Gopkg.lock" This reverts commit fcbfbdc9db7b3573fdec8eee1c3e172dcb880820. Signed-off-by: Reinhard Nägele <unguiculus@gmail.com> * Fix link Signed-off-by: Reinhard Nägele <unguiculus@gmail.com> * Fix readme Signed-off-by: Reinhard Nägele <unguiculus@gmail.com>
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
```
--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
--helm-extra-args string Additional arguments for Helm. Must be passed as a single quoted string
(e.g. "--timeout 500s"
--helm-extra-set-args string Additional arguments for Helm. Must be passed as a single quoted string
(e.g. "--set=name=value"
--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")
--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")
--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
--target-branch string The name of the target branch used to identify changed charts (default "master")
--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
Re-write it in Go (#35) * Re-write it in Go Signed-off-by: Reinhard Nägele <unguiculus@gmail.com> * Fix loading config from home dir Signed-off-by: Reinhard Nägele <unguiculus@gmail.com> * Print config Signed-off-by: Reinhard Nägele <unguiculus@gmail.com> * Remove git gc test code Signed-off-by: Reinhard Nägele <unguiculus@gmail.com> * Remove year in copyright header Signed-off-by: Reinhard Nägele <unguiculus@gmail.com> * Add alias for lint-and-install Signed-off-by: Reinhard Nägele <unguiculus@gmail.com> * Fix examples Signed-off-by: Reinhard Nägele <unguiculus@gmail.com> * Remove OWNERS file Signed-off-by: Reinhard Nägele <unguiculus@gmail.com> * Add docs generation Signed-off-by: Reinhard Nägele <unguiculus@gmail.com> * Update CircleCI Signed-off-by: Reinhard Nägele <unguiculus@gmail.com> * Update readme Signed-off-by: Reinhard Nägele <unguiculus@gmail.com> * Document building and releasing Signed-off-by: Reinhard Nägele <unguiculus@gmail.com> Signed-off-by: Reinhard Nägele <unguiculus@gmail.com> * Remove Makefile Signed-off-by: Reinhard Nägele <unguiculus@gmail.com> * Hide doc-gen command Signed-off-by: Reinhard Nägele <unguiculus@gmail.com> * Add support for Helm extra args Signed-off-by: Reinhard Nägele <unguiculus@gmail.com> * Update tool dependencies Signed-off-by: Reinhard Nägele <unguiculus@gmail.com> * Update Goreleaser Signed-off-by: Reinhard Nägele <unguiculus@gmail.com> * Upgrade pip Signed-off-by: Reinhard Nägele <unguiculus@gmail.com> * Update Gopkg.lock Signed-off-by: Reinhard Nägele <unguiculus@gmail.com> * Add log messages Signed-off-by: Reinhard Nägele <unguiculus@gmail.com> * Fix CircleCI env var for tag Signed-off-by: Reinhard Nägele <unguiculus@gmail.com> * Add Docker login Signed-off-by: Reinhard Nägele <unguiculus@gmail.com> * Readme update for MacOS (#1) * Add build.sh mac prerequisites, and README markdown linting fixes Signed-off-by: Scott Rigby <scott@r6by.com> * Update README.md Signed-off-by: Reinhard Nägele <unguiculus@gmail.com> Signed-off-by: Reinhard Nägele <unguiculus@gmail.com> * Update Gopkg.lock Signed-off-by: Reinhard Nägele <unguiculus@gmail.com> * Update config search locations Signed-off-by: Reinhard Nägele <unguiculus@gmail.com> * Add config files to distro Signed-off-by: Reinhard Nägele <unguiculus@gmail.com> * Add debug flag Signed-off-by: Reinhard Nägele <unguiculus@gmail.com> * Add note on config files for linting Signed-off-by: Reinhard Nägele <unguiculus@gmail.com> * Fix link Signed-off-by: Reinhard Nägele <unguiculus@gmail.com> * Revert "Update Gopkg.lock" This reverts commit fcbfbdc9db7b3573fdec8eee1c3e172dcb880820. Signed-off-by: Reinhard Nägele <unguiculus@gmail.com> * Fix link Signed-off-by: Reinhard Nägele <unguiculus@gmail.com> * Fix readme Signed-off-by: Reinhard Nägele <unguiculus@gmail.com>
2018-11-07 19:06:20 +01:00
```
### SEE ALSO
* [ct](ct.md) - The Helm chart testing tool
###### Auto generated by spf13/cobra on 16-Mar-2022