provision

type App interface {
	Named

	// GetPlatform returns the platform (type) of the app. It is equivalent
	// to the Unit `Type` field.
	GetPlatform() string

	// GetPlatformVersion returns the locked platform version of the app.
	GetPlatformVersion() string

	// GetDeploy returns the deploys that an app has.
	GetDeploys() uint

	Envs() map[string]bindTypes.EnvVar

	GetUpdatePlatform() bool

	GetRouters() []appTypes.AppRouter

	GetTeamOwner() string
	GetTeamsName() []string

	GetPlan() appTypes.Plan
	GetPool() string
	GetProcess(process string) *appTypes.Process

	ListTags() []string

	GetMetadata(process string) appTypes.Metadata

	GetRegistry() (imgTypes.ImageRegistry, error)
}

type AppFilterProvisioner interface {
	FilterAppsByUnitStatus(context.Context, []App, []string) ([]App, error)
}

type AppInternalAddress struct {
	Domain   string
	Protocol string
	Port     int32
	Version  string
	Process  string
}

type AutoScalePrometheus struct {
	Name                string  `json:"name"`
	Query               string  `json:"query"`
	Threshold           float64 `json:"threshold"`
	ActivationThreshold float64 `json:"activationThreshold,omitempty"`
	PrometheusAddress   string  `json:"prometheusAddress,omitempty"`
}

type AutoScaleProvisioner interface {
	GetAutoScale(ctx context.Context, a App) ([]AutoScaleSpec, error)
	GetVerticalAutoScaleRecommendations(ctx context.Context, a App) ([]RecommendedResources, error)
	SetAutoScale(ctx context.Context, a App, spec AutoScaleSpec) error
	RemoveAutoScale(ctx context.Context, a App, process string) error
}

type AutoScaleSchedule struct {
	Name        string `json:"name,omitempty"`
	MinReplicas int    `json:"minReplicas"`
	Start       string `json:"start"`
	End         string `json:"end"`
	Timezone    string `json:"timezone,omitempty"`
}

type AutoScaleSpec struct {
	Process    string                `json:"process"`
	MinUnits   uint                  `json:"minUnits"`
	MaxUnits   uint                  `json:"maxUnits"`
	AverageCPU string                `json:"averageCPU,omitempty"`
	Schedules  []AutoScaleSchedule   `json:"schedules,omitempty"`
	Prometheus []AutoScalePrometheus `json:"prometheus,omitempty"`
	Version    int                   `json:"version"`
}

type BuilderDeploy interface {
	Deploy(context.Context, DeployArgs) (string, error)
}

type DeployArgs struct {
	App              App
	Version          appTypes.AppVersion
	Event            *event.Event
	PreserveVersions bool
	OverrideVersions bool
}

type ErrUnitStartup struct {
	CrashedUnits     []string
	CrashedUnitsLogs []appTypes.Applog
	Err              error
}

type Error struct {
	Reason string
	Err    error
}

type ExecOptions struct {
	App    App
	Stdout io.Writer
	Stderr io.Writer
	Stdin  io.Reader
	Width  int
	Height int
	Term   string
	Cmds   []string
	Units  []string
}

type ExecutableProvisioner interface {
	ExecuteCommand(ctx context.Context, opts ExecOptions) error
}

type HCProvisioner interface {
	// HandlesHC returns true if the provisioner will handle healthchecking
	// instead of the router.
	HandlesHC() bool
}

type ImageBuildLabelsOpts struct {
	Name         string
	CustomLabels map[string]string
	Prefix       string
	IsBuild      bool
}

type InitializableProvisioner interface {
	Initialize() error
}

type InspectData struct {
	Image     docker.Image
	TsuruYaml provTypes.TsuruYamlData
	Procfile  string
}

type InterAppProvisioner interface {
	InternalAddresses(ctx context.Context, a App) ([]AppInternalAddress, error)
}

type InvalidProcessError struct {
	Msg string
}

type JobProvisioner interface {
	// JobUnits returns information about units related to a specific Job or CronJob
	JobUnits(context.Context, *jobTypes.Job) ([]Unit, error)

	// EnsureJob creates/update a cronjob object in the cluster
	EnsureJob(context.Context, *jobTypes.Job) error

	DestroyJob(context.Context, *jobTypes.Job) error
	TriggerCron(ctx context.Context, name, pool string) error
	KillJobUnit(ctx context.Context, job *jobTypes.Job, unitName string, force bool) error
}

type KillUnitProvisioner interface {
	KillUnit(ctx context.Context, app App, unit string, force bool) error
}

type LabelSet struct {
	Labels    map[string]string
	RawLabels map[string]string
	Prefix    string
}

type LogsProvisioner interface {
	ListLogs(ctx context.Context, obj logTypes.LogabbleObject, args appTypes.ListLogArgs) ([]appTypes.Applog, error)
	WatchLogs(ctx context.Context, obj logTypes.LogabbleObject, args appTypes.ListLogArgs) (appTypes.LogWatcher, error)
}

type MessageProvisioner interface {
	StartupMessage() (string, error)
}

type MetricsProvisioner interface {
	// Units returns information about cpu and memory usage by App.
	UnitsMetrics(ctx context.Context, a App) ([]UnitMetric, error)
}

type MultiRegistryProvisioner interface {
	RegistryForPool(ctx context.Context, pool string) (imgTypes.ImageRegistry, error)
}

type Named interface {
	GetName() string
}

type NodeCheckResult struct {
	Name       string
	Err        string
	Successful bool
}

type NodeLabelsOpts struct {
	Addr         string
	Pool         string
	Prefix       string
	CustomLabels map[string]string
}

type OptionalLogsProvisioner interface {
	// Checks if logs are enabled for given app.
	LogsEnabled(App) (bool, string, error)
}

type PDBLabelsOpts struct {
	App     App
	Prefix  string
	Process string
}

type ProcessLabelsOpts struct {
	App     App
	Process string
	Prefix  string
}

type Provisioner interface {
	Named

	// Provision is called when tsuru is creating the app.
	Provision(context.Context, App) error

	// Destroy is called when tsuru is destroying the app.
	Destroy(context.Context, App) error

	// DestroyVersion is called when tsuru is destroying an app version.
	DestroyVersion(context.Context, App, appTypes.AppVersion) error

	// AddUnits adds units to an app. The first parameter is the app, the
	// second is the number of units to be added.
	//
	// It returns a slice containing all added units
	AddUnits(context.Context, App, uint, string, appTypes.AppVersion, io.Writer) error

	// RemoveUnits "undoes" AddUnits, removing the given number of units
	// from the app.
	RemoveUnits(context.Context, App, uint, string, appTypes.AppVersion, io.Writer) error

	// Restart restarts the units of the application, with an optional
	// string parameter represeting the name of the process to start. When
	// the process is empty, Restart will restart all units of the
	// application.
	Restart(context.Context, App, string, appTypes.AppVersion, io.Writer) error

	// Start starts the units of the application, with an optional string
	// parameter representing the name of the process to start. When the
	// process is empty, Start will start all units of the application.
	Start(context.Context, App, string, appTypes.AppVersion, io.Writer) error

	// Stop stops the units of the application, with an optional string
	// parameter representing the name of the process to start. When the
	// process is empty, Stop will stop all units of the application.
	Stop(context.Context, App, string, appTypes.AppVersion, io.Writer) error

	// Units returns information about units by App.
	Units(context.Context, ...App) ([]Unit, error)

	// RoutableAddresses returns the addresses used to access an application.
	RoutableAddresses(context.Context, App) ([]appTypes.RoutableAddresses, error)
}

type ProvisionerNotSupported struct {
	Prov   Provisioner
	Action string
}

type RebalanceNodesOptions struct {
	Event          *event.Event
	Pool           string
	MetadataFilter map[string]string
	AppFilter      []string
	Dry            bool
	Force          bool
}

type RecommendedProcessResources struct {
	Type   string `json:"type"`
	CPU    string `json:"cpu"`
	Memory string `json:"memory"`
}

type RecommendedResources struct {
	Process         string                        `json:"process"`
	Recommendations []RecommendedProcessResources `json:"recommendations"`
}

type RunArgs struct {
	Once     bool
	Isolated bool
}

type ServiceAccountLabelsOpts struct {
	App               App
	Job               *jobTypes.Job
	NodeContainerName string
	Prefix            string
}

type ServiceLabelExtendedOpts struct {
	Prefix        string
	IsIsolatedRun bool
	IsBuild       bool
}

type ServiceLabelsOpts struct {
	App     App
	Process string
	Version int
	ServiceLabelExtendedOpts
}

type Status string

type Unit struct {
	ID           string
	Name         string
	AppName      string
	ProcessName  string
	Type         string
	IP           string
	InternalIP   string
	Status       Status
	StatusReason string
	Address      *url.URL  // TODO: deprecate after drop docker provisioner
	Addresses    []url.URL // TODO: deprecate after drop docker provisioner
	Version      int
	Routable     bool
	Restarts     *int32
	CreatedAt    *time.Time
	Ready        *bool
}

type UnitFinderProvisioner interface {
	// GetAppFromUnitID returns an app from unit id
	GetAppFromUnitID(context.Context, string) (App, error)
}

type UnitMetric struct {
	ID     string
	CPU    string
	Memory string
}

type UnitNotFoundError struct {
	ID string
}

type UnitStatusData struct {
	ID     string
	Name   string
	Status Status
}

type UpdatableProvisioner interface {
	UpdateApp(ctx context.Context, old, new App, w io.Writer) error
}

type VersionsProvisioner interface {
	ToggleRoutable(context.Context, App, appTypes.AppVersion, bool) error
	DeployedVersions(context.Context, App) ([]int, error)
}

type VolumeLabelsOpts struct {
	Name   string
	Pool   string
	Plan   string
	Team   string
	Prefix string
}

type VolumeProvisioner interface {
	ValidateVolume(context.Context, *volumeTypes.Volume) error
	IsVolumeProvisioned(ctx context.Context, volumeName, pool string) (bool, error)
	DeleteVolume(ctx context.Context, volumeName, pool string) error
}