helm:install

Full name:

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

Description:

Installs a chart and hence creates a release.

Attributes:

  • Requires a Maven project to be executed.

Required Parameters

Name Type Since Description
chartUrl URL - A URL representing the chart to install. If omitted, file:/${project.build.directory}/generated-sources/helm/charts/${project.artifactId} will be used instead.
Default value is: file:${project.build.directory}/generated-sources/helm/charts/${project.artifactId}.
User property is: helm.install.chartUrl.

Optional Parameters

Name Type Since Description
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.
lenient boolean - Whether a missing or non-resolvable chartUrl parameter will result in skipped execution or an error.
Default value is: false.
releaseName String - The name of the release to install. If omitted, a release name will be generated and used instead.
releaseNamespace String - The namespace into which the release will be installed.
reuseReleaseName boolean - Whether to reuse the release name for repeated installations. It is strongly recommended that you not set this to true in production scenarios.
Default value is: false.
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 - YAML-formatted values to supply at the time of installation. 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.install.valuesYaml.
valuesYamlUri URI - A URI identifying a document containing YAML-formatted values to supply at the time of installation. 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.install.valuesYamlUri.
wait boolean - Whether to wait until any Pods in a release are ready.
Default value is: false.

Parameter Details

chartUrl:

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

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

lenient:

Whether a missing or non-resolvable chartUrl parameter will result in skipped execution or an error.
  • Type: boolean
  • Required: No
  • Default: false

releaseName:

The name of the release to install. If omitted, a release name will be generated and used instead.
  • Type: java.lang.String
  • Required: No

releaseNamespace:

The namespace into which the release will be installed.
  • Type: java.lang.String
  • Required: No

reuseReleaseName:

Whether to reuse the release name for repeated installations. It is strongly recommended that you not set this to true in production scenarios.
  • Type: boolean
  • Required: No
  • Default: false

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:

YAML-formatted values to supply at the time of installation. 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.install.valuesYaml

valuesYamlUri:

A URI identifying a document containing YAML-formatted values to supply at the time of installation. 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.install.valuesYamlUri

wait:

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