api

type API interface {

	// Server
	StartServer() error
	StartProxy(ControllerOptions) error

	// Hosts
	GetHosts() ([]host.Host, error)
	GetHost(string) (*host.Host, error)
	AddHost(HostConfig) (*host.Host, error)
	RemoveHost(string) error

	// Pools
	GetResourcePools() ([]pool.ResourcePool, error)
	GetResourcePool(string) (*pool.ResourcePool, error)
	AddResourcePool(PoolConfig) (*pool.ResourcePool, error)
	RemoveResourcePool(string) error
	GetPoolIPs(string) (*facade.PoolIPs, error)
	AddVirtualIP(pool.VirtualIP) error
	RemoveVirtualIP(pool.VirtualIP) error

	// Services
	GetServices() ([]service.Service, error)
	GetServiceStates(string) ([]servicestate.ServiceState, error)
	GetServiceStatus(string) (map[string]dao.ServiceStatus, error)
	GetService(string) (*service.Service, error)
	GetServicesByName(string) ([]service.Service, error)
	AddService(ServiceConfig) (*service.Service, error)
	RemoveService(string) error
	UpdateService(io.Reader) (*service.Service, error)
	StartService(SchedulerConfig) (int, error)
	RestartService(SchedulerConfig) (int, error)
	StopService(SchedulerConfig) (int, error)
	AssignIP(IPConfig) error

	// RunningServices (ServiceStates)
	GetRunningServices() ([]dao.RunningService, error)
	Attach(AttachConfig) error
	Action(AttachConfig) error

	// Shell
	StartShell(ShellConfig) error
	RunShell(ShellConfig) error

	// Snapshots
	GetSnapshots() ([]dao.SnapshotInfo, error)
	GetSnapshotsByServiceID(string) ([]dao.SnapshotInfo, error)
	AddSnapshot(string, string) (string, error)
	RemoveSnapshot(string) error
	Commit(string) (string, error)
	Rollback(string, bool) error

	// Templates
	GetServiceTemplates() ([]template.ServiceTemplate, error)
	GetServiceTemplate(string) (*template.ServiceTemplate, error)
	AddServiceTemplate(io.Reader) (*template.ServiceTemplate, error)
	RemoveServiceTemplate(string) error
	CompileServiceTemplate(CompileTemplateConfig) (*template.ServiceTemplate, error)
	DeployServiceTemplate(DeployTemplateConfig) ([]service.Service, error)

	// Backup & Restore
	Backup(string) (string, error)
	Restore(string) error

	// Docker
	ResetRegistry() error
	Squash(imageName, downToLayer, newName, tempDir string) (string, error)
	RegistrySync() error

	// Logs
	ExportLogs(config ExportLogsConfig) error

	// Metric
	PostMetric(metricName string, metricValue string) (string, error)

	ScriptRun(fileName string, config *script.Config, stopChan chan struct{}) error
	ScriptParse(fileName string, config *script.Config) error
}

type AttachConfig struct {
	Running *dao.RunningService
	Command string
	Args    []string
}

type CompileTemplateConfig struct {
	Dir string
	Map ImageMap
}

type ControllerOptions struct {
	ServiceID               string   // The uuid of the service to launch
	InstanceID              string   // The service state instance id
	Command                 []string // The command to launch
	MuxPort                 int      // the TCP port for the remote mux
	Mux                     bool     // True if a remote mux is used
	TLS                     bool     // True if TLS should be used on the mux
	KeyPEMFile              string   // path to the KeyPEMfile
	CertPEMFile             string   // path to the CertPEMfile
	ServicedEndpoint        string
	Autorestart             bool
	MetricForwarderPort     string // port to which container processes send performance data to
	Logstash                bool
	LogstashBinary          string // path to the logstash-forwarder binary
	LogstashConfig          string // path to the logstash-forwarder config file
	LogstashIdleFlushTime   string // how often should log stash flush its logs
	LogstashSettleTime      string // how long to wait for log stash to flush its logs before exiting
	VirtualAddressSubnet    string // The subnet of virtual addresses, 10.3
	MetricForwardingEnabled bool   // Enable metric forwarding from the container
}

type DeployTemplateConfig struct {
	ID              string
	PoolID          string
	DeploymentID    string
	ManualAssignIPs bool
}

type ExportLogsConfig struct {
	ServiceIDs []string
	FromDate   string
	ToDate     string
	Outfile    string
}

type HostConfig struct {
	Address *URL
	PoolID  string
	IPs     []string
}

type IPConfig struct {
	ServiceID string
	IPAddress string
}

type ImageMap map[string]string

type Options struct {
	Endpoint             string // the endpoint address to make RPC requests to
	UIPort               string
	Listen               string
	OutboundIP           string // outbound ip to listen on
	Master               bool
	DockerDNS            []string
	Agent                bool
	MuxPort              int
	TLS                  bool
	KeyPEMFile           string
	CertPEMFile          string
	VarPath              string
	ResourcePath         string
	Zookeepers           []string
	RemoteZookeepers     []string
	ReportStats          bool
	HostStats            string
	StatsPeriod          int
	MCUsername           string
	MCPasswd             string
	Mount                []string
	ResourcePeriod       int
	FSType               string
	ESStartupTimeout     int
	HostAliases          []string
	Verbosity            int
	StaticIPs            []string
	DockerRegistry       string
	CPUProfile           string // write cpu profile to file
	MaxContainerAge      int    // max container age in seconds
	MaxDFSTimeout        int    // max timeout for snapshot
	VirtualAddressSubnet string
	MasterPoolID         string
	LogstashES           string //logstatsh elasticsearch host:port
	LogstashMaxDays      int    // Days to keep logstash indices
	LogstashMaxSize      int    // Max size of logstash data
	DebugPort            int    // Port to listen for profile clients
	AdminGroup           string // user group that can log in to control center
	MaxRPCClients        int    // the max number of rpc clients to an endpoint
	RPCDialTimeout       int
	SnapshotTTL          int // hours to keep snapshots around, zero for infinity
}

type PoolConfig struct {
	PoolID      string
	Realm       string
	CoreLimit   int
	MemoryLimit uint64
}

type PortMap map[string]servicedefinition.EndpointDefinition

type RunningService struct {
	Service *service.Service
	State   *servicestate.ServiceState
}

type SchedulerConfig struct {
	ServiceID  string
	AutoLaunch bool
}

type ServiceConfig struct {
	Name            string
	ParentServiceID string
	ImageID         string
	Command         string
	LocalPorts      *PortMap
	RemotePorts     *PortMap
}

type ServiceMap map[string]service.Service

type ServiceStateController func(SchedulerConfig) (int, error)

type ShellConfig struct {
	ServiceID        string
	Command          string
	Args             []string
	Username         string
	SaveAs           string
	IsTTY            bool
	Mounts           []string
	ServicedEndpoint string
	LogToStderr      bool
	LogStash         struct {
		Enable        bool
		SettleTime    string
		IdleFlushTime string
	}
}

type URL struct {
	Host string
	Port int
}