package
1.5.0
Repository: https://github.com/m3db/m3.git
Documentation: pkg.go.dev

# Functions

NewAggregatorClient creates a new aggregator client.
NewHelper creates a new deployment helper.
NewHelperOptions create a set of deployment helper options.
NewMockAggregatorClient creates a new mock instance.
NewMockInstance creates a new mock instance.
NewMockManager creates a new mock instance.
NewMockplanner creates a new mock instance.
NewMockvalidatorFactory creates a new mock instance.
NewPlannerOptions create a new set of options for the deployment planner.

# Constants

A list of supported deployment modes.
A list of supported deployment modes.

# Structs

MockAggregatorClient is a mock of AggregatorClient interface.
MockAggregatorClientMockRecorder is the mock recorder for MockAggregatorClient.
MockInstance is a mock of Instance interface.
MockInstanceMockRecorder is the mock recorder for MockInstance.
MockManager is a mock of Manager interface.
MockManagerMockRecorder is the mock recorder for MockManager.
Mockplanner is a mock of planner interface.
MockplannerMockRecorder is the mock recorder for Mockplanner.
MockvalidatorFactory is a mock of validatorFactory interface.
MockvalidatorFactoryMockRecorder is the mock recorder for MockvalidatorFactory.

# Interfaces

AggregatorClient interacts with aggregator instances via aggregator endpoints.
Helper is a helper class handling deployments.
HelperOptions provide a set of options for the deployment helper.
Instance represents an instance in the deployment.
Manager manages the state of deployments and interacts with instances to perform the actual deployment.
PlannerOptions provide a set of options for the deployment planner.

# Type aliases

Mode is the deployment mode.
ToAPIEndpointFn converts a placement instance endpoint to the corresponding aggregator instance api endpoint.
ToPlacementInstanceIDFn converts a deployment instance id to the corresponding placement instance id.