engine

package
v0.5.24 Latest Latest
Warning

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

 Go to latest Published: Apr 19, 2026 License: MPL-2.0 Imports: 24 Imported by: 0

Documentation

Overview

Package engine manages the CLI engine binaries that carry out run operations.

Index

Constants

View Source 
const MinEngineVersion = "1.2.0"

MinEngineVersion specifies the minimum engine version accepted by OTF.

TODO: This originally applied only to terraform before tofu was added as an alternative engine. Tofu's earliest version is 1.6.0, which should really be the minimum version if tofu is the selected engine.

Variables

View Source 
var (
	// Default is the default for setting the default engine.
	//
	// NOTE: the actual default engine that has been set by the user should be
	// retrieved via the daemon config.
	Default = Terraform()
	// ErrInvalidVersion is returned when a engine version string is
	// not a semantic version string (major.minor.patch).
	ErrInvalidVersion = errors.New("invalid engine version")
)
View Source 
var DefaultBinDir = path.Join(os.TempDir(), "otf-engine-bins")

Functions

func NewDownloader added in v0.3.21 

func NewDownloader(logger logr.Logger, engine *Engine, destdir string) (*downloader, error)

NewDownloader constructs a terraform downloader, with destdir set as the parent directory into which the binaries are downloaded. Pass an empty string to use a default.

Types

type Client added in v0.5.22 

type Client interface {
	// contains filtered or unexported methods
}

Client provides access to the engine's upstream services.

type Engine 

type Engine struct {
	Name           string
	DefaultVersion string
	// contains filtered or unexported fields
}

Engine represents a CLI capable of carrying out infrastructure as code operations, e.g. terraform.

func Engines added in v0.3.21 

func Engines() []*Engine

func Terraform 

func Terraform() *Engine

func Tofu 

func Tofu() *Engine

Tofu is the opentofu engine.

func (*Engine) MarshalText 

func (e *Engine) MarshalText() ([]byte, error)

func (*Engine) Scan 

func (e *Engine) Scan(text any) error

func (*Engine) Set 

func (e *Engine) Set(v string) error

func (*Engine) String added in v0.5.22 

func (e *Engine) String() string

func (*Engine) Type 

func (e *Engine) Type() string

func (*Engine) UnmarshalText 

func (e *Engine) UnmarshalText(text []byte) error

func (*Engine) Value 

func (e *Engine) Value() (driver.Value, error)

type EngineService added in v0.5.18 

type EngineService = Service

Alias service to permit embedding it with other services in a struct without a name clash.

type Options added in v0.3.21 

type Options struct {
	Logger logr.Logger
	DB     *sql.DB
	BinDir string // destination directory for binaries
}

type Service added in v0.3.21 

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

func NewService added in v0.3.21 

func NewService(opts Options) *Service

func (*Service) GetLatest added in v0.3.21 

func (s *Service) GetLatest(ctx context.Context, engine *Engine) (string, time.Time, error)

GetLatest returns the latest engine version and the time when it was fetched; if it has not yet been fetched then the default version is returned instead along with zero time.

func (*Service) UpdateLatestVersion added in v0.5.22 

func (s *Service) UpdateLatestVersion(ctx context.Context, engine *Engine, version string) error

type VersionChecker added in v0.5.22 

type VersionChecker struct {
	Logger logr.Logger
	Client VersionCheckerClient
}

func (*VersionChecker) Start added in v0.5.22 

func (s *VersionChecker) Start(ctx context.Context) error

Start the latest checker go routine, checking the latest version of each engine on a regular interval.

type VersionCheckerClient added in v0.5.22 

type VersionCheckerClient interface {
	GetLatest(ctx context.Context, engine *Engine) (string, time.Time, error)
	UpdateLatestVersion(ctx context.Context, engine *Engine, v string) error
}

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.