Class HelmTemplate

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

    Renders chart templates locally.

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
    • Constructor Summary

      Constructors 
      Constructor Description
      HelmTemplate()
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
    • 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, 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 Unit renderTemplate()
      • 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.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

      • HelmTemplate

        HelmTemplate()
    • Method Detail

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