builder

Documentation

Index

• func ExtractYAML(ctxt *cue.Context, filepaths []string) (cue.Value, error)
• type BuildPlan
  • func LoadBuildPlan(i *Instance, opts holos.BuildOpts) (bp BuildPlan, err error)
• type Instance
  • func LoadInstance(path string, filepaths []string, tags []string) (*Instance, error)
  • func (i *Instance) Decoder() (*json.Decoder, error)
  • func (i *Instance) Discriminate(discriminate func(tm holos.TypeMeta) error) error
  • func (i *Instance) Export(enc holos.Encoder) error
  • func (i *Instance) HolosValue() (v cue.Value, err error)
• type Platform
  • func LoadPlatform(i *Instance) (platform Platform, err error)
  • func (p *Platform) Build(ctx context.Context, opts PlatformOpts) error
• type PlatformOpts

Functions

func ExtractYAML

func ExtractYAML(ctxt *cue.Context, filepaths []string) (cue.Value, error)

ExtractYAML extracts yaml encoded data from file paths. The data is unified into one cue.Value. If a path element is a directory, all files in the directory are loaded non-recursively.

Attribution: https://github.com/cue-lang/cue/issues/3504

Types

type BuildPlan

type BuildPlan struct {
	holos.BuildPlan
}

func LoadBuildPlan

func LoadBuildPlan(i *Instance, opts holos.BuildOpts) (bp BuildPlan, err error)

type Instance

type Instance struct {
	// contains filtered or unexported fields
}

Instance represents a cue instance to build. Use LoadInstance to create a new Instance.

func LoadInstance

func LoadInstance(path string, filepaths []string, tags []string) (*Instance, error)

LoadInstance loads the cue configuration instance at path. External data file paths are loaded by calling ExtractYAML providing filepaths. The extracted data values are unified with the platform configuration cue.Value in the returned Instance.

func (*Instance) Decoder

func (i *Instance) Decoder() (*json.Decoder, error)

func (*Instance) Discriminate

func (i *Instance) Discriminate(discriminate func(tm holos.TypeMeta) error) error

Discriminate calls the discriminate func for side effects. Useful to switch over the instance kind and apiVersion.

func (*Instance) Export

func (i *Instance) Export(enc holos.Encoder) error

func (*Instance) HolosValue

func (i *Instance) HolosValue() (v cue.Value, err error)

HolosValue returns the value of the holos field of the exported CUE instance.

type Platform

type Platform struct {
	holos.Platform
}

Platform represents a common abstraction over different platform schema versions.

func LoadPlatform

func LoadPlatform(i *Instance) (platform Platform, err error)

func (*Platform) Build

func (p *Platform) Build(ctx context.Context, opts PlatformOpts) error

Build calls PlatformOpts Fn(ctx, component) concurrently.

type PlatformOpts

type PlatformOpts struct {
	Fn          func(context.Context, int, holos.Component) error
	Selector    holos.Selector
	Concurrency int
	InfoEnabled bool
}

PlatformOpts represents build options when processing the components in a platform.