bundle

Documentation

Index

• type Bundle
• type BundleConfig
  • func ReadConfig(file []string) (*BundleConfig, error)
• type K8sVersions
• type Source
• type Versions

Types

type Bundle

type Bundle struct {
	Name                  string      `yaml:"name"`                    // name of the helm release
	Versions              Versions    `yaml:"versions"`                // start and stop versions of helm chart to evaluate
	Notes                 string      `yaml:"notes"`                   // strings of general notes
	Source                Source      `yaml:"source"`                  // chart name and repository for helm release
	Warnings              []string    `yaml:"warnings"`                // strings of warning messages
	CompatibleK8sVersions K8sVersions `yaml:"compatible_k8s_versions"` // kubernetes cluster version to check for
	NecessaryAPIVersions  []string    `yaml:"necessary_api_versions"`  // specific api versions to check for
	ValuesSchema          string      `yaml:"values_schema"`           // embedded values.schema.json
	OpaChecks             []string    `yaml:"opa_checks"`              // embedded rego code
	Resources             []string    `yaml:"resources"`               // api objects
}

Bundle maps the fields from a supplied bundle spec file

type BundleConfig

type BundleConfig struct {
	Addons []*Bundle `yaml:"addons"`
}

BundleConfig is the top level key for the bundle spec file and contains slices of the Bundle struct

func ReadConfig

func ReadConfig(file []string) (*BundleConfig, error)

ReadConfig takes a bundle spec file as a string and maps it into the Bundle struct

type K8sVersions

type K8sVersions struct {
	Min string `yaml:"min"`
	Max string `yaml:"max"`
}

type Source

type Source struct {
	Chart      string `yaml:"chart"`
	Repository string `yaml:"repository"`
}

Source is the chart and repo for Helm releases

type Versions

type Versions struct {
	Start string `yaml:"start"`
	End   string `yaml:"end"`
}

Versions is a list of version strings within the bundle spec file