engine

Documentation

Overview

Package engine manages the acquisition and compilation of Timoni's CUE modules.

Index

• Constants
• func CopyModule(srcDir string, dstDir string) (err error)
• func ExtractValueFromBytes(ctx *cue.Context, data []byte, expr string) (cue.Value, error)
• func ExtractValueFromFile(ctx *cue.Context, filePath, expr string) (cue.Value, error)
• func MergeValue(overlay, base cue.Value) (cue.Value, error)
• func ReadIgnoreFile(moduleRoot string) ([]string, error)
• type Bundle
• type BundleBuilder
  • func NewBundleBuilder(ctx *cue.Context, files []string) *BundleBuilder
  • func (b *BundleBuilder) Build() (cue.Value, error)
  • func (b *BundleBuilder) GetBundle(v cue.Value) (*Bundle, error)
• type BundleInstance
• type Fetcher
  • func NewFetcher(ctx context.Context, src, version, dst, creds string) *Fetcher
  • func (f *Fetcher) Fetch() (*apiv1.ModuleReference, error)
  • func (f *Fetcher) GetModuleRoot() string
  • func (f *Fetcher) GetVersions() ([]ModuleVersion, error)
• type ModuleBuilder
  • func NewModuleBuilder(ctx *cue.Context, name, namespace, moduleRoot, pkgName string) *ModuleBuilder
  • func (b *ModuleBuilder) Build() (cue.Value, error)
  • func (b *ModuleBuilder) GetAPIVersion(value cue.Value) (string, error)
  • func (b *ModuleBuilder) GetApplySets(value cue.Value) ([]ResourceSet, error)
  • func (b *ModuleBuilder) GetDefaultValues() (string, error)
  • func (b *ModuleBuilder) GetModuleName() (string, error)
  • func (b *ModuleBuilder) GetValues(value cue.Value) (string, error)
  • func (b *ModuleBuilder) MergeValuesFile(overlays [][]byte) error
  • func (b *ModuleBuilder) WriteSchemaFile() error
  • func (b *ModuleBuilder) WriteValuesFile(val cue.Value) error
• type ModuleVersion
• type ResourceSet
  • func GetResources(value cue.Value) ([]ResourceSet, error)
• type ValuesBuilder
  • func NewValuesBuilder(ctx *cue.Context) *ValuesBuilder
  • func (b *ValuesBuilder) MergeValues(overlays [][]byte, base string) (cue.Value, error)

Constants

const LatestTag = "latest"

LatestTag is the OCI tag name used to denote the latest stable version of a module.

Functions

func CopyModule

func CopyModule(srcDir string, dstDir string) (err error)

CopyModule copies the given module to the destination directory, while excluding files that match the timoni.ignore patterns.

func ExtractValueFromBytes

func ExtractValueFromBytes(ctx *cue.Context, data []byte, expr string) (cue.Value, error)

func ExtractValueFromFile

func ExtractValueFromFile(ctx *cue.Context, filePath, expr string) (cue.Value, error)

ExtractValueFromFile compiles the given file and returns the CUE value that matches the given expression.

func MergeValue

func MergeValue(overlay, base cue.Value) (cue.Value, error)

MergeValue merges the given overlay on top of the base CUE value. New fields from the overlay are added to the base and existing fields are overridden with the overlay values.

func ReadIgnoreFile

func ReadIgnoreFile(moduleRoot string) ([]string, error)

ReadIgnoreFile returns the ignore patters found in the module root.

Types

type Bundle

type Bundle struct {
	Name      string
	Instances []BundleInstance
}

type BundleBuilder

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

BundleBuilder compiles CUE definitions to Go Bundle objects.

func NewBundleBuilder

func NewBundleBuilder(ctx *cue.Context, files []string) *BundleBuilder

NewBundleBuilder creates a BundleBuilder for the given module and package.

func (*BundleBuilder) Build

func (b *BundleBuilder) Build() (cue.Value, error)

Build builds a CUE instance for the specified files and returns the CUE value.

func (*BundleBuilder) GetBundle

func (b *BundleBuilder) GetBundle(v cue.Value) (*Bundle, error)

GetBundle returns a Bundle from the bundle CUE value.

type BundleInstance

type BundleInstance struct {
	Bundle    string
	Name      string
	Namespace string
	Module    apiv1.ModuleReference
	Values    cue.Value
}

type Fetcher

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

Fetcher downloads a module and extracts it locally.

func NewFetcher

func NewFetcher(ctx context.Context, src, version, dst, creds string) *Fetcher

NewFetcher creates a Fetcher for the given module.

func (*Fetcher) Fetch

func (f *Fetcher) Fetch() (*apiv1.ModuleReference, error)

Fetch downloads a remote module locally into tmp.

func (*Fetcher) GetModuleRoot

func (f *Fetcher) GetModuleRoot() string

func (*Fetcher) GetVersions

func (f *Fetcher) GetVersions() ([]ModuleVersion, error)

GetVersions returns a list of OCI tags and their digests. The list is ordered based on semver, newest version first.

type ModuleBuilder

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

ModuleBuilder compiles CUE definitions to Kubernetes objects.

func NewModuleBuilder

func NewModuleBuilder(ctx *cue.Context, name, namespace, moduleRoot, pkgName string) *ModuleBuilder

NewModuleBuilder creates a ModuleBuilder for the given module and package.

func (*ModuleBuilder) Build

func (b *ModuleBuilder) Build() (cue.Value, error)

Build builds a CUE instances for the specified package and returns the CUE value.

func (*ModuleBuilder) GetAPIVersion

func (b *ModuleBuilder) GetAPIVersion(value cue.Value) (string, error)

GetAPIVersion returns the list of API version of the Timoni's CUE definition.

func (*ModuleBuilder) GetApplySets

func (b *ModuleBuilder) GetApplySets(value cue.Value) ([]ResourceSet, error)

GetApplySets returns the list of Kubernetes unstructured objects to be applied in steps.

func (*ModuleBuilder) GetDefaultValues

func (b *ModuleBuilder) GetDefaultValues() (string, error)

GetDefaultValues extracts the default values from the module.

func (*ModuleBuilder) GetModuleName

func (b *ModuleBuilder) GetModuleName() (string, error)

GetModuleName returns the module name as defined in 'cue.mod/module.cue'.

func (*ModuleBuilder) GetValues

func (b *ModuleBuilder) GetValues(value cue.Value) (string, error)

GetValues extracts the values from the build result.

func (*ModuleBuilder) MergeValuesFile

func (b *ModuleBuilder) MergeValuesFile(overlays [][]byte) error

MergeValuesFile merges the given values overlays into the module's root values.cue.

func (*ModuleBuilder) WriteSchemaFile

func (b *ModuleBuilder) WriteSchemaFile() error

WriteSchemaFile generates the module's instance schema.

func (*ModuleBuilder) WriteValuesFile

func (b *ModuleBuilder) WriteValuesFile(val cue.Value) error

WriteValuesFile overwrites the module's root values.cue.

type ModuleVersion

type ModuleVersion struct {
	Number string
	Digest string
}

type ResourceSet

type ResourceSet struct {

	// Name of the object list.
	Name string `json:"name"`

	// Objects holds the list of Kubernetes objects.
	// +optional
	Objects []*unstructured.Unstructured `json:"objects,omitempty"`
}

ResourceSet is a named list of Kubernetes resource objects.

func GetResources

func GetResources(value cue.Value) ([]ResourceSet, error)

GetResources converts the CUE value to a list of ResourceSets.

type ValuesBuilder

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

ValuesBuilder compiles and merges values files.

func NewValuesBuilder

func NewValuesBuilder(ctx *cue.Context) *ValuesBuilder

NewValuesBuilder creates a ValuesBuilder for the given context.

func (*ValuesBuilder) MergeValues

func (b *ValuesBuilder) MergeValues(overlays [][]byte, base string) (cue.Value, error)

MergeValues merges the given overlays in order using the base as the starting point.