spec

type App struct {
	// Repo is the git repository; Path a folder of the project's own repository.
	Repo   string `yaml:"repo,omitempty"`
	Path   string `yaml:"path,omitempty"`
	Branch string `yaml:"branch,omitempty"`
	// Image or Build when no runtime service is attached.
	Image string `yaml:"image,omitempty"`
	Build *Build `yaml:"build,omitempty"`
	// Mount is where the code appears in the container.
	Mount  string   `yaml:"mount,omitempty"`
	Routes []string `yaml:"routes,omitempty"`
	Port   int      `yaml:"port,omitempty"`
	// Uses are the other applications it calls.
	Uses        []string           `yaml:"uses,omitempty"`
	Env         map[string]string  `yaml:"env,omitempty"`
	Command     string             `yaml:"command,omitempty"`
	Entrypoint  string             `yaml:"entrypoint,omitempty"`
	Healthcheck *Healthcheck       `yaml:"healthcheck,omitempty"`
	Tmpfs       []string           `yaml:"tmpfs,omitempty"`
	Ulimits     map[string]*Ulimit `yaml:"ulimits,omitempty"`
	Optional    bool               `yaml:"optional,omitempty"`
	Hooks       *Hooks             `yaml:"hooks,omitempty"`
	Volumes     []string           `yaml:"volumes,omitempty"`
}

type AppOverride struct {
	Env  map[string]string `yaml:"env,omitempty"`
	Port int               `yaml:"port,omitempty"`
}

type Build struct {
	Context    string            `yaml:"context"`
	Dockerfile string            `yaml:"dockerfile,omitempty"`
	Target     string            `yaml:"target,omitempty"`
	Args       map[string]string `yaml:"args,omitempty"`
}

type Change struct {
	What  string
	Risky bool
	// Section is apps.<name> or services.<name>; empty for the project's own settings.
	Section string
}

type DataPolicy struct {
	Snapshots map[string]*Snapshot `yaml:"snapshots,omitempty"`
}

type FeaturePolicy struct {
	Database     string `yaml:"database,omitempty"` // clone | shared
	SleepAfter   string `yaml:"sleep_after,omitempty"`
	Cleanup      string `yaml:"cleanup,omitempty"`
	Isolation    string `yaml:"isolation,omitempty"`
	BranchPrefix string `yaml:"branch_prefix,omitempty"`
	MaxRunning   int    `yaml:"max_running,omitempty"`
}

type Healthcheck struct {
	Test        []string `yaml:"test,omitempty"`
	Interval    string   `yaml:"interval,omitempty"`
	Timeout     string   `yaml:"timeout,omitempty"`
	Retries     int      `yaml:"retries,omitempty"`
	StartPeriod string   `yaml:"start_period,omitempty"`
	Disable     bool     `yaml:"disable,omitempty"`
}

type Hooks struct {
	Install string `yaml:"install,omitempty"`
	Migrate string `yaml:"migrate,omitempty"`
	Seed    string `yaml:"seed,omitempty"`
	Build   string `yaml:"build,omitempty"`
}

type Override struct {
	Apps     map[string]*AppOverride     `yaml:"apps,omitempty"`
	Services map[string]*ServiceOverride `yaml:"services,omitempty"`
}

type OverridePolicy struct {
	Allowed []string `yaml:"allowed,omitempty"`
}

type OverrideResult struct {
	Applied  []string
	Rejected []string
}

type Project struct {
	Name   string `yaml:"name"`
	Domain string `yaml:"domain"`
	// Apps are the parts of the product: frontend, backend, admin.
	Apps map[string]*App `yaml:"apps"`
	// Services live in the project and are attached to applications.
	Services  map[string]*Service `yaml:"services,omitempty"`
	Features  *FeaturePolicy      `yaml:"features,omitempty"`
	Overrides *OverridePolicy     `yaml:"overrides,omitempty"`
	Data      *DataPolicy         `yaml:"data,omitempty"`
}

type Ref struct {
	Kind RefKind
	Name string // secret, application or service; empty for env
	Attr string
	Raw  string // the whole ${{ … }}
}

type RefKind int

type Service struct {
	// Type is a catalog type (php, mysql, queue…) or catalog.Custom.
	Type    string `yaml:"type"`
	Version string `yaml:"version,omitempty"`
	// Image overrides the catalog's image; a custom container needs it.
	Image string `yaml:"image,omitempty"`
	// Apps are the applications the service is attached to.
	Apps []string `yaml:"apps,omitempty"`
	// Uses are the other services a container service needs.
	Uses []string `yaml:"uses,omitempty"`

	Port        int                `yaml:"port,omitempty"`
	UIPort      int                `yaml:"ui_port,omitempty"`
	Expose      string             `yaml:"expose,omitempty"`
	Data        *ServiceData       `yaml:"data,omitempty"`
	Env         map[string]string  `yaml:"env,omitempty"`
	Command     string             `yaml:"command,omitempty"`
	Entrypoint  string             `yaml:"entrypoint,omitempty"`
	Volumes     []string           `yaml:"volumes,omitempty"`
	Healthcheck *Healthcheck       `yaml:"healthcheck,omitempty"`
	Tmpfs       []string           `yaml:"tmpfs,omitempty"`
	Ulimits     map[string]*Ulimit `yaml:"ulimits,omitempty"`
	PerFeature  string             `yaml:"per_feature,omitempty"` // clone | shared | instance
	Optional    bool               `yaml:"optional,omitempty"`
	// Replicas of a queue; Schedule of a cronjob.
	Replicas int    `yaml:"replicas,omitempty"`
	Schedule string `yaml:"schedule,omitempty"`
}

type ServiceData struct {
	Seed string `yaml:"seed,omitempty"`
}

type ServiceOverride struct {
	Version string            `yaml:"version,omitempty"`
	Env     map[string]string `yaml:"env,omitempty"`
	Port    int               `yaml:"port,omitempty"`
}

type Snapshot struct {
	Source string            `yaml:"source"`
	Mask   map[string]string `yaml:"mask,omitempty"`
}

type Ulimit struct {
	Single int `yaml:"single,omitempty"`
	Soft   int `yaml:"soft,omitempty"`
	Hard   int `yaml:"hard,omitempty"`
}