helm

Documentation

Index

• Constants
• func FindChartDirectories(chartSearchRoot string) ([]string, error)
• type ChartDocumentationInfo
  • func ParseChartInformation(chartDirectory string, ...) (ChartDocumentationInfo, error)
• type ChartMeta
• type ChartMetaMaintainer
• type ChartRequirements
• type ChartRequirementsItem
• type ChartValueDescription
  • func ParseComment(commentLines []string) (string, ChartValueDescription)
• type ChartValuesDocumentationParsingConfig

Constants

const (
	PrefixComment = "# --"
)

Functions

func FindChartDirectories

func FindChartDirectories(chartSearchRoot string) ([]string, error)

Types

type ChartDocumentationInfo

type ChartDocumentationInfo struct {
	ChartMeta
	ChartRequirements

	ChartDirectory          string
	ChartValues             *yaml.Node
	ChartValuesDescriptions map[string]ChartValueDescription
}

func ParseChartInformation

func ParseChartInformation(chartDirectory string, documentationParsingConfig ChartValuesDocumentationParsingConfig) (ChartDocumentationInfo, error)

type ChartMeta

type ChartMeta struct {
	ApiVersion  string `yaml:"apiVersion"`
	AppVersion  string `yaml:"appVersion"`
	KubeVersion string `yaml:"kubeVersion"`
	Name        string
	Deprecated  bool
	Description string
	Version     string
	Home        string
	Type        string
	Sources     []string
	Engine      string
	Maintainers []ChartMetaMaintainer
}

type ChartMetaMaintainer

type ChartMetaMaintainer struct {
	Email string
	Name  string
	Url   string
}

type ChartRequirements

type ChartRequirements struct {
	Dependencies []ChartRequirementsItem
}

type ChartRequirementsItem

type ChartRequirementsItem struct {
	Name       string
	Version    string
	Repository string
	Alias      string
}

type ChartValueDescription

type ChartValueDescription struct {
	Description  string
	Default      string
	ValueType    string
	NotationType string
}

func ParseComment

func ParseComment(commentLines []string) (string, ChartValueDescription)

type ChartValuesDocumentationParsingConfig

type ChartValuesDocumentationParsingConfig struct {
	StrictMode                 bool
	AllowedMissingValuePaths   []string
	AllowedMissingValueRegexps []*regexp.Regexp
}