Package 

Interface ConfigurableHelmInstallationOptions

  • All Implemented Interfaces:
    org.unbrokendome.gradle.plugins.helm.command.ConfigurableHelmOptions , org.unbrokendome.gradle.plugins.helm.command.ConfigurableHelmServerOperationOptions , org.unbrokendome.gradle.plugins.helm.command.ConfigurableHelmServerOptions , org.unbrokendome.gradle.plugins.helm.command.HelmInstallationOptions , org.unbrokendome.gradle.plugins.helm.command.HelmOptions , org.unbrokendome.gradle.plugins.helm.command.HelmServerOperationOptions , org.unbrokendome.gradle.plugins.helm.command.HelmServerOptions

    
    public interface ConfigurableHelmInstallationOptions
     implements ConfigurableHelmServerOperationOptions, HelmInstallationOptions
                        
    • Method Detail

      • getAtomic

         abstract Property<Boolean> getAtomic()

        If true, roll back changes on failure.

        Corresponds to the --atomic Helm CLI parameter.

      • getDevel

         abstract Property<Boolean> getDevel()

        If true, use development versions, too. Equivalent to version >0.0.0-0.

        Corresponds to the --devel CLI parameter.

      • getVerify

         abstract Property<Boolean> getVerify()

        If true, verify the package before installing it.

        Corresponds to the --verify CLI parameter.

      • getWait

         abstract Property<Boolean> getWait()

        If true, use the --wait flag when installing/upgrading or uninstalling this release.

        When installing or upgrading, it 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. When uninstalling, will wait until all the resources are deleted before returning. It will wait for as long as remoteTimeout.

      • getWaitForJobs

         abstract 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.

      • getVersion

         abstract Property<String> getVersion()

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

        Corresponds to the --version CLI parameter.

      • getCreateNamespace

         abstract Property<Boolean> getCreateNamespace()

        If true, create the release namespace if not present.

        Corresponds to the --create-namespace CLI parameter.

      • getDryRun

         abstract Property<Boolean> getDryRun()

        If true, only simulate the operation.

        Corresponds to the --dry-run CLI parameter.

      • getNoHooks

         abstract Property<Boolean> getNoHooks()

        If true, prevent hooks from running during the operation.

        Corresponds to the --no-hooks CLI parameter.

      • getRemoteTimeout

         abstract Property<Duration> getRemoteTimeout()

        Time to wait for any individual Kubernetes operation (like Jobs for hooks). Default is 300.

        Corresponds to the --timeout command line option in 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.