engine

Documentation

Index

• Variables
• func Clone(s *scm.ScmHandler, channel chan int, hashes *[]uint64, wg *sync.WaitGroup) error
• func GenerateSchema(baseSchemaID, schemaDir string) error
• func PrintTitle(title string)
• type Engine
  • func (e *Engine) Clean() (err error)
  • func (e *Engine) InitSCM() (err error)
  • func (e *Engine) LoadAutoDiscovery(ctx context.Context, defaultEnabled bool) error
  • func (e *Engine) LoadConfigurations() error
  • func (e *Engine) ManifestUpgrade(saveToDisk bool) (err error)
  • func (e *Engine) OrderPipelines() error
  • func (e *Engine) Prepare(ctx context.Context) (err error)
  • func (e *Engine) PullFromRegistry(policyReference string, disableTLS bool) (err error)
  • func (e *Engine) PushToRegistry(manifests, valuesFiles, secretsFiles, policyReference []string, ...) error
  • func (e *Engine) Run(ctx context.Context) (err error)
  • func (e *Engine) Scaffold(rootDir string) error
  • func (e *Engine) SetTracer(t trace.Tracer)
  • func (e *Engine) Show() (err error)
• type Options

Variables

var (
	// ErrNoManifestDetected is the error message returned by Updatecli if it can't find manifest
	ErrNoManifestDetected error = errors.New("no Updatecli manifest detected")
)

Functions

func Clone

func Clone(
	s *scm.ScmHandler,
	channel chan int,
	hashes *[]uint64,
	wg *sync.WaitGroup,
) error

Clone parses a scm configuration then clone the git repository if needed.

func GenerateSchema

func GenerateSchema(baseSchemaID, schemaDir string) error

func PrintTitle

func PrintTitle(title string)

PrintTitle print a title

Types

type Engine

type Engine struct {
	Pipelines []*pipeline.Pipeline
	Options   Options
	Reports   reports.Reports
	// contains filtered or unexported fields
}

Engine defined parameters for a specific engine run.

func (*Engine) Clean

func (e *Engine) Clean() (err error)

Clean remove every traces from an updatecli run.

func (*Engine) InitSCM

func (e *Engine) InitSCM() (err error)

InitSCM search and clone only once SCM configurations found.

func (*Engine) LoadAutoDiscovery

func (e *Engine) LoadAutoDiscovery(ctx context.Context, defaultEnabled bool) error

LoadAutoDiscovery runs autodiscovery under the provided context so that crawler spans can be linked to the calling prepare span.

func (*Engine) LoadConfigurations

func (e *Engine) LoadConfigurations() error

ReadConfigurations read every strategies configuration.

func (*Engine) ManifestUpgrade

func (e *Engine) ManifestUpgrade(saveToDisk bool) (err error)

ManifestUpgrade load Updatecli Manifest to update them then written them back on disk

func (*Engine) OrderPipelines

func (e *Engine) OrderPipelines() error

OrderPipelines resolves manifest-level dependencies and reorders pipelines accordingly.

func (*Engine) Prepare

func (e *Engine) Prepare(ctx context.Context) (err error)

Prepare runs all preparation phases under the provided context, emitting an OTel span for the overall prepare phase and one child span per sub-phase.

func (*Engine) PullFromRegistry

func (e *Engine) PullFromRegistry(policyReference string, disableTLS bool) (err error)

PullFromRegistry retrieves an Updatecli policy from an OCI registry.

func (*Engine) PushToRegistry

func (e *Engine) PushToRegistry(manifests, valuesFiles, secretsFiles, policyReference []string, disableTLS bool, policyMetadataFile, fileStore string, overwrite bool) error

PushToRegistry pushes an Updatecli policy to an OCI registry.

func (*Engine) Run

func (e *Engine) Run(ctx context.Context) (err error)

Run runs the full process under the provided context, emitting OpenTelemetry spans for each major operation so failures are observable.

func (*Engine) Scaffold

func (e *Engine) Scaffold(rootDir string) error

func (*Engine) SetTracer

func (e *Engine) SetTracer(t trace.Tracer)

SetTracer configures the tracer used for OTel instrumentation across all engine operations. Call this once after telemetry is initialized, before invoking Prepare or Run.

func (*Engine) Show

func (e *Engine) Show() (err error)

Show displays configurations that should be apply.

type Options

type Options struct {
	// Config holds the application configuration options
	Config config.Option
	// Pipeline holds pipeline execution options
	Pipeline pipeline.Options
	// Manifests holds a list of manifests to process
	Manifests []manifest.Manifest
	// DisplayFlavor defines the flavor of the display output
	DisplayFlavor string
	// GraphFlavor defines the flavor of the dependency graph
	GraphFlavor string
	// PipelineIDs holds a list of pipeline IDs to filter on
	PipelineIDs []string
	// Labels holds a map of labels to filter on
	Labels map[string]string
}

Options defines application specific behaviors