helm

Documentation

Index

• Constants
• func FindRequirementsFileName(dir string) (string, error)
• func LoadChartName(chartFile string) (string, error)
• func LoadChartNameAndVersion(chartFile string) (string, string, error)
• func SaveRequirementsFile(fileName string, requirements *Requirements) error
• type Dependency
• type ErrNoRequirementsFile
• type Requirements
  • func LoadRequirements(data []byte) (*Requirements, error)
  • func LoadRequirementsFile(fileName string) (*Requirements, error)
  • func (r *Requirements) RemoveApp(app string) bool
  • func (r *Requirements) SetAppVersion(app string, version string, repository string)

Constants

const (
	RequirementsFileName = "requirements.yaml"

	DefaultHelmRepositoryURL = "http://jenkins-x-chartmuseum:8080"
)

Functions

func FindRequirementsFileName

func FindRequirementsFileName(dir string) (string, error)

FindRequirementsFileName returns the default requirements.yaml file name

func LoadChartName

func LoadChartName(chartFile string) (string, error)

func LoadChartNameAndVersion

func LoadChartNameAndVersion(chartFile string) (string, string, error)

func SaveRequirementsFile

func SaveRequirementsFile(fileName string, requirements *Requirements) error

SaveRequirementsFile saves the requirements file

Types

type Dependency

type Dependency struct {
	// Name is the name of the dependency.
	//
	// This must mach the name in the dependency's Chart.yaml.
	Name string `json:"name"`
	// Version is the version (range) of this chart.
	//
	// A lock file will always produce a single version, while a dependency
	// may contain a semantic version range.
	Version string `json:"version,omitempty"`
	// The URL to the repository.
	//
	// Appending `index.yaml` to this string should result in a URL that can be
	// used to fetch the repository index.
	Repository string `json:"repository"`
	// A yaml path that resolves to a boolean, used for enabling/disabling charts (e.g. subchart1.enabled )
	Condition string `json:"condition,omitempty"`
	// Tags can be used to group charts for enabling/disabling together
	Tags []string `json:"tags,omitempty"`
	// Enabled bool determines if chart should be loaded
	Enabled bool `json:"enabled,omitempty"`
	// ImportValues holds the mapping of source values to parent key to be imported. Each item can be a
	// string or pair of child/parent sublist items.
	ImportValues []interface{} `json:"import-values,omitempty"`
	// Alias usable alias to be used for the chart
	Alias string `json:"alias,omitempty"`
}

Dependency describes a chart upon which another chart depends.

Dependencies can be used to express developer intent, or to capture the state of a chart.

type ErrNoRequirementsFile

type ErrNoRequirementsFile error

ErrNoRequirementsFile to detect error condition

type Requirements

type Requirements struct {
	Dependencies []*Dependency `json:"dependencies"`
}

Requirements is a list of requirements for a chart.

Requirements are charts upon which this chart depends. This expresses developer intent.

func LoadRequirements

func LoadRequirements(data []byte) (*Requirements, error)

LoadRequirements loads the requirements from some data

func LoadRequirementsFile

func LoadRequirementsFile(fileName string) (*Requirements, error)

LoadRequirementsFile loads the requirements file or creates empty requirements if the file does not exist

func (*Requirements) RemoveApp

func (r *Requirements) RemoveApp(app string) bool

RemoveApp removes the given app name. Returns true if a dependency was removed

func (*Requirements) SetAppVersion

func (r *Requirements) SetAppVersion(app string, version string, repository string)

SetAppVersion sets the version of the app to use