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

Interface HelmRelease

  • All Implemented Interfaces:
    io.github.build.extensions.oss.gradle.plugins.helm.command.ConfigurableHelmInstallFromRepositoryOptions , 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.HelmInstallFromRepositoryOptions , 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 , io.github.build.extensions.oss.gradle.plugins.helm.release.dsl.HelmReleaseProperties , org.gradle.api.Named 
    
public interface HelmRelease
 implements Named, HelmReleaseProperties, ConfigurableHelmInstallFromRepositoryOptions

    Represents a release to be installed into or uninstalled from a Kubernetes cluster.

    Provides methods for target-specific configuration of the release.

    • 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 tags(Iterable<String> tags) Declare tags for this release.
      Unit tags(String tags) Declare tags for this release.
      abstract Unit valuesDirs(Iterable<Object> directories) Adds directories containing values files to the release.
      Unit valuesDirs(Object directories) Adds directories containing values files to the release.
      Unit valuesDir(Object directory) Adds a directory containing values files to the release.
      abstract Unit forTargets(Iterable<String> targets, Action<HelmRelease.TargetSpecific> action) Adds a target-specific configuration action for the given release targets.
      Unit forTargets(String targets, Action<HelmRelease.TargetSpecific> action) Adds a target-specific configuration action for the given release targets.
      Unit forTarget(String target, Action<HelmRelease.TargetSpecific> action) Adds a target-specific configuration action for the given release target.
      Unit forAnyTarget(Action<HelmRelease.TargetSpecific> action) Adds a target-specific configuration action for any target.
      abstract Set<String> getTags() Tags for this release.
      abstract ListProperty<File> getValuesDirs() A list of directories that contain target-specific values files for the release.

      • Methods inherited from class io.github.build.extensions.oss.gradle.plugins.helm.release.dsl.HelmReleaseProperties

        chart, chart, chart, dependsOn, dependsOn, from, getChart, getDependsOn, getHistoryMax, getInstallDependsOn, getKeepHistoryOnUninstall, getMustInstallAfter, getMustUninstallAfter, getReleaseName, getReplace, getTest, installDependsOn, installDependsOn, mustInstallAfter, mustUninstallAfter, test

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

        getCaFile, getCertFile, getKeyFile, getPassword, getRepository, getUsername

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

        getFileValues, getValueFiles, getValues

      • 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

      • tags

         Unit tags(Iterable<String> tags)

        Declare tags for this release.

        Tags can be used to filter the set of releases to be installed or uninstalled. Releases that do not have any tags will always be installed.

        Parameters:
        tags - the tags to use for this release

      • tags

         Unit tags(String tags)

        Declare tags for this release.

        Tags can be used to filter the set of releases to be installed or uninstalled. Releases that do not have any tags will always be installed.

        Parameters:
        tags - the tags to use for this release

      • valuesDirs

         abstract Unit valuesDirs(Iterable<Object> directories)

        Adds directories containing values files to the release.

        Parameters:
        directories - the directories to add.

      • valuesDirs

         Unit valuesDirs(Object directories)

        Adds directories containing values files to the release.

        Parameters:
        directories - the directories to add.

      • valuesDir

         Unit valuesDir(Object directory)

        Adds a directory containing values files to the release.

        Parameters:
        directory - the directory to add.

      • forTargets

         abstract Unit forTargets(Iterable<String> targets, Action<HelmRelease.TargetSpecific> action)

        Adds a target-specific configuration action for the given release targets.

        Target names can be prefixed with an exclamation mark (e.g. !target) to apply the configuration for any but the given target.

        Parameters:
        targets - the names of release targets
        action - the target-specific configuration to apply

      • forTargets

         Unit forTargets(String targets, Action<HelmRelease.TargetSpecific> action)

        Adds a target-specific configuration action for the given release targets.

        Target names can be prefixed with an exclamation mark (e.g. !target) to apply the configuration for any but the given target.

        Parameters:
        targets - the names of release targets
        action - the target-specific configuration to apply

      • forTarget

         Unit forTarget(String target, Action<HelmRelease.TargetSpecific> action)

        Adds a target-specific configuration action for the given release target.

        The target name can be prefixed with an exclamation mark (e.g. !target) to apply the configuration for any but the given target.

        Parameters:
        target - the name of the release target
        action - the target-specific configuration to apply

      • forAnyTarget

         Unit forAnyTarget(Action<HelmRelease.TargetSpecific> action)

        Adds a target-specific configuration action for any target.

        Use this method to specify a custom configuration block that depends on the HelmReleaseTarget, which is available via the TargetSpecific.target property in the action parameter.

        Parameters:
        action - the target-specific configuration to apply

      • getTags

         abstract Set<String> getTags()

        Tags for this release.

        Tags can be used to filter the set of releases to be installed or uninstalled. Releases that do not have any tags will always be installed.

      • getValuesDirs

         abstract ListProperty<File> getValuesDirs()

        A list of directories that contain target-specific values files for the release.

        From each directory in the list, in the order of appearance, the following files are used if they exist:

        • A file named values.yaml

        • A file named values-<target>.yaml, where <target> is the currently active release target.