builder

Documentation

Overview

Package builder is responsible for building fully rendered kubernetes api objects from various input directories. A directory may contain a platform spec or a component spec.

Index

• Constants
• type BuildData
• type Builder
  • func New(opts ...Option) *Builder
  • func (b *Builder) Cluster() string
  • func (b *Builder) Platform(ctx context.Context, cfg *client.Config) (*core.Platform, error)
  • func (b *Builder) Run(ctx context.Context, cfg *client.Config) (results []*render.Result, err error)
  • func (b *Builder) Unify(ctx context.Context, cfg *client.Config) (bd BuildData, err error)
• type Option
  • func Cluster(name string) Option
  • func Entrypoints(args []string) Option

Constants

const (
	KubernetesObjects = v1.KubernetesObjectsKind
	// Helm is the value of the kind field of holos build output indicating helm
	// values and helm command information.
	Helm = v1.HelmChartKind
	// Skip is the value when the instance should be skipped
	Skip = "Skip"
	// KustomizeBuild is the value of the kind field of cue output indicating
	// holos should process the component using kustomize build to render output.
	KustomizeBuild = v1alpha1.KustomizeBuildKind
)

Types

type BuildData

type BuildData struct {
	Value        cue.Value
	ModuleRoot   string
	InstancePath holos.InstancePath
	Dir          string
}

BuildData represents the data necessary to produce a build plan. It is a convenience wrapper to store relevant fields to inform the user.

type Builder

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

func New

func New(opts ...Option) *Builder

New returns a new *Builder configured by opts Option.

func (*Builder) Cluster

func (b *Builder) Cluster() string

Cluster returns the cluster name of the component instance being built.

func (*Builder) Platform

func (b *Builder) Platform(ctx context.Context, cfg *client.Config) (*core.Platform, error)

Platform builds a platform

func (*Builder) Run

func (b *Builder) Run(ctx context.Context, cfg *client.Config) (results []*render.Result, err error)

Run builds the cue entrypoint into zero or more Results. Exactly one CUE package entrypoint is expected in the args slice. The platform config is provided to the entrypoint through a json encoded string tag named platform_config. The resulting cue.Value is unified with all user data files at the path "#UserData".

func (*Builder) Unify

func (b *Builder) Unify(ctx context.Context, cfg *client.Config) (bd BuildData, err error)

Unify returns a cue.Value representing the kind of build holos is meant to execute. This function unifies a cue package entrypoint with platform.config.json and user data json files located recursively within the userdata directory at the cue module root.

type Option

type Option func(*config)

An Option configures a Builder

func Cluster

func Cluster(name string) Option

Cluster configures the cluster name for the holos component instance.

func Entrypoints

func Entrypoints(args []string) Option

Entrypoints configures the leaf directories Builder builds.