Package io.github.build.extensions.oss.gradle.plugins.helm.release.dsl

Interface HelmReleaseTarget

  • All Implemented Interfaces:
    io.github.build.extensions.oss.gradle.plugins.helm.command.ConfigurableHelmInstallationOptions , io.github.build.extensions.oss.gradle.plugins.helm.command.ConfigurableHelmOptions , io.github.build.extensions.oss.gradle.plugins.helm.command.ConfigurableHelmServerOperationOptions , io.github.build.extensions.oss.gradle.plugins.helm.command.ConfigurableHelmServerOptions , io.github.build.extensions.oss.gradle.plugins.helm.command.ConfigurableHelmValueOptions , io.github.build.extensions.oss.gradle.plugins.helm.command.HelmInstallationOptions , io.github.build.extensions.oss.gradle.plugins.helm.command.HelmOptions , io.github.build.extensions.oss.gradle.plugins.helm.command.HelmServerOperationOptions , io.github.build.extensions.oss.gradle.plugins.helm.command.HelmServerOptions , io.github.build.extensions.oss.gradle.plugins.helm.command.HelmValueOptions , org.gradle.api.Named , org.gradle.api.plugins.ExtensionAware 
    
public interface HelmReleaseTarget
 implements Named, ConfigurableHelmInstallationOptions, ConfigurableHelmValueOptions, ExtensionAware

    Defines a target configuration for installing and uninstalling releases.

    A release target can specify its own server options to coordinate to a specific remote Kubernetes cluster. Additionally, it can specify values that should be applied to all releases when installing to this target.

    This interface also exposes ExtensionAware, so that build scripts can access the ext (Groovy) / extra (Kotlin) properties of the release target.

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description

    • Field Summary

      Fields 
      Modifier and Type Field Description

    • Constructor Summary

      Constructors 
      Constructor Description

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description

    • Method Summary

      Modifier and Type Method Description
      Unit test(Action<ConfigurableHelmReleaseTestOptions> configureAction) Configure testing options for this release target.
      abstract MapProperty<String, Object> getValues() Values to be passed directly.
      abstract MapProperty<String, Object> getFileValues() Values read from the contents of files.
      abstract ConfigurableFileCollection getValueFiles() A collection of YAML files containing values.
      abstract String getSelectTags() Tag expression to select releases for this target.
      abstract Unit setSelectTags(String value) Tag expression to select releases for this target.
      abstract ConfigurableHelmReleaseTestOptions getTest() Access testing configuration options for this release target.

      • Methods inherited from class io.github.build.extensions.oss.gradle.plugins.helm.command.ConfigurableHelmInstallationOptions

        getAtomic, getCreateNamespace, getDevel, getVerify, getVersion, getWait, getWaitForJobs

      • Methods inherited from class org.gradle.api.plugins.ExtensionAware

        getExtensions

      • Methods inherited from class org.gradle.api.Named

        getName

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

    • Method Detail

      • test

         Unit test(Action<ConfigurableHelmReleaseTestOptions> configureAction)

        Configure testing options for this release target.

        Parameters:
        configureAction - an Action to configure testing options for this release target

      • getValues

         abstract MapProperty<String, Object> getValues()

        Values to be passed directly. These will be applied to all releases when this target is active.

        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

         abstract MapProperty<String, Object> getFileValues()

        Values read from the contents of files. These will be applied to all releases when this target is active.

        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, the consuming 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

         abstract ConfigurableFileCollection getValueFiles()

        A collection of YAML files containing values. These will be applied to all releases when this target is active.

        Corresponds to the --values CLI option.

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

      • getSelectTags

         abstract String getSelectTags()

        Tag expression to select releases for this target.