backend

Documentation

Index

• Constants
• func CollectConsumerInfo(nc *nats.Conn, streamName string) ([]*jetstream.ConsumerInfo, error)
• func CollectStreamInfo(nc *nats.Conn, names []string) ([]*jetstream.StreamInfo, error)
• func ConvertToHumanReadableDateType(timestamp *time.Time) string
• func ErrorToAPIStatus(err error) *metav1.Status
• func GRPCCode(err error) gcerrors.ErrorCode
• func HTTPStatusFromCode(code gcerrors.ErrorCode) int32
• func NewConnection(addr, credFile string) (nc *nats.Conn, err error)
• func RenderConsumerInfo(consumers []*jetstream.ConsumerInfo) []byte
• func RenderStreamInfo(streams []*jetstream.StreamInfo) []byte
• func ReportStatus(nc *nats.Conn, name string, s Status, comments ...string)
• func RunsOnSelfHosted(e *github.WorkflowJobEvent) (string, bool)
• func SubmitPayload(gh *github.Client, nc *nats.Conn, r *http.Request, secretToken []byte) error
• func UseHighPriorityRunner(gh *github.Client, org string, private bool) string
• func UseRegularRunner(gh *github.Client, org string, private bool) string
• type MachineStatus
  • func (ms MachineStatus) Strings() []string
• type Manager
  • func New(nc *nats.Conn, opts Options) *Manager
  • func (mgr *Manager) EnsureStreams(jsOpts ...jetstream.JetStreamOpt) error
  • func (mgr *Manager) ProcessCompletedJobs() error
  • func (mgr *Manager) ProcessCompletedJobs__() error
  • func (mgr *Manager) ProcessCompletedMsg(payload []byte) (*github.WorkflowJobEvent, error)
  • func (mgr *Manager) RunVMs()
  • func (mgr *Manager) Start(ctx context.Context, jsOpts ...jetstream.JetStreamOpt) error
• type NATSOptions
  • func NewNATSOptions() *NATSOptions
  • func (opts *NATSOptions) AddFlags(fs *pflag.FlagSet)
• type Options
  • func DefaultOptions() Options
  • func (opts *Options) AddFlags(fs *pflag.FlagSet)
• type Status
• type StatusReporter
  • func NewStatusReporter(nc *nats.Conn) (*StatusReporter, error)
  • func (sp *StatusReporter) GenerateHTMLReport() (string, error)
  • func (sp *StatusReporter) GenerateMarkdownReport() ([]byte, error)

Constants

const (
	NatsConnectionTimeout       = 350 * time.Millisecond
	NatsConnectionRetryInterval = 100 * time.Millisecond
	NatsRequestTimeout          = 10 * time.Second

	StreamPrefix = "gha_"
)

const (
	RunnerRegular       = "firecracker"
	RunnerHigh          = "f0"
	RunnerLabelDetector = "label-detector"
)

Functions

func CollectConsumerInfo

func CollectConsumerInfo(nc *nats.Conn, streamName string) ([]*jetstream.ConsumerInfo, error)

func CollectStreamInfo

func CollectStreamInfo(nc *nats.Conn, names []string) ([]*jetstream.StreamInfo, error)

func ConvertToHumanReadableDateType

func ConvertToHumanReadableDateType(timestamp *time.Time) string

ConvertToHumanReadableDateType returns the elapsed time since timestamp in human-readable approximation. ref: https://github.com/kubernetes/apimachinery/blob/v0.21.1/pkg/api/meta/table/table.go#L63-L70 But works for timestamp before or after now.

func ErrorToAPIStatus

func ErrorToAPIStatus(err error) *metav1.Status

ErrorToAPIStatus converts an error to an metav1.Status object.

func GRPCCode

func GRPCCode(err error) gcerrors.ErrorCode

GRPCCode extracts the gRPC status code and converts it into an ErrorCode. It returns Unknown if the error isn't from gRPC.

func HTTPStatusFromCode

func HTTPStatusFromCode(code gcerrors.ErrorCode) int32

HTTPStatusFromCode converts a gRPC error code into the corresponding HTTP response status. See: https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto See: https://github.com/grpc-ecosystem/grpc-gateway/blob/v2.11.3/runtime/errors.go#L34-L77

func NewConnection

func NewConnection(addr, credFile string) (nc *nats.Conn, err error)

NewConnection creates a new NATS connection

func RenderConsumerInfo

func RenderConsumerInfo(consumers []*jetstream.ConsumerInfo) []byte

func RenderStreamInfo

func RenderStreamInfo(streams []*jetstream.StreamInfo) []byte

func ReportStatus

func ReportStatus(nc *nats.Conn, name string, s Status, comments ...string)

func RunsOnSelfHosted

func RunsOnSelfHosted(e *github.WorkflowJobEvent) (string, bool)

func SubmitPayload

func SubmitPayload(gh *github.Client, nc *nats.Conn, r *http.Request, secretToken []byte) error

func UseHighPriorityRunner

func UseHighPriorityRunner(gh *github.Client, org string, private bool) string

func UseRegularRunner

func UseRegularRunner(gh *github.Client, org string, private bool) string

Types

type MachineStatus

type MachineStatus struct {
	Name      string
	Status    Status
	Timestamp time.Time
	Comment   string
}

func (MachineStatus) Strings

func (ms MachineStatus) Strings() []string

type Manager

type Manager struct {
	Provider api.Interface
	// contains filtered or unexported fields
}

func New

func New(nc *nats.Conn, opts Options) *Manager

func (*Manager) EnsureStreams

func (mgr *Manager) EnsureStreams(jsOpts ...jetstream.JetStreamOpt) error

func (*Manager) ProcessCompletedJobs

func (mgr *Manager) ProcessCompletedJobs() error

func (*Manager) ProcessCompletedJobs__

func (mgr *Manager) ProcessCompletedJobs__() error

func (*Manager) ProcessCompletedMsg

func (mgr *Manager) ProcessCompletedMsg(payload []byte) (*github.WorkflowJobEvent, error)

func (*Manager) RunVMs

func (mgr *Manager) RunVMs()

func (*Manager) Start

func (mgr *Manager) Start(ctx context.Context, jsOpts ...jetstream.JetStreamOpt) error

type NATSOptions

type NATSOptions struct {
	Addr     string
	CredFile string
}

func NewNATSOptions

func NewNATSOptions() *NATSOptions

func (*NATSOptions) AddFlags

func (opts *NATSOptions) AddFlags(fs *pflag.FlagSet)

type Options

type Options struct {
	AckWait time.Duration

	// hostname
	Name       string
	NumWorkers int

	Provider string
}

func DefaultOptions

func DefaultOptions() Options

func (*Options) AddFlags

func (opts *Options) AddFlags(fs *pflag.FlagSet)

type Status

type Status string

const (
	StatusStarting Status = "starting"
	StatusStarted  Status = "started"
	StatusWaiting  Status = "waiting"
	StatusPicked   Status = "picked"
	StatusStopping Status = "stopping"
	StatusStopped  Status = "stopped"
)

type StatusReporter

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

func NewStatusReporter

func NewStatusReporter(nc *nats.Conn) (*StatusReporter, error)

func (*StatusReporter) GenerateHTMLReport

func (sp *StatusReporter) GenerateHTMLReport() (string, error)

func (*StatusReporter) GenerateMarkdownReport

func (sp *StatusReporter) GenerateMarkdownReport() ([]byte, error)