components

Documentation

Index

• Variables
• func Chart(name string) (*chart.Chart, error)
• func ListNames() []string
• func Register(name string, obj Component)
• type Component
  • func Get(name string) (Component, error)
  • func List() []Component
• type HelmMetadata
• type Metadata

Variables

var (
	HCLDiagConfigBodyNil = &hcl.Diagnostic{
		Severity: hcl.DiagError,
		Summary:  "*hcl.Body is nil",
		Detail:   "*hcl.Body pointer must not be nil - did you provide a lokocfg configuration file?",
	}
)

Functions

func Chart

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

Chart is a convenience function which returns a pointer to a chart.Chart representing the component named name.

func ListNames

func ListNames() []string

func Register

func Register(name string, obj Component)

Types

type Component

type Component interface {
	// LoadConfig loads specific component configuration from HCL configuration.
	// If an error occurs, HCL diagnostics are returned.
	LoadConfig(*hcl.Body, *hcl.EvalContext) hcl.Diagnostics
	// RenderManifests returns a map of Kubernetes manifests in YAML format, where
	// the key is the file from which the content comes.
	RenderManifests() (map[string]string, error)
	// Metadata returns component metadata.
	Metadata() Metadata
}

Component represents functionality each Lokomotive component should implement.

func Get

func Get(name string) (Component, error)

func List

func List() []Component

type HelmMetadata

type HelmMetadata struct {
	Wait bool
}

HelmMetadata stores Helm-related information about a component that is needed when managing component using Helm.

type Metadata

type Metadata struct {
	Name      string
	Namespace k8sutil.Namespace
	Helm      HelmMetadata
}

Metadata is a struct which represents basic information about the component. It may contain information like name, version, dependencies, namespace, source etc.