manager.go

// Copyright (c) 2017 Uber Technologies, Inc.
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.

package deploy

// Instance represents an instance in the deployment.
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
}

// Manager manages the state of deployments and interacts with
// instances to perform the actual deployment.
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
}