runner

Documentation

Overview

Package runner package

Index

• type ClaimJobInput
• type ClaimJobResponse
• type Client
  • func NewInternalClient(runnerService runner.Service, jobService job.Service) Client
• type CreateRunnerSessionInput
• type JobDispatcherSettings
• type Runner
  • func NewRunner(ctx context.Context, runnerPath string, logger logger.Logger, client Client, ...) (*Runner, error)
  • func (r *Runner) Start(ctx context.Context)

Types

type ClaimJobInput

type ClaimJobInput struct {
	RunnerPath string
}

ClaimJobInput is the input for claiming the next available job

type ClaimJobResponse

type ClaimJobResponse struct {
	JobID string
	Token string
}

ClaimJobResponse is the response when claiming a job

type Client

type Client interface {
	CreateRunnerSession(ctx context.Context, input *CreateRunnerSessionInput) (string, error)
	SendRunnerSessionHeartbeat(ctx context.Context, sessionID string) error
	ClaimJob(ctx context.Context, input *ClaimJobInput) (*ClaimJobResponse, error)
	CreateRunnerSessionError(ctx context.Context, sessionID string, err error) error
}

Client interface for claiming a job

func NewInternalClient

func NewInternalClient(runnerService runner.Service, jobService job.Service) Client

NewInternalClient creates a new internal client

type CreateRunnerSessionInput

type CreateRunnerSessionInput struct {
	RunnerPath string
}

CreateRunnerSessionInput is the input for creating a runner session

type JobDispatcherSettings

type JobDispatcherSettings struct {
	PluginData           map[string]string
	DispatcherType       string
	ServiceDiscoveryHost string
}

JobDispatcherSettings defines the job dispatcher that'll be used for this runner

type Runner

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

Runner will claim the next available job and dispatch it using the configured job dispatcher

func NewRunner

func NewRunner(
	ctx context.Context,
	runnerPath string,
	logger logger.Logger,
	client Client,
	jobDispatcherSettings *JobDispatcherSettings,
) (*Runner, error)

NewRunner creates a new Runner In Tharsis, this takes a runner path, not a runner ID.

func (*Runner) Start

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

Start will start the runner so it can begin picking up jobs