Interface HelmRendering

  • All Implemented Interfaces:
    io.github.build.extensions.oss.gradle.plugins.helm.command.ConfigurableHelmOptions , io.github.build.extensions.oss.gradle.plugins.helm.command.ConfigurableHelmValueOptions , io.github.build.extensions.oss.gradle.plugins.helm.command.HelmOptions , io.github.build.extensions.oss.gradle.plugins.helm.command.HelmValueOptions , org.gradle.api.Buildable , org.gradle.api.Named

    
    public interface HelmRendering
     implements Named, Buildable, ConfigurableHelmValueOptions
                        

    Represents a local rendering of templates for the containing chart.

    • Field Summary

      Fields 
      Modifier and Type Field Description
    • Constructor Summary

      Constructors 
      Constructor Description
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
    • Method Summary

      Modifier and Type Method Description
      abstract Property<String> getReleaseName() The name of the release.
      abstract ListProperty<String> getApiVersions() Kubernetes API versions used for Capabilities.APIVersions.
      abstract Property<Boolean> isUpgrade() If true, set Release.IsUpgrade instead of Release.IsInstall.
      abstract ListProperty<String> getShowOnly() If not empty, only output manifests rendered from the given templates.
      abstract Property<Boolean> getUseReleaseNameInOutputPath() If true, use the release name in the output path.
      abstract Property<Boolean> getValidate() If true, validate your manifests against the Kubernetes cluster you are currently pointing at.
      abstract DirectoryProperty getOutputDir() Directory into which the template output files will be written.
      • Methods inherited from class org.gradle.api.Named

        getName
      • Methods inherited from class org.gradle.api.Buildable

        getBuildDependencies
      • Methods inherited from class io.github.build.extensions.oss.gradle.plugins.helm.command.ConfigurableHelmValueOptions

        getFileValues, getValueFiles, getValues
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

    • Method Detail

      • getApiVersions

         abstract ListProperty<String> getApiVersions()

        Kubernetes API versions used for Capabilities.APIVersions.

        Corresponds to the --api-versions CLI option.

      • isUpgrade

         abstract Property<Boolean> isUpgrade()

        If true, set Release.IsUpgrade instead of Release.IsInstall.

        Corresponds to the --is-upgrade CLI option.

      • getShowOnly

         abstract ListProperty<String> getShowOnly()

        If not empty, only output manifests rendered from the given templates.

        Corresponds to the --show-only CLI option.

      • getUseReleaseNameInOutputPath

         abstract Property<Boolean> getUseReleaseNameInOutputPath()

        If true, use the release name in the output path.

        Corresponds to the --release-name CLI option.

      • getValidate

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

      • getOutputDir

         abstract DirectoryProperty getOutputDir()

        Directory into which the template output files will be written.

        Corresponds to the --output-dir CLI option.