model

Documentation

Index

• type Artefact
• type ControllerKey
  • func NewControllerKey(hostname, port string) ControllerKey
  • func NewLocalControllerKey(suffix int) ControllerKey
  • func ParseControllerKey(key string) (ControllerKey, error)
• type ControllerPayload
  • func (c *ControllerPayload) Kind() string
• type Deployment
  • func (d *Deployment) Close() error
• type DeploymentKey
  • func NewDeploymentKey(module string) DeploymentKey
  • func ParseDeploymentKey(key string) (DeploymentKey, error)
• type DeploymentPayload
  • func (d *DeploymentPayload) Kind() string
  • func (d *DeploymentPayload) Parse(parts []string) error
  • func (d *DeploymentPayload) RandomBytes() int
  • func (d *DeploymentPayload) String() string
• type HostPortMixin
  • func (h *HostPortMixin) Parse(parts []string) error
  • func (h *HostPortMixin) RandomBytes() int
  • func (h *HostPortMixin) String() string
• type KeyPayload
• type KeyType
  • func (d KeyType[T, TP]) Equal(other KeyType[T, TP]) bool
  • func (d KeyType[T, TP]) IsZero() bool
  • func (d KeyType[T, TP]) Kind() string
  • func (d KeyType[T, TP]) MarshalText() ([]byte, error)
  • func (d *KeyType[T, TP]) Scan(src any) error
  • func (d KeyType[T, TP]) String() string
  • func (d *KeyType[T, TP]) UnmarshalText(bytes []byte) error
  • func (d KeyType[T, TP]) Value() (driver.Value, error)
• type Labels
  • func (l Labels) String() string
• type Origin
  • func ParseOrigin(origin string) (Origin, error)
• type RequestKey
  • func NewRequestKey(origin Origin, key string) RequestKey
  • func ParseRequestKey(name string) (RequestKey, error)
• type RequestKeyPayload
  • func (r *RequestKeyPayload) Kind() string
  • func (r *RequestKeyPayload) Parse(parts []string) error
  • func (r *RequestKeyPayload) RandomBytes() int
  • func (r *RequestKeyPayload) String() string
• type RunnerKey
  • func NewLocalRunnerKey(suffix int) RunnerKey
  • func NewRunnerKey(hostname, port string) RunnerKey
  • func ParseRunnerKey(key string) (RunnerKey, error)
• type RunnerPayload
  • func (r *RunnerPayload) Kind() string

Types

type Artefact

type Artefact struct {
	Path       string
	Executable bool
	Digest     sha256.SHA256
	// ~Zero-cost on-demand reader.
	Content io.ReadCloser
}

type ControllerKey

type ControllerKey = KeyType[ControllerPayload, *ControllerPayload]

func NewControllerKey

func NewControllerKey(hostname, port string) ControllerKey

func NewLocalControllerKey

func NewLocalControllerKey(suffix int) ControllerKey

func ParseControllerKey

func ParseControllerKey(key string) (ControllerKey, error)

type ControllerPayload

type ControllerPayload struct {
	HostPortMixin
}

func (*ControllerPayload) Kind

func (c *ControllerPayload) Kind() string

type Deployment

type Deployment struct {
	Module    string
	Language  string
	Key       DeploymentKey
	Schema    *schema.Module
	Artefacts []*Artefact
}

func (*Deployment) Close

func (d *Deployment) Close() error

Close is a convenience function to close all artefacts.

type DeploymentKey

type DeploymentKey = KeyType[DeploymentPayload, *DeploymentPayload]

func NewDeploymentKey

func NewDeploymentKey(module string) DeploymentKey

func ParseDeploymentKey

func ParseDeploymentKey(key string) (DeploymentKey, error)

type DeploymentPayload

type DeploymentPayload struct {
	Module string
}

func (*DeploymentPayload) Kind

func (d *DeploymentPayload) Kind() string

func (*DeploymentPayload) Parse

func (d *DeploymentPayload) Parse(parts []string) error

func (*DeploymentPayload) RandomBytes

func (d *DeploymentPayload) RandomBytes() int

func (*DeploymentPayload) String

func (d *DeploymentPayload) String() string

type HostPortMixin

type HostPortMixin struct {
	Hostname optional.Option[string]
	Port     string
}

HostPortMixin is a mixin for keys that have an (optional) hostname and a port.

func (*HostPortMixin) Parse

func (h *HostPortMixin) Parse(parts []string) error

func (*HostPortMixin) RandomBytes

func (h *HostPortMixin) RandomBytes() int

func (*HostPortMixin) String

func (h *HostPortMixin) String() string

type KeyPayload

type KeyPayload interface {
	Kind() string
	String() string
	// Parse the hyphen-separated parts of the payload
	Parse(parts []string) error
	// RandomBytes determines the number of random bytes the key should include.
	RandomBytes() int
}

KeyPayload is an interface that all key payloads must implement.

type KeyType

type KeyType[T any, TP keyPayloadConstraint[T]] struct {
	Payload T
	Suffix  []byte
}

KeyType is a helper type to avoid having to write a bunch of boilerplate.

func (KeyType[T, TP]) Equal

func (d KeyType[T, TP]) Equal(other KeyType[T, TP]) bool

func (KeyType[T, TP]) IsZero

func (d KeyType[T, TP]) IsZero() bool

func (KeyType[T, TP]) Kind

func (d KeyType[T, TP]) Kind() string

func (KeyType[T, TP]) MarshalText

func (d KeyType[T, TP]) MarshalText() ([]byte, error)

func (*KeyType[T, TP]) Scan

func (d *KeyType[T, TP]) Scan(src any) error

Scan from DB representation.

func (KeyType[T, TP]) String

func (d KeyType[T, TP]) String() string

func (*KeyType[T, TP]) UnmarshalText

func (d *KeyType[T, TP]) UnmarshalText(bytes []byte) error

func (KeyType[T, TP]) Value

func (d KeyType[T, TP]) Value() (driver.Value, error)

type Labels

type Labels map[string]any

func (Labels) String

func (l Labels) String() string

type Origin

type Origin string

Origin of a request.

const (
	OriginIngress Origin = "ingress"
	OriginCron    Origin = "cron"
	OriginPubsub  Origin = "pubsub"
)

func ParseOrigin

func ParseOrigin(origin string) (Origin, error)

type RequestKey

type RequestKey = KeyType[RequestKeyPayload, *RequestKeyPayload]

A RequestKey represents an inbound request into the cluster.

func NewRequestKey

func NewRequestKey(origin Origin, key string) RequestKey

func ParseRequestKey

func ParseRequestKey(name string) (RequestKey, error)

type RequestKeyPayload

type RequestKeyPayload struct {
	Origin Origin
	Key    string
}

func (*RequestKeyPayload) Kind

func (r *RequestKeyPayload) Kind() string

func (*RequestKeyPayload) Parse

func (r *RequestKeyPayload) Parse(parts []string) error

func (*RequestKeyPayload) RandomBytes

func (r *RequestKeyPayload) RandomBytes() int

func (*RequestKeyPayload) String

func (r *RequestKeyPayload) String() string

type RunnerKey

type RunnerKey = KeyType[RunnerPayload, *RunnerPayload]

func NewLocalRunnerKey

func NewLocalRunnerKey(suffix int) RunnerKey

func NewRunnerKey

func NewRunnerKey(hostname, port string) RunnerKey

func ParseRunnerKey

func ParseRunnerKey(key string) (RunnerKey, error)

type RunnerPayload

type RunnerPayload struct {
	HostPortMixin
}

func (*RunnerPayload) Kind

func (r *RunnerPayload) Kind() string