package
0.0.0-20181017201615-3b9dd4710f09
Repository: https://github.com/m3db/m3cluster.git
Documentation: pkg.go.dev

# Packages

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Functions

NewActiveStagedPlacementOptions create a new set of active staged placement options.
NewDeploymentOptions returns a default DeploymentOptions.
NewEmptyInstance returns a Instance with some basic properties but no shards assigned.
NewInstance returns a new Instance.
NewInstanceFromProto creates a new placement instance from proto.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
NewOptions returns a default Options.
NewPlacement returns a ServicePlacement.
NewPlacementFromProto creates a new placement from proto.
NewPlacementsFromProto creates a list of placements from proto.
NewStagedPlacement creates an empty staged placement.
NewStagedPlacementFromProto creates a new staged placement from proto.
NewStagedPlacementWatcher creates a new staged placement watcher.
NewStagedPlacementWatcherOptions create a new set of topology options.
Validate validates a placement.

# Constants

IncludeTransitionalShardStates means the placement will include transitional shard states.
StableShardStateOnly means the placement should only keep stable shard state.

# Structs

Mock of ActiveStagedPlacement interface.
Mock of ActiveStagedPlacementOptions interface.
Mock of Algorithm interface.
Mock of DeploymentOptions interface.
Mock of DeploymentPlanner interface.
Mock of Instance interface.
Mock of InstanceSelector interface.
Mock of Options interface.
Mock of Placement interface.
Mock of Service interface.
Mock of StagedPlacement interface.
Mock of StagedPlacementWatcher interface.
Mock of StagedPlacementWatcherOptions interface.
Mock of Storage interface.
Mock of Watch interface.
WatcherConfiguration contains placement watcher configuration.

# Interfaces

ActiveStagedPlacement describes active staged placement.
ActiveStagedPlacementOptions provide a set of options for active staged placement.
Algorithm places shards on instances.
DeploymentOptions provides options for DeploymentPlanner.
DeploymentPlanner generates deployment steps for a placement.
Instance represents an instance in a placement.
InstanceSelector selects valid instances for the placement change.
Options is the interface for placement options.
Placement describes how instances are placed.
Service handles the placement related operations for registered services all write or update operations will persist the generated placement before returning success.
StagedPlacement describes a series of placements applied in staged fashion.
StagedPlacementWatcher watches for updates to staged placement.
StagedPlacementWatcherOptions provide a set of staged placement watcher options.
Storage provides read and write access to placement.
Watch watches for updates of a placement.

# Type aliases

ByIDAscending sorts Instance by ID ascending.
DoneFn is called when caller is done using the resource.
Instances is a slice of instances that can produce a debug string.
OnPlacementsAddedFn is called when placements are added.
OnPlacementsRemovedFn is called when placements are removed.
Placements represents a list of placements.
ShardStateMode describes the way to manage shard state in the placement.
ShardValidationFn validates the shard.
TimeNanosFn returns the time in the format of Unix nanoseconds.