gitops

Documentation

Overview

Package gitops is an implementation of the terra.State interface that reads configuration from terra-helmfile

Index

• func NewCluster(name string, base string, address string, ...) terra.Cluster
• func NewEnvironment(name string, base string, defaultCluster string, lifecycle terra.Lifecycle, ...) terra.Environment
• func NewStateLoader(thelmaHome string, shellRunner shell.Runner, options ...LoadOption) (terra.StateLoader, error)
• type LoadOption
• type LoadOptions
• type MockSnapshot
  • func NewMockSnapshot() *MockSnapshot
  • func (s *MockSnapshot) AppVersion(releaseName string) string
  • func (s *MockSnapshot) ChartVersion(releaseName string) string
  • func (s *MockSnapshot) ReleaseDefined(releaseName string) bool
  • func (s *MockSnapshot) UpdateChartVersionIfDefined(releaseName string, newVersion string) error
• type MockVersions
  • func NewMockVersions() *MockVersions
  • func (v *MockVersions) GetSnapshot(releaseType terra.ReleaseType, versionSet VersionSet) VersionSnapshot
• type VersionSet
  • func VersionSets() []VersionSet
  • func (s VersionSet) String() string
• type VersionSnapshot
• type Versions
  • func NewVersions(thelmaHome string, shellRunner shell.Runner) (Versions, error)

Functions

func NewCluster

func NewCluster(name string, base string, address string, releases map[string]terra.ClusterRelease) terra.Cluster

NewCluster constructs a new Cluster

func NewEnvironment

func NewEnvironment(name string, base string, defaultCluster string, lifecycle terra.Lifecycle, template string, fiab terra.Fiab, releases map[string]terra.AppRelease) terra.Environment

NewEnvironment constructs a new Environment

func NewStateLoader

func NewStateLoader(thelmaHome string, shellRunner shell.Runner, options ...LoadOption) (terra.StateLoader, error)

NewStateLoader returns a new StateLoader w/ given settings

Types

type LoadOption

type LoadOption func(LoadOptions) LoadOptions

type LoadOptions

type LoadOptions struct {
	StateBucket statebucket.StateBucket
}

type MockSnapshot

type MockSnapshot struct {
	mock.Mock
}

func NewMockSnapshot

func NewMockSnapshot() *MockSnapshot

func (*MockSnapshot) AppVersion

func (s *MockSnapshot) AppVersion(releaseName string) string

func (*MockSnapshot) ChartVersion

func (s *MockSnapshot) ChartVersion(releaseName string) string

func (*MockSnapshot) ReleaseDefined

func (s *MockSnapshot) ReleaseDefined(releaseName string) bool

func (*MockSnapshot) UpdateChartVersionIfDefined

func (s *MockSnapshot) UpdateChartVersionIfDefined(releaseName string, newVersion string) error

type MockVersions

type MockVersions struct {
	mock.Mock
}

func NewMockVersions

func NewMockVersions() *MockVersions

func (*MockVersions) GetSnapshot

func (v *MockVersions) GetSnapshot(releaseType terra.ReleaseType, versionSet VersionSet) VersionSnapshot

type VersionSet

type VersionSet int

VersionSet is an enum type representing a version set defined in terra-helmfile

const (
	Dev VersionSet = iota
	Alpha
	Staging
	Prod
)

func VersionSets

func VersionSets() []VersionSet

func (VersionSet) String

func (s VersionSet) String() string

type VersionSnapshot

type VersionSnapshot interface {
	// ReleaseDefined returns true if the given release is defined in this snapshot
	ReleaseDefined(releaseName string) bool
	// ChartVersion returns the chartVersion for the given release in this snapshot. If the release is not defined, returns ""
	ChartVersion(releaseName string) string
	// AppVersion returns the chartVersion for the given release in this snapshot. If the release is not defined, returns ""
	AppVersion(releaseName string) string
	// UpdateChartVersionIfDefined sets the chartVersion for the given release to the given version.
	// If the release is not defined, or if newVersion <= the current chart version, this function does nothing.
	UpdateChartVersionIfDefined(releaseName string, newVersion string) error
}

type Versions

type Versions interface {
	// GetSnapshot returns a VersionSnapshot reference for the given release type & version set
	GetSnapshot(releaseType terra.ReleaseType, versionSet VersionSet) VersionSnapshot
}

Versions is for manipulating chart release versions in terra-helmfile (eg. versions/app/dev.yaml, versions/cluster/dev.yaml)

func NewVersions

func NewVersions(thelmaHome string, shellRunner shell.Runner) (Versions, error)

NewVersions returns a new Versions instance