Package 

Interface HelmExtension

  • All Implemented Interfaces:
    org.unbrokendome.gradle.plugins.helm.command.ConfigurableGlobalHelmOptions , org.unbrokendome.gradle.plugins.helm.command.ConfigurableHelmOptions , org.unbrokendome.gradle.plugins.helm.command.ConfigurableHelmServerOptions , org.unbrokendome.gradle.plugins.helm.command.GlobalHelmOptions , org.unbrokendome.gradle.plugins.helm.command.HelmExecProvider , org.unbrokendome.gradle.plugins.helm.command.HelmOptions , org.unbrokendome.gradle.plugins.helm.command.HelmServerOptions 
    
public interface HelmExtension
 implements HelmExecProvider, ConfigurableGlobalHelmOptions, ConfigurableHelmServerOptions

    The main Helm DSL extension, accessible using the helm { ... } block in build scripts.

    • Method Detail

      • getRenderOutputDir

         abstract DirectoryProperty getRenderOutputDir()

        Base output directory for rendering (helm template) outputs.

        Defaults to "${project.buildDir}/helm/render".

      • getExecutable

         abstract Property<String> getExecutable()

        The name or path of the Helm executable. The PATH variable is taken into account, so this can just be "helm" if the Helm client is installed in a suitable location.

      • getDebug

         abstract Property<Boolean> getDebug()

        Indicates whether to use the verbose output (--debug flag) when invoking commands.

      • getExtraArgs

         abstract ListProperty<String> getExtraArgs()

        Additional command-line arguments to pass to the Helm CLI.

        This can be used for command-line options that have no counterpart in the plugin.

      • getXdgDataHome

         abstract DirectoryProperty getXdgDataHome()

        Base directory for storing data.

        Corresponds to the XDG_DATA_HOME environment variable. If not set, defaults to helm/data inside the project build directory.

        See [https://helm.sh/docs/helm/helm/] for details about how XDG base directories are used by the Helm CLI.

      • getXdgConfigHome

         abstract DirectoryProperty getXdgConfigHome()

        Base directory for storing configuration.

        Corresponds to the XDG_CONFIG_HOME environment variable. If not set, defaults to helm/config inside the project build directory.

        See [https://helm.sh/docs/helm/helm/] for details about how XDG base directories are used by the Helm CLI.

      • getXdgCacheHome

         abstract DirectoryProperty getXdgCacheHome()

        Base directory for storing cached data.

        Corresponds to the XDG_CACHE_HOME environment variable. If not set, defaults to .gradle/helm/cache inside the root project directory.

        See [https://helm.sh/docs/helm/helm/] for details about how XDG base directories are used by the Helm CLI.

      • getKubeConfig

         abstract RegularFileProperty getKubeConfig()

        Path to the Kubernetes configuration file.

        If this property is set, its value will be used to set the KUBECONFIG environment variable for each Helm invocation.

      • getKubeContext

         abstract Property<String> getKubeContext()

        Name of the kubeconfig context to use.

        Corresponds to the --kube-context command line option in the Helm CLI.

      • getNamespace

         abstract Property<String> getNamespace()

        Namespace scope for this request.

        Corresponds to the --namespace CLI parameter.