Class HelmTemplate
-
- All Implemented Interfaces:
-
io.github.build.extensions.oss.gradle.plugins.helm.command.ConfigurableGlobalHelmOptions,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
@DisableCachingByDefault(because = "See https://github.com/build-extensions-oss/gradle-helm-plugin/issues/208") public abstract class HelmTemplate extends AbstractHelmInstallationCommandTask
Renders chart templates locally.
-
-
Field Summary
Fields Modifier and Type Field Description private final Property<String>releaseNameprivate final ListProperty<String>apiVersionsprivate final Property<Boolean>replaceprivate final Property<Boolean>isUpgradeprivate final ListProperty<String>showOnlyprivate final Property<Boolean>validateprivate final Property<Boolean>useReleaseNameInOutputPathprivate final DirectoryPropertyoutputDirprivate 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 Property<String>executableprivate final Property<Boolean>debugprivate final ListProperty<String>extraArgsprivate final DirectoryPropertyxdgDataHomeprivate final DirectoryPropertyxdgConfigHomeprivate final DirectoryPropertyxdgCacheHomeprivate final TaskOutputsInternaloutputsprivate final Spec<in TaskInternal>onlyIfprivate final Property<Duration>timeoutprivate final TaskRequiredServicesrequiredServicesprivate final TaskDependencyInternaltaskDependenciesprivate final Set<Object>dependsOnprivate final TaskDestroyablesdestroyablesprivate final Loggerloggerprivate final Stringpathprivate final Factory<File>temporaryDirFactoryprivate final Optional<String>reasonTaskIsIncompatibleWithConfigurationCacheprivate final TaskLocalStatelocalStateprivate final List<InputChangesAwareTaskAction>taskActionsprivate final TaskDependencyInternallifecycleDependenciesprivate BooleanisEnabledprivate BooleanimpliesSubProjectsprivate final TaskInputsInternalinputsprivate Booleanenabledprivate final TaskStateInternalstateprivate final TaskIdentity<?>taskIdentityprivate final TaskDependencyshouldRunAfterprivate final ExtensionContainerextensionsprivate final BooleanisCompatibleWithConfigurationCacheprivate final TaskDependencyfinalizedByprivate final AntBuilderantprivate final DynamicObjectasDynamicObjectprivate final List<ResourceLock>sharedResourcesprivate BooleandidWorkprivate final Optional<String>reasonNotToTrackStateprivate Stringgroupprivate final Set<String>reasonsNotToTrackStateprivate final BooleanisHasCustomActionsprivate List<Action<in Task>>actionsprivate final Stringnameprivate final FiletemporaryDirprivate final LoggingManagerloggingprivate final PathidentityPathprivate final LoggingManagerInternalloggingManagerprivate final TaskDependencymustRunAfterprivate final StandardOutputCapturestandardOutputCaptureprivate final Projectprojectprivate Stringdescription
-
Constructor Summary
Constructors Constructor Description HelmTemplate()
-
Method Summary
Modifier and Type Method Description Property<String>getReleaseName()Release name. final ListProperty<String>getApiVersions()Kubernetes API versions used for Capabilities.APIVersions.final Property<Boolean>getReplace()If true, re-use the given release name, even if that name is already used.final Property<Boolean>getIsUpgrade()If true, setRelease.IsUpgradeinstead ofRelease.IsInstall.final ListProperty<String>getShowOnly()If not empty, only output manifests rendered from the given templates. final Property<Boolean>getValidate()If true, validate your manifests against the Kubernetes cluster you are currently pointing at.final Property<Boolean>getUseReleaseNameInOutputPath()If true, use the release name in the output path.final DirectoryPropertygetOutputDir()Directory into which the template output files will be written. final UnitrenderTemplate()-
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, 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.DefaultTask
getActions, getAnt, getDependsOn, getDescription, getDestroyables, getDidWork, getEnabled, getExtensions, getFinalizedBy, getGroup, getInputs, getLocalState, getLogger, getLogging, getMustRunAfter, getName, getOutputs, getPath, getProject, getShouldRunAfter, getState, getTaskDependencies, getTemporaryDir, getTimeout, setActions, setDescription, setDidWork, setEnabled, setEnabled, setGroup -
Methods inherited from class org.gradle.api.internal.AbstractTask
getAsDynamicObject, getIdentityPath, getImpliesSubProjects, getLifecycleDependencies, getLoggingManager, getOnlyIf, getReasonNotToTrackState, getReasonTaskIsIncompatibleWithConfigurationCache, getReasonsNotToTrackState, getRequiredServices, getSharedResources, getStandardOutputCapture, getTaskActions, getTaskIdentity, getTemporaryDirFactory, isCompatibleWithConfigurationCache, isEnabled, isHasCustomActions, setImpliesSubProjects -
Methods inherited from class org.gradle.api.Task
configure, dependsOn, doFirst, doFirst, doFirst, doLast, doLast, doLast, doNotTrackState, finalizedBy, hasProperty, mustRunAfter, notCompatibleWithConfigurationCache, onlyIf, onlyIf, onlyIf, property, setDependsOn, setFinalizedBy, setMustRunAfter, setOnlyIf, setOnlyIf, setOnlyIf, setProperty, setShouldRunAfter, shouldRunAfter, usesService -
Methods inherited from class kotlin.Comparable
compareTo -
Methods inherited from class org.gradle.api.internal.TaskInternal
acceptServiceReferences, appendParallelSafeAction, doNotTrackStateIf, hasTaskActions, prependParallelSafeAction, restoreOnlyIf, restoreTaskActions -
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
-
Method Detail
-
getReleaseName
@Input()@Optional() Property<String> getReleaseName()
Release name.
-
getApiVersions
@Input() final ListProperty<String> getApiVersions()
Kubernetes API versions used for
Capabilities.APIVersions.Corresponds to the
--api-versionsCLI option.
-
getReplace
@Internal() final Property<Boolean> getReplace()
If
true, re-use the given release name, even if that name is already used.Corresponds to the
--replaceCLI option.
-
getIsUpgrade
@Input()@Optional() final Property<Boolean> getIsUpgrade()
If
true, setRelease.IsUpgradeinstead ofRelease.IsInstall.Corresponds to the
--is-upgradeCLI option.
-
getShowOnly
@Input() final ListProperty<String> getShowOnly()
If not empty, only output manifests rendered from the given templates.
Corresponds to the
--show-onlyCLI option.
-
getValidate
@Internal() final Property<Boolean> getValidate()
If
true, validate your manifests against the Kubernetes cluster you are currently pointing at. This is the same validation performed on an install.Corresponds to the
--validateCLI option.
-
getUseReleaseNameInOutputPath
@Input()@Optional() final Property<Boolean> getUseReleaseNameInOutputPath()
If
true, use the release name in the output path.Corresponds to the
--release-nameCLI option.
-
getOutputDir
@OutputDirectory() final DirectoryProperty getOutputDir()
Directory into which the template output files will be written.
Corresponds to the
--output-dirCLI option.
-
renderTemplate
final Unit renderTemplate()
-
-
-
-