Package io.github.build.extensions.oss.gradle.plugins.helm.dsl

Interface HelmChart

  • All Implemented Interfaces:
    org.gradle.api.Buildable , org.gradle.api.Named 
    
public interface HelmChart
 implements Named, Buildable

    Represents a Helm chart built by this project.

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description

    • 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
      Unit extraFiles(Action<CopySpec> action) Configures a CopySpec that allows copying additional files into the chart.
      Unit renderings(Action<NamedDomainObjectContainer<HelmRendering>> action) Configures the renderings for this chart.
      abstract Property<String> getChartName() The chart name.
      abstract Property<String> getChartVersion() The chart version.
      abstract DirectoryProperty getSourceDir() The directory that contains the chart sources.
      abstract DirectoryProperty getBaseOutputDir() The base output directory.
      Provider<Directory> getOutputDir()
      Provider<String> getPackageFileName()
      abstract Provider<RegularFile> getPackageFile() The location of the packaged chart file.
      Provider<RegularFile> getPackageOutputFile()
      abstract CopySpec getExtraFiles() A CopySpec that allows copying additional files into the chart.
      abstract DirectoryProperty getRenderBaseOutputDir() The base output directory for renderings.
      abstract NamedDomainObjectContainer<HelmRendering> getRenderings() The renderings for this chart.
      abstract Property<Boolean> getOverrideChartInfo() If true, override the name and version fields in the Chart.

      • Methods inherited from class org.gradle.api.Named

        getName

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

        getBuildDependencies

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

    • Method Detail

      • extraFiles

         Unit extraFiles(Action<CopySpec> action)

        Configures a CopySpec that allows copying additional files into the chart.

        Parameters:
        action - an Action to configure on the extraFiles CopySpec

      • renderings

         Unit renderings(Action<NamedDomainObjectContainer<HelmRendering>> action)

        Configures the renderings for this chart.

        Each rendering allows specifying a different set of values and other options to pass to helm template. If no renderings are added to this container, the plugin will add a single rendering named "default" with no values.

        Parameters:
        action - an Action to configure the renderings for this chart

      • getChartName

         abstract Property<String> getChartName()

        The chart name.

        By default, the chart will have the same name as in the Gradle DSL (except for the "main" chart which will have the same name as the project by default).

      • getChartVersion

         abstract Property<String> getChartVersion()

        The chart version.

        By default, the chart will have the same version as the Gradle project.

      • getSourceDir

         abstract DirectoryProperty getSourceDir()

        The directory that contains the chart sources.

      • getBaseOutputDir

         abstract DirectoryProperty getBaseOutputDir()

        The base output directory. When the chart is built, a subdirectory with the same name as the chart will be created below this. (That subdirectory can be queried using outputDir.)

        By default, this is the same as the HelmExtension.outputDir configured on the global helm extension.

      • getPackageFile

         abstract Provider<RegularFile> getPackageFile()

        The location of the packaged chart file.

        The file will be placed inside the baseOutputDir and have a name according to the pattern <chart>-<version>.tgz.

      • getExtraFiles

         abstract CopySpec getExtraFiles()

        A CopySpec that allows copying additional files into the chart.

      • getRenderBaseOutputDir

         abstract DirectoryProperty getRenderBaseOutputDir()

        The base output directory for renderings. When a rendering is executed using helm template, a subdirectory with the name of the rendering will be created below this. (That subdirectory can be queried using HelmRendering.outputDir.)

        By default, this is a subdirectory with the name of the chart, under the global base directory configured using HelmExtension.renderOutputDir on the global helm extension.

      • getRenderings

         abstract NamedDomainObjectContainer<HelmRendering> getRenderings()

        The renderings for this chart.

        Each rendering allows specifying a different set of values and other options to pass to helm template. If no renderings are added to this container, the plugin will add a single rendering named "default" with no values.

      • getOverrideChartInfo

         abstract Property<Boolean> getOverrideChartInfo()

        If true, override the name and version fields in the Chart.yaml file with the values of chartName and chartVersion, respectively. This step is performed after any filtering (as configured by the filtering block).

        Defaults to true.