runner

Documentation

Overview

Package runner contains a server that implements the RunnerService and proxies VerbService requests to user code.

Index

• func Start(ctx context.Context, config Config) error
• type Config
• type Service
  • func (s *Service) Call(ctx context.Context, req *connect.Request[ftlv1.CallRequest]) (*connect.Response[ftlv1.CallResponse], error)
  • func (s *Service) Close() error
  • func (s *Service) Ping(ctx context.Context, req *connect.Request[ftlv1.PingRequest]) (*connect.Response[ftlv1.PingResponse], error)
  • func (s *Service) ServeHTTP(w http.ResponseWriter, r *http.Request)

Functions

func Start

func Start(ctx context.Context, config Config) error

Types

type Config

type Config struct {
	Config                []string                 `` /* 139-byte string literal not displayed */
	Bind                  *url.URL                 `help:"Endpoint the Runner should bind to and advertise." default:"http://127.0.0.1:8893" env:"FTL_RUNNER_BIND"`
	Key                   model.RunnerKey          `help:"Runner key (auto)."`
	ControllerEndpoint    *url.URL                 `name:"ftl-endpoint" help:"Controller endpoint." env:"FTL_ENDPOINT" default:"http://127.0.0.1:8892"`
	ControllerPublicKey   *identity.PublicKey      `name:"ftl-public-key" help:"Controller public key in Base64. Temporarily optional." env:"FTL_CONTROLLER_PUBLIC_KEY"`
	TemplateDir           string                   `help:"Template directory to copy into each deployment, if any." type:"existingdir"`
	DeploymentDir         string                   `help:"Directory to store deployments in." default:"${deploymentdir}"`
	DeploymentKeepHistory int                      `help:"Number of deployments to keep history for." default:"3"`
	HeartbeatPeriod       time.Duration            `help:"Minimum period between heartbeats." default:"3s"`
	HeartbeatJitter       time.Duration            `help:"Jitter to add to heartbeat period." default:"2s"`
	Deployment            string                   `help:"The deployment this runner is for." env:"FTL_DEPLOYMENT"`
	DebugPort             int                      `help:"The port to use for debugging." env:"FTL_DEBUG_PORT"`
	Registry              artefacts.RegistryConfig `embed:"" prefix:"oci-"`
	ObservabilityConfig   ftlobservability.Config  `embed:"" prefix:"o11y-"`
}

type Service

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

func (*Service) Call

func (s *Service) Call(ctx context.Context, req *connect.Request[ftlv1.CallRequest]) (*connect.Response[ftlv1.CallResponse], error)

func (*Service) Close

func (s *Service) Close() error

func (*Service) Ping

func (s *Service) Ping(ctx context.Context, req *connect.Request[ftlv1.PingRequest]) (*connect.Response[ftlv1.PingResponse], error)

func (*Service) ServeHTTP

func (s *Service) ServeHTTP(w http.ResponseWriter, r *http.Request)