host

type ClientFactory func(token string) ermiteconnect.RunnerServiceClient

type Config struct {
	// URL is the base URL of the ermite server.
	URL string
	// Name is the runner name: 1 to 64 letters, digits, ".", "_" and "-".
	Name string
	// Labels are the extra labels of the runner.
	Labels []string
	// StateDir holds the runner token (mode 0600).
	StateDir string
	// Capacity is the number of jobs in parallel.
	Capacity int
	// Version is the version of the runner binary.
	Version string
	// Environment is the "runner.environment" value of the jobs and what decides
	// whether "Set up job" prints the runner and machine name: EnvGitHubHosted
	// (the default) or EnvSelfHosted. The runners of ermite stand in for the
	// GitHub-hosted ones: workflows written for github.com test
	// runner.environment == 'github-hosted' and the recordings of github.com
	// (ermite-conformance) carry that value, so it is the default; an operator
	// who wants jobs to see a self-hosted runner sets ERMITE_RUNNER_ENVIRONMENT.
	Environment string
	// InsecureHTTP allows a non-loopback http URL (ERMITE_RUNNER_INSECURE_HTTP=1).
	InsecureHTTP bool
	// GuestForgeOrigin is the origin (scheme://host[:port]) of ERMITE_RUNNER_URL
	// when ERMITE_RUNNER_GUEST_FORGE=1, "" otherwise. The server URLs of every
	// job are rewritten to it, see RewriteServerURLs. Set by the caller after
	// sandbox.ResolveGuestForge.
	GuestForgeOrigin string
}

type Runner struct {
	Cfg    Config
	Driver sandbox.Driver
	// Poll is the client that carries the runner token (FetchJob).
	Poll ermiteconnect.RunnerServiceClient
	// Job builds the client of a job from its job token.
	Job    func(jobToken string) ermiteconnect.RunnerServiceClient
	Timing Timing
	// Features lists the features of the server (GetVersion). Annotations and
	// step summaries are sent only when it says "ci.annotations" and
	// "ci.summaries". Nil means neither is sent.
	Features ServerFeatures
	// Cache, when not nil, is the cache service of the runner; the sandbox
	// drivers serve it on a channel of each sandbox (see sandbox.Config.Cache),
	// which the guest reaches on its loopback (cachesvc.DefaultPort), and each
	// job gets a token scoped to its repository and refs.
	Cache *cachesvc.Service
	// Archives, when not nil (and Cache is), is the host's cache of action
	// archives: the host downloads them and the sandbox reads them from the cache
	// channel (see cacheArchives). ArchiveHTTP is its HTTP client (tests); nil
	// means the default transport.
	Archives    *actionscache.Cache
	ArchiveHTTP *http.Client
	// Results, when not nil, is the results service of the runner (artifacts
	// v4). A job gets it when Cache is set too (it is served on the cache
	// channel and checks the cache's runtime tokens), Artifacts is set and the
	// server has the feature ci.artifacts.
	Results *resultssvc.Service
	// Artifacts builds the JobArtifactService client of a job from its job
	// token.
	Artifacts func(jobToken string) ermiteconnect.JobArtifactServiceClient
	// contains filtered or unexported fields
}

type ServerFeatures func(ctx context.Context) ([]string, error)

type State struct {
	URL         string `json:"url"`
	RunnerID    string `json:"runner_id"`
	Name        string `json:"name"`
	RunnerToken string `json:"runner_token"`
}

type Timing struct {
	// PollTimeout bounds one FetchJob call (the server holds it up to 50 s).
	PollTimeout time.Duration
	// HeartbeatEvery is the heartbeat period (30 s); HeartbeatRetry the delay
	// after a failed heartbeat (5 s).
	HeartbeatEvery, HeartbeatRetry time.Duration
	// CallTimeout bounds one unary job call.
	CallTimeout time.Duration
	// BackoffMin and BackoffMax bound the retry delay of calls that fail
	// without a verdict.
	BackoffMin, BackoffMax time.Duration
	// LogFlush is how long log lines are held to fill a batch.
	LogFlush time.Duration
	// WatchRetry is the delay before WatchJob is reopened.
	WatchRetry time.Duration
	// TimeoutGrace is how long the executor gets after the job timeout to stop
	// its steps (SIGINT, then SIGTERM after 7.5 s, then SIGKILL 2.5 s later) and
	// report, before the sandbox is destroyed.
	TimeoutGrace time.Duration
	// ShutdownGrace is how long jobs get to stop after a shutdown signal before
	// their sandbox is destroyed. The executor needs 10 s for its escalation
	// (SIGINT, SIGTERM after 7.5 s, SIGKILL 2.5 s later) and some for the
	// post-steps and the report to the host.
	ShutdownGrace time.Duration
	// StopDeadline bounds the destruction of a sandbox.
	StopDeadline time.Duration
	// ShutdownReport bounds the last flush of the log and CompleteJob of a job
	// that a shutdown cut short.
	ShutdownReport time.Duration
	// CompleteDeadline bounds the flush of logs and CompleteJob at the end of
	// a job.
	CompleteDeadline time.Duration
	// NoJobPause is the pause after a poll without a job and without
	// retry_after.
	NoJobPause time.Duration
	// ReapRetry is the delay between attempts to reap after a leaked sandbox.
	ReapRetry time.Duration
}