Package 

Interface HelmRendering

  • All Implemented Interfaces:
    org.gradle.api.Buildable , org.gradle.api.Named , org.unbrokendome.gradle.plugins.helm.command.ConfigurableHelmOptions , org.unbrokendome.gradle.plugins.helm.command.ConfigurableHelmValueOptions , org.unbrokendome.gradle.plugins.helm.command.HelmOptions , org.unbrokendome.gradle.plugins.helm.command.HelmValueOptions

    
    public interface HelmRendering
     implements Named, Buildable, ConfigurableHelmValueOptions
                        

    Represents a local rendering of templates for the containing chart.

    • Method Detail

      • getApiVersions

         abstract ListProperty<String> getApiVersions()

        Kubernetes API versions used for Capabilities.APIVersions.

        Corresponds to the --api-versions CLI option.

      • getIsUpgrade

         abstract Property<Boolean> getIsUpgrade()

        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.

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

      • getValues

         abstract MapProperty<String, Object> getValues()

        Values to be passed directly.

        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

         abstract MapProperty<String, Object> getFileValues()

        Values read from the contents of files.

        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, the consuming 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

         abstract ConfigurableFileCollection getValueFiles()

        A collection of YAML files containing values.

        Corresponds to the --values CLI option.

        Not to be confused with fileValues, which contains entries whose values are the contents of files.