platform

Documentation

Index

• func AppendVersionTag(tags *map[string]string)
• func CommonControlPlaneCharts() []helm.LokomotiveChart
• func ControlPlaneChart(name string) (*chart.Chart, error)
• func Register(name string, p Platform)
• type Meta
• type Platform
  • func GetPlatform(name string) (Platform, error)
• type PlatformWithPostApplyHook

Functions

func AppendVersionTag

func AppendVersionTag(tags *map[string]string)

AppendVersionTag appends the lokoctl-version tag to a given tags map.

func CommonControlPlaneCharts

func CommonControlPlaneCharts() []helm.LokomotiveChart

CommonControlPlaneCharts returns a list of control plane Helm charts to be deployed for all platforms.

func ControlPlaneChart

func ControlPlaneChart(name string) (*chart.Chart, error)

ControlPlaneChart is a convenience function which returns a pointer to a chart.Chart representing the control plane element named name.

func Register

func Register(name string, p Platform)

Register adds platform into internal map

Types

type Meta

type Meta struct {
	AssetDir      string
	ExpectedNodes int
	Managed       bool
}

Meta is a generic information format about the platform.

type Platform

type Platform interface {
	LoadConfig(*hcl.Body, *hcl.EvalContext) hcl.Diagnostics
	Apply(*terraform.Executor) error
	Destroy(*terraform.Executor) error
	Initialize(*terraform.Executor) error
	Meta() Meta
}

Platform describes single environment, where cluster can be installed

func GetPlatform

func GetPlatform(name string) (Platform, error)

GetPlatform returns platform based on the name

type PlatformWithPostApplyHook

type PlatformWithPostApplyHook interface {
	PostApplyHook(kubeconfig []byte) error
}

PlatformWithPostApplyHook runs code after Terraform finishes applying. This allows running sanity checks on the newly created cluster. Implementing this interface is optional for platforms.