watchdog

README

Watchdog for self-hosted build VMs that serve GitHub Actions

This program starts any sleeping build agent VMs that are needed by the GitHub Actions scripts currently running in the given repo, and stops any running build agents that aren't needed.

Installation

Install this program as a Google Cloud Function.

Define the following environment variables:

• GOOGLE_CLOUD_PROJECT - project ID for a Google Cloud Platform project that contains the build agent VMs
• GCE_ZONE - zone where the build agent VMs reside
• GITHUB_ORGANIZATION - GitHub organization containing the game project
• GITHUB_REPOSITORY - GitHub project containing the game project
• GITHUB_PAT - Personal Access Token that allows querying the GitHub Actions REST API for the game project, and downloading files from the game project repository

Local development

• Set all the environment variables manually, plus PORT to something unique.
• cd cmd && go build . && cmd
• Use curl http://localhost:<PORT> in a different window to trigger a run of the program.

Documentation

Index

• func Process(ctx context.Context, computeService *compute.Service, httpClient *http.Client, ...) ([]string, []OnDemandInstance, []OnDemandInstance, []OnDemandInstance, error)
• func RunWatchdog(w http.ResponseWriter, r *http.Request)
• type GitHubWorkflowYamlJob
• type GitHubWorkflowYamlJobs
• type LogMessage
• type OnDemandInstance
• type Result
• type RunsOn
  • func (runsOn *RunsOn) UnmarshalYAML(unmarshal func(interface{}) error) error

Functions

func Process

func Process(ctx context.Context, computeService *compute.Service, httpClient *http.Client, gitHubClient *github.Client, project string, zone string, gitHubOrganization string, gitHubRepository string) ([]string, []OnDemandInstance, []OnDemandInstance, []OnDemandInstance, error)

func RunWatchdog

func RunWatchdog(w http.ResponseWriter, r *http.Request)

Types

type GitHubWorkflowYamlJob

type GitHubWorkflowYamlJob struct {
	Name   string `yaml:"name"`
	RunsOn RunsOn `yaml:"runs-on"`
}

type GitHubWorkflowYamlJobs

type GitHubWorkflowYamlJobs struct {
	Jobs map[string]GitHubWorkflowYamlJob `yaml:"jobs"`
}

type LogMessage

type LogMessage struct {
	Message  string `json:"message"`
	Severity string `json:"severity"`
}

type OnDemandInstance

type OnDemandInstance struct {
	InstanceName string `json:"instance_name"`
	RunnerName   string `json:"runner_name"`
	GitHubScope  string `json:"github_scope"`
	Status       string `json:"status"`
}

type Result

type Result struct {
	RunnersRequired   []string           `json:"runners_required"`
	OnDemandInstances []OnDemandInstance `json:"on_demand_instances"`
	StartedInstances  []OnDemandInstance `json:"started_instances"`
	StoppedInstances  []OnDemandInstance `json:"stopped_instances"`
}

type RunsOn

type RunsOn []string

func (*RunsOn) UnmarshalYAML

func (runsOn *RunsOn) UnmarshalYAML(unmarshal func(interface{}) error) error

Implements the Unmarshaler interface of the yaml pkg.