client

type API interface {
	// ID requests the starters ID.
	ID(ctx context.Context) (IDInfo, error)

	// Version requests the starter version.
	Version(ctx context.Context) (VersionInfo, error)

	// DatabaseVersion returns the version of the `arangod` binary that is being
	// used by this starter.
	DatabaseVersion(ctx context.Context) (driver.Version, error)

	// Processes loads information of all the database server processes launched by the starter.
	Processes(ctx context.Context) (ProcessList, error)

	// Endpoints loads the URL's needed to reach all starters, agents & coordinators in the cluster.
	Endpoints(ctx context.Context) (EndpointList, error)

	// Shutdown will shutdown a starter (and all its started database servers).
	// With goodbye set, it will remove the peer slot for the starter.
	Shutdown(ctx context.Context, goodbye bool) error

	// RemovePeer removes a peer with given ID from the starter cluster.
	// The removal tries to cleanout & properly shutdown servers first.
	// If that does not succeed, the operation returns an error,
	// unless force is set to true.
	RemovePeer(ctx context.Context, id string, force bool) error

	// StartDatabaseUpgrade is called to start the upgrade process
	StartDatabaseUpgrade(ctx context.Context, forceMinorUpgrade bool) error

	// RetryDatabaseUpgrade resets a failure mark in the existing upgrade plan
	// such that the starters will retry the upgrade once more.
	RetryDatabaseUpgrade(ctx context.Context) error

	// AbortDatabaseUpgrade removes the existing upgrade plan.
	// Note that Starters working on an entry of the upgrade
	// will finish that entry.
	// If there is no plan, a NotFoundError will be returned.
	AbortDatabaseUpgrade(ctx context.Context) error

	// UpgradeStatus returns the status of any upgrade plan
	UpgradeStatus(context.Context) (UpgradeStatus, error)

	Inventory(ctx context.Context) (api.Inventory, error)

	ClusterInventory(ctx context.Context) (api.ClusterInventory, error)

	AdminJWTRefresh(ctx context.Context) (api.Empty, error)

	AdminJWTActivate(ctx context.Context, token string) (api.Empty, error)
}

type DatabaseVersionResponse struct {
	Version driver.Version `json:"version"`
}

type EndpointList struct {
	Starters     []string `json:"starters,omitempty"`     // List of URL's to all starter APIs
	Agents       []string `json:"agents,omitempty"`       // List of URL's to all agents (database servers) in the cluster
	Coordinators []string `json:"coordinators,omitempty"` // List of URL's to all coordinators (database servers) in the cluster
}

type ErrorResponse struct {
	Error string
}

type GoodbyeRequest struct {
	SlaveID string // Unique ID of the slave that should be removed.
}

type IDInfo struct {
	ID string `json:"id"`
}

type ProcessList struct {
	ServersStarted bool            `json:"servers-started,omitempty"` // True if the server have all been started
	Servers        []ServerProcess `json:"servers,omitempty"`         // List of servers started by the starter
}

type ServerProcess struct {
	Type        ServerType `json:"type"`                   // agent | coordinator | dbserver
	IP          string     `json:"ip"`                     // IP address needed to reach the server
	Port        int        `json:"port"`                   // Port needed to reach the server
	ProcessID   int        `json:"pid,omitempty"`          // PID of the process (0 when running in docker)
	ContainerID string     `json:"container-id,omitempty"` // ID of docker container running the server
	ContainerIP string     `json:"container-ip,omitempty"` // IP address of docker container running the server
	IsSecure    bool       `json:"is-secure,omitempty"`    // If set, this server is using an SSL connection
}

type ServerType string

type StatusError struct {
	StatusCode int
	// contains filtered or unexported fields
}

type UpgradeStatus struct {
	// Ready is set to true when the entire upgrade has been finished succesfully.
	Ready bool `json:"ready"`
	// Failed is set to true when the upgrade process has yielded an error
	Failed bool `json:"failed"`
	// Reasons contains a human readable description of the state
	Reason string `json:"reason,omitempty"`
	// FromVersions contains all database versions found that will be upgraded.
	FromVersions []driver.Version `json:"from_versions"`
	// ToVersion contains the database version that will be upgraded to.
	ToVersion driver.Version `json:"to_version"`
	// ServersUpgraded contains the servers that have been upgraded
	ServersUpgraded []UpgradeStatusServer `json:"servers_upgraded"`
	// ServersRemaining contains the servers that have not yet been upgraded
	ServersRemaining []UpgradeStatusServer `json:"servers_remaining"`
}

type UpgradeStatusServer struct {
	// Type of the server
	Type ServerType `json:"type"`
	// Port the server is listening on
	Port int `json:"port"`
	// Address of the server (IP or hostname)
	Address string `json:"address"`
}

type VersionInfo struct {
	Version string `json:"version"`
	Build   string `json:"build"`
}