modulepackage
0.2.0
Repository: https://github.com/hashicorp/raft-autopilot.git
Documentation: pkg.go.dev
# README
raft-autopilot
Raft Autopilot
# Functions
No description provided by the author
New will create a new Autopilot instance utilizing the given Raft and Delegate.
NewMockApplicationIntegration creates a new instance of MockApplicationIntegration.
NewMockOption creates a new instance of MockOption.
NewMockPromoter creates a new instance of MockPromoter.
NewMockRaft creates a new instance of MockRaft.
NewMockTimeProvider creates a new instance of MockTimeProvider.
ServerLessThan will look up both servers in the given State and return true if the first id corresponds to a server that is logically less than lower than, better than etc.
SortServers will take a list of raft ServerIDs and sort it using information from the State.
WithLogger returns an Option to set the Autopilot instance's logger.
WithPromoter returns an option to set the Promoter type that Autpilot will use.
WithReconcileInterval returns an Option to set the Autopilot instance's reconcile interval.
WithReconciliationDisabled returns an option to initially disable reconciliation for all autopilot go routines.
WithTimeProvider returns an Option which overrides and Autopilot instance's time provider with the given one.
WithUpdateInterval returns an Option to set the Autopilot instance's update interval.
# Constants
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
# Structs
Autopilot is the type to manage a running Raft instance.
Config represents all the tunables of autopilot.
No description provided by the author
MockApplicationIntegration is an autogenerated mock type for the ApplicationIntegration type.
MockOption is an autogenerated mock type for the Option type.
MockPromoter is an autogenerated mock type for the Promoter type.
MockRaft is an autogenerated mock type for the Raft type.
MockTimeProvider is an autogenerated mock type for the TimeProvider type.
No description provided by the author
Server represents one Raft server.
No description provided by the author
No description provided by the author
ServerStats holds miscellaneous Raft metrics for a server.
No description provided by the author
No description provided by the author
# Interfaces
No description provided by the author
Promoter is an interface to provide promotion/demotion algorithms to the core autopilot type.
Raft is the interface of all the methods on the Raft type that autopilot needs to function.
TimeProvider is an interface for getting a local time.
# Type aliases
ExecutionStatus represents the current status of the autopilot background go routines.
NodeStatus represents the health of a server as know to the autopilot consumer.
No description provided by the author
Option is an option to be used when creating a new Autopilot instance.
RaftState is the status of a single server in the Raft cluster.