github.com/m3db/m3@v1.5.1-0.20231129193456-75a402aa583b/src/aggregator/tools/deploy/manager.go (about)

     1  // Copyright (c) 2017 Uber Technologies, Inc.
     2  //
     3  // Permission is hereby granted, free of charge, to any person obtaining a copy
     4  // of this software and associated documentation files (the "Software"), to deal
     5  // in the Software without restriction, including without limitation the rights
     6  // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
     7  // copies of the Software, and to permit persons to whom the Software is
     8  // furnished to do so, subject to the following conditions:
     9  //
    10  // The above copyright notice and this permission notice shall be included in
    11  // all copies or substantial portions of the Software.
    12  //
    13  // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    14  // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    15  // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    16  // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    17  // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
    18  // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
    19  // THE SOFTWARE.
    20  
    21  package deploy
    22  
    23  // Instance represents an instance in the deployment.
    24  type Instance interface {
    25  	// ID returns the instance id.
    26  	ID() string
    27  
    28  	// Revision returns the revision deployed to the instance.
    29  	Revision() string
    30  
    31  	// IsHealthy determines whether the instance is healthy.
    32  	IsHealthy() bool
    33  
    34  	// IsDeploying determines whether the instance is being deployed.
    35  	IsDeploying() bool
    36  }
    37  
    38  // Manager manages the state of deployments and interacts with
    39  // instances to perform the actual deployment.
    40  type Manager interface {
    41  	// QueryAll returns the full list of instances in the deployment.
    42  	QueryAll() ([]Instance, error)
    43  
    44  	// Query returns the deployment instances for given set of ids.
    45  	Query(instanceIDs []string) ([]Instance, error)
    46  
    47  	// Deploy deploys the given revision to the given set of instances.
    48  	Deploy(instanceIDs []string, revision string) error
    49  }