runner

Nov 2, 2025

Changes in this version

+ type AgentToken struct

+ AgentPoolID resource.TfeID

+ CreatedAt time.Time

+ Description string

+ ID resource.TfeID

+ func (a *AgentToken) LogValue() slog.Value

+ type ListPoolOptions struct

+ AllowedWorkspaceID *resource.TfeID

+ AllowedWorkspaceName *string

+ NameSubstring *string

+ type RegisterRunnerOptions struct

+ AgentPoolID *string

+ Concurrency int

+ CurrentJobs []resource.TfeID

+ IPAddress *netip.Addr

+ Name string

+ Version string

type Service

+ func (s *Service) DeleteAgentPool(ctx context.Context, poolID resource.TfeID) (*Pool, error)

+ func (s *Service) DeleteRunner(ctx context.Context, runnerID resource.TfeID) error

+ func (s *Service) ListAgentPoolsByOrganization(ctx context.Context, organization organization.Name, opts ListPoolOptions) ([]*Pool, error)

+ func (s *Service) ListRunners(ctx context.Context, opts ListOptions) ([]*RunnerMeta, error)

+ func (s *Service) Register(ctx context.Context, opts RegisterRunnerOptions) (*RunnerMeta, error)

+ func (s *Service) UpdateAgentPool(ctx context.Context, poolID resource.TfeID, opts UpdatePoolOptions) (*Pool, error)

+ type UpdatePoolOptions struct

+ AllowedWorkspaces []resource.TfeID

+ AssignedWorkspaces []resource.TfeID

+ Name *string

+ OrganizationScoped *bool

Jul 24, 2025

Changes in this version

type Service

+ func (s *Service) GenerateDynamicCredentialsToken(ctx context.Context, jobID resource.TfeID, audience string) ([]byte, error)

type ServiceOptions

+ DynamicCredentialsService *dynamiccreds.Service

+ HostnameService *internal.HostnameService

Jul 1, 2025

Changes in this version

type Service

+ Signaler *jobSignaler

May 26, 2025

Changes in this version

+ type JobEvent struct

+ ID resource.TfeID

+ RunID resource.TfeID

+ RunnerID *resource.TfeID

+ Signaled *bool

+ Status JobStatus

type Runner

+ func (r *Runner) Started() <-chan struct{}

+ type RunnerEvent struct

+ ID resource.TfeID

+ Status RunnerStatus

Apr 25, 2025

Changes in this version

type Config

+ EngineBinDir string

+ func NewConfig() *Config

Apr 8, 2025

Changes in this version

+ type ListOptions struct

+ HideServerRunners bool

+ Organization *organization.Name

+ PoolID *resource.TfeID

type Pool

+ ID resource.TfeID

type Service

+ func (s *Service) List(ctx context.Context, opts ListOptions) (*resource.Page[*RunnerMeta], error)

+ func (s *Service) Watch(ctx context.Context) (<-chan pubsub.Event[*RunnerMeta], func())

+ type TFEAgentPool struct

+ AgentCount int

+ AllowedWorkspaces []*workspace.TFEWorkspace

+ ID resource.TfeID

+ Name string

+ Organization *organization.TFEOrganization

+ OrganizationScoped bool

+ Workspaces []*workspace.TFEWorkspace

+ type TFEAgentPoolCreateOptions struct

+ AllowedWorkspaces []*workspace.TFEWorkspace

+ Name *string

+ OrganizationScoped *bool

+ Type string

+ type TFEAgentPoolListOptions struct

+ AllowedWorkspacesName *string

+ Query *string

+ type TFEAgentPoolUpdateOptions struct

+ AllowedWorkspaces []*workspace.TFEWorkspace

+ Name *string

+ OrganizationScoped *bool

+ Type string

+ type TFEAgentToken struct

+ CreatedAt time.Time

+ Description string

+ ID resource.TfeID

+ LastUsedAt time.Time

+ Token string

+ type TFEAgentTokenCreateOptions struct

+ Description string

+ Type string

Nov 22, 2024

Changes in this version

+ const AllocatorLockID

+ const DefaultMaxJobs

+ const ManagerLockID

+ var ErrCannotDeletePoolReferencedByWorkspaces = errors.New(...)

+ var ErrInvalidJobStateTransition = errors.New("invalid job state transition")

+ var ErrInvalidStateTransition = errors.New("invalid runner state transition")

+ var ErrMalformedJobSpecString = errors.New("malformed stringified job spec")

+ var ErrPoolAssignedWorkspacesNotAllowed = errors.New("workspaces assigned to the pool have not been granted access to the pool")

+ var ErrWorkspaceNotAllowedToUsePool = errors.New(...)

+ var PluginCacheDir = filepath.Join(os.TempDir(), "plugin-cache")

+ func NewAgentsCommand(apiClient *otfapi.Client) *cobra.Command

+ type AgentOptions struct

+ Token string

+ URL string

+ func NewAgentOptionsFromFlags(flags *pflag.FlagSet) *AgentOptions

+ type Config struct

+ Debug bool

+ MaxJobs int

+ Name string

+ PluginCache bool

+ Sandbox bool

+ TerraformBinDir string

+ func NewConfigFromFlags(flags *pflag.FlagSet) *Config

+ type CreateAgentPoolOptions struct

+ AllowedWorkspaces []resource.ID

+ Name string

+ Organization string

+ OrganizationScoped *bool

+ type CreateAgentTokenOptions struct

+ Description string

+ type Job struct

+ AgentPoolID *resource.ID

+ ID resource.ID

+ Organization string

+ Phase internal.PhaseType

+ RunID resource.ID

+ RunnerID *resource.ID

+ Signaled *bool

+ Status JobStatus

+ WorkspaceID resource.ID

+ func (j *Job) CanAccess(action authz.Action, req *authz.AccessRequest) bool

+ func (j *Job) LogValue() slog.Value

+ func (j *Job) String() string

+ type JobStatus string

+ const JobAllocated

+ const JobCanceled

+ const JobErrored

+ const JobFinished

+ const JobRunning

+ const JobUnallocated

+ type Pool struct

+ AllowedWorkspaces []resource.ID

+ AssignedWorkspaces []resource.ID

+ CreatedAt time.Time

+ Name string

+ Organization string

+ OrganizationScoped bool

+ func (p *Pool) LogValue() slog.Value

+ type Runner struct

+ Debug bool

+ PluginCache bool

+ Sandbox bool

+ TerraformBinDir string

+ func NewAgent(logger logr.Logger, opts AgentOptions) (*Runner, error)

+ func NewServerRunner(opts ServerRunnerOptions) (*Runner, error)

+ func (r *Runner) Registered() <-chan *RunnerMeta

+ func (r *Runner) Start(ctx context.Context) error

+ type RunnerMeta struct

+ AgentPool *RunnerMetaAgentPool

+ CurrentJobs int

+ ID resource.ID

+ IPAddress netip.Addr

+ LastPingAt time.Time

+ LastStatusAt time.Time

+ MaxJobs int

+ Name string

+ Status RunnerStatus

+ Version string

+ func (m *RunnerMeta) CanAccess(action authz.Action, req *authz.AccessRequest) bool

+ func (m *RunnerMeta) IsAgent() bool

+ func (m *RunnerMeta) LogValue() slog.Value

+ func (m *RunnerMeta) String() string

+ type RunnerMetaAgentPool struct

+ ID resource.ID

+ Name string

+ OrganizationName string

+ TokenID resource.ID

+ func (m *RunnerMetaAgentPool) LogValue() slog.Value

+ type RunnerStatus string

+ const RunnerBusy

+ const RunnerErrored

+ const RunnerExited

+ const RunnerIdle

+ const RunnerUnknown

+ type ServerRunnerOptions struct

+ Configs configClient

+ Jobs operationJobsClient

+ Logger logr.Logger

+ Logs logsClient

+ Runners *Service

+ Runs runClient

+ Server hostnameClient

+ State stateClient

+ Variables variablesClient

+ Workspaces workspaceClient

+ type Service struct

+ func NewService(opts ServiceOptions) *Service

+ func (f Service) NewAgentToken(poolID resource.ID, opts CreateAgentTokenOptions) (*agentToken, []byte, error)

+ func (s *Service) AddHandlers(r *mux.Router)

+ func (s *Service) CreateAgentPool(ctx context.Context, opts CreateAgentPoolOptions) (*Pool, error)

+ func (s *Service) CreateAgentToken(ctx context.Context, poolID resource.ID, opts CreateAgentTokenOptions) (*agentToken, []byte, error)

+ func (s *Service) DeleteAgentToken(ctx context.Context, tokenID resource.ID) (*agentToken, error)

+ func (s *Service) GetAgentPool(ctx context.Context, poolID resource.ID) (*Pool, error)

+ func (s *Service) GetAgentToken(ctx context.Context, tokenID resource.ID) (*agentToken, error)

+ func (s *Service) ListAgentTokens(ctx context.Context, poolID resource.ID) ([]*agentToken, error)

+ func (s *Service) NewAllocator(logger logr.Logger) *allocator

+ func (s *Service) NewManager() *manager

+ func (s *Service) WatchAgentPools(ctx context.Context) (<-chan pubsub.Event[*Pool], func())

+ func (s *Service) WatchJobs(ctx context.Context) (<-chan pubsub.Event[*Job], func())

+ func (s *Service) WatchRunners(ctx context.Context) (<-chan pubsub.Event[*RunnerMeta], func())

+ type ServiceOptions struct

+ Authorizer *authz.Authorizer

+ RunService *otfrun.Service

+ TokensService *tokens.Service

+ WorkspaceService *workspace.Service