Constructor Detail

• AbstractHelmInstallationCommandTask

  AbstractHelmInstallationCommandTask()

Method Detail

• getReleaseName

  @Input() Property<String> getReleaseName()

  Release name.

• getChart

  @Input() final Property<String> getChart()

  The chart to be installed. This can be any of the forms accepted by the Helm CLI.

  • chart reference: e.g. stable/mariadb

  • path to a packaged chart

  • path to an unpacked chart directory

  • absolute URL: e.g. https://example.com/charts/nginx-1.2.3.tgz

  • simple chart reference, e.g. mariadb (you must also set the repository property in this case)

• getVersion

  @Input()@Optional() Property<String> getVersion()

  Specify the exact chart version to install. If this is not specified, the latest version is installed.

  Corresponds to the --version Helm CLI parameter.

• getAtomic

  @Internal() final Property<Boolean> getAtomic()

  If true, roll back changes on failure.

  Corresponds to the --atomic Helm CLI parameter.

• getCaFile

  @Internal() final RegularFileProperty getCaFile()

  Verify certificates of HTTPS-enabled servers using this CA bundle.

  Corresponds to the --ca-file CLI parameter.

• getCertFile

  @Internal() final RegularFileProperty getCertFile()

  Identify HTTPS client using this SSL certificate file.

  Corresponds to the --cert-file CLI parameter.

• getDevel

  @Input()@Optional() final Property<Boolean> getDevel()

  If true, use development versions, too. Equivalent to version >0.0.0-0. If version is set, this is ignored.

  Corresponds to the --devel CLI parameter.

• getKeyFile

  @Internal() final RegularFileProperty getKeyFile()

  Identify HTTPS client using this SSL key file.

  Corresponds to the --key-file CLI parameter.

• getPassword

  @Internal() final Property<String> getPassword()

  Chart repository password where to locate the requested chart.

  Corresponds to the --password CLI parameter.

• getRepository

  @Input()@Optional() final Property<URI> getRepository()

  Chart repository URL where to locate the requested chart.

  Corresponds to the --repo Helm CLI parameter.

  Use this when the chart property contains only a simple chart reference, without a symbolic repository name.

• getUsername

  @Internal() final Property<String> getUsername()

  Chart repository username where to locate the requested chart.

  Corresponds to the --username CLI parameter.

• getValues

  @Input() final MapProperty<String, Object> getValues()

  Values to be used for the release.

  Entries in the map will be sent to the CLI using either the --set-string option (for strings) or the --set option (for all other types).

• getFileValues

  @Input() final MapProperty<String, Object> getFileValues()

  Values read from the contents of files, to be used for the release.

  Corresponds to the --set-file CLI option.

  The values of the map can be of any type that is accepted by Project.file. Additionally, when adding a Provider that represents an output file of another task, this task will automatically have a task dependency on the producing task.

  Not to be confused with valueFiles, which contains a collection of YAML files that supply multiple values.

• getValueFiles

  @InputFiles() final ConfigurableFileCollection getValueFiles()

  A collection of YAML files containing values for this release.

  Corresponds to the --values CLI option.

  Not to be confused with fileValues, which contains entries whose values are the contents of files.

• getVerify

  @Internal() final Property<Boolean> getVerify()

  If true, verify the package before installing it.

  Corresponds to the --verify CLI parameter.

• getWait

  @Internal() final Property<Boolean> getWait()

  If true, will wait until all Pods, PVCs, Services, and minimum number of Pods of a Deployment are in a ready state before marking the release as successful. It will wait for as along as remoteTimeout.

• getWaitForJobs

  @Internal() final Property<Boolean> getWaitForJobs()

  If true, and wait is also true, will wait until all Jobs have been completed before marking the release as successful. It will wait for as long as remoteTimeout.

• getCreateNamespace

  @Internal() final Property<Boolean> getCreateNamespace()

  If true, create the release namespace if not present.

  Corresponds to the --create-namespace CLI parameter.

• from

   final Unit from(Object chart)

  Sets the chart to be installed. The value can be any of the forms accepted by the Helm CLI.

  This is a convenience method that can be used instead of setting the chart property directly.

  The following argument types are accepted:

  • A chart reference (String): e.g. stable/mariadb.

  • A path to a packaged chart (String, File, RegularFile)

  • A path to an unpacked chart directory (String, File, Directory)

  • An absolute URL (String, URI): e.g. https://example.com/charts/nginx-1.2.3.tgz

  • A simple chart reference (String), e.g. mariadb. Note that you must also set the repository property in this case.

  • a Provider of any of the above.