project

type Bucket struct{}

type Collection struct{}

type Compute interface {
	ImageTagName(s *Project, provider string) string
	Unit() *ComputeUnit
	Workers() int
}

type ComputeUnit struct {
	Name string `yaml:"-"`

	// Triggers used to invoke this compute unit, e.g. Topic Subscriptions
	Triggers Triggers `yaml:"triggers,omitempty"`

	// The memory of the compute instance in MB: default 128
	Memory int `yaml:"memory,omitempty"`

	// The minimum number of instances to keep alive: default 0
	MinScale int `yaml:"minScale,omitempty"`

	// The maximum number of instances to scale to: default 10
	MaxScale int `yaml:"maxScale,omitempty"`

	// The max running time of the function: default 15
	Timeout int `yaml:"timeout,omitempty"`
}

type Config struct {
	Name     string   `yaml:"name"`
	Dir      string   `yaml:"-"`
	Handlers []string `yaml:"handlers"`
}

type Container struct {
	Dockerfile string   `yaml:"dockerfile"`
	Args       []string `yaml:"args,omitempty"`

	ComputeUnit `yaml:",inline"`
}

type Function struct {
	// The location of the function handler
	Handler string `yaml:"handler"`

	ComputeUnit `yaml:",inline"`

	// The number of workers this function contains
	WorkerCount int
}

type Project struct {
	Dir                 string                                          `yaml:"-"`
	Name                string                                          `yaml:"name"`
	Functions           map[string]Function                             `yaml:"functions,omitempty"`
	Collections         map[string]Collection                           `yaml:"collections,omitempty"`
	Containers          map[string]Container                            `yaml:"containers,omitempty"`
	Buckets             map[string]Bucket                               `yaml:"buckets,omitempty"`
	Topics              map[string]Topic                                `yaml:"topics,omitempty"`
	Queues              map[string]Queue                                `yaml:"queues,omitempty"`
	Schedules           map[string]Schedule                             `yaml:"schedules,omitempty"`
	ApiDocs             map[string]*openapi3.T                          `yaml:"-"`
	SecurityDefinitions map[string]map[string]*v1.ApiSecurityDefinition `yaml:"-"`
	Apis                map[string]string                               `yaml:"apis,omitempty"`
	// TODO: Not currently supported by nitric.yaml configuration (but is technically definable using the proto model)
	// We may want to decouple the definition from contracts at a later stage
	// but re-using the contract here provides us a serializable entity with no
	// repetition/redefinition
	// NOTE: if we want to use the proto definition here we would need support for yaml parsing to use customisable tags
	Policies []*v1.PolicyResource `yaml:"-"`
	Secrets  map[string]Secret    `yaml:"secrets,omitempty"`
}

type Queue struct{}

type Schedule struct {
	Expression string `yaml:"expression"`

	// The Topic to be targeted for schedule
	Target ScheduleTarget `yaml:"target"`
	Event  ScheduleEvent  `yaml:"event"`
}

type ScheduleEvent struct {
	PayloadType string                 `yaml:"payloadType"`
	Payload     map[string]interface{} `yaml:"payload,omitempty"`
}

type ScheduleTarget struct {
	Type string `yaml:"type"` // TODO(Angus) check type: 'topic'; // ; | "queue"
	Name string `yaml:"name"`
}

type Secret struct{}

type Topic struct{}

type Triggers struct {
	Topics []string `yaml:"topics,omitempty"`
}