helm:list

Full name:

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

Description:

Retrieves releases matching certain criteria and notifies registered listeners.

Attributes:

  • Requires a Maven project to be executed.

Optional Parameters

Name Type Since Description
clientConfiguration Config - The Config describing how a DefaultKubernetesClient should connect to a Kubernetes cluster.
filter String - The regular expression that will be applied to the list of releases. Only releases that match the filter will be considered for listing.
limit long - The maximum number of releases to retrieve.
Default value is: 256.
namespace String - The namespace from which releases will be listed.
offset String - The next release name in the list; used to offset from the start value.
releaseDiscoveryListeners List - A List of ReleaseDiscoveryListeners whose elements will be notified of each release in the list created by this goal.
Alias is: releaseDiscoveryListenersList.
skip boolean - Whether to skip execution.
Default value is: false.
User property is: helm.skip.
sortBy Tiller$ListSort$SortBy - A SortBy indicating how the results should be sorted. Useful values are NAME and LAST_RELEASED.
Default value is: NAME.
sortOrder Tiller$ListSort$SortOrder - A SortOrder indicating whether results should appear sorted in ascending or descending order.
statusCodes List - A List of StatusOuterClass.Status.Codes. Releases must have one of these status codes to be included in the list created by this goal.
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.

Parameter Details

clientConfiguration:

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

filter:

The regular expression that will be applied to the list of releases. Only releases that match the filter will be considered for listing.
  • Type: java.lang.String
  • Required: No

limit:

The maximum number of releases to retrieve.
  • Type: long
  • Required: No
  • Default: 256

namespace:

The namespace from which releases will be listed.
  • Type: java.lang.String
  • Required: No

offset:

The next release name in the list; used to offset from the start value.
  • Type: java.lang.String
  • Required: No

releaseDiscoveryListeners:

A List of ReleaseDiscoveryListeners whose elements will be notified of each release in the list created by this goal.
  • Type: java.util.List
  • Required: No
  • Alias: releaseDiscoveryListenersList

skip:

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

sortBy:

A SortBy indicating how the results should be sorted. Useful values are NAME and LAST_RELEASED.
  • Type: hapi.services.tiller.Tiller$ListSort$SortBy
  • Required: No
  • Default: NAME

sortOrder:

A SortOrder indicating whether results should appear sorted in ascending or descending order.
  • Type: hapi.services.tiller.Tiller$ListSort$SortOrder
  • Required: No

statusCodes:

A List of StatusOuterClass.Status.Codes. Releases must have one of these status codes to be included in the list created by this goal.
  • Type: java.util.List
  • Required: No

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