helm:uninstall

Full name:

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

Description:

Uninstalls a release.

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
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.
purge boolean - Whether the release being uninstalled should be purged entirely instead of being marked as deleted.
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 default 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.

Parameter Details

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

purge:

Whether the release being uninstalled should be purged entirely instead of being marked as deleted.
  • Type: boolean
  • Required: No
  • Default: false

releaseName:

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

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 default 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
  • Default: 300