From 03739d3328a1fee4978971969ffffed1af1c7a64 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Reinhard=20N=C3=A4gele?= Date: Fri, 25 Sep 2020 11:06:06 +0200 Subject: [PATCH] Update docs (#274) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Reinhard Nägele --- doc/ct_install.md | 8 +++++--- doc/ct_lint-and-install.md | 8 +++++--- doc/ct_lint.md | 8 +++++--- 3 files changed, 15 insertions(+), 9 deletions(-) diff --git a/doc/ct_install.md b/doc/ct_install.md index e38f651d..7e71521e 100644 --- a/doc/ct_install.md +++ b/doc/ct_install.md @@ -43,8 +43,8 @@ ct install [flags] 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 (Note: depending on helm-extra-args - passed, this may reveal sensitive data) + --debug Print CLI calls of external tools to stdout (caution: setting this may + expose sensitive data when helm-repo-extra-args contains passwords) --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 @@ -56,6 +56,8 @@ ct install [flags] -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 stdout (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") @@ -72,4 +74,4 @@ ct install [flags] * [ct](ct.md) - The Helm chart testing tool -###### Auto generated by spf13/cobra on 21-Apr-2020 +###### Auto generated by spf13/cobra on 25-Sep-2020 diff --git a/doc/ct_lint-and-install.md b/doc/ct_lint-and-install.md index a7888b14..b3dc90c3 100644 --- a/doc/ct_lint-and-install.md +++ b/doc/ct_lint-and-install.md @@ -31,8 +31,8 @@ ct lint-and-install [flags] or separate values with commas --check-version-increment Activates a check for chart version increments (default: true) (default true) --config string Config file - --debug Print CLI calls of external tools to stdout (Note: depending on helm-extra-args - passed, this may reveal sensitive data) + --debug Print CLI calls of external tools to stdout (caution: setting this may + expose sensitive data when helm-repo-extra-args contains passwords) --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 @@ -47,6 +47,8 @@ ct lint-and-install [flags] that order --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 stdout (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") @@ -67,4 +69,4 @@ ct lint-and-install [flags] * [ct](ct.md) - The Helm chart testing tool -###### Auto generated by spf13/cobra on 21-Apr-2020 +###### Auto generated by spf13/cobra on 25-Sep-2020 diff --git a/doc/ct_lint.md b/doc/ct_lint.md index 8e94b6b7..82b059c4 100644 --- a/doc/ct_lint.md +++ b/doc/ct_lint.md @@ -41,8 +41,8 @@ ct lint [flags] or separate values with commas --check-version-increment Activates a check for chart version increments (default: true) (default true) --config string Config file - --debug Print CLI calls of external tools to stdout (Note: depending on helm-extra-args - passed, this may reveal sensitive data) + --debug Print CLI calls of external tools to stdout (caution: setting this may + expose sensitive data when helm-repo-extra-args contains passwords) --excluded-charts strings Charts that should be skipped. May be specified multiple times or separate values with commas --helm-repo-extra-args strings Additional arguments for the 'helm repo add' command to be @@ -53,6 +53,8 @@ ct lint [flags] --lint-conf string The config file for YAML linting. If not specified, 'lintconf.yaml' is searched in the current directory, '$HOME/.ct', and '/etc/ct', in that order + --print-config Prints the configuration to stdout (caution: setting this may + expose sensitive data when helm-repo-extra-args contains passwords) --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") --target-branch string The name of the target branch used to identify changed charts (default "master") @@ -66,4 +68,4 @@ ct lint [flags] * [ct](ct.md) - The Helm chart testing tool -###### Auto generated by spf13/cobra on 21-Apr-2020 +###### Auto generated by spf13/cobra on 25-Sep-2020