api

type API interface {

	// Server
	StartServer() error
	ServicedHealthCheck(IServiceNames []string) ([]isvcs.IServiceHealthResult, error)

	// Hosts
	GetHosts() ([]host.Host, error)
	GetHost(string) (*host.Host, error)
	GetHostMap() (map[string]host.Host, error)
	AddHost(HostConfig) (*host.Host, []byte, error)
	AddHostPrivate(HostConfig) (*host.Host, []byte, error)
	RemoveHost(string) error
	GetHostMemory(string) (*metrics.MemoryUsageStats, error)
	SetHostMemory(HostUpdateConfig) error
	GetHostPublicKey(string) ([]byte, error)
	RegisterHost([]byte) error
	RegisterRemoteHost(*host.Host, utils.URL, []byte, bool) error
	WriteDelegateKey(string, []byte) error
	AuthenticateHost(string) (string, int64, error)
	ResetHostKey(string) ([]byte, error)
	GetHostWithAuthInfo(string) (*AuthHost, error)
	GetHostsWithAuthInfo() ([]AuthHost, error)

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

	// Services
	GetAllServiceDetails() ([]service.ServiceDetails, error)
	GetServiceDetails(serviceID string) (*service.ServiceDetails, error)
	GetServiceStatus(string) (map[string]map[string]interface{}, error)
	GetService(string) (*service.Service, error)
	AddService(ServiceConfig) (*service.ServiceDetails, error)
	CloneService(string, string) (*service.ServiceDetails, error)
	RemoveService(string) error
	UpdateService(io.Reader) (*service.ServiceDetails, error)
	UpdateServiceObj(service.Service) (*service.ServiceDetails, error)
	StartService(SchedulerConfig) (int, error)
	RestartService(SchedulerConfig) (int, error)
	RebalanceService(SchedulerConfig) (int, error)
	StopService(SchedulerConfig) (int, error)
	PauseService(SchedulerConfig) (int, error)
	AssignIP(IPConfig) error
	GetEndpoints(serviceID string, reportImports, reportExports, validate bool) ([]applicationendpoint.EndpointReport, error)
	ResolveServicePath(path string, noprefix bool) ([]service.ServiceDetails, error)
	ClearEmergency(serviceID string) (int, error)
	RemoveIP(args []string) error
	SetIP(IPConfig) error

	// Shell
	StartShell(ShellConfig) error
	RunShell(ShellConfig, chan struct{}) (int, error)

	// Snapshots
	GetSnapshots() ([]dao.SnapshotInfo, error)
	GetSnapshotsByServiceID(string) ([]dao.SnapshotInfo, error)
	GetSnapshotByServiceIDAndTag(string, string) (string, error)
	AddSnapshot(SnapshotConfig) (string, error)
	RemoveSnapshot(string) error
	Rollback(string, bool) error
	TagSnapshot(string, string) error
	RemoveSnapshotTag(string, string) (string, 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.ServiceDetails, error)

	// Backup & Restore
	GetBackupEstimate(string, []string) (*dao.BackupEstimate, error)
	Backup(string, []string, bool) (string, error)
	Restore(string) error

	// Docker
	ResetRegistry() error
	RegistrySync() error
	UpgradeRegistry(endpoint string, override bool) error
	DockerOverride(newImage string, oldImage string) error

	// Logs
	ExportLogs(config ExportLogsConfig) error

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

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

	// Volumes
	GetVolumeStatus() (*volume.Statuses, error)

	// Public endpoints
	AddPublicEndpointPort(serviceid, endpointName, portAddr string, usetls bool, protocol string, isEnabled, restart bool) (*servicedefinition.Port, error)
	RemovePublicEndpointPort(serviceid, endpointName, portAddr string) error
	EnablePublicEndpointPort(serviceid, endpointName, portAddr string, isEnabled bool) error
	AddPublicEndpointVHost(serviceid, endpointName, vhost string, isEnabled, restart bool) (*servicedefinition.VHost, error)
	RemovePublicEndpointVHost(serviceid, endpointName, vhost string) error
	EnablePublicEndpointVHost(serviceid, endpointName, vhost string, isEnabled bool) error
	GetAllPublicEndpoints() ([]service.PublicEndpoint, error)

	// Service Instances
	GetServiceInstances(serviceID string) ([]service.Instance, error)
	StopServiceInstance(serviceID string, instanceID int) error
	AttachServiceInstance(serviceID string, instanceID int, command string, args []string) error
	LogsForServiceInstance(serviceID string, instanceID int, command string, args []string) error
	SendDockerAction(serviceID string, instanceID int, action string, args []string) error

	// Debug Management
	DebugEnableMetrics() (string, error)
	DebugDisableMetrics() (string, error)
}

type AuthHost struct {
	host.Host
	Authenticated bool
}

type CompileTemplateConfig struct {
	Dir string
	Map ImageMap
}

type ContainerFileIndex struct {
	// contains filtered or unexported fields
}

type DateFileIndex struct {
	// contains filtered or unexported fields
}

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

type ElasticSearchResults struct {
	Took     int            `json:"took,omitempty"`
	TimedOut bool           `json:"timed_out,omitempty"`
	Shards   map[string]int `json:"_shards,omitempty"`
	ScrollID string         `json:"_scroll_id,omitempty"`
	Hits     ExternalHit    `json:"hits,omitempty"`
}

type ExportGroup int

type ExportLogDriver interface {
	// Sets the ES Logstash connection info; logstashES should be in the format hostname:port
	SetLogstashInfo(logstashES string) error

	// Returns a list of all the dates for which logs are available
	// The strings are in YYYY.MM.DD format, and in reverse chronological order.
	LogstashDays() ([]string, error)

	// Start a new search of ES logstash for a given date
	StartSearch(logstashIndex string, query string) (ElasticSearchResults, error)

	// Scroll to the next set of search results
	ScrollSearch(scrollID string) (ElasticSearchResults, error)
}

type ExportLogDriverMock struct {
	mock.Mock
}

type ExportLogsConfig struct {
	// A list of one or more serviced IDs to export logs for
	// (includes all child services unless ExcludeChildren is true)
	ServiceIDs []string

	// A list of one or more application log file names to export
	FileNames []string

	// In the format yyyy.mm.dd (inclusive), "" means unbounded
	FromDate string

	// In the format yyyy.mm.dd (inclusive), "" means unbounded
	ToDate string

	// Name of the compressed tar file containing all of the exported logs. If not specified, defaults to
	// "./serviced-log-export-<TIMESTAMP>.tgz" where <TIMESTAMP> is an RFC3339-like string (e.g. 2016-06-02T143843Z)
	OutFileName string

	// Set to true to default more verbose logging
	Debug bool

	// Defines which messages are grouped together in each output file
	GroupBy ExportGroup

	// Set to true to exclude child services
	ExcludeChildren bool

	// Driver to work with logstash ES instance; if nil a default driver will be used. Primarily used for testing.
	Driver ExportLogDriver
	// contains filtered or unexported fields
}

type ExternalHit struct {
	Total    Total         `json:"total"`
	MaxScore float64       `json:"max_score"`
	Hits     []InternalHit `json:"hits,omitempty"`
}

type FileIndex interface {
	FindIndexForMessage(message *parsedMessage) (index int, found bool)
	AddIndexForMessage(index int, message *parsedMessage)
	GetFileIndexData(index int, outputFile outputFileInfo, hostName, serviceName string) string
	GetIndexHeader() string
	GetFileName(index int, message *parsedMessage) string
}

type HostConfig struct {
	Address *utils.URL
	Nat     *utils.URL
	PoolID  string
	Memory  string
	IPs     []string
}

type HostUpdateConfig struct {
	HostID string
	Memory string
}

type IPConfig struct {
	ServiceID    string
	IPAddress    string
	Port         uint16
	Proto        string
	EndpointName string
}

type ImageMap map[string]string

type InternalHit struct {
	Index       string           `json:"_index"`
	Type        string           `json:"_type"`
	Id          string           `json:"_id"`
	Version     int              `json:"_version,omitempty"`
	PrimaryTerm int              `json:"_primary_term,omitempty"`
	SeqNo       int              `json:"_seq_no,omitempty"`
	Score       float64          `json:"_score"`
	Source      *json.RawMessage `json:"_source"`
}

type PoolConfig struct {
	PoolID      string
	Realm       string
	CoreLimit   int
	MemoryLimit uint64
	Permissions pool.Permission
}

type PortMap map[string]servicedefinition.EndpointDefinition

type SchedulerConfig struct {
	ServiceIDs  []string
	AutoLaunch  bool
	Synchronous bool
}

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

type ServiceFileIndex struct {
	// contains filtered or unexported fields
}

type ServiceMap map[string]service.ServiceDetails

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
	}
}

type SnapshotConfig struct {
	ServiceID string
	Message   string
	Tag       string
	DockerID  string
}

type Total struct {
	Value    int    `json:"value"`
	Relation string `json:"relation"`
}

type UnknownElasticStructError struct {
	UnknownData   string
	UnknownStruct string
}