Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix help command and output in docs #409

Merged
merged 1 commit into from
Oct 10, 2023
Merged

Fix help command and output in docs #409

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
76 changes: 38 additions & 38 deletions docs/helm-chart-checks.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,47 +109,47 @@ This section provides help on the basic usage of Helm chart checks with the podm
- Get the list of options for the `verify` command:

```
$ podman run -it --rm quay.io/redhat-certification/chart-verifier verify help
$ podman run -it --rm quay.io/redhat-certification/chart-verifier verify --help
```
The output is similar to the following example:
```
Verifies a Helm chart by checking some of its characteristics

Usage:
chart-verifier verify <chart-uri> [flags]

Flags:
-S, --chart-set strings set values for the chart (can specify multiple or separate values with commas: key1=val1,key2=val2)
-G, --chart-set-file strings set values from respective files specified via the command line (can specify multiple or separate values with commas: key1=path1,key2=path2)
-X, --chart-set-string strings set STRING values for the chart (can specify multiple or separate values with commas: key1=val1,key2=val2)
-F, --chart-values strings specify values in a YAML file or a URL (can specify multiple)
--debug enable verbose output
-x, --disable strings all checks will be enabled except the informed ones
-e, --enable strings only the informed checks will be enabled
--helm-install-timeout duration helm install timeout (default 5m0s)
-h, --help help for verify
--kube-apiserver string the address and the port for the Kubernetes API server
--kube-as-group stringArray group to impersonate for the operation, this flag can be repeated to specify multiple groups.
--kube-as-user string username to impersonate for the operation
--kube-ca-file string the certificate authority file for the Kubernetes API server connection
--kube-context string name of the kubeconfig context to use
--kube-token string bearer token used for authentication
--kubeconfig string path to the kubeconfig file
-n, --namespace string namespace scope for this request
-V, --openshift-version string set the value of certifiedOpenShiftVersions in the report
-o, --output string the output format: default, json or yaml
-k, --pgp-public-key string file containing gpg public key of the key used to sign the chart
-W, --web-catalog-only set this to indicate that the distribution method is web catalog only (default: false)
--registry-config string path to the registry config file (default "/home/baiju/.config/helm/registry.json")
--repository-cache string path to the file containing cached repository indexes (default "/home/baiju/.cache/helm/repository")
--repository-config string path to the file containing repository names and URLs (default "/home/baiju/.config/helm/repositories.yaml")
-s, --set strings overrides a configuration, e.g: dummy.ok=false
-f, --set-values strings specify application and check configuration values in a YAML file or a URL (can specify multiple)
-E, --suppress-error-log suppress the error log (default: written to ./chartverifier/verifier-<timestamp>.log)
--timeout duration time to wait for completion of chart install and test (default 30m0s)
-w, --write-to-file write report to ./chartverifier/report.yaml (default: stdout)
Global Flags:
--config string config file (default is $HOME/.chart-verifier.yaml)
Verifies a Helm chart by checking some of its characteristics

Usage:
chart-verifier verify <chart-uri> [flags]

Flags:
-S, --chart-set strings set values for the chart (can specify multiple or separate values with commas: key1=val1,key2=val2)
-G, --chart-set-file strings set values from respective files specified via the command line (can specify multiple or separate values with commas: key1=path1,key2=path2)
-X, --chart-set-string strings set STRING values for the chart (can specify multiple or separate values with commas: key1=val1,key2=val2)
-F, --chart-values strings specify values in a YAML file or a URL (can specify multiple)
--debug enable verbose output
-x, --disable strings all checks will be enabled except the informed ones
-e, --enable strings only the informed checks will be enabled
--helm-install-timeout duration helm install timeout (default 5m0s)
-h, --help help for verify
--kube-apiserver string the address and the port for the Kubernetes API server
--kube-as-group stringArray group to impersonate for the operation, this flag can be repeated to specify multiple groups.
--kube-as-user string username to impersonate for the operation
--kube-ca-file string the certificate authority file for the Kubernetes API server connection
--kube-context string name of the kubeconfig context to use
--kube-token string bearer token used for authentication
--kubeconfig string path to the kubeconfig file
-n, --namespace string namespace scope for this request
-V, --openshift-version string set the value of certifiedOpenShiftVersions in the report
-o, --output string the output format: default, json or yaml
-k, --pgp-public-key string file containing gpg public key of the key used to sign the chart
-W, --web-catalog-only set this to indicate that the distribution method is web catalog only (default: false)
--registry-config string path to the registry config file (default "/home/baiju/.config/helm/registry.json")
--repository-cache string path to the file containing cached repository indexes (default "/home/baiju/.cache/helm/repository")
--repository-config string path to the file containing repository names and URLs (default "/home/baiju/.config/helm/repositories.yaml")
-s, --set strings overrides a configuration, e.g: dummy.ok=false
-f, --set-values strings specify application and check configuration values in a YAML file or a URL (can specify multiple)
-E, --suppress-error-log suppress the error log (default: written to ./chartverifier/verifier-<timestamp>.log)
--timeout duration time to wait for completion of chart install and test (default 30m0s)
-w, --write-to-file write report to ./chartverifier/report.yaml (default: stdout)
Global Flags:
--config string config file (default is $HOME/.chart-verifier.yaml)
```
- Run a subset of the checks:

Expand Down