Difference between revisions of "Helm upgrade --help"

From wikieduonline
Jump to navigation Jump to search
 
(4 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
{{lc}}
 
{{lc}}
 +
[[helm upgrade]] --help
  
 +
This command upgrades a release to a new version of a chart.
 +
 +
The upgrade arguments must be a release and chart. The chart
 +
argument can be either: a CHART reference('example/mariadb'), a path to a chart directory,
 +
a packaged chart, or a fully qualified URL. For chart references, the latest
 +
version will be specified unless the '--version' flag is set.
 +
 +
To override values in a chart, use either the '--values' flag and pass in a file
 +
or use the '--set' flag and pass configuration from the command line, to force string
 +
values, use '--set-string'. You can use '--set-file' to set individual
 +
values from a file when the value itself is too long for the command line
 +
or is dynamically generated.
 +
 +
You can specify the '--values'/'-f' flag multiple times. The priority will be given to the
 +
last (right-most) file specified. For example, if both myvalues.yaml and override.yaml
 +
contained a key called 'Test', the value set in override.yaml would take precedence:
 +
 +
    $ helm upgrade -f myvalues.yaml -f override.yaml redis ./redis
 +
 +
You can specify the '--set' flag multiple times. The priority will be given to the
 +
last (right-most) set specified. For example, if both 'bar' and 'newbar' values are
 +
set for a key called 'foo', the 'newbar' value would take precedence:
 +
 +
    $ helm upgrade --set foo=bar --set foo=newbar redis ./redis
 +
 +
Usage:
 +
  helm upgrade [RELEASE] [CHART] [flags]
 +
 +
Flags:
 +
      [[--atomic]]                                    if set, upgrade process rolls back changes made in case of failed upgrade. The --wait flag will be set automatically if --atomic is used
 +
<pre>
 +
      --ca-file string                            verify certificates of HTTPS-enabled servers using this CA bundle
 +
      --cert-file string                          identify HTTPS client using this SSL certificate file
 +
      --cleanup-on-fail                            allow deletion of new resources created in this upgrade when upgrade fails
 +
      --create-namespace                          if --install is set, 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 upgrade process will not validate rendered templates against the Kubernetes OpenAPI Schema
 +
      --dry-run                                    simulate an upgrade
 +
      --force                                      force resource updates through a replacement strategy
 +
  -h, --help                                      help for upgrade
 +
      --history-max int                            limit the maximum number of revisions saved per release. Use 0 for no limit (default 10)
 +
      --insecure-skip-tls-verify                  skip tls certificate checks for the chart download
 +
  -i, --install                                    if a release by this name doesn't already exist, run an install
 +
      --key-file string                            identify HTTPS client using this SSL key file
 +
      --keyring string                            location of public keys used for verification (default "/Users/m/.gnupg/pubring.gpg")
 +
      --no-hooks                                  disable pre/post upgrade hooks
 +
  -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
 +
      --repo string                                chart repository url where to locate the requested chart
 +
      --reset-values                              when upgrading, reset the values to the ones built into the chart
 +
      --reuse-values                              when upgrading, reuse the last release's values and merge in any overrides from the command line via --set and -f. If '--reset-values' is specified, this is ignored
 +
      --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 when an upgrade is performed with install flag enabled. By default, CRDs are installed if not already present, when an upgrade is performed with install flag enabled
 +
      --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
 +
 +
Global Flags:
 +
      --debug                      enable verbose output
 +
      --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
 +
      --registry-config string      path to the registry config file (default "/Users/m/Library/Preferences/helm/registry/config.json")
 +
      --repository-cache string    path to the file containing cached repository indexes (default "/Users/m/Library/Caches/helm/repository")
 +
      --repository-config string    path to the file containing repository names and URLs (default "/Users/m/Library/Preferences/helm/repositories.yaml")
 +
</pre>
  
  

Latest revision as of 15:04, 11 October 2023

helm upgrade --help
This command upgrades a release to a new version of a chart.

The upgrade arguments must be a release and chart. The chart
argument can be either: a CHART reference('example/mariadb'), a path to a chart directory,
a packaged chart, or a fully qualified URL. For chart references, the latest
version will be specified unless the '--version' flag is set.

To override values in a chart, use either the '--values' flag and pass in a file
or use the '--set' flag and pass configuration from the command line, to force string
values, use '--set-string'. You can use '--set-file' to set individual
values from a file when the value itself is too long for the command line
or is dynamically generated.

You can specify the '--values'/'-f' flag multiple times. The priority will be given to the
last (right-most) file specified. For example, if both myvalues.yaml and override.yaml
contained a key called 'Test', the value set in override.yaml would take precedence:

    $ helm upgrade -f myvalues.yaml -f override.yaml redis ./redis

You can specify the '--set' flag multiple times. The priority will be given to the
last (right-most) set specified. For example, if both 'bar' and 'newbar' values are
set for a key called 'foo', the 'newbar' value would take precedence:

    $ helm upgrade --set foo=bar --set foo=newbar redis ./redis

Usage:
  helm upgrade [RELEASE] [CHART] [flags]

Flags:
      --atomic                                     if set, upgrade process rolls back changes made in case of failed upgrade. 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
      --cleanup-on-fail                            allow deletion of new resources created in this upgrade when upgrade fails
      --create-namespace                           if --install is set, 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 upgrade process will not validate rendered templates against the Kubernetes OpenAPI Schema
      --dry-run                                    simulate an upgrade
      --force                                      force resource updates through a replacement strategy
  -h, --help                                       help for upgrade
      --history-max int                            limit the maximum number of revisions saved per release. Use 0 for no limit (default 10)
      --insecure-skip-tls-verify                   skip tls certificate checks for the chart download
  -i, --install                                    if a release by this name doesn't already exist, run an install
      --key-file string                            identify HTTPS client using this SSL key file
      --keyring string                             location of public keys used for verification (default "/Users/m/.gnupg/pubring.gpg")
      --no-hooks                                   disable pre/post upgrade hooks
  -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
      --repo string                                chart repository url where to locate the requested chart
      --reset-values                               when upgrading, reset the values to the ones built into the chart
      --reuse-values                               when upgrading, reuse the last release's values and merge in any overrides from the command line via --set and -f. If '--reset-values' is specified, this is ignored
      --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 when an upgrade is performed with install flag enabled. By default, CRDs are installed if not already present, when an upgrade is performed with install flag enabled
      --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

Global Flags:
      --debug                       enable verbose output
      --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
      --registry-config string      path to the registry config file (default "/Users/m/Library/Preferences/helm/registry/config.json")
      --repository-cache string     path to the file containing cached repository indexes (default "/Users/m/Library/Caches/helm/repository")
      --repository-config string    path to the file containing repository names and URLs (default "/Users/m/Library/Preferences/helm/repositories.yaml")


See also[edit]

Advertising: