Documentation
¶
Overview ¶
Package helmtemplate provides functions for templating helm charts
Index ¶
Constants ¶
View Source
const ( // HelmChartYamlName is the name of Helm's chart yaml. HelmChartYamlName = "Chart.yaml" // HelmValuesYamlName is hte name fo the file that holds default Helm chart // values inside the template directory. HelmValuesYamlName = "values.yaml" // HelmTemplateDirectoryName is the name of the directory that stores // Kubernetes resources inside a chart. HelmTemplateDirectoryName = "templates" )
Variables ¶
This section is empty.
Functions ¶
func IsInvalidConfig ¶
IsInvalidConfig asserts invalidConfigError.
func IsValidationFailedError ¶
IsValidationFailedError asserts validationFailedError.
Types ¶
type BuildInfo ¶
type BuildInfo struct {
// Branch is the name of the branch we're building.
Branch string
// SHA is the SHA-1 tag of the commit we are building for.
SHA string
// Version is the version of the commit being built.
Version string
// AppVersion is the version read from pkg/project/project.go if it
// exists or set to the same value as Version otherwise.
AppVersion string
}
BuildInfo holds information concerning the current build.
type Config ¶
type Config struct {
Fs afero.Fs
ChartDir string
Branch string
Sha string
Version string
AppVersion string
SkipAppVersionCheck bool
}
Config holds configuration for building a new TemplateHelmChartTask
type TemplateHelmChartTask ¶
type TemplateHelmChartTask struct {
// contains filtered or unexported fields
}
TemplateHelmChartTask is used to run a template-helm-chart command
func NewTemplateHelmChartTask ¶
func NewTemplateHelmChartTask(config Config) (*TemplateHelmChartTask, error)
NewTemplateHelmChartTask creates a new TemplateHelmChartTask
func (TemplateHelmChartTask) Run ¶
func (t TemplateHelmChartTask) Run(validate, tagBuild bool) error
Run templates the chart's Chart.yaml and templates/deployment.yaml.
func (TemplateHelmChartTask) String ¶
func (t TemplateHelmChartTask) String() string
Source Files
Click to show internal directories.
Click to hide internal directories.