jobtypes

type AllocationConfig struct {
	Executor    AllocationExecutor        `json:"executor"`              // the executor of the allocation
	Resources   types.Resources           `json:"resources"`             // the HW resources required by the allocation
	Execution   types.SpecConfig          `json:"execution"`             // the allocation execution configuration
	DNSName     string                    `json:"dns_name,omitempty"`    // the internal DNS name of the allocation
	Keys        []string                  `json:"keys,omitempty"`        // names of the authorized ssh keys for the allocation
	Provision   []string                  `json:"provision,omitempty"`   // names of provisioning scripts to run (in order)
	HealthCheck types.HealthCheckManifest `json:"healthcheck,omitempty"` // name of the health check script
}

type AllocationExecutor string

type AllocationManifest struct {
	ID          string                    `json:"id"`              // allocation unique id
	NodeID      string                    `json:"node_id"`         // allocation node
	Handle      actor.Handle              `json:"handle"`          // handle of the allocation control actor
	DNSName     string                    `json:"dns_name"`        // (internal) DNS name of the allocation
	PrivAddr    string                    `json:"priv_addr"`       // (VPN) private IP address of the allocation peer
	Ports       map[int]int               `json:"ports,omitempty"` // port mapping, public -> private
	Healthcheck types.HealthCheckManifest `json:"healthcheck"`     // healthcheck configuration
}

type Bid struct {
	V1 *BidV1
}

type BidRequest struct {
	V1 *BidRequestV1
}

type BidRequestV1 struct {
	// NodeID is the unique identifier for a node, within the context of an ensemble
	NodeID string `json:"node_id"`

	// Executors list of required executors to support the allocation(s)
	Executors []AllocationExecutor `json:"executors"`

	// Resources (aggregate) required hardware resources
	Resources types.Resources `json:"resources"`

	// Location is the node location constraints
	Location LocationConstraints `json:"location,omitempty"`

	PublicPorts struct {
		Static  []int `json:"static,omitempty"`  // statically configured public ports
		Dynamic int   `json:"dynamic,omitempty"` // number of dynamic ports
	} `json:"public_ports,omitempty"`

	GeneralRequirements struct {
		PrivilegedDocker bool `json:"privileged_docker,omitempty"`
	} `json:"general_requirements,omitempty"`

	// contract attached to a bid request
	ContractDID did.DID
}

type BidV1 struct {
	EnsembleID string       // unique identifier for the ensemble
	NodeID     string       // unique identifier for a node; matches the id of the BidRequest to which this bid pertains
	Peer       string       // the peer ID of the node
	Location   Location     // the location of the node
	Handle     actor.Handle // the handle of the actor submitting the bid
	Signature  []byte
}

type DeploymentSnapshot struct {
	// candidates keeps state of candidates while committing.
	Candidates map[string]Bid

	// Expiry is the time passed as an argument when calling Deploy()
	Expiry time.Time
}

type DeploymentStatus int

type EdgeConstraint struct {
	S   string `json:"s"`             // source node ID
	T   string `json:"t"`             // target node ID
	RTT uint   `json:"rtt,omitempty"` // round trip time in milliseconds
	BW  uint   `json:"bw,omitempty"`  // bandwidth in bits per second
}

type EnsembleBidRequest struct {
	// ID is the unique identifier of an ensemble (in the context of the orchestrator)
	ID string `json:"id"`

	// Request is the list of node bid requests
	Request []BidRequest `json:"request"`

	// PeerExclusion is the list of peers to exclude from bidding
	PeerExclusion []string `json:"peer_exclusion,omitempty"`
}

type EnsembleConfig struct {
	V1 *EnsembleConfigV1 `json:"v1"`
}

type EnsembleConfigV1 struct {
	Allocations map[string]AllocationConfig `json:"allocations"`          // (named) allocations in the ensemble
	Nodes       map[string]NodeConfig       `json:"nodes"`                // (named) nodes in the ensemble
	Edges       []EdgeConstraint            `json:"edges,omitempty"`      // network edge constraints
	Supervisor  SupervisorConfig            `json:"supervisor,omitempty"` // supervision structure
	Keys        map[string]string           `json:"keys,omitempty"`       // (named) ssh public keys relevant to the allocation
	Scripts     map[string][]byte           `json:"scripts,omitempty"`    // (named) provisioning scripts
}

type EnsembleManifest struct {
	ID           string                        // ensemble globally unique id
	Orchestrator actor.Handle                  // orchestrator actor
	Allocations  map[string]AllocationManifest // allocation name -> manifest
	Nodes        map[string]NodeManifest       // node name -> manifest
}

type Location struct {
	Region  string `json:"region,omitempty"`  // geographical region
	Country string `json:"country,omitempty"` // country code
	City    string `json:"city,omitempty"`    // city name
	ASN     uint   `json:"asn,omitempty"`     // autonomous system number
	ISP     string `json:"isp,omitempty"`     // internet service provider
}

type LocationConstraints struct {
	Accept []Location `json:"accept,omitempty"` // list of accepted locations
	Reject []Location `json:"reject,omitempty"` // list of rejected locations
}

type NodeConfig struct {
	Allocations []string            `json:"allocations"`        // list of allocation IDs
	Ports       []PortConfig        `json:"ports,omitempty"`    // list of port mappings
	Location    LocationConstraints `json:"location,omitempty"` // location constraints
	Peer        string              `json:"peer,omitempty"`     // peer ID to use for this node

}

type NodeManifest struct {
	ID          string       `json:"id"`             // node unique id
	Peer        string       `json:"peer,omitempty"` // peer where the node is running
	Handle      actor.Handle `json:"handle"`         // handle of the control actor for the node
	PubAddrss   []string     `json:"pub_addrss"`     // public IP4/6 address of the node peer
	Location    Location     `json:"location"`       // location of the peer
	Allocations []string     `json:"allocations"`    // allocations in the nod
}

type OrchestratorView struct {
	types.BaseDBModel
	DeploymentID       string
	Cfg                EnsembleConfig
	Manifest           EnsembleManifest
	Status             DeploymentStatus
	DeploymentSnapshot DeploymentSnapshot
	PrivKey            []byte
}

type PortConfig struct {
	Public     int    `json:"public"`     // public port number
	Private    int    `json:"private"`    // private port number
	Allocation string `json:"allocation"` // allocation ID
}

type SupervisorConfig struct {
	Strategy    SupervisorStrategy `json:"strategy,omitempty"`    // supervision strategy
	Allocations []string           `json:"allocations,omitempty"` // list of allocation IDs
	Children    []SupervisorConfig `json:"children,omitempty"`    // list of child supervisors
}

type SupervisorStrategy string