deploy

type AggregatorClient interface {
	// IsHealthy determines whether an instance is healthy.
	IsHealthy(instance string) error

	// Status returns the instance status.
	Status(instance string) (aggregator.RuntimeStatus, error)

	// Resign asks an aggregator instance to give up its current leader role if applicable.
	// The instance however still participates in leader election as a follower after
	// resiganation succeeds.
	Resign(instance string) error
}

type Helper interface {
	// Deploy deploys a target revision to the instances in the placement.
	Deploy(revision string, placement placement.Placement, mode Mode) error
}

type HelperOptions interface {
	// SetInstrumentOptions sets the instrument options.
	SetInstrumentOptions(value instrument.Options) HelperOptions

	// InstrumentOptions returns the instrument options.
	InstrumentOptions() instrument.Options

	// SetPlannerOptions sets the deployment planner options.
	SetPlannerOptions(value PlannerOptions) HelperOptions

	// PlannerOptions returns the deployment planner options.
	PlannerOptions() PlannerOptions

	// SetManager sets the deployment manager.
	SetManager(value Manager) HelperOptions

	// Manager returns the deployment manager.
	Manager() Manager

	// SetHTTPClient sets the http client.
	SetHTTPClient(value *http.Client) HelperOptions

	// HTTPClient returns the http client.
	HTTPClient() *http.Client

	// SetRetryOptions sets the retry options.
	SetRetryOptions(value retry.Options) HelperOptions

	// RetryOptions returns the retry options.
	RetryOptions() retry.Options

	// SetWorkerPool sets the worker pool.
	SetWorkerPool(value sync.WorkerPool) HelperOptions

	// WorkerPool returns the worker pool.
	WorkerPool() sync.WorkerPool

	// SetToPlacementInstanceIDFn sets the function that converts a deployment
	// instance id to the corresponding placement instance id.
	SetToPlacementInstanceIDFn(value ToPlacementInstanceIDFn) HelperOptions

	// ToPlacementInstanceIDFn returns the function that converts a deployment
	// instance id to the corresponding placement instance id.
	ToPlacementInstanceIDFn() ToPlacementInstanceIDFn

	// SetToAPIEndpointFn sets the function that converts a placement
	// instance endpoint to the corresponding aggregator instance api endpoint.
	SetToAPIEndpointFn(value ToAPIEndpointFn) HelperOptions

	// ToAPIEndpointFn returns the function that converts a placement
	// instance endpoint to the corresponding aggregator instance api endpoint.
	ToAPIEndpointFn() ToAPIEndpointFn

	// SetSettleDurationBetweenSteps sets the settlement duration between consecutive steps.
	SetSettleDurationBetweenSteps(value time.Duration) HelperOptions

	// SettleDurationBetweenSteps returns the settlement duration between consecutive steps.
	SettleDurationBetweenSteps() time.Duration

	// Validate validates the options.
	Validate() error
}

type Instance interface {
	// ID returns the instance id.
	ID() string

	// Revision returns the revision deployed to the instance.
	Revision() string

	// IsHealthy determines whether the instance is healthy.
	IsHealthy() bool

	// IsDeploying determines whether the instance is being deployed.
	IsDeploying() bool
}

type Manager interface {
	// QueryAll returns the full list of instances in the deployment.
	QueryAll() ([]Instance, error)

	// Query returns the deployment instances for given set of ids.
	Query(instanceIDs []string) ([]Instance, error)

	// Deploy deploys the given revision to the given set of instances.
	Deploy(instanceIDs []string, revision string) error
}

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

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

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

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

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

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

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

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

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

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

type Mode int

type PlannerOptions interface {
	// SetLeaderService sets the leader service.
	SetLeaderService(value services.LeaderService) PlannerOptions

	// LeaderService returns the leader service.
	LeaderService() services.LeaderService

	// SetWorkerPool sets the worker pool.
	SetWorkerPool(value xsync.WorkerPool) PlannerOptions

	// WorkerPool returns the worker pool.
	WorkerPool() xsync.WorkerPool

	// SetElectionKeyFmt sets the election key format.
	SetElectionKeyFmt(value string) PlannerOptions

	// ElectionKeyFmt returns the election key format.
	ElectionKeyFmt() string

	// SetMaxStepSize sets the maximum step size (i.e., number of instances per step).
	SetMaxStepSize(value int) PlannerOptions

	// MaxStepSize returns the maximum step size (i.e., number of instances per step).
	MaxStepSize() int
}

type ToAPIEndpointFn func(placementEndpoint string) (string, error)

type ToPlacementInstanceIDFn func(deploymentInstanceID string) (string, error)