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(defaultEnabled bool) error
  • func (e *Engine) LoadConfigurations() error
  • func (e *Engine) ManifestUpgrade(saveToDisk bool) (err error)
  • func (e *Engine) Prepare() (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() (err error)
  • func (e *Engine) Scaffold(rootDir string) error
  • func (e *Engine) Show() 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(defaultEnabled bool) error

LoadAutoDiscovery tries to guess available pipelines based on specific directory

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) Prepare

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

Prepare run every actions needed before going further.

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() (err error)

Run runs the full process for one manifest

func (*Engine) Scaffold

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

func (*Engine) Show

func (e *Engine) Show() error

Show displays configurations that should be apply.

type Options

type Options struct {
	Config    config.Option
	Pipeline  pipeline.Options
	Manifests []manifest.Manifest
}

Options defines application specific behaviors