All Implemented Interfaces:

kotlin.Comparable , org.gradle.api.Task , org.gradle.api.internal.DynamicObjectAware , org.gradle.api.internal.TaskInternal , org.gradle.api.plugins.ExtensionAware , org.gradle.util.Configurable , org.unbrokendome.gradle.plugins.helm.command.ConfigurableHelmInstallFromRepositoryOptions , org.unbrokendome.gradle.plugins.helm.command.ConfigurableHelmInstallationOptions , org.unbrokendome.gradle.plugins.helm.command.ConfigurableHelmOptions , org.unbrokendome.gradle.plugins.helm.command.ConfigurableHelmServerOperationOptions , org.unbrokendome.gradle.plugins.helm.command.ConfigurableHelmServerOptions , org.unbrokendome.gradle.plugins.helm.command.ConfigurableHelmValueOptions , org.unbrokendome.gradle.plugins.helm.command.GlobalHelmOptions , org.unbrokendome.gradle.plugins.helm.command.HelmInstallFromRepositoryOptions , org.unbrokendome.gradle.plugins.helm.command.HelmInstallationOptions , org.unbrokendome.gradle.plugins.helm.command.HelmOptions , org.unbrokendome.gradle.plugins.helm.command.HelmServerOperationOptions , org.unbrokendome.gradle.plugins.helm.command.HelmServerOptions , org.unbrokendome.gradle.plugins.helm.command.HelmValueOptions
```
public class HelmTemplate
extends AbstractHelmInstallationCommandTask
                    
```
Renders chart templates locally.

Field Summary

Fields
Modifier and Type	Field	Description
`private final Property<String>`	`releaseName`
`private final ListProperty<String>`	`apiVersions`
`private final Property<Boolean>`	`replace`
`private final Property<Boolean>`	`isUpgrade`
`private final ListProperty<String>`	`showOnly`
`private final Property<Boolean>`	`validate`
`private final Property<Boolean>`	`useReleaseNameInOutputPath`
`private final DirectoryProperty`	`outputDir`
`private final Property<String>`	`chart`
`private final Property<String>`	`version`
`private final Property<Boolean>`	`atomic`
`private final RegularFileProperty`	`caFile`
`private final RegularFileProperty`	`certFile`
`private final Property<Boolean>`	`devel`
`private final RegularFileProperty`	`keyFile`
`private final Property<String>`	`password`
`private final Property<URI>`	`repository`
`private final Property<String>`	`username`
`private final MapProperty<String, Object>`	`values`
`private final MapProperty<String, Object>`	`fileValues`
`private final ConfigurableFileCollection`	`valueFiles`
`private final Property<Boolean>`	`verify`
`private final Property<Boolean>`	`wait`
`private final Property<Boolean>`	`waitForJobs`
`private final Property<Boolean>`	`createNamespace`
`private final Property<Boolean>`	`dryRun`
`private final Property<Boolean>`	`noHooks`
`private final Property<Duration>`	`remoteTimeout`
`private final RegularFileProperty`	`kubeConfig`
`private final Property<String>`	`kubeContext`
`private final Property<String>`	`namespace`
`private final Provider<String>`	`executable`
`private final Provider<Boolean>`	`debug`
`private final Provider<List<String>>`	`extraArgs`
`private final Provider<Directory>`	`xdgDataHome`
`private final Provider<Directory>`	`xdgConfigHome`
`private final Provider<Directory>`	`xdgCacheHome`

Constructor Summary

Constructors
Constructor	Description
`HelmTemplate()`

Method Summary

Modifier and Type	Method	Description
`Property<String>`	`getReleaseName()`
`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`, set `Release.IsUpgrade` instead of `Release.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 DirectoryProperty`	`getOutputDir()`	Directory into which the template output files will be written.
`final Property<String>`	`getChart()`	The chart to be installed.
`Property<String>`	`getVersion()`	Specify the exact chart version to install.
`final Property<Boolean>`	`getAtomic()`	If `true`, roll back changes on failure.
`final RegularFileProperty`	`getCaFile()`	Verify certificates of HTTPS-enabled servers using this CA bundle.
`final RegularFileProperty`	`getCertFile()`	Identify HTTPS client using this SSL certificate file.
`final Property<Boolean>`	`getDevel()`	If `true`, use development versions, too.
`final RegularFileProperty`	`getKeyFile()`	Identify HTTPS client using this SSL key file.
`final Property<String>`	`getPassword()`	Chart repository password where to locate the requested chart.
`final Property<URI>`	`getRepository()`	Chart repository URL where to locate the requested chart.
`final Property<String>`	`getUsername()`	Chart repository username where to locate the requested chart.
`final MapProperty<String, Object>`	`getValues()`	Values to be used for the release.
`final MapProperty<String, Object>`	`getFileValues()`	Values read from the contents of files, to be used for the release.
`final ConfigurableFileCollection`	`getValueFiles()`	A collection of YAML files containing values for this release.
`final Property<Boolean>`	`getVerify()`	If `true`, verify the package before installing it.
`final Property<Boolean>`	`getWait()`	If `true`, 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.
`final Property<Boolean>`	`getWaitForJobs()`	If `true`, and wait is also `true`, will wait until all Jobs have been completed before marking the release as successful.
`final Property<Boolean>`	`getCreateNamespace()`	If `true`, create the release namespace if not present.
`final Property<Boolean>`	`getDryRun()`	If `true`, only simulate the operation.
`final Property<Boolean>`	`getNoHooks()`	If `true`, prevent hooks from running during the operation.
`final Property<Duration>`	`getRemoteTimeout()`	Time in seconds to wait for any individual Kubernetes operation (like Jobs for hooks).
`final RegularFileProperty`	`getKubeConfig()`	Path to the Kubernetes configuration file.
`final Property<String>`	`getKubeContext()`	Name of the kubeconfig context to use.
`final Property<String>`	`getNamespace()`	Namespace scope for this request.
`final Provider<String>`	`getExecutable()`
`final Provider<Boolean>`	`getDebug()`
`final Provider<List<String>>`	`getExtraArgs()`
`final Provider<Directory>`	`getXdgDataHome()`
`final Provider<Directory>`	`getXdgConfigHome()`
`final Provider<Directory>`	`getXdgCacheHome()`
`final Unit`	`renderTemplate()`

Methods inherited from class org.unbrokendome.gradle.plugins.helm.command.tasks.HelmTemplate
from
Methods inherited from class org.unbrokendome.gradle.plugins.helm.command.tasks.AbstractHelmCommandTask
compareTo, configure, dependsOn, doFirst, doFirst, doFirst, doLast, doLast, doLast, finalizedBy, getActions, getAnt, getDependsOn, getDescription, getDestroyables, getDidWork, getEnabled, getExtensions, getFinalizedBy, getGroup, getInputs, getLocalState, getLogger, getLogging, getMustRunAfter, getName, getOutputs, getPath, getProject, getShouldRunAfter, getState, getTaskDependencies, getTemporaryDir, getTimeout, hasProperty, mustRunAfter, onlyIf, onlyIf, property, setActions, setDependsOn, setDescription, setDidWork, setEnabled, setFinalizedBy, setGroup, setMustRunAfter, setOnlyIf, setOnlyIf, setProperty, setShouldRunAfter, shouldRunAfter, usesService
Methods inherited from class org.gradle.api.DefaultTask
appendParallelSafeAction, getAsDynamicObject, getConvention, getIdentityPath, getImpliesSubProjects, getOnlyIf, getRequiredServices, getServices, getSharedResources, getStandardOutputCapture, getTaskActions, getTaskIdentity, getTemporaryDirFactory, hasTaskActions, isEnabled, isHasCustomActions, prependParallelSafeAction, setImpliesSubProjects, setLoggerMessageRewriter
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - HelmTemplate
```
HelmTemplate()
```
- Method Detail
  - getReleaseName
```
@Input()@Optional() Property<String> getReleaseName()
```
  - getApiVersions
```
@Input() final ListProperty<String> getApiVersions()
```
    Kubernetes API versions used for Capabilities.APIVersions.
    Corresponds to the --api-versions CLI 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 --replace CLI option.
  - getIsUpgrade
```
@Input()@Optional() final Property<Boolean> getIsUpgrade()
```
    If true, set Release.IsUpgrade instead of Release.IsInstall.
    Corresponds to the --is-upgrade CLI option.
  - getShowOnly
```
@Input() final ListProperty<String> getShowOnly()
```
    If not empty, only output manifests rendered from the given templates.
    Corresponds to the --show-only CLI 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 --validate CLI option.
  - getUseReleaseNameInOutputPath
```
@Input()@Optional() final Property<Boolean> getUseReleaseNameInOutputPath()
```
    If true, use the release name in the output path.
    Corresponds to the --release-name CLI option.
  - getOutputDir
```
@OutputDirectory() final DirectoryProperty getOutputDir()
```
    Directory into which the template output files will be written.
    Corresponds to the --output-dir CLI option.
  - getChart
```
@Input() final Property<String> getChart()
```
    The chart to be installed. This can be any of the forms accepted by the Helm CLI.
    chart reference: e.g. stable/mariadb
    path to a packaged chart
    path to an unpacked chart directory
    absolute URL: e.g. https://example.com/charts/nginx-1.2.3.tgz
    simple chart reference, e.g. mariadb (you must also set the repository property in this case)
  - getVersion
```
@Input()@Optional() Property<String> getVersion()
```
    Specify the exact chart version to install. If this is not specified, the latest version is installed.
    Corresponds to the --version Helm CLI parameter.
  - getAtomic
```
@Internal() final Property<Boolean> getAtomic()
```
    If true, roll back changes on failure.
    Corresponds to the --atomic Helm CLI parameter.
  - getCaFile
```
@Internal() final RegularFileProperty getCaFile()
```
    Verify certificates of HTTPS-enabled servers using this CA bundle.
    Corresponds to the --ca-file CLI parameter.
  - getCertFile
```
@Internal() final RegularFileProperty getCertFile()
```
    Identify HTTPS client using this SSL certificate file.
    Corresponds to the --cert-file CLI parameter.
  - getDevel
```
@Input()@Optional() final Property<Boolean> getDevel()
```
    If true, use development versions, too. Equivalent to version >0.0.0-0. If version is set, this is ignored.
    Corresponds to the --devel CLI parameter.
  - getKeyFile
```
@Internal() final RegularFileProperty getKeyFile()
```
    Identify HTTPS client using this SSL key file.
    Corresponds to the --key-file CLI parameter.
  - getPassword
```
@Internal() final Property<String> getPassword()
```
    Chart repository password where to locate the requested chart.
    Corresponds to the --password CLI parameter.
  - getRepository
```
@Input()@Optional() final Property<URI> getRepository()
```
    Chart repository URL where to locate the requested chart.
    Corresponds to the --repo Helm CLI parameter.
    Use this when the chart property contains only a simple chart reference, without a symbolic repository name.
  - getUsername
```
@Internal() final Property<String> getUsername()
```
    Chart repository username where to locate the requested chart.
    Corresponds to the --username CLI parameter.
  - getValues
```
@Input() final MapProperty<String, Object> getValues()
```
    Values to be used for the release.
    Entries in the map will be sent to the CLI using either the --set-string option (for strings) or the --set option (for all other types).
  - getFileValues
```
@Input() final MapProperty<String, Object> getFileValues()
```
    Values read from the contents of files, to be used for the release.
    Corresponds to the --set-file CLI option.
    The values of the map can be of any type that is accepted by Project.file. Additionally, when adding a Provider that represents an output file of another task, this task will automatically have a task dependency on the producing task.
    Not to be confused with valueFiles, which contains a collection of YAML files that supply multiple values.
  - getValueFiles
```
@InputFiles() final ConfigurableFileCollection getValueFiles()
```
    A collection of YAML files containing values for this release.
    Corresponds to the --values CLI option.
    Not to be confused with fileValues, which contains entries whose values are the contents of files.
  - getVerify
```
@Internal() final Property<Boolean> getVerify()
```
    If true, verify the package before installing it.
    Corresponds to the --verify CLI parameter.
  - getWait
```
@Internal() final Property<Boolean> getWait()
```
    If true, 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. It will wait for as along as remoteTimeout.
  - getWaitForJobs
```
@Internal() final 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.
  - getCreateNamespace
```
@Internal() final Property<Boolean> getCreateNamespace()
```
    If true, create the release namespace if not present.
    Corresponds to the --create-namespace CLI parameter.
  - getDryRun
```
@Internal() final Property<Boolean> getDryRun()
```
    If true, only simulate the operation.
    Corresponds to the --dry-run CLI parameter.
  - getNoHooks
```
@Internal() final Property<Boolean> getNoHooks()
```
    If true, prevent hooks from running during the operation.
    Corresponds to the --no-hooks CLI parameter.
  - getRemoteTimeout
```
@Internal() final Property<Duration> getRemoteTimeout()
```
    Time in seconds to wait for any individual Kubernetes operation (like Jobs for hooks). Default is 300.
    Corresponds to the --timeout command line option in the Helm CLI.
  - getKubeConfig
```
@InputFile()@Optional() final RegularFileProperty getKubeConfig()
```
    Path to the Kubernetes configuration file.
    If this property is set, its value will be used to set the KUBECONFIG environment variable for each Helm invocation.
  - getKubeContext
```
@Input()@Optional() final Property<String> getKubeContext()
```
    Name of the kubeconfig context to use.
    Corresponds to the --kube-context command line option in the Helm CLI.
  - getNamespace
```
@Internal() final Property<String> getNamespace()
```
    Namespace scope for this request.
    Corresponds to the --namespace CLI parameter.
  - getExecutable
```
@Input() final Provider<String> getExecutable()
```
  - getDebug
```
@Console() final Provider<Boolean> getDebug()
```
  - getExtraArgs
```
@Input() final Provider<List<String>> getExtraArgs()
```
  - getXdgDataHome
```
@Internal() final Provider<Directory> getXdgDataHome()
```
  - getXdgConfigHome
```
@Internal() final Provider<Directory> getXdgConfigHome()
```
  - getXdgCacheHome
```
@Internal() final Provider<Directory> getXdgCacheHome()
```
  - renderTemplate
```
 final Unit renderTemplate()
```

Class HelmTemplate

Field Summary

Constructor Summary

Method Summary

Methods inherited from class org.unbrokendome.gradle.plugins.helm.command.tasks.HelmTemplate

Methods inherited from class org.unbrokendome.gradle.plugins.helm.command.tasks.AbstractHelmCommandTask

Methods inherited from class org.gradle.api.DefaultTask

Methods inherited from class java.lang.Object

Constructor Detail

HelmTemplate

Method Detail

getReleaseName

getApiVersions

getReplace

getIsUpgrade

getShowOnly

getValidate

getUseReleaseNameInOutputPath

getOutputDir

getChart

getVersion

getAtomic

getCaFile

getCertFile

getDevel

getKeyFile

getPassword

getRepository

getUsername

getValues

getFileValues

getValueFiles

getVerify

getWait

getWaitForJobs

getCreateNamespace

getDryRun

getNoHooks

getRemoteTimeout

getKubeConfig

getKubeContext

getNamespace

getExecutable

getDebug

getExtraArgs

getXdgDataHome

getXdgConfigHome

getXdgCacheHome

renderTemplate