krt

Documentation

Index

• type Config
• type Entrypoint
• type File
• type Node
• type Workflow

Types

type Config

type Config struct {
	Variables []string `yaml:"variables" validate:"dive,env"`
	Files     []string `yaml:"files" validate:"dive,env"`
}

Config contains variables and file names.

type Entrypoint

type Entrypoint struct {
	Image string `yaml:"image" validate:"required"`
	Proto string `yaml:"proto" validate:"required,endswith=.proto"`
}

Entrypoint defines a KRT entrypoint Image and Proto file.

type File

type File struct {
	Version     string     `yaml:"version" validate:"required,resource-name,lt=20"`
	Description string     `yaml:"description" validate:"required"`
	Entrypoint  Entrypoint `yaml:"entrypoint" validate:"required"`
	Config      Config     `yaml:"config" validate:"required"`
	Nodes       []Node     `yaml:"nodes" validate:"required,dive,min=1"`
	Workflows   []Workflow `yaml:"workflows" validate:"required,dive,min=1"`
}

File contains data about a version.

type Node

type Node struct {
	Name  string `yaml:"name" validate:"required,resource-name,lt=20"`
	Image string `yaml:"image" validate:"required"`
	Src   string `yaml:"src" validate:"required"`
	GPU   bool   `yaml:"gpu"`
}

Node contains data about a version's node.

type Workflow

type Workflow struct {
	Name       string   `yaml:"name" validate:"required,resource-name,lt=20"`
	Entrypoint string   `yaml:"entrypoint" validate:"required"`
	Sequential []string `yaml:"sequential" validate:"required"`
}

Workflow contains data about a version's workflow.