engine

package
v0.17.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Nov 28, 2023 License: Apache-2.0 Imports: 31 Imported by: 0

Documentation

Overview

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

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func CopyModule added in v0.0.4 

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 ExtractStringFromFile added in v0.15.0 

func ExtractStringFromFile(ctx *cue.Context, filePath, exprPath string) (string, error)

func ExtractValueFromBytes added in v0.3.0 

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

func ExtractValueFromFile added in v0.0.4 

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 GetEnv added in v0.13.0 

func GetEnv() map[string]string

GetEnv returns a map of all environment variables.

func MergeValue added in v0.0.4 

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 added in v0.6.0 

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

ReadIgnoreFile returns the ignore patters found in the module root.

Types

type Bundle added in v0.5.0 

type Bundle struct {
	Name      string
	Instances []*BundleInstance
}

type BundleBuilder added in v0.4.0 

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

BundleBuilder compiles CUE definitions to Go Bundle objects.

func NewBundleBuilder added in v0.4.0 

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

NewBundleBuilder creates a BundleBuilder for the given module and package.

func (*BundleBuilder) Build added in v0.4.0 

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

Build builds a CUE instance for the specified files and returns the CUE value. A workspace must be initialised with InitWorkspace before calling this function.

func (*BundleBuilder) GetBundle added in v0.5.0 

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

GetBundle returns a Bundle from the bundle CUE value.

func (*BundleBuilder) InitWorkspace added in v0.9.0 

func (b *BundleBuilder) InitWorkspace(workspace string, runtimeValues map[string]string) error

InitWorkspace copies the bundle definitions to the specified workspace, sets the bundle schema, and then it injects the runtime values based on @timoni() attributes. A workspace must be initialised before calling Build.

type BundleInstance added in v0.4.0 

type BundleInstance struct {
	Bundle    string
	Cluster   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, cacheDir, creds string) *Fetcher

NewFetcher creates a Fetcher for the given module.

func (*Fetcher) Fetch 

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

Fetch copies the module contents to the destination directory. If the module source is a remote OCI repository, the artifact is pulled from the registry and its contents extracted to the destination dir. If the module source is a local directory, the module required files are validated and the module contents is copied to the destination dir while excluding files based on the timoni.ignore patters.

func (*Fetcher) GetModuleRoot 

func (f *Fetcher) GetModuleRoot() string

type Importer added in v0.14.0 

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

Importer generates CUE definitions from Kubernetes CRDs using the OpenAPI v3 spec.

func NewImporter added in v0.14.0 

func NewImporter(ctx *cue.Context, header string) *Importer

NewImporter creates an Importer for the given CUE context.

func (*Importer) Generate added in v0.14.0 

func (imp *Importer) Generate(crdData []byte) (map[string][]byte, error)

Generate takes a multi-doc YAML containing Kubernetes CRDs and returns the CUE definitions generated from the OpenAPI spec. The resulting key value pairs, contain a unique identifier in the format `<group>/<kind>/<version>` and the contents of the CUE definition.

type IntermediateCRD added in v0.13.0 

type IntermediateCRD struct {
	// The original unmodified CRD YAML, after conversion to a cue.Value.
	Original cue.Value
	Props    struct {
		Spec struct {
			Group string `json:"group"`
			Names struct {
				Kind     string `json:"kind"`
				ListKind string `json:"listKind"`
				Plural   string `json:"plural"`
				Singular string `json:"singular"`
			} `json:"names"`
			Scope string `json:"scope"`
		} `json:"spec"`
	}

	// All the schemas in the original CRD, converted to CUE representation.
	Schemas []VersionedSchema
}

IntermediateCRD is an intermediate representation of CRD YAML. It contains the original CRD YAML input, a subset of useful naming-related fields, and an extracted list of the version schemas in the CRD, having been converted from OpenAPI to CUE.

type ModuleBuilder added in v0.0.4 

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

ModuleBuilder compiles CUE definitions to Kubernetes objects.

func NewModuleBuilder added in v0.0.4 

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

NewModuleBuilder creates a ModuleBuilder for the given module and package.

func (*ModuleBuilder) Build added in v0.0.4 

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

Build builds the Timoni instance for the specified module and returns its CUE value. If the instance validation fails, the returned error may represent more than one error, retrievable with errors.Errors.

func (*ModuleBuilder) GetAPIVersion added in v0.0.6 

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 added in v0.0.5 

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

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

func (*ModuleBuilder) GetContainerImages added in v0.15.0 

func (b *ModuleBuilder) GetContainerImages(value cue.Value) ([]string, error)

GetContainerImages extracts the container images referenced in the instance config values.

func (*ModuleBuilder) GetDefaultValues added in v0.0.4 

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

GetDefaultValues extracts the default values from the module.

func (*ModuleBuilder) GetModuleName added in v0.0.4 

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

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

func (*ModuleBuilder) MergeValuesFile added in v0.0.4 

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

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

func (*ModuleBuilder) SetVersionInfo added in v0.12.0 

func (b *ModuleBuilder) SetVersionInfo(moduleVersion, kubeVersion string)

SetVersionInfo allows setting the Timoni module version and Kubernetes version, which are injected at build time as optional CUE tags.

func (*ModuleBuilder) WriteSchemaFile added in v0.5.0 

func (b *ModuleBuilder) WriteSchemaFile() error

WriteSchemaFile generates the module's instance schema.

func (*ModuleBuilder) WriteValuesFileWithDefaults added in v0.8.2 

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

WriteValuesFileWithDefaults merges the module's root values.cue with the supplied value.

type ResourceSet added in v0.0.5 

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 added in v0.0.5 

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

GetResources converts the CUE value to a list of ResourceSets.

type RuntimeBuilder added in v0.13.0 

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

RuntimeBuilder compiles CUE definitions to Go Runtime objects.

func NewRuntimeBuilder added in v0.13.0 

func NewRuntimeBuilder(ctx *cue.Context, files []string) *RuntimeBuilder

NewRuntimeBuilder creates a RuntimeBuilder for the given module and package.

func (*RuntimeBuilder) Build added in v0.13.0 

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

Build builds a CUE instance for the specified files and returns the CUE value. A workspace must be initialised with InitWorkspace before calling this function.

func (*RuntimeBuilder) GetRuntime added in v0.13.0 

func (b *RuntimeBuilder) GetRuntime(v cue.Value) (*apiv1.Runtime, error)

GetRuntime returns a Runtime from the specified CUE value.

func (*RuntimeBuilder) InitWorkspace added in v0.13.0 

func (b *RuntimeBuilder) InitWorkspace(workspace string) error

InitWorkspace extracts the runtime definitions to the specified workspace. A workspace must be initialised before calling Build.

type RuntimeInjector added in v0.13.0 

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

RuntimeInjector injects field values in CUE files based on @timoni() attributes.

func NewRuntimeInjector added in v0.13.0 

func NewRuntimeInjector(ctx *cue.Context) *RuntimeInjector

NewRuntimeInjector creates an RuntimeInjector for the given context.

func (*RuntimeInjector) Inject added in v0.13.0 

func (in *RuntimeInjector) Inject(node ast.Node, vars map[string]string) ([]byte, error)

Inject searches for Timoni's attributes and sets the CUE field value to the runtime value. If an attribute does not match any runtime value, the CUE field is left untouched.

func (*RuntimeInjector) ListAttributes added in v0.13.0 

func (in *RuntimeInjector) ListAttributes(f *ast.File) map[string]string

type ValuesBuilder added in v0.0.4 

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

ValuesBuilder compiles and merges values files.

func NewValuesBuilder added in v0.0.4 

func NewValuesBuilder(ctx *cue.Context) *ValuesBuilder

NewValuesBuilder creates a ValuesBuilder for the given context.

func (*ValuesBuilder) MergeValues added in v0.0.4 

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.

type VersionedSchema added in v0.13.0 

type VersionedSchema struct {
	// The contents of the `spec.versions[].name`
	Version string
	// The contents of `spec.versions[].schema.openAPIV3Schema`, after conversion of the OpenAPI
	// schema to native CUE constraints.
	Schema cue.Value
}

VersionedSchema is an intermediate form of a single versioned schema from a CRD (an element in `spec.versions`), converted to CUE.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.