helm

Documentation

Index

• Constants
• type Chart
  • func New(spec interface{}) (*Chart, error)
  • func (c Chart) Changelog() string
  • func (c *Chart) Condition(source string) (bool, error)
  • func (c *Chart) ConditionFromSCM(source string, scm scm.ScmHandler) (bool, error)
  • func (c *Chart) Source(workingDir string) (string, error)
  • func (c *Chart) Target(source string, dryRun bool) (changed bool, err error)
  • func (c *Chart) TargetFromSCM(source string, scm scm.ScmHandler, dryRun bool) (changed bool, files []string, message string, err error)
  • func (c *Chart) UpdateMetadata(metadataFilename string, dryRun bool) error
  • func (c *Chart) UpdateRequirements(lockFilename string) (bool, error)
  • func (c *Chart) ValidateTarget() error
• type Spec

Constants

const (
	// CHANGELOGTEMPLATE contains helm chart changelog information
	CHANGELOGTEMPLATE string = `` /* 618-byte string literal not displayed */

	// MINORVERSION defines minor version identifier
	MINORVERSION = "minor"
	// MAJORVERSION defines major version identifier
	MAJORVERSION = "major"
	// PATCHVERSION defines patch version identifier
	PATCHVERSION = "patch"
)

Types

type Chart

type Chart struct {
	// contains filtered or unexported fields
}

Chart defines a resource of kind "helmchart"

func New

func New(spec interface{}) (*Chart, error)

New returns a reference to a newly initialized Chart object from a Spec or an error if the provided YamlSpec triggers a validation error.

func (Chart) Changelog

func (c Chart) Changelog() string

Changelog returns a rendered template with this chart version informations

func (*Chart) Condition

func (c *Chart) Condition(source string) (bool, error)

Condition check if a specific chart version exist

func (*Chart) ConditionFromSCM

func (c *Chart) ConditionFromSCM(source string, scm scm.ScmHandler) (bool, error)

ConditionFromSCM returns an error because it's not supported

func (*Chart) Source

func (c *Chart) Source(workingDir string) (string, error)

Source return the latest version

func (*Chart) Target

func (c *Chart) Target(source string, dryRun bool) (changed bool, err error)

Target updates helm chart, it receives the default source value and a dryrun flag then return if it changed something or failed

func (*Chart) TargetFromSCM

func (c *Chart) TargetFromSCM(source string, scm scm.ScmHandler, dryRun bool) (
	changed bool, files []string, message string, err error)

TargetFromSCM updates helm chart then push changed to a scm, it receives the default source value and dryrun flag then return if it changed something or failed

func (*Chart) UpdateMetadata

func (c *Chart) UpdateMetadata(metadataFilename string, dryRun bool) error

UpdateMetadata updates a metadata if necessary and it bump the ChartVersion

func (*Chart) UpdateRequirements

func (c *Chart) UpdateRequirements(lockFilename string) (bool, error)

UpdateRequirements test if we are updating the file requirements.yaml if it's the case then we also have to delete and recreate the file requirements.lock

func (*Chart) ValidateTarget

func (c *Chart) ValidateTarget() error

ValidateTarget ensure that target required parameter are set

type Spec

type Spec struct {
	File             string // [target] Define file to update
	Key              string // [target] Define Key to update
	Name             string // [source][condition][target] Define Chart name path like "stable/chart"
	URL              string // [source][condition] Define the chart location
	Value            string // [target] Define value to set
	Version          string // [source][condition]
	VersionIncrement string // [target] Define the rule to incremental the Chart version, accept a list of rules
	AppVersion       bool   // [target] Boolean that define we must update the App Version
}

Spec defines a specification for an "helmchart" resource parsed from an updatecli manifest file