plans

type Annotation struct {
	Key   string
	Value string
}

type AnnotationChange struct {
	// Annotations to be added.
	//
	// If the Plan to be annotated already has the key, the value is updated.
	// If same key is set multiple times, the last one is used.
	Add Annotations `json:"add,omitempty" yaml:"add,omitempty"`

	// Keys of Annotations to be removed.
	Remove Annotations `json:"remove,omitempty" yaml:"remove,omitempty"`

	RemoveKey []string `json:"remove_key,omitempty" yaml:"remove_key,omitempty"`
}

type Annotations []Annotation

type Detail struct {
	Summary

	// Inputs are the input mountpoints of the plan.
	Inputs []Input `json:"inputs"`

	// Outputs are the output mountpoints of the plan.
	Outputs []Output `json:"outputs"`

	// Log is the log point of the plan.
	//
	// If nil, the plan does not record logs.
	Log *Log `json:"log,omitempty"`

	// Active shows Plan's activeness.
	//
	// It is true if the plan is active and new runs can be created.
	Active bool `json:"active"`

	// OnNode is the node affinity/torelance of the plan.
	//
	// If nil, the plan does not have node affinity/torelance.
	OnNode *OnNode `json:"on_node,omitempty"`

	// Resources is the resource limits and requiremnts of the plan.
	Resources Resources `json:"resources,omitempty"`

	// ServiceAccount is the ServiceAccount name of the plan.
	//
	// Workers of the Run based this Plan will run with this ServiceAccount.
	ServiceAccount string `json:"service_account,omitempty"`
}

type Downstream struct {
	// Plan is the downstream Plan.
	Plan Summary `json:"plan"`

	// Mountpoint represents the Input which is direct downstream.
	Mountpoint Mountpoint `json:"mountpoint"`
}

type Image struct {
	Repository string
	Tag        string
}

type Input struct {
	Mountpoint

	// Upstreams are the upstream Plans and their output mountpoints
	// whose output Data can be mounted to this input mountpoint.
	Upstreams []Upstream `json:"upstreams"`
}

type Log struct {
	LogPoint

	// Downstreams are the downstream Plans and their input mountpoints
	// can be assigned with Data from this output.
	Downstreams []Downstream `json:"downstreams"`
}

type LogPoint struct {
	Tags []tags.Tag
}

type Mountpoint struct {
	// Path is the path of the mountpoint.
	//
	// This is the path in the container where the Data will be mounted
	// when the Run starts.
	Path string `json:"path"`

	// Tags are the tags of the mountpoint.
	//
	// For input mountpoints, these are the required tags of the Data to be mounted.
	// The Data with these all tags will be mounted to the Path when the Run starts.
	//
	// For output mountpoints, these are the tags to be attached to the Data mounted.
	Tags []tags.Tag `json:"tags"`
}

type OnNode struct {
	May    []OnSpecLabel `json:"may,omitempty" yaml:"may,omitempty"`
	Prefer []OnSpecLabel `json:"prefer,omitempty" yaml:"prefer,omitempty"`
	Must   []OnSpecLabel `json:"must,omitempty" yaml:"must,omitempty"`
}

type OnSpecLabel struct {
	Key   string
	Value string
}

type Output struct {
	Mountpoint

	// Downstreams are the downstream Plans and their input mountpoints
	// can be assigned with Data from this output.
	Downstreams []Downstream `json:"downstreams"`
}

type PlanSpec struct {
	// Annotations are the annotations of the Plan.
	//
	// In JSON format, it is a list of strings in the form of "key=value".
	//
	// If same key is set multiple times, the last one is used.
	Annotations Annotations `json:"annotations,omitempty" yaml:"annotations,omitempty"`

	// Image is the container image of the Plan.
	Image Image `json:"image" yaml:"image"`

	// Entrypoint is the entrypoint of the container of the Plan.
	Entrypoint []string `json:"entrypoint,omitempty" yaml:"entrypoint,omitempty"`

	// Args are the arguments of the container of the Plan.
	Args []string `json:"args,omitempty" yaml:"args,omitempty"`

	// Inputs are the input mountpoints of the plan.
	//
	// These describes "where should input Data be mounted to the container" and
	// "what tags should be attached to the input Data".
	//
	// When Knitfab detect the Data with the tags, it will be mounted to the container and started as a Run.
	Inputs []Mountpoint `json:"inputs" yaml:"inputs"`

	// Outputs are the output mountpoints of the plan.
	//
	// These describes "where should output Data be mounted to the container" and
	// "what tags will be attached to the output Data".
	//
	// On the Run start, Knitfab will create the mountpoints and attach the tags to the output Data.
	Outputs []Mountpoint `json:"outputs" yaml:"outputs"`

	// Log is the log point of the plan.
	//
	// "Log" means a Data containing standard output and standard error of the container.
	// If nil, the plan does not record logs.
	//
	// As Outputs, Log can have Tags which will be attached to the log Data.
	Log *LogPoint `json:"log,omitempty" yaml:"log,omitempty"`

	// OnNode is the node affinity/torelance of the plan.
	//
	// If nil, the plan does not have node affinity/torelance.
	OnNode *OnNode `json:"on_node,omitempty" yaml:"on_node,omitempty"`

	// Resources is the conputational resource limits and requiremnts of the plan.
	Resources Resources `json:"resources,omitempty" yaml:"resources,omitempty"`

	// ServiceAccount is the Kubernetes ServiceAccount name of the plan.
	ServiceAccount string `json:"service_account,omitempty" yaml:"service_account,omitempty"`

	// Active shows Plan's activeness.
	//
	// If true or nil, the Plan is active and new Runs based the Plan can be started.
	//
	// If false, the Plan is inactive and new Runs based the Plan are created but suspended to start.
	Active *bool `json:"active" yaml:"active,omitempty"`
}

type ResourceLimitChange struct {

	// Resource to be set.
	Set Resources `json:"set,omitempty" yaml:"set,omitempty"`

	// Resource types to be unset.
	//
	// If same type Set and Unset, Unset is affected.
	Unset []string `json:"unset,omitempty" yaml:"unset,omitempty"`
}

type Resources map[string]resource.Quantity

type SetServiceAccount struct {
	ServiceAccount string `json:"service_account" yaml:"service_account"`
}

type Summary struct {
	// PlanId is the id of the Plan.
	PlanId string `json:"planId"`

	// Image is the container image of the Plan.
	//
	// This is exclusive with Name.
	Image *Image `json:"image,omitempty"`

	// Entrypoint is the entrypoint of the container of the Plan.
	Entrypoint []string `json:"entrypoint,omitempty"`

	// Args are the arguments of the container of the Plan.
	Args []string `json:"args,omitempty"`

	// Name is the name of the Plan.
	//
	// This is exclusive with Image, and used only for the system-builtin Plan with no image.
	Name string `json:"name,omitempty"`

	// Annotations are the annotations of the Plan.
	//
	// In JSON format, it is a list of strings in the form of "key=value".
	Annotations Annotations `json:"annotations,omitempty"`
}

type Upstream struct {
	// Plan is the upstream Plan.
	Plan Summary `json:"plan"`

	// Mountpoint represents the Output which is directt upstream.
	//
	// Log and Mountpoint are mutually exclusive.
	Mountpoint *Mountpoint `json:"mountpoint,omitempty"`

	// Log represents the Log which is direct upstream.
	//
	// Log and Mountpoint are mutually exclusive.
	Log *LogPoint `json:"log,omitempty"`
}