Constructor Detail

Method Detail

• chart

   abstract ChartReference chart(String project, String chart)

  Returns a reference to a chart, which can be used as a value for the chart property.

  Parameters:

  project - the path to the project that contains the chart, e.g.

  chart - the name of the chart inside the Gradle project.

  Returns:

  a ChartReference that can be used as a value for the chart property

• chart

   ChartReference chart(String name)

  Returns a reference to a chart in the same project, which can be used as a value for the chart property.

  Parameters:

  name - the name of the chart inside the Gradle project

  Returns:

  a ChartReference that can be used as a value for the chart property

• chart

   ChartReference chart(Map<?, ?> notation)

  Returns a reference to a chart that can be used as a value for the chart property.

  This variant is intended for Groovy DSL support, allowing us to declare a chart reference like this:

  chart = chart(project: ':someProject', chart: 'main')

  The following keys are supported in the notation map parameter:

  • project: the path to the project that contains the chart

  • chart: the name of the chart inside the Gradle project

  Parameters:

  notation - a Map containing the chart reference properties

  Returns:

  a ChartReference that can be used as a value for the chart property

• from

   abstract Unit from(Object notation)

  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 ChartReference, as produced by one of the chart methods.

  • A String containing a textual chart reference, e.g. stable/mariadb.

  • A File pointing to an unpackaged chart directory or a packaged chart file.

  • A Directory pointing to an unpackaged chart directory.

  • A RegularFile pointing to a packaged chart file.

  • A URI pointing to a remote chart location.

  • A FileCollection (for example, a Gradle Configuration) that contains a single file or directory. If the FileCollection has any builtBy task dependencies, they will be honored by the helmInstall task associated with this release.

  • a Provider of any of the above.

  Parameters:

  notation - an object defining the chart to be installed by this release

• dependsOn

  @Deprecated(message = "use release tags instead") Unit dependsOn(String releaseName)

  Express a dependency on another release.

  A dependency between two releases will create task dependencies such that the dependency will be installed before, and uninstalled after, the dependent release.

  Currently such dependencies can be expressed only within the same project.

  Deprecated as of 1.2.0; build scripts should indicate such dependencies using release tags instead, and specify the preferred installation/uninstallation order using mustInstallAfter and mustUninstallAfter.

• dependsOn

  @Deprecated(message = "use release tags instead") Unit dependsOn(String releaseNames)

  Express a dependency on several other releases.

  Deprecated as of 1.2.0; build scripts should indicate such dependencies using release tags instead, and specify the preferred installation/uninstallation order using mustInstallAfter and mustUninstallAfter.

• installDependsOn

   Unit installDependsOn(Iterable<Object> paths)

  Declare additional dependencies for the task that installs this release.

  Parameters:

  paths - Additional installation dependencies.

• installDependsOn

   Unit installDependsOn(Object paths)

  Declare additional dependencies for the task that installs this release.

  Parameters:

  paths - Additional installation dependencies.

• mustInstallAfter

   Unit mustInstallAfter(String releaseNames)

  Specifies that this release must be installed after all the supplied releases.

  Parameters:

  releaseNames - names of releases that this release must be installed after

• mustUninstallAfter

   Unit mustUninstallAfter(String releaseNames)

  Specifies that this release must be uninstalled after all the supplied releases.

  Parameters:

  releaseNames - names of releases that this release must be uninstalled after

• test

   Unit test(Action<ConfigurableHelmReleaseTestOptions> configureAction)

  Configure testing options for this release.

  Parameters:

  configureAction - an Action to configure testing options for this release

• getReleaseName

   abstract Property<String> getReleaseName()

• getChart

   abstract Property<ChartReference> getChart()

• getReplace

   abstract Property<Boolean> getReplace()

• getHistoryMax

   abstract Property<Integer> getHistoryMax()

• getKeepHistoryOnUninstall

   abstract Property<Boolean> getKeepHistoryOnUninstall()

• getDependsOn

   abstract SetProperty<String> getDependsOn()

• getInstallDependsOn

   abstract Set<Object> getInstallDependsOn()

• getMustInstallAfter

   abstract Set<String> getMustInstallAfter()

• getMustUninstallAfter

   abstract Set<String> getMustUninstallAfter()

• getTest

   abstract ConfigurableHelmReleaseTestOptions getTest()

• getRepository

   abstract Property<URI> getRepository()

• getUsername

   abstract Property<String> getUsername()

• getPassword

   abstract Property<String> getPassword()

• getCaFile

   abstract RegularFileProperty getCaFile()

• getCertFile

   abstract RegularFileProperty getCertFile()

• getKeyFile

   abstract RegularFileProperty getKeyFile()

• getValues

   abstract MapProperty<String, Object> getValues()

• getFileValues

   abstract MapProperty<String, Object> getFileValues()

• getValueFiles

   abstract ConfigurableFileCollection getValueFiles()