Skip to content

Commit

Permalink
Updaing docs for Helm v3.9.0
Browse files Browse the repository at this point in the history
This includes:
- updating the current version
- updating the next feature version
- new generation of docs for help/flag updates
- version skew updated

Signed-off-by: Matt Farina <matt.farina@suse.com>
  • Loading branch information
mattfarina committed May 18, 2022
1 parent fb8c226 commit 08e56ae
Show file tree
Hide file tree
Showing 58 changed files with 178 additions and 173 deletions.
6 changes: 3 additions & 3 deletions config.toml
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ jsFiles = [
]

[[params.versions]]
version = "v3.8.2"
version = "v3.9.0"
patch = "stable"
url = "https://helm.sh/docs"
primary = true
Expand All @@ -53,8 +53,8 @@ version = "v2.17.0"
url = "https://v2.helm.sh/docs"

[params.nextversion]
version = "v3.9.0"
date = "May 18, 2022 (Delayed from May 11)"
version = "v3.10.0"
date = "September 14, 2022"

[[params.quicklinks]]
title = "Quickstart Guide"
Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/helm/helm.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,4 +103,4 @@ By default, the default directories depend on the Operating System. The defaults
* [helm verify](helm_verify.md) - verify that a chart at the given path has been signed and is valid
* [helm version](helm_version.md) - print the client version information

###### Auto generated by spf13/cobra on 24-Jan-2022
###### Auto generated by spf13/cobra on 18-May-2022
2 changes: 1 addition & 1 deletion content/en/docs/helm/helm_completion.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,4 +43,4 @@ Generate autocompletion scripts for Helm for the specified shell.
* [helm completion powershell](helm_completion_powershell.md) - generate autocompletion script for powershell
* [helm completion zsh](helm_completion_zsh.md) - generate autocompletion script for zsh

###### Auto generated by spf13/cobra on 24-Jan-2022
###### Auto generated by spf13/cobra on 18-May-2022
2 changes: 1 addition & 1 deletion content/en/docs/helm/helm_completion_bash.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,4 +57,4 @@ helm completion bash [flags]

* [helm completion](helm_completion.md) - generate autocompletion scripts for the specified shell

###### Auto generated by spf13/cobra on 24-Jan-2022
###### Auto generated by spf13/cobra on 18-May-2022
2 changes: 1 addition & 1 deletion content/en/docs/helm/helm_completion_fish.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,4 +54,4 @@ helm completion fish [flags]

* [helm completion](helm_completion.md) - generate autocompletion scripts for the specified shell

###### Auto generated by spf13/cobra on 24-Jan-2022
###### Auto generated by spf13/cobra on 18-May-2022
2 changes: 1 addition & 1 deletion content/en/docs/helm/helm_completion_powershell.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,4 +50,4 @@ helm completion powershell [flags]

* [helm completion](helm_completion.md) - generate autocompletion scripts for the specified shell

###### Auto generated by spf13/cobra on 24-Jan-2022
###### Auto generated by spf13/cobra on 18-May-2022
2 changes: 1 addition & 1 deletion content/en/docs/helm/helm_completion_zsh.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,4 +52,4 @@ helm completion zsh [flags]

* [helm completion](helm_completion.md) - generate autocompletion scripts for the specified shell

###### Auto generated by spf13/cobra on 24-Jan-2022
###### Auto generated by spf13/cobra on 18-May-2022
2 changes: 1 addition & 1 deletion content/en/docs/helm/helm_create.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,4 +61,4 @@ helm create NAME [flags]

* [helm](helm.md) - The Helm package manager for Kubernetes.

###### Auto generated by spf13/cobra on 24-Jan-2022
###### Auto generated by spf13/cobra on 18-May-2022
2 changes: 1 addition & 1 deletion content/en/docs/helm/helm_dependency.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,4 +86,4 @@ for this case.
* [helm dependency list](helm_dependency_list.md) - list the dependencies for the given chart
* [helm dependency update](helm_dependency_update.md) - update charts/ based on the contents of Chart.yaml

###### Auto generated by spf13/cobra on 24-Jan-2022
###### Auto generated by spf13/cobra on 18-May-2022
2 changes: 1 addition & 1 deletion content/en/docs/helm/helm_dependency_build.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,4 +53,4 @@ helm dependency build CHART [flags]

* [helm dependency](helm_dependency.md) - manage a chart's dependencies

###### Auto generated by spf13/cobra on 24-Jan-2022
###### Auto generated by spf13/cobra on 18-May-2022
2 changes: 1 addition & 1 deletion content/en/docs/helm/helm_dependency_list.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,4 +49,4 @@ helm dependency list CHART [flags]

* [helm dependency](helm_dependency.md) - manage a chart's dependencies

###### Auto generated by spf13/cobra on 24-Jan-2022
###### Auto generated by spf13/cobra on 18-May-2022
2 changes: 1 addition & 1 deletion content/en/docs/helm/helm_dependency_update.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,4 +57,4 @@ helm dependency update CHART [flags]

* [helm dependency](helm_dependency.md) - manage a chart's dependencies

###### Auto generated by spf13/cobra on 24-Jan-2022
###### Auto generated by spf13/cobra on 18-May-2022
2 changes: 1 addition & 1 deletion content/en/docs/helm/helm_env.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,4 +43,4 @@ helm env [flags]

* [helm](helm.md) - The Helm package manager for Kubernetes.

###### Auto generated by spf13/cobra on 24-Jan-2022
###### Auto generated by spf13/cobra on 18-May-2022
2 changes: 1 addition & 1 deletion content/en/docs/helm/helm_get.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,4 +50,4 @@ get extended information about the release, including:
* [helm get notes](helm_get_notes.md) - download the notes for a named release
* [helm get values](helm_get_values.md) - download the values file for a named release

###### Auto generated by spf13/cobra on 24-Jan-2022
###### Auto generated by spf13/cobra on 18-May-2022
2 changes: 1 addition & 1 deletion content/en/docs/helm/helm_get_all.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,4 +46,4 @@ helm get all RELEASE_NAME [flags]

* [helm get](helm_get.md) - download extended information of a named release

###### Auto generated by spf13/cobra on 24-Jan-2022
###### Auto generated by spf13/cobra on 18-May-2022
2 changes: 1 addition & 1 deletion content/en/docs/helm/helm_get_hooks.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,4 +46,4 @@ helm get hooks RELEASE_NAME [flags]

* [helm get](helm_get.md) - download extended information of a named release

###### Auto generated by spf13/cobra on 24-Jan-2022
###### Auto generated by spf13/cobra on 18-May-2022
2 changes: 1 addition & 1 deletion content/en/docs/helm/helm_get_manifest.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,4 +48,4 @@ helm get manifest RELEASE_NAME [flags]

* [helm get](helm_get.md) - download extended information of a named release

###### Auto generated by spf13/cobra on 24-Jan-2022
###### Auto generated by spf13/cobra on 18-May-2022
2 changes: 1 addition & 1 deletion content/en/docs/helm/helm_get_notes.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,4 +44,4 @@ helm get notes RELEASE_NAME [flags]

* [helm get](helm_get.md) - download extended information of a named release

###### Auto generated by spf13/cobra on 24-Jan-2022
###### Auto generated by spf13/cobra on 18-May-2022
2 changes: 1 addition & 1 deletion content/en/docs/helm/helm_get_values.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,4 +46,4 @@ helm get values RELEASE_NAME [flags]

* [helm get](helm_get.md) - download extended information of a named release

###### Auto generated by spf13/cobra on 24-Jan-2022
###### Auto generated by spf13/cobra on 18-May-2022
2 changes: 1 addition & 1 deletion content/en/docs/helm/helm_history.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,4 +57,4 @@ helm history RELEASE_NAME [flags]

* [helm](helm.md) - The Helm package manager for Kubernetes.

###### Auto generated by spf13/cobra on 24-Jan-2022
###### Auto generated by spf13/cobra on 18-May-2022
71 changes: 36 additions & 35 deletions content/en/docs/helm/helm_install.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,40 +82,41 @@ helm install [NAME] [CHART] [flags]
### Options

```
--atomic if set, the installation process deletes the installation on failure. The --wait flag will be set automatically if --atomic is used
--ca-file string verify certificates of HTTPS-enabled servers using this CA bundle
--cert-file string identify HTTPS client using this SSL certificate file
--create-namespace create the release namespace if not present
--dependency-update update dependencies if they are missing before installing the chart
--description string add a custom description
--devel use development versions, too. Equivalent to version '>0.0.0-0'. If --version is set, this is ignored
--disable-openapi-validation if set, the installation process will not validate rendered templates against the Kubernetes OpenAPI Schema
--dry-run simulate an install
-g, --generate-name generate the name (and omit the NAME parameter)
-h, --help help for install
--insecure-skip-tls-verify skip tls certificate checks for the chart download
--key-file string identify HTTPS client using this SSL key file
--keyring string location of public keys used for verification (default "~/.gnupg/pubring.gpg")
--name-template string specify template used to name the release
--no-hooks prevent hooks from running during install
-o, --output format prints the output in the specified format. Allowed values: table, json, yaml (default table)
--pass-credentials pass credentials to all domains
--password string chart repository password where to locate the requested chart
--post-renderer postrenderer the path to an executable to be used for post rendering. If it exists in $PATH, the binary will be used, otherwise it will try to look for the executable at the given path (default exec)
--render-subchart-notes if set, render subchart notes along with the parent
--replace re-use the given name, only if that name is a deleted release which remains in the history. This is unsafe in production
--repo string chart repository url where to locate the requested chart
--set stringArray set values on the command line (can specify multiple or separate values with commas: key1=val1,key2=val2)
--set-file stringArray set values from respective files specified via the command line (can specify multiple or separate values with commas: key1=path1,key2=path2)
--set-string stringArray set STRING values on the command line (can specify multiple or separate values with commas: key1=val1,key2=val2)
--skip-crds if set, no CRDs will be installed. By default, CRDs are installed if not already present
--timeout duration time to wait for any individual Kubernetes operation (like Jobs for hooks) (default 5m0s)
--username string chart repository username where to locate the requested chart
-f, --values strings specify values in a YAML file or a URL (can specify multiple)
--verify verify the package before using it
--version string specify a version constraint for the chart version to use. This constraint can be a specific tag (e.g. 1.1.1) or it may reference a valid range (e.g. ^2.0.0). If this is not specified, the latest version is used
--wait if set, will wait until all Pods, PVCs, Services, and minimum number of Pods of a Deployment, StatefulSet, or ReplicaSet are in a ready state before marking the release as successful. It will wait for as long as --timeout
--wait-for-jobs if set and --wait enabled, will wait until all Jobs have been completed before marking the release as successful. It will wait for as long as --timeout
--atomic if set, the installation process deletes the installation on failure. The --wait flag will be set automatically if --atomic is used
--ca-file string verify certificates of HTTPS-enabled servers using this CA bundle
--cert-file string identify HTTPS client using this SSL certificate file
--create-namespace create the release namespace if not present
--dependency-update update dependencies if they are missing before installing the chart
--description string add a custom description
--devel use development versions, too. Equivalent to version '>0.0.0-0'. If --version is set, this is ignored
--disable-openapi-validation if set, the installation process will not validate rendered templates against the Kubernetes OpenAPI Schema
--dry-run simulate an install
-g, --generate-name generate the name (and omit the NAME parameter)
-h, --help help for install
--insecure-skip-tls-verify skip tls certificate checks for the chart download
--key-file string identify HTTPS client using this SSL key file
--keyring string location of public keys used for verification (default "~/.gnupg/pubring.gpg")
--name-template string specify template used to name the release
--no-hooks prevent hooks from running during install
-o, --output format prints the output in the specified format. Allowed values: table, json, yaml (default table)
--pass-credentials pass credentials to all domains
--password string chart repository password where to locate the requested chart
--post-renderer postRendererString the path to an executable to be used for post rendering. If it exists in $PATH, the binary will be used, otherwise it will try to look for the executable at the given path
--post-renderer-args postRendererArgsSlice an argument to the post-renderer (can specify multiple) (default [])
--render-subchart-notes if set, render subchart notes along with the parent
--replace re-use the given name, only if that name is a deleted release which remains in the history. This is unsafe in production
--repo string chart repository url where to locate the requested chart
--set stringArray set values on the command line (can specify multiple or separate values with commas: key1=val1,key2=val2)
--set-file stringArray set values from respective files specified via the command line (can specify multiple or separate values with commas: key1=path1,key2=path2)
--set-string stringArray set STRING values on the command line (can specify multiple or separate values with commas: key1=val1,key2=val2)
--skip-crds if set, no CRDs will be installed. By default, CRDs are installed if not already present
--timeout duration time to wait for any individual Kubernetes operation (like Jobs for hooks) (default 5m0s)
--username string chart repository username where to locate the requested chart
-f, --values strings specify values in a YAML file or a URL (can specify multiple)
--verify verify the package before using it
--version string specify a version constraint for the chart version to use. This constraint can be a specific tag (e.g. 1.1.1) or it may reference a valid range (e.g. ^2.0.0). If this is not specified, the latest version is used
--wait if set, will wait until all Pods, PVCs, Services, and minimum number of Pods of a Deployment, StatefulSet, or ReplicaSet are in a ready state before marking the release as successful. It will wait for as long as --timeout
--wait-for-jobs if set and --wait enabled, will wait until all Jobs have been completed before marking the release as successful. It will wait for as long as --timeout
```

### Options inherited from parent commands
Expand All @@ -139,4 +140,4 @@ helm install [NAME] [CHART] [flags]

* [helm](helm.md) - The Helm package manager for Kubernetes.

###### Auto generated by spf13/cobra on 24-Jan-2022
###### Auto generated by spf13/cobra on 18-May-2022
3 changes: 2 additions & 1 deletion content/en/docs/helm/helm_lint.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ helm lint PATH [flags]

```
-h, --help help for lint
--quiet print only warnings and errors
--set stringArray set values on the command line (can specify multiple or separate values with commas: key1=val1,key2=val2)
--set-file stringArray set values from respective files specified via the command line (can specify multiple or separate values with commas: key1=path1,key2=path2)
--set-string stringArray set STRING values on the command line (can specify multiple or separate values with commas: key1=val1,key2=val2)
Expand Down Expand Up @@ -54,4 +55,4 @@ helm lint PATH [flags]

* [helm](helm.md) - The Helm package manager for Kubernetes.

###### Auto generated by spf13/cobra on 24-Jan-2022
###### Auto generated by spf13/cobra on 18-May-2022
2 changes: 1 addition & 1 deletion content/en/docs/helm/helm_list.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,4 +83,4 @@ helm list [flags]

* [helm](helm.md) - The Helm package manager for Kubernetes.

###### Auto generated by spf13/cobra on 24-Jan-2022
###### Auto generated by spf13/cobra on 18-May-2022
2 changes: 1 addition & 1 deletion content/en/docs/helm/helm_package.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,4 +63,4 @@ helm package [CHART_PATH] [...] [flags]

* [helm](helm.md) - The Helm package manager for Kubernetes.

###### Auto generated by spf13/cobra on 24-Jan-2022
###### Auto generated by spf13/cobra on 18-May-2022
2 changes: 1 addition & 1 deletion content/en/docs/helm/helm_plugin.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,4 +43,4 @@ Manage client-side Helm plugins.
* [helm plugin uninstall](helm_plugin_uninstall.md) - uninstall one or more Helm plugins
* [helm plugin update](helm_plugin_update.md) - update one or more Helm plugins

###### Auto generated by spf13/cobra on 24-Jan-2022
###### Auto generated by spf13/cobra on 18-May-2022
2 changes: 1 addition & 1 deletion content/en/docs/helm/helm_plugin_install.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,4 +44,4 @@ helm plugin install [options] <path|url>... [flags]

* [helm plugin](helm_plugin.md) - install, list, or uninstall Helm plugins

###### Auto generated by spf13/cobra on 24-Jan-2022
###### Auto generated by spf13/cobra on 18-May-2022
2 changes: 1 addition & 1 deletion content/en/docs/helm/helm_plugin_list.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,4 +37,4 @@ helm plugin list [flags]

* [helm plugin](helm_plugin.md) - install, list, or uninstall Helm plugins

###### Auto generated by spf13/cobra on 24-Jan-2022
###### Auto generated by spf13/cobra on 18-May-2022
2 changes: 1 addition & 1 deletion content/en/docs/helm/helm_plugin_uninstall.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,4 +37,4 @@ helm plugin uninstall <plugin>... [flags]

* [helm plugin](helm_plugin.md) - install, list, or uninstall Helm plugins

###### Auto generated by spf13/cobra on 24-Jan-2022
###### Auto generated by spf13/cobra on 18-May-2022
2 changes: 1 addition & 1 deletion content/en/docs/helm/helm_plugin_update.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,4 +37,4 @@ helm plugin update <plugin>... [flags]

* [helm plugin](helm_plugin.md) - install, list, or uninstall Helm plugins

###### Auto generated by spf13/cobra on 24-Jan-2022
###### Auto generated by spf13/cobra on 18-May-2022
4 changes: 2 additions & 2 deletions content/en/docs/helm/helm_pull.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ helm pull [chart URL | repo/chartname] [...] [flags]
```
--ca-file string verify certificates of HTTPS-enabled servers using this CA bundle
--cert-file string identify HTTPS client using this SSL certificate file
-d, --destination string location to write the chart. If this and tardir are specified, tardir is appended to this (default ".")
-d, --destination string location to write the chart. If this and untardir are specified, untardir is appended to this (default ".")
--devel use development versions, too. Equivalent to version '>0.0.0-0'. If --version is set, this is ignored.
-h, --help help for pull
--insecure-skip-tls-verify skip tls certificate checks for the chart download
Expand Down Expand Up @@ -70,4 +70,4 @@ helm pull [chart URL | repo/chartname] [...] [flags]

* [helm](helm.md) - The Helm package manager for Kubernetes.

###### Auto generated by spf13/cobra on 24-Jan-2022
###### Auto generated by spf13/cobra on 18-May-2022
2 changes: 1 addition & 1 deletion content/en/docs/helm/helm_push.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,4 +46,4 @@ helm push [chart] [remote] [flags]

* [helm](helm.md) - The Helm package manager for Kubernetes.

###### Auto generated by spf13/cobra on 24-Jan-2022
###### Auto generated by spf13/cobra on 18-May-2022
2 changes: 1 addition & 1 deletion content/en/docs/helm/helm_registry.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,4 +41,4 @@ This command consists of multiple subcommands to interact with registries.
* [helm registry login](helm_registry_login.md) - login to a registry
* [helm registry logout](helm_registry_logout.md) - logout from a registry

###### Auto generated by spf13/cobra on 24-Jan-2022
###### Auto generated by spf13/cobra on 18-May-2022
2 changes: 1 addition & 1 deletion content/en/docs/helm/helm_registry_login.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,4 +47,4 @@ helm registry login [host] [flags]

* [helm registry](helm_registry.md) - login to or logout from a registry

###### Auto generated by spf13/cobra on 24-Jan-2022
###### Auto generated by spf13/cobra on 18-May-2022
2 changes: 1 addition & 1 deletion content/en/docs/helm/helm_registry_logout.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,4 +43,4 @@ helm registry logout [host] [flags]

* [helm registry](helm_registry.md) - login to or logout from a registry

###### Auto generated by spf13/cobra on 24-Jan-2022
###### Auto generated by spf13/cobra on 18-May-2022
2 changes: 1 addition & 1 deletion content/en/docs/helm/helm_repo.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,4 +46,4 @@ It can be used to add, remove, list, and index chart repositories.
* [helm repo remove](helm_repo_remove.md) - remove one or more chart repositories
* [helm repo update](helm_repo_update.md) - update information of available charts locally from chart repositories

###### Auto generated by spf13/cobra on 24-Jan-2022
###### Auto generated by spf13/cobra on 18-May-2022
2 changes: 1 addition & 1 deletion content/en/docs/helm/helm_repo_add.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,4 +48,4 @@ helm repo add [NAME] [URL] [flags]

* [helm repo](helm_repo.md) - add, list, remove, update, and index chart repositories

###### Auto generated by spf13/cobra on 24-Jan-2022
###### Auto generated by spf13/cobra on 18-May-2022
2 changes: 1 addition & 1 deletion content/en/docs/helm/helm_repo_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,4 +52,4 @@ helm repo index [DIR] [flags]

* [helm repo](helm_repo.md) - add, list, remove, update, and index chart repositories

###### Auto generated by spf13/cobra on 24-Jan-2022
###### Auto generated by spf13/cobra on 18-May-2022
Loading

0 comments on commit 08e56ae

Please sign in to comment.