buildingblocks

Documentation

Index

• func CreateConfigDoc(pathToBB, pathToValues, pathToBestPractices string) ([]byte, error)
• func CreateJobEnvironment(bbProjectID int, bbVersion string, environment string, ...) ([]byte, error)
• func CreateJobTemplate(bbProjectID int, bbVersion string) ([]byte, error)
• func CreateValueFiles(pathToHelmfile, pathToValues string)
• func GenerateK3sYaml(versions []string, defaultVersion string) []byte
• func GenerateReadme(bbName string, k8sVersions []string, docsPage string, ...) ([]byte, error)
• func GenerateUpstreamComponentsTables(pathToHelmfile string, pathToImagesTxt string) ([]byte, error)
• func GetDefault(pathToK8sVersions string) string
• func GetK3sDefaultImage(k8sVersions []string, defaultVersion string) string
• func GetK3sImages(k8sVersions []string) []string
• func GetLocalReleases(pathToHelmfile string) []string
• func GetReleases(pathToHelmfile string) []string
• func GetTags(pID int) (s []string)
• func GetUpstreamComponentsJson(pathToHelmfile string, pathToImagesTxt string) ([]byte, error)
• func GetVersions(pathToK8sVersions string) []string
• func RenderHelmfile(path string) []byte
• func SortTags(versions []string) v.Collection
• func UpdateScript(versionFrom, versionTo string, p *RepoRef) ([]byte, error)
• type BuildingBlock
• type DockerImages
• type HelmChart
• type HelmDefaults
• type HelmfileConfig
• type Hook
• type K3sJson
• type K3sVersions
• type K3sYaml
• type K8sVersionsConfig
• type Matrix
• type Parallel
• type Release
• type RepoRef
• type Repository
• type UpstreamComponents
• type Variables

Functions

func CreateConfigDoc

func CreateConfigDoc(pathToBB, pathToValues, pathToBestPractices string) ([]byte, error)

func CreateJobEnvironment

func CreateJobEnvironment(bbProjectID int, bbVersion string, environment string, ciTemplatesVersion string) ([]byte, error)

CreateJobEnvironment will generate the job template for the given building block defined by the arguments, fully extended for the specified environment Output: JobEnvironment

func CreateJobTemplate

func CreateJobTemplate(bbProjectID int, bbVersion string) ([]byte, error)

CreateJobTemplate will generate the job template for the given building block defined by the arguments Output: JobTemplate

func CreateValueFiles

func CreateValueFiles(pathToHelmfile, pathToValues string)

CreateValueFiles requires helmfile's path as input It parses the helmfiles and creates a directory with all the value files from the upstream helm charts

func GenerateK3sYaml

func GenerateK3sYaml(versions []string, defaultVersion string) []byte

GenerateK3sYaml creates the k3s.yaml references for gitlab-ci-templates including the k3s versions matrix and the default k3s version

func GenerateReadme

func GenerateReadme(bbName string, k8sVersions []string, docsPage string, upstreamComponents string, customNotes string, helmChartConfig string) ([]byte, error)

This functions generates a BB's readme

func GenerateUpstreamComponentsTables

func GenerateUpstreamComponentsTables(pathToHelmfile string, pathToImagesTxt string) ([]byte, error)

GenerateUpstreamComponentsTables generates a markdown file for a building block that includes a table for each upstream component used by it with their versions: helm charts and docker images

func GetDefault

func GetDefault(pathToK8sVersions string) string

GetDefault returns the default K8s version defined in k8sVersions.json If the default version doesn't follow the K8s schema (x.yz), the function will fail with the relevant error message Also, the default version needs to be one of the supported versions of the config otherwise the function will fail with the relevant error message

func GetK3sDefaultImage

func GetK3sDefaultImage(k8sVersions []string, defaultVersion string) string

GetK3sDefaultImage returns the corresponding k3s image of the given default k8s version

func GetK3sImages

func GetK3sImages(k8sVersions []string) []string

GetK3sImages returns the corresponding k3s images to the given k8s versions If there are multiple patch images for one k8s version, the latest patch is chosen If there is no corresponding k3s image for a given k8s version, the function will fail with the relevant message

func GetLocalReleases

func GetLocalReleases(pathToHelmfile string) []string

GetLocalReleases returns the list of local helmfile's releases in the order they appear in helmfile

func GetReleases

func GetReleases(pathToHelmfile string) []string

GetReleases returns the list of helmfile's releases in the order they appear in helmfile

func GetTags

func GetTags(pID int) (s []string)

returns the list of tags for the given gitlab project.

func GetUpstreamComponentsJson

func GetUpstreamComponentsJson(pathToHelmfile string, pathToImagesTxt string) ([]byte, error)

GetUpstreamComponentsJson generates a json file for a building block that includes all the upstream components used by it with their versions: helm charts and docker images

func GetVersions

func GetVersions(pathToK8sVersions string) []string

GetVersions returns the list of k8sVersions.json versions in the order they appear in the file If a version of the config doesn't follow the K8s schema (x.yz), the function will fail with the relevant error message

func RenderHelmfile

func RenderHelmfile(path string) []byte

renderHelmfile requires helmfile's path as input its content is treated as a gotemplate, which is executed and the result returned

func SortTags

func SortTags(versions []string) v.Collection

sorts a list of semantic versions, ascending.

func UpdateScript

func UpdateScript(versionFrom, versionTo string, p *RepoRef) ([]byte, error)

UpdateScript will generate a script containing a series of update scripts if there are any for the update of one version (versionFrom) to another (versionTo) of the given building block project ref.

Types

type BuildingBlock

type BuildingBlock struct {
	Name      string
	Version   string
	ProjectID int
}

type DockerImages

type DockerImages struct {
	Repository string `json:"repository"`
	Tag        string `json:"tag"`
}

Docker Images struct

type HelmChart

type HelmChart struct {
	RepoUrl string `json:"repo-url"`
	Name    string `json:"name"`
	Version string `json:"version"`
}

Helm Chart struct

type HelmDefaults

type HelmDefaults struct {
	Timeout int  `yaml:"timeout"`
	Wait    bool `yaml:"wait"`
}

Helmfile HelmDefaults element

type HelmfileConfig

type HelmfileConfig struct {
	Repositories []Repository `yaml:"repositories"`
	HelmDefaults HelmDefaults `yaml:"helmDefaults"`
	Releases     []Release    `yaml:"releases"`
}

Helmfile top level elements.

type Hook

type Hook struct {
	Command string   `yaml:"command"`
	Args    []string `yaml:"args"`
	Events  []string `yaml:"events"`
}

Helmfile Hook element

type K3sJson

type K3sJson []struct {
	Name string `json:"name"`
}

k3s container registry json

type K3sVersions

type K3sVersions struct {
	Matrix []Matrix `yaml:"matrix"`
}

K3sVersions element

type K3sYaml

type K3sYaml struct {
	Variables Variables `yaml:".variables"`
	Parallel  Parallel  `yaml:".parallel"`
}

k3s.yaml into struct k3s top level elements.

type K8sVersionsConfig

type K8sVersionsConfig struct {
	K8sVersions []string `json:"K8sVersions"`
	Default     string   `json:"Default"`
}

k8sVersions.json into struct

type Matrix

type Matrix struct {
	K3sVersion []string `yaml:"K3S_VERSION"`
}

Matrix element

type Parallel

type Parallel struct {
	K3sVersions K3sVersions `yaml:"k3s_versions"`
}

Parallel element (Helm Charts)

type Release

type Release struct {
	Name               string   `yaml:"name"`
	Namespace          string   `yaml:"namespace"`
	Chart              string   `yaml:"chart"`
	Version            string   `yaml:"version"`
	DisableValidation  bool     `yaml:"disableValidation"`
	MissingFileHandler string   `yaml:"missingFileHandler"`
	Values             []string `yaml:"values"`
	Hooks              []Hook   `yaml:"hooks"`
	Needs              []string `yaml:"needs"`
}

Helmfile Release element (Helm Charts)

type RepoRef

type RepoRef struct {
	ID  int
	Ref string
}

type Repository

type Repository struct {
	Name string `yaml:"name"`
	Url  string `yaml:"url"`
}

Helmfile Repository element

type UpstreamComponents

type UpstreamComponents struct {
	HelmChart    []HelmChart    `json:"helm-charts"`
	DockerImages []DockerImages `json:"docker-images"`
}

Upstream components struct

type Variables

type Variables struct {
	DefaultVersion string `yaml:"DEFAULT_K3S_VERSION"`
}

Variables element