Class HelmUpgrade

  • 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 HelmUpgrade
    extends AbstractHelmInstallationCommandTask
                        

    Upgrades a release on the cluster. Corresponds to the helm upgrade CLI command.

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
    • Constructor Summary

      Constructors 
      Constructor Description
      HelmUpgrade()
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
    • Method Summary

      Modifier and Type Method Description
      final Property<Boolean> getInstall() If true, run an install if a release by this name doesn't already exist.
      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 upgradeRelease()
      • 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

      • HelmUpgrade

        HelmUpgrade()
    • Method Detail

      • getInstall

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

        If true, run an install if a release by this name doesn't already exist.

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

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

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