provisionerd

Documentation

Index

• Constants
• func IsMissingParameterError(err string) bool
• type Dialer
• type Options
• type Provisioners
• type Server
  • func New(clientDialer Dialer, opts *Options) *Server
  • func (p *Server) Close() error
  • func (p *Server) Shutdown(ctx context.Context) error

Constants

const ReadmeFile = "README.md"

ReadmeFile is the location we look for to extract documentation from template versions.

Functions

func IsMissingParameterError

func IsMissingParameterError(err string) bool

IsMissingParameterError returns whether the error message provided is a missing parameter error. This can indicate to consumers that they should check parameters.

Types

type Dialer

type Dialer func(ctx context.Context) (proto.DRPCProvisionerDaemonClient, error)

Dialer represents the function to create a daemon client connection.

type Options

type Options struct {
	Logger slog.Logger

	ForceCancelInterval time.Duration
	UpdateInterval      time.Duration
	PollInterval        time.Duration
	Provisioners        Provisioners
	WorkDirectory       string
}

Options provides customizations to the behavior of a provisioner daemon.

type Provisioners

type Provisioners map[string]sdkproto.DRPCProvisionerClient

Provisioners maps provisioner ID to implementation.

type Server

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

func New

func New(clientDialer Dialer, opts *Options) *Server

New creates and starts a provisioner daemon.

func (*Server) Close

func (p *Server) Close() error

Close ends the provisioner. It will mark any running jobs as failed.

func (*Server) Shutdown

func (p *Server) Shutdown(ctx context.Context) error

Shutdown triggers a graceful exit of each registered provisioner. It exits when an active job stops.