Package io.github.build.extensions.oss.gradle.plugins.helm.command

Interface ConfigurableHelmInstallationOptions

  • All Implemented Interfaces:
    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.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 
    
public interface ConfigurableHelmInstallationOptions
 implements ConfigurableHelmServerOperationOptions, HelmInstallationOptions

    • 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
      abstract Property<Boolean> getAtomic() If true, roll back changes on failure.
      abstract Property<Boolean> getDevel() If true, use development versions, too.
      abstract Property<Boolean> getVerify() If true, verify the package before installing it.
      abstract Property<Boolean> getWait() If true, use the --wait flag when installing/upgrading or uninstalling this release.
      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.
      abstract Property<String> getVersion() Specify the exact chart version to install.
      abstract Property<Boolean> getCreateNamespace() If true, create the release namespace if not present.

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

        getDryRun, getNoHooks, getRemoteTimeout

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

        getKubeConfig, getKubeContext, getNamespace

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

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