supervisor

Documentation

Index

• type BuildInfo
• type CommitInfo
  • func (ci CommitInfo) AsRevisionString() string
• type Config
• type Proc
• type Supervisor
  • func New(cfg *Config, rtCfg *runtimev1.RuntimeConfig) (*Supervisor, error)
  • func (s *Supervisor) Run(ctx context.Context) error

Types

type BuildInfo

type BuildInfo struct {
	// The version of Encore with which the app was compiled.
	// This is string is for informational use only, and its format should not be relied on.
	EncoreCompiler string

	// AppCommit describes the commit of the app.
	AppCommit CommitInfo
}

type CommitInfo

type CommitInfo struct {
	Revision    string
	Uncommitted bool
}

func (CommitInfo) AsRevisionString

func (ci CommitInfo) AsRevisionString() string

type Config

type Config struct {
	Procs []Proc `json:"procs"`

	// NoopGateways are the noop-gateways to start up,
	// keyed by gateway name.
	NoopGateways map[string]*noopgateway.Description
}

Config is the configuration used by the supervisor.

type Proc

type Proc struct {
	// ID is a unique id representing this process.
	ID string `json:"id"`

	// Command and arguments for running the proc.
	Command []string `json:"command"`

	// Extra environment variables to pass.
	Env []string `json:"env"`

	// supervisedProc and gateway names included in this proc.
	Services []string `json:"services"`
	Gateways []string `json:"gateways"`
}

Proc represents a supervised proc.

type Supervisor

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

func New

func New(cfg *Config, rtCfg *runtimev1.RuntimeConfig) (*Supervisor, error)

New creates a new supervisor.

func (*Supervisor) Run

func (s *Supervisor) Run(ctx context.Context) error

Run runs the supervisor. It returns immediately on error, and otherwise blocks until ctx is canceled.