manage

type CatalogCassandraOptions struct {
	Replicas      int64
	Volume        *common.ServiceVolume
	JournalVolume *common.ServiceVolume

	// Cassandra JVM heap size. The default volue is 8GB.
	HeapSizeMB int64
	// The user for the JMX remote access. If empty, will be set as "jmxuser".
	JmxRemoteUser string
	// The password for the JMX remote access. If empty, a uuid will be generated
	// as the password. This will be used by nodetool to access replica remotely.
	JmxRemotePasswd string
}

type CatalogCheckServiceInitRequest struct {
	Service            *ServiceCommonRequest
	CatalogServiceType string
}

type CatalogCheckServiceInitResponse struct {
	Initialized   bool
	StatusMessage string
}

type CatalogConsulOptions struct {
	Replicas int64
	Volume   *common.ServiceVolume

	// https://www.consul.io/docs/agent/options.html#_datacenter
	// if not specified, use the current Region.
	Datacenter string

	// https://www.consul.io/docs/agent/options.html#_domain
	Domain string

	// https://www.consul.io/docs/agent/options.html#_encrypt
	// This key must be 16-bytes that are Base64-encoded.
	Encrypt string

	// TLS configs
	EnableTLS         bool
	CertFileContent   string
	KeyFileContent    string
	CACertFileContent string
	HTTPSPort         int64
}

type CatalogCouchDBOptions struct {
	Replicas int64
	Volume   *common.ServiceVolume

	// CouchDB admin username and password
	Admin       string
	AdminPasswd string

	// CouchDB Cors configs
	EnableCors  bool
	Credentials bool
	Origins     string
	Headers     string
	Methods     string

	// CouchDB SSL configs
	EnableSSL         bool
	CertFileContent   string
	KeyFileContent    string
	CACertFileContent string
}

type CatalogCreateCassandraRequest struct {
	Service  *ServiceCommonRequest
	Resource *common.Resources
	Options  *CatalogCassandraOptions
}

type CatalogCreateCassandraResponse struct {
	JmxRemoteUser   string
	JmxRemotePasswd string
}

type CatalogCreateConsulRequest struct {
	Service  *ServiceCommonRequest
	Resource *common.Resources
	Options  *CatalogConsulOptions
}

type CatalogCreateConsulResponse struct {
	ConsulServerIPs []string
}

type CatalogCreateCouchDBRequest struct {
	Service  *ServiceCommonRequest
	Resource *common.Resources
	Options  *CatalogCouchDBOptions
}

type CatalogCreateElasticSearchRequest struct {
	Service  *ServiceCommonRequest
	Resource *common.Resources
	Options  *CatalogElasticSearchOptions
}

type CatalogCreateKafkaManagerRequest struct {
	Service  *ServiceCommonRequest
	Resource *common.Resources
	Options  *CatalogKafkaManagerOptions
}

type CatalogCreateKafkaRequest struct {
	Service  *ServiceCommonRequest
	Resource *common.Resources
	Options  *CatalogKafkaOptions
}

type CatalogCreateKafkaResponse struct {
	JmxRemoteUser   string
	JmxRemotePasswd string
}

type CatalogCreateKafkaSinkESRequest struct {
	Service  *ServiceCommonRequest
	Resource *common.Resources
	Options  *CatalogKafkaSinkESOptions
}

type CatalogCreateKibanaRequest struct {
	Service  *ServiceCommonRequest
	Resource *common.Resources
	Options  *CatalogKibanaOptions
}

type CatalogCreateLogstashRequest struct {
	Service  *ServiceCommonRequest
	Resource *common.Resources
	Options  *CatalogLogstashOptions
}

type CatalogCreateMongoDBRequest struct {
	Service  *ServiceCommonRequest
	Resource *common.Resources
	Options  *CatalogMongoDBOptions
}

type CatalogCreateMongoDBResponse struct {
	KeyFileContent string
}

type CatalogCreatePostgreSQLRequest struct {
	Service  *ServiceCommonRequest
	Resource *common.Resources
	Options  *CatalogPostgreSQLOptions
}

type CatalogCreateRedisRequest struct {
	Service *ServiceCommonRequest

	// Resources.MaxMemoryMB should always be set.
	// if cluster mode is enabled (Shards >= 3), the actual redis memory will be
	// Resources.MaxMemoryMB - default output buffer for the slaves (512MB).
	Resource *common.Resources

	Options *CatalogRedisOptions
}

type CatalogCreateTelegrafRequest struct {
	Service  *ServiceCommonRequest
	Resource *common.Resources
	Options  *CatalogTelegrafOptions
}

type CatalogCreateZooKeeperRequest struct {
	Service  *ServiceCommonRequest
	Resource *common.Resources
	Options  *CatalogZooKeeperOptions
}

type CatalogCreateZooKeeperResponse struct {
	JmxRemoteUser   string
	JmxRemotePasswd string
}

type CatalogElasticSearchOptions struct {
	Replicas int64
	Volume   *common.ServiceVolume

	// ElasticSearch JVM heap size
	HeapSizeMB int64

	DedicatedMasters       int64
	DisableDedicatedMaster bool
	DisableForceAwareness  bool
}

type CatalogKafkaManagerOptions struct {
	// Kafka Manager JVM heap size
	HeapSizeMB int64

	// Kafka Manager user and password
	User     string
	Password string

	// The existing ZooKeeper service that Kafka Manager will use.
	ZkServiceName string
}

type CatalogKafkaOptions struct {
	Replicas int64
	Volume   *common.ServiceVolume

	// Kafka JVM heap size
	HeapSizeMB int64

	AllowTopicDel  bool
	RetentionHours int64
	// the existing ZooKeeper service that Kafka will use.
	ZkServiceName string

	JmxRemoteUser   string
	JmxRemotePasswd string
}

type CatalogKafkaSinkESOptions struct {
	Replicas int64

	// Kafka Connect JVM heap size
	HeapSizeMB int64

	// The Kafka service to sink from
	KafkaServiceName string

	// The Kafka Topic to read data from
	Topic string

	// The replication factor for storage, offset and status topics
	ReplFactor uint

	// The ElasticSearch service to sink to
	ESServiceName string

	// https://docs.confluent.io/3.1.0/connect/connect-elasticsearch/docs/configuration_options.html
	// MaxBufferedRecords and BatchSize should be adjusted according to the load.
	// The ElasticSearch connector default max.buffer.records is 20000, default batch.size is 2000.
	// For example, one record is 1KB. By default, will buffer 20MB, and batch 2MB.
	MaxBufferedRecords int
	BatchSize          int

	// The ElasticSearch index type. This could not be empty for kafka elasticsearch connector.
	// The "type" is deprecated in ElasticSearch 6.0.0.
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/removal-of-types.html
	// https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-type-field.html
	// https://www.elastic.co/blog/index-vs-type
	TypeName string
}

type CatalogKibanaOptions struct {
	Replicas int64
	Volume   *common.ServiceVolume

	// the ElasticSearch service that Kibana is used for
	ESServiceName string

	// specify a path to mount Kibana at if you are running behind a proxy.
	// This only affects the URLs generated by Kibana, your proxy is expected to remove the
	// basePath value before forwarding requests to Kibana. This setting cannot end in a slash (/).
	ProxyBasePath string

	EnableSSL bool
	SSLKey    string
	SSLCert   string
}

type CatalogLogstashOptions struct {
	Replicas int64
	Volume   *common.ServiceVolume

	// Logstash JVM heap size
	HeapSizeMB int64

	// The container image for the service, such as cloudstax/firecamp-logstash:version or cloudstax/firecamp-logstash-input-couchdb:version
	ContainerImage string

	// The internal queue model: "memory" or "persisted"
	QueueType             string
	EnableDeadLetterQueue bool

	// The pipeline configs.
	// There is no need to have multiple config file, as Logstash currently has a single event pipeline.
	// All configuration files are just concatenated (in order) as if you had written a single flat file.
	PipelineConfigs string

	// https://www.elastic.co/guide/en/logstash/5.6/tuning-logstash.html
	// The pipeline settings
	PipelineWorkers       int
	PipelineOutputWorkers int
	PipelineBatchSize     int
	PipelineBatchDelay    int
}

type CatalogMongoDBOptions struct {
	// if ReplicaSetOnly == true and Shards == 1, create a single replicaset, else create a sharded cluster.
	Shards           int64
	ReplicasPerShard int64
	ReplicaSetOnly   bool
	// the number of config servers, ignored if ReplicaSetOnly == true and Shards == 1.
	ConfigServers int64

	Volume        *common.ServiceVolume
	JournalVolume *common.ServiceVolume

	Admin       string
	AdminPasswd string
}

type CatalogPostgreSQLOptions struct {
	Replicas      int64
	Volume        *common.ServiceVolume
	JournalVolume *common.ServiceVolume

	// The container image for the service, such as cloudstax/firecamp-postgres:version or cloudstax/firecamp-postgres-postgis:version
	ContainerImage string

	// the default admin user is: postgres
	AdminPasswd    string
	ReplUser       string
	ReplUserPasswd string
}

type CatalogRedisOptions struct {
	// The number of shards for Redis cluster, minimal 3.
	// Setting to 1 will disable cluster mode. 2 is invalid.
	Shards           int64
	ReplicasPerShard int64

	// Redis memory cache size
	MemoryCacheSizeMB int64

	Volume *common.ServiceVolume

	// whether disable Redis "append only file", not recommended unless for cache only.
	DisableAOF bool
	// The AUTH password, recommended to set it for production environment. Empty string means disable it.
	AuthPass string
	// minimal 60s, not recommend to change unless necessary. see Redis Readme for details.
	ReplTimeoutSecs int64
	// how Redis will select what to remove when maxmemory is reached
	MaxMemPolicy string
	// rename the CONFIG command
	ConfigCmdName string
}

type CatalogScaleCassandraRequest struct {
	Service  *ServiceCommonRequest
	Replicas int64
}

type CatalogSetRedisInitRequest struct {
	Region      string
	Cluster     string
	ServiceName string
}

type CatalogSetServiceInitRequest struct {
	Region      string
	Cluster     string
	ServiceName string
	ServiceType string
}

type CatalogTelegrafOptions struct {
	CollectIntervalSecs int
	MonitorServiceName  string
	// The custom metrics to monitor. Leave it empty to use the default metrics for the service.
	MonitorMetrics string
}

type CatalogZooKeeperOptions struct {
	Replicas int64
	Volume   *common.ServiceVolume

	// ZooKeeper JVM heap size
	HeapSizeMB int64

	// The user for the JMX remote access. If empty, will be set as "jmxuser".
	JmxRemoteUser string
	// The password for the JMX remote access. If empty, a uuid will be generated as the password.
	JmxRemotePasswd string
}

type ConfigFileContent struct {
	FileName string
	FileMode uint32
	Content  string
}

type CreateServiceRequest struct {
	Service  *ServiceCommonRequest
	Resource *common.Resources

	// ServiceType: stateful or stateless. default: stateful.
	// The empty string means stateful as this field is added after 0.9.3.
	ServiceType string

	// Catalog Service, such as Cassandra, Kafka, etc.
	CatalogServiceType string

	ContainerImage string
	Replicas       int64
	PortMappings   []common.PortMapping
	Envkvs         []*common.EnvKeyValuePair

	// whether need to register DNS
	RegisterDNS bool

	ServiceConfigs []*ConfigFileContent

	// The primary volume for the service data
	Volume *common.ServiceVolume
	// The journal volume for the service journal
	JournalVolume *common.ServiceVolume
	// TODO remove ContainerPath, as the docker entrypoint script simply uses the default path
	ContainerPath        string // The mount path inside container for the primary volume
	JournalContainerPath string // The mount path inside container for the journal volume

	// Whether the service requires static ip
	RequireStaticIP bool

	// The detail configs for each replica
	ReplicaConfigs []*ReplicaConfig
}

type DeleteServiceRequest struct {
	Service *ServiceCommonRequest
}

type DeleteServiceResponse struct {
	VolumeIDs []string
}

type DeleteTaskRequest struct {
	Service  *ServiceCommonRequest
	TaskType string
}

type GetConfigFileRequest struct {
	Region      string
	Cluster     string
	ServiceUUID string
	FileID      string
}

type GetConfigFileResponse struct {
	ConfigFile *common.ConfigFile
}

type GetServiceAttributesResponse struct {
	Service *common.ServiceAttr
}

type GetServiceStatusResponse struct {
	Status *common.ServiceStatus
}

type GetServiceTaskStatusResponse struct {
	Complete      bool
	StatusMessage string
}

type GetTaskStatusRequest struct {
	Service *ServiceCommonRequest
	TaskID  string
}

type GetTaskStatusResponse struct {
	Status *common.TaskStatus
}

type InternalGetServiceTaskRequest struct {
	Region              string
	Cluster             string
	ServiceName         string
	ContainerInstanceID string
}

type InternalGetServiceTaskResponse struct {
	ServiceTaskID string
}

type InternalListActiveServiceTasksRequest struct {
	Region      string
	Cluster     string
	ServiceName string
}

type InternalListActiveServiceTasksResponse struct {
	ServiceTaskIDs map[string]bool
}

type ListServiceMemberRequest struct {
	Service *ServiceCommonRequest
}

type ListServiceMemberResponse struct {
	ServiceMembers []*common.ServiceMember
}

type ListServiceRequest struct {
	// region, az and cluster are for the management service to verify
	// the request is sent to the correct server
	Region  string
	Cluster string

	// The prefix of the service name
	Prefix string
}

type ListServiceResponse struct {
	Services []*common.ServiceAttr
}

type ReplicaConfig struct {
	// The availability zone this replica should run.
	Zone string
	// The replica's member name.
	MemberName string
	// The detail config files for this replica.
	Configs []*ConfigFileContent
}

type RunTaskRequest struct {
	Service        *ServiceCommonRequest
	Resource       *common.Resources
	ContainerImage string
	TaskType       string
	Envkvs         []*common.EnvKeyValuePair
}

type RunTaskResponse struct {
	TaskID string
}

type ServiceCommonRequest struct {
	Region      string
	Cluster     string
	ServiceName string
}

type UpdateServiceConfigRequest struct {
	Service           *ServiceCommonRequest
	ConfigFileName    string
	ConfigFileContent string
}

type UpdateServiceResourceRequest struct {
	Service         *ServiceCommonRequest
	MaxCPUUnits     *int64
	ReserveCPUUnits *int64
	MaxMemMB        *int64
	ReserveMemMB    *int64
}