agent

Documentation

Overview

Package agent provides a daemon capable of running remote operations on behalf of a user.

Index

• Constants
• Variables
• func NewAgent(logger logr.Logger, app client, cfg Config) (*agent, error)
• func NewExternalAgent(ctx context.Context, logger logr.Logger, cfg ExternalConfig) (*agent, error)
• type Config
  • func NewConfigFromFlags(flags *pflag.FlagSet) *Config
• type ExternalConfig
  • func NewExternalConfigFromFlags(flags *pflag.FlagSet) *ExternalConfig
• type LocalClient

Constants

const (
	DefaultID          = "agent-001"
	DefaultConcurrency = 5
)

Variables

var (
	PluginCacheDir = filepath.Join(os.TempDir(), "plugin-cache")
	DefaultEnvs    = []string{
		"TF_IN_AUTOMATION=true",
		"CHECKPOINT_DISABLE=true",
	}
)

Functions

func NewAgent

func NewAgent(logger logr.Logger, app client, cfg Config) (*agent, error)

NewAgent is the constructor for an agent

func NewExternalAgent

func NewExternalAgent(ctx context.Context, logger logr.Logger, cfg ExternalConfig) (*agent, error)

NewExternalAgent constructs an external agent, which communicates with otfd via http

Types

type Config

type Config struct {
	Organization    *string // only process runs belonging to org
	External        bool    // dedicated agent (true) or integrated into otfd (false)
	Concurrency     int     // number of workers
	Sandbox         bool    // isolate privileged ops within sandbox
	Debug           bool    // toggle debug mode
	PluginCache     bool    // toggle use of terraform's shared plugin cache
	TerraformBinDir string  // destination directory for terraform binaries
}

Config is configuration for an agent.

func NewConfigFromFlags

func NewConfigFromFlags(flags *pflag.FlagSet) *Config

type ExternalConfig

type ExternalConfig struct {
	APIConfig api.Config

	Config
}

ExternalConfig is configuration for an external agent

func NewExternalConfigFromFlags

func NewExternalConfigFromFlags(flags *pflag.FlagSet) *ExternalConfig

type LocalClient

type LocalClient struct {
	tokens.TokensService
	variable.VariableService
	state.StateService
	workspace.WorkspaceService
	internal.HostnameService
	configversion.ConfigurationVersionService
	run.RunService
	logs.LogsService
}

LocalClient is the client for an internal agent.