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 --installby default, orhelm install --replaceif the release does not exist or has previously failed.
-
-
Field Summary
Fields Modifier and Type Field Description private final Property<Boolean>replaceprivate final Property<Boolean>resetValuesprivate final Property<Boolean>reuseValuesprivate final Property<Integer>historyMaxprivate final Property<String>releaseNameprivate final Property<String>chartprivate final Property<String>versionprivate final Property<Boolean>atomicprivate final RegularFilePropertycaFileprivate final RegularFilePropertycertFileprivate final Property<Boolean>develprivate final RegularFilePropertykeyFileprivate final Property<String>passwordprivate final Property<URI>repositoryprivate final Property<String>usernameprivate final MapProperty<String, Object>valuesprivate final MapProperty<String, Object>fileValuesprivate final ConfigurableFileCollectionvalueFilesprivate final Property<Boolean>verifyprivate final Property<Boolean>waitprivate final Property<Boolean>waitForJobsprivate final Property<Boolean>createNamespaceprivate final Property<Boolean>dryRunprivate final Property<Boolean>noHooksprivate final Property<Duration>remoteTimeoutprivate final RegularFilePropertykubeConfigprivate final Property<String>kubeContextprivate final Property<String>namespaceprivate final Provider<String>executableprivate final Provider<Boolean>debugprivate final Provider<List<String>>extraArgsprivate final Provider<Directory>xdgDataHomeprivate final Provider<Directory>xdgConfigHomeprivate final Provider<Directory>xdgCacheHomeprivate Booleanenabledprivate final Property<Duration>timeoutprivate final TaskStateInternalstateprivate BooleanimpliesSubProjectsprivate final BooleanhasCustomActions
-
Constructor Summary
Constructors Constructor Description HelmInstallOrUpgrade()
-
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 UnitinstallOrUpgrade()-
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
-
-
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 ahelm install --replacecommand. If it isfalse(default), then it will perform ahelm upgrade --installcommand 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-valuesparameter of thehelm upgradeCLI 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-valuesparameter of thehelm upgradeCLI 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
0for no limit. If not set, the default value from Helm (currently10) is used.Corresponds to the
--history-maxparameter of thehelm upgradeCLI command.If replace is set to
true, this property will be ignored.
-
installOrUpgrade
final Unit installOrUpgrade()
-
-
-
-