Class HelmInstallOrUpgrade

  • 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.GlobalHelmOptions , 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 , kotlin.Comparable , org.gradle.api.Named , org.gradle.api.Task , org.gradle.api.internal.DynamicObjectAware , org.gradle.api.internal.TaskInternal , org.gradle.api.plugins.ExtensionAware , org.gradle.util.Configurable

    
    public class HelmInstallOrUpgrade
    extends AbstractHelmInstallationCommandTask
                        

    Installs a chart into a remote Kubernetes cluster as a new release, or upgrades an existing release.

    This task will call helm upgrade --install by default, or helm install --replace if the release does not exist or has previously failed.

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
    • Method Summary

      Modifier and Type Method Description
      final Property<Boolean> getReplace() If true, re-use the given release name, even if that name is already used.
      final Property<Boolean> getResetValues() If true, reset the values to the ones built into the chart when upgrading.
      final Property<Boolean> getReuseValues() If true, reuse the last release's values, and merge in any new values.
      final Property<Integer> getHistoryMax() Limit the maximum number of revisions saved per release.
      final Unit installOrUpgrade()
      • Methods inherited from class io.github.build.extensions.oss.gradle.plugins.helm.command.tasks.AbstractHelmInstallationCommandTask

        from, getAtomic, getCaFile, getCertFile, getChart, getCreateNamespace, getDevel, getFileValues, getKeyFile, getPassword, getReleaseName, getRepository, getUsername, getValueFiles, getValues, getVerify, getVersion, getWait, getWaitForJobs
      • Methods inherited from class io.github.build.extensions.oss.gradle.plugins.helm.command.tasks.AbstractHelmServerOperationCommandTask

        getDryRun, getNoHooks, getRemoteTimeout
      • Methods inherited from class io.github.build.extensions.oss.gradle.plugins.helm.command.tasks.AbstractHelmServerCommandTask

        getKubeConfig, getKubeContext, getNamespace
      • Methods inherited from class io.github.build.extensions.oss.gradle.plugins.helm.command.tasks.AbstractHelmCommandTask

        getDebug, getExecutable, getExtraArgs, getXdgCacheHome, getXdgConfigHome, getXdgDataHome
      • Methods inherited from class org.gradle.api.internal.AbstractTask

        acceptServiceReferences, appendParallelSafeAction, doNotTrackState, getAsDynamicObject, getConvention, getIdentityPath, getImpliesSubProjects, getLifecycleDependencies, getOnlyIf, getReasonNotToTrackState, getReasonTaskIsIncompatibleWithConfigurationCache, getRequiredServices, getSharedResources, getStandardOutputCapture, getTaskActions, getTaskIdentity, getTemporaryDirFactory, hasTaskActions, isCompatibleWithConfigurationCache, isEnabled, isHasCustomActions, notCompatibleWithConfigurationCache, prependParallelSafeAction, setImpliesSubProjects
      • Methods inherited from class org.gradle.api.DefaultTask

        compareTo, configure, dependsOn, doFirst, doFirst, doFirst, doLast, doLast, doLast, finalizedBy, getActions, getAnt, getDependsOn, getDescription, getDestroyables, getDidWork, getExtensions, getFinalizedBy, getGroup, getInputs, getLocalState, getLogger, getLogging, getMustRunAfter, getName, getOutputs, getPath, getProject, getShouldRunAfter, getState, getTaskDependencies, getTemporaryDir, getTimeout, hasProperty, mustRunAfter, onlyIf, onlyIf, onlyIf, property, setActions, setDependsOn, setDescription, setDidWork, setEnabled, setFinalizedBy, setGroup, setMustRunAfter, setOnlyIf, setOnlyIf, setOnlyIf, setProperty, setShouldRunAfter, shouldRunAfter, usesService
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • HelmInstallOrUpgrade

        HelmInstallOrUpgrade()
    • Method Detail

      • getReplace

        @Internal() final Property<Boolean> getReplace()

        If true, re-use the given release name, even if that name is already used.

        If this is true, the task will perform a helm install --replace command. If it is false (default), then it will perform a helm upgrade --install command instead.

      • getResetValues

        @Internal() final Property<Boolean> getResetValues()

        If true, reset the values to the ones built into the chart when upgrading.

        Corresponds to the --reset-values parameter of the helm upgrade CLI command.

        If replace is set to true, this property will be ignored.

      • getReuseValues

        @Internal() final Property<Boolean> getReuseValues()

        If true, reuse the last release's values, and merge in any new values. If resetValues is specified, this is ignored.

        Corresponds to the --reuse-values parameter of the helm upgrade CLI command.

        If replace is set to true, this property will be ignored.

      • getHistoryMax

        @Internal() final Property<Integer> getHistoryMax()

        Limit the maximum number of revisions saved per release.

        Use 0 for no limit. If not set, the default value from Helm (currently 10) is used.

        Corresponds to the --history-max parameter of the helm upgrade CLI command.

        If replace is set to true, this property will be ignored.