agent

Documentation

Overview

Package agent provides the agent that will claim and run the jobs.

Index

• type Agent
  • func NewAgent(ctx context.Context, agentID string, logger logger.Logger, client Client, ...) (*Agent, error)
  • func (r *Agent) Start(ctx context.Context)
• type ClaimJobInput
• type ClaimJobResponse
• type Client
  • func NewInternalClient(agentService agent.Service, jobService job.Service) Client
• type JobDispatcherSettings

Types

type Agent

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

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

func NewAgent

func NewAgent(
	ctx context.Context,
	agentID string,
	logger logger.Logger,
	client Client,
	jobDispatcherSettings *JobDispatcherSettings,
) (*Agent, error)

NewAgent creates a new Agent

func (*Agent) Start

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

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

type ClaimJobInput

type ClaimJobInput struct {
	AgentID string
}

ClaimJobInput is the input for claiming the next available job

type ClaimJobResponse

type ClaimJobResponse struct {
	JobID         string
	Token         string
	ImageOverride *string
}

ClaimJobResponse is the response when claiming a job

type Client

type Client interface {
	CreateSession(ctx context.Context, agentID string) (string, error)
	SendHeartbeat(ctx context.Context, sessionID string) error
	ClaimJob(ctx context.Context, input *ClaimJobInput) (*ClaimJobResponse, error)
	SendError(ctx context.Context, sessionID string, err error) error
}

Client interface for claiming a job

func NewInternalClient

func NewInternalClient(agentService agent.Service, jobService job.Service) Client

NewInternalClient creates a new internal client

type JobDispatcherSettings

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

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