util

Documentation

Index

• Constants
• func DashboardApiKey() (string, error)
• func DashboardRunKey() (string, error)
• func RemoteNewRun(run Run) error
• func RemoteSetFile(file File) error
• func RemoteSetJobs(jobGroups []JobGroup) error
• func RemoteSetKeys(dashVals Dashboard) error
• type Arg
• type CronTime
• type CronTimePiece
• type CronTimeSection
• type Dashboard
  • func RemoteGetDashboard() (*Dashboard, error)
  • func RemoteNewDashboard(dashVals Dashboard) (*Dashboard, error)
• type File
  • func RemoteGetFile(filePath string) (*File, error)
  • func RemoteGetFileMetadata() ([]File, error)
• type Flags
• type Job
  • func ParseJob(str string) (*Job, error)
• type JobGroup
  • func ParseLines(lines []string) ([]JobGroup, error)
• type ManualQueue
  • func RemoteGetManualQueue() (ManualQueue, error)
• type ManualQueueItem
• type ManualToRun
• type OutputLine
• type Run
• type Trigger

Constants

const (
	TempKoitabPath = "/tmp/koitab"
	KoitabPath     = "/var/lib/koi/koitab"
	ApiKeyPath     = "/var/lib/koi/apikey"
	RunKeyPath     = "/var/lib/koi/runkey"
	UserPath       = "/var/lib/koi/user"
	ApiBase        = "https://api.koi.org"
)

Functions

func DashboardApiKey

func DashboardApiKey() (string, error)

func DashboardRunKey

func DashboardRunKey() (string, error)

func RemoteNewRun

func RemoteNewRun(run Run) error

func RemoteSetFile

func RemoteSetFile(file File) error

func RemoteSetJobs

func RemoteSetJobs(jobGroups []JobGroup) error

func RemoteSetKeys

func RemoteSetKeys(dashVals Dashboard) error

Types

type Arg

type Arg struct {
	Range   [2]int
	Name    string
	Type    string
	Default string
}

type CronTime

type CronTime [5]CronTimeSection

type CronTimePiece

type CronTimePiece struct {
	From int64
	To   int64
	Div  int64
}

type CronTimeSection

type CronTimeSection []CronTimePiece

type Dashboard

type Dashboard struct {
	DashboardID string
	Salt        string
	ApiKey      string
	JobGroups   []JobGroup
	ManualQueue ManualQueue
}

func RemoteGetDashboard

func RemoteGetDashboard() (*Dashboard, error)

func RemoteNewDashboard

func RemoteNewDashboard(dashVals Dashboard) (*Dashboard, error)

type File

type File struct {
	DashboardID string
	FilePath    string
	Modified    int64
	Content     string
}

func RemoteGetFile

func RemoteGetFile(filePath string) (*File, error)

func RemoteGetFileMetadata

func RemoteGetFileMetadata() ([]File, error)

type Flags

type Flags struct {
}

type Job

type Job struct {
	// Tag is Name if not empty, otherwise Command. Not JobID because not unique.
	JobTag string

	Name    string
	Flags   Flags
	Trigger Trigger
	Command string
	Args    []Arg
}

func ParseJob

func ParseJob(str string) (*Job, error)

type JobGroup

type JobGroup struct {
	Name string
	Jobs []Job
}

func ParseLines

func ParseLines(lines []string) ([]JobGroup, error)

type ManualQueue

type ManualQueue []ManualQueueItem

func RemoteGetManualQueue

func RemoteGetManualQueue() (ManualQueue, error)

type ManualQueueItem

type ManualQueueItem [2]string

type ManualToRun

type ManualToRun struct {
	Timestamp int64
	ToBeRunID string
	JobTag    string
	ArgValues []string
}

type OutputLine

type OutputLine struct {
	Time   time.Time
	String string
}

type Run

type Run struct {
	RunID       string
	DashboardID string
	Job         Job
	Started     time.Time
	Ended       *time.Time
	Output      []OutputLine
	Error       string

	// Calculated by koi service
	Display string
}

type Trigger

type Trigger struct {
	String   string
	Manual   bool
	File     bool
	CronTime *CronTime
}