service

type AggregateService struct {
	ServiceID         string
	Name              string
	DesiredState      DesiredState
	CurrentState      ServiceCurrentState
	Status            []StatusInstance
	NotFound          bool
	EmergencyShutdown bool
	RAMCommitment     int64
}

type BaseIPAssignment struct {
	ServiceID       string
	ParentServiceID string
	ServiceName     string
	PoolID          string
	Port            uint16
	Application     string
	EndpointName    string
}

type Config struct {
	ID       string
	Filename string
}

type DesiredState int

type EndpointQueryResult struct {
	ID              string
	Name            string
	PoolID          string
	ParentServiceID string
	Endpoints       []ServiceEndpoint
	datastore.VersionedEntity
}

type ExportedEndpoint struct {
	ServiceID   string
	ServiceName string
	Application string
	Protocol    string
}

type FindChildService func(parentID, childName string) (Service, error)

type GetChildServices func(parentID string) ([]Service, error)

type GetService func(serviceID string) (Service, error)

type IPAssignment struct {
	BaseIPAssignment
	HostID    string
	HostName  string
	Type      string
	IPAddress string
}

type Instance struct {
	InstanceID    int
	HostID        string
	HostName      string
	ServiceID     string
	ServiceName   string // FIXME: service path would be better
	ContainerID   string
	ImageSynced   bool
	DesiredState  DesiredState
	CurrentState  InstanceCurrentState
	HealthStatus  map[string]health.Status
	RAMCommitment int64
	RAMThreshold  uint
	MemoryUsage   Usage
	Scheduled     time.Time
	Started       time.Time
	Terminated    time.Time
}

type InstanceCurrentState string

type LocationInstance struct {
	HostID      string
	HostIP      string
	ContainerID string
}

type PublicEndpoint struct {
	ServiceID   string
	ServiceName string
	Application string
	Protocol    string
	VHostName   string `json:",omitempty"`
	PortAddress string `json:",omitempty"`
	Enabled     bool
}

type Query struct {
	Name    string
	Since   time.Duration
	Tags    []string
	Tenants bool
}

type Service struct {
	ID              string
	Name            string
	Title           string // Title is a label used when describing this service in the context of a service tree
	Version         string
	Context         map[string]interface{}
	Environment     []string
	Startup         string
	RunAs           string
	Description     string
	Tags            []string
	OriginalConfigs map[string]svcdef.ConfigFile
	ConfigFiles     map[string]svcdef.ConfigFile
	Instances       int
	InstanceLimits  domain.MinMax
	ChangeOptions   []svcdef.ChangeOption
	ImageID         string
	PoolID          string
	DesiredState    int
	CurrentState    string
	HostPolicy      svcdef.HostPolicy
	Hostname        string
	Privileged      bool
	Launch          string
	Endpoints       []ServiceEndpoint
	ParentServiceID string
	Volumes         []svcdef.Volume
	CreatedAt       time.Time
	UpdatedAt       time.Time
	DeploymentID    string
	DisableImage    bool
	LogConfigs      []svcdef.LogConfig
	Snapshot        svcdef.SnapshotCommands
	DisableShell    bool
	Runs            map[string]string // FIXME: This field is deprecated. Remove when possible.
	Commands        map[string]domain.Command
	RAMCommitment   utils.EngNotation
	RAMThreshold    uint
	CPUCommitment   uint64
	Actions         map[string]string
	HealthChecks    map[string]health.HealthCheck // A health check for the service.

	// Prereqs is a list of scripts that must run successfully before running the command in the Startup field.
	Prereqs []domain.Prereq

	MonitoringProfile domain.MonitorProfile
	MemoryLimit       float64
	CPUShares         int64
	OomKillDisable    bool
	OomScoreAdj       int64
	PIDFile           string

	// StartLevel represents the order in which services are started and stopped
	// in normal operations.  All services of a given level start before any services
	// at higher levels.  Stopping services occurs in the reverse order.  Services
	// with StartLevel 0 (representing undefined) start after and stop before services
	// with a defined StartLevel.
	StartLevel uint

	// EmergencyShutdownLevel represents the order in which services are stopped in an
	// emergency low-storage situation.  All services of a given EmergencyShutdownLevel are
	// stopped before any services of a higher EmergencyShutdownLevel.  In an emergency
	// low-storage shutdown, services with EmergencyShutdownLevel 0 (representing undefined)
	// are stopped after services with a defined EmergencyShutdownLevel, in the normal order
	// dictated by their StartLevel.
	EmergencyShutdownLevel uint

	// EmergencyShutdown is a flag that indicates whether this service has been shutdown due
	// to an emergency (low-storage) situation.  Services with this flag set can not be started
	EmergencyShutdown bool
	datastore.VersionedEntity
}

type ServiceCurrentState string

type ServiceDetails struct {
	ID                string
	Name              string
	Description       string
	PoolID            string
	ImageID           string
	ParentServiceID   string
	Parent            *ServiceDetails `json:",omitempty"` // optional, only needed when looking up service ancestry
	Instances         int
	InstanceLimits    domain.MinMax
	RAMCommitment     utils.EngNotation
	RAMThreshold      uint
	Startup           string
	HasChildren       bool
	DeploymentID      string
	DesiredState      int
	CurrentState      string
	Launch            string
	Tags              []string
	EmergencyShutdown bool
	UpdatedAt         time.Time
	CreatedAt         time.Time
	Version           string
	datastore.VersionedEntity
}

type ServiceEndpoint struct {
	Name         string // Human readable name of the endpoint. Unique per service definition
	Purpose      string
	Protocol     string
	PortNumber   uint16
	PortTemplate string // A template which, if specified, is used to calculate the port number

	// VirtualAddress is an address by which an imported endpoint may be accessed within the container.
	// e.g. "mysqlhost:1234"
	VirtualAddress string

	Application         string
	ApplicationTemplate string
	AddressConfig       svcdef.AddressResourceConfig

	// VHost is used to request named vhost for this endpoint.
	// Should be the name of a subdomain, i.e "myapplication"  not "myapplication.host.com"
	VHosts []string

	// VHostList is used to request named vhost(s) for this endpoint.
	VHostList []svcdef.VHost

	AddressAssignment addressassignment.AddressAssignment

	// PortList is the list of enabled/disabled ports to assign to this endpoint.
	PortList []svcdef.Port
}

type ServiceHealth struct {
	ID                string
	Name              string
	PoolID            string
	Instances         int
	DesiredState      int
	CurrentState      string
	HealthChecks      map[string]health.HealthCheck
	EmergencyShutdown bool
	RAMCommitment     utils.EngNotation
	datastore.VersionedEntity
}

type StatusInstance struct {
	InstanceID   int
	HealthStatus map[string]health.Status
	MemoryUsage  Usage
}

type Store interface {
	// Put adds or updates a Service
	Put(ctx datastore.Context, svc *Service) error

	// Get a Service by id. Return ErrNoSuchEntity if not found
	Get(ctx datastore.Context, id string) (*Service, error)

	// Delete removes the a Service if it exists
	Delete(ctx datastore.Context, id string) error

	// Update the DesiredState in volatile memory for the service
	UpdateDesiredState(ctx datastore.Context, serviceID string, desiredState int) error

	// Update the CurrentState in volatile memory for the service
	UpdateCurrentState(ctx datastore.Context, serviceID string, currentState string) error

	// GetServices returns all services
	GetServices(ctx datastore.Context) ([]Service, error)

	// GetUpdatedServices returns all services updated since "since" time.Duration ago
	GetUpdatedServices(ctx datastore.Context, since time.Duration) ([]Service, error)

	// GetTaggedServices returns services with the given tags
	GetTaggedServices(ctx datastore.Context, tags ...string) ([]Service, error)

	// GetServicesByPool returns services with the given pool id
	GetServicesByPool(ctx datastore.Context, poolID string) ([]Service, error)

	// GetServiceCountByImage returns a count of services using a given imageid
	GetServiceCountByImage(ctx datastore.Context, imageID string) (int, error)

	// GetServicesByDeployment returns services with the given deployment id
	GetServicesByDeployment(ctx datastore.Context, deploymentID string) ([]Service, error)

	// GetChildServices returns services that are children of the given parent service id
	GetChildServices(ctx datastore.Context, parentID string) ([]Service, error)

	FindChildService(ctx datastore.Context, deploymentID, parentID, serviceName string) (*Service, error)

	// FindTenantByDeployment returns the tenant service for a given deployment id and service name
	FindTenantByDeploymentID(ctx datastore.Context, deploymentID, name string) (*Service, error)

	// GetServiceDetails returns the details for the given service
	GetServiceDetails(ctx datastore.Context, serviceID string) (*ServiceDetails, error)

	// GetChildServiceDetails returns the details for the child service of the given parent
	GetServiceDetailsByParentID(ctx datastore.Context, parentID string, since time.Duration) ([]ServiceDetails, error)

	// GetAllServiceHealth returns all service health
	GetAllServiceHealth(ctx datastore.Context) ([]ServiceHealth, error)

	// GetServiceHealth returns a service health by service id
	GetServiceHealth(ctx datastore.Context, serviceID string) (*ServiceHealth, error)

	// GetAllPublicEndpoints returns all public endpoints in the system
	GetAllPublicEndpoints(ctx datastore.Context) ([]PublicEndpoint, error)

	// GetAllExportedEndpoints returns all the exported endpoints in the system
	GetAllExportedEndpoints(ctx datastore.Context) ([]ExportedEndpoint, error)

	// GetAllIPAssignments returns all IP assignments in the system, including those that may not have address assignments
	GetAllIPAssignments(ctx datastore.Context) ([]BaseIPAssignment, error)

	// GetServiceDetailsByIDOrName returns the service details for any services
	// whose serviceID matches the query exactly or whose names contain the
	// query as a substring or string suffix
	GetServiceDetailsByIDOrName(ctx datastore.Context, query string, noprefix bool) ([]ServiceDetails, error)

	Query(ctx datastore.Context, query Query) ([]ServiceDetails, error)
}

type StrategyInstance struct {
	HostID        string
	ServiceID     string
	CPUCommitment int
	RAMCommitment uint64
	RAMThreshold  uint
	HostPolicy    servicedefinition.HostPolicy
}

type Usage struct {
	Cur int64
	Max int64
	Avg int64
}

type Visit func(svc *Service) error