helm:update

Full name:

org.microbean:helm-maven-plugin:2.8.2.1.1.2:update

Description:

Updates a release with a new chart.

Attributes:

  • Requires a Maven project to be executed.

Required Parameters

Name Type Since Description
releaseName String - The name of the release.
User property is: helm.releaseName.

Optional Parameters

Name Type Since Description
chartUrl URL - A URL to the new chart to update the release with. If omitted, file:/${project.build.directory}/generated-sources/helm/charts/${project.artifactId} will be used instead.
User property is: helm.update.chartUrl.
clientConfiguration Config - The Config describing how a DefaultKubernetesClient should connect to a Kubernetes cluster.
disableHooks boolean - Whether release hooks should be disabled.
Default value is: false.
dryRun boolean - Whether the operation should be treated as a dry run-a simulation of a real operation.
Default value is: false.
User property is: helm.dryRun.
force boolean - Whether the operation should be forced.
Default value is: false.
User property is: helm.force.
recreate boolean - Whether Pods should be recreated as part of the operation.
Default value is: false.
User property is: helm.recreate.
resetValues boolean - Whether values should be reset to the values built in to the chart. Ignored if reuseValues is true.
Default value is: false.
User property is: helm.update.resetValues.
reuseValues boolean - Whether values should be reused from the prior release, merged together with any additional values specified in the valuesYaml parameter. Ignored if resetValues is true.
User property is: helm.update.reuseValues.
skip boolean - Whether to skip execution.
Default value is: false.
User property is: helm.skip.
tillerLabels Map - The Kubernetes labels normally found on Tiller pods.
User property is: tiller.labels.
tillerNamespace String - The Kubernetes cluster namespace in which Tiller may be found.
Default value is: kube-system.
User property is: tiller.namespace.
tillerPort int - The port on which Tiller may be reached.
Default value is: 44134.
User property is: tiller.port.
timeout long - The timeout, in seconds, to use for Kubernetes operations; set to 300 by default for parity with the helm command line program.
Default value is: 300.
User property is: helm.timeout.
valuesYaml String - New values in YAML format to use when updating the release. May be combined with the effects of the resetValues and reuseValues parameters. If this parameter and the valuesYamlUri parameter are both specified, this parameter is preferred if its value is non-null and non-empty.
User property is: helm.update.valuesYaml.
valuesYamlUri URI - A URI identifying a document containing YAML-formatted values to supply at the time of updating the release. If this parameter and the valuesYaml parameter are both specified, this parameter is ignored if the value of the valuesYaml parameter is non-null and non-empty.
User property is: helm.update.valuesYamlUri.
wait boolean - Whether to wait until any Pods in a release are ready.
Default value is: false.

Parameter Details

chartUrl:

A URL to the new chart to update the release with. If omitted, file:/${project.build.directory}/generated-sources/helm/charts/${project.artifactId} will be used instead.
  • Type: java.net.URL
  • Required: No
  • User Property: helm.update.chartUrl

clientConfiguration:

The Config describing how a DefaultKubernetesClient should connect to a Kubernetes cluster.
  • Type: io.fabric8.kubernetes.client.Config
  • Required: No

disableHooks:

Whether release hooks should be disabled.
  • Type: boolean
  • Required: No
  • Default: false

dryRun:

Whether the operation should be treated as a dry run-a simulation of a real operation.
  • Type: boolean
  • Required: No
  • User Property: helm.dryRun
  • Default: false

force:

Whether the operation should be forced.
  • Type: boolean
  • Required: No
  • User Property: helm.force
  • Default: false

recreate:

Whether Pods should be recreated as part of the operation.
  • Type: boolean
  • Required: No
  • User Property: helm.recreate
  • Default: false

releaseName:

The name of the release.
  • Type: java.lang.String
  • Required: Yes
  • User Property: helm.releaseName

resetValues:

Whether values should be reset to the values built in to the chart. Ignored if reuseValues is true.
  • Type: boolean
  • Required: No
  • User Property: helm.update.resetValues
  • Default: false

reuseValues:

Whether values should be reused from the prior release, merged together with any additional values specified in the valuesYaml parameter. Ignored if resetValues is true.
  • Type: boolean
  • Required: No
  • User Property: helm.update.reuseValues

skip:

Whether to skip execution.
  • Type: boolean
  • Required: No
  • User Property: helm.skip
  • Default: false

tillerLabels:

The Kubernetes labels normally found on Tiller pods.
  • Type: java.util.Map
  • Required: No
  • User Property: tiller.labels

tillerNamespace:

The Kubernetes cluster namespace in which Tiller may be found.
  • Type: java.lang.String
  • Required: No
  • User Property: tiller.namespace
  • Default: kube-system

tillerPort:

The port on which Tiller may be reached.
  • Type: int
  • Required: No
  • User Property: tiller.port
  • Default: 44134

timeout:

The timeout, in seconds, to use for Kubernetes operations; set to 300 by default for parity with the helm command line program.
  • Type: long
  • Required: No
  • User Property: helm.timeout
  • Default: 300

valuesYaml:

New values in YAML format to use when updating the release. May be combined with the effects of the resetValues and reuseValues parameters. If this parameter and the valuesYamlUri parameter are both specified, this parameter is preferred if its value is non-null and non-empty.
  • Type: java.lang.String
  • Required: No
  • User Property: helm.update.valuesYaml

valuesYamlUri:

A URI identifying a document containing YAML-formatted values to supply at the time of updating the release. If this parameter and the valuesYaml parameter are both specified, this parameter is ignored if the value of the valuesYaml parameter is non-null and non-empty.
  • Type: java.net.URI
  • Required: No
  • User Property: helm.update.valuesYamlUri

wait:

Whether to wait until any Pods in a release are ready.
  • Type: boolean
  • Required: No
  • Default: false