const (
ApplyBoth = ShouldApplyV3(true)
ApplyV2storeOnly = ShouldApplyV3(false)
)
var (
ErrIDRemoved = errors.New("membership: ID removed")
ErrIDExists = errors.New("membership: ID exists")
ErrIDNotFound = errors.New("membership: ID not found")
ErrPeerURLexists = errors.New("membership: peerURL exists")
ErrMemberNotLearner = errors.New("membership: can only promote a learner member")
ErrTooManyLearners = errors.New("membership: too many learner members in cluster")
)
var (
ClusterVersionMetrics = prometheus.NewGaugeVec(prometheus.GaugeOpts{
Namespace: "etcd",
Subsystem: "cluster",
Name: "version",
Help: "Which version is running. 1 for 'cluster_version' label with current cluster version",
},
[]string{"cluster_version"})
)
var (
StoreMembersPrefix = path.Join(storePrefix, "members")
)
func AllowedDowngradeVersion(ver *semver.Version) *semver.Version
func IsMetaStoreOnly(store v2store.Store) (bool, error)
IsMetaStoreOnly verifies if the given `store` contains only a meta-information (members, version) that can be recovered from the backend (storev3) as well as opposed to user-data.
func IsValidVersionChange(cv *semver.Version, lv *semver.Version) bool
IsValidVersionChange checks the two scenario when version is valid to change: 1. Downgrade: cluster version is 1 minor version higher than local version, cluster version should change. 2. Cluster start: when not all members version are available, cluster version is set to MinVersion(3.0), when all members are at higher version, cluster version is lower than local version, cluster version should change
func MemberAttributesStorePath(id types.ID) string
func MemberStoreKey(id types.ID) string
func MustParseMemberIDFromKey(lg *zap.Logger, key string) types.ID
func MustUnsafeSaveConfStateToBackend(lg *zap.Logger, tx backend.BatchTx, confState *raftpb.ConfState)
MustUnsafeSaveConfStateToBackend persists confState using given transaction (tx). confState in backend is persisted since etcd v3.5.
func RemovedMemberStoreKey(id types.ID) string
func StoreClusterVersionKey() string
func TrimClusterFromBackend(be backend.Backend) error
TrimClusterFromBackend removes all information about cluster (versions) from the v3 backend.
func TrimMembershipFromBackend(lg *zap.Logger, be backend.Backend) error
TrimMembershipFromBackend removes all information about members & removed_members from the v3 backend.
func TrimMembershipFromV2Store(lg *zap.Logger, s v2store.Store) error
TrimMembershipFromV2Store removes all information about members & removed_members from the v2 store.
func UnsafeConfStateFromBackend(lg *zap.Logger, tx backend.ReadTx) *raftpb.ConfState
UnsafeConfStateFromBackend retrieves ConfState from the backend. Returns nil if confState in backend is not persisted (e.g. backend writen by <v3.5).
func ValidateClusterAndAssignIDs(lg *zap.Logger, local *RaftCluster, existing *RaftCluster) error
ValidateClusterAndAssignIDs validates the local cluster by matching the PeerURLs with the existing cluster. If the validation succeeds, it assigns the IDs from the existing cluster to the local cluster. If the validation fails, an error will be returned.
Attributes represents all the non-raft related attributes of an etcd member.
type Attributes struct {
Name string `json:"name,omitempty"`
ClientURLs []string `json:"clientURLs,omitempty"`
}
ConfigChangeContext represents a context for confChange.
type ConfigChangeContext struct {
Member
// IsPromote indicates if the config change is for promoting a learner member.
// This flag is needed because both adding a new member and promoting a learner member
// uses the same config change type 'ConfChangeAddNode'.
IsPromote bool `json:"isPromote"`
}
type DowngradeInfo struct {
// TargetVersion is the target downgrade version, if the cluster is not under downgrading,
// the targetVersion will be an empty string
TargetVersion string `json:"target-version"`
// Enabled indicates whether the cluster is enabled to downgrade
Enabled bool `json:"enabled"`
}
func (d *DowngradeInfo) GetTargetVersion() *semver.Version
type Member struct {
ID types.ID `json:"id"`
RaftAttributes
Attributes
}
func NewMember(name string, peerURLs types.URLs, clusterName string, now *time.Time) *Member
NewMember creates a Member without an ID and generates one based on the cluster name, peer URLs, and time. This is used for bootstrapping/adding new member.
func NewMemberAsLearner(name string, peerURLs types.URLs, clusterName string, now *time.Time) *Member
NewMemberAsLearner creates a learner Member without an ID and generates one based on the cluster name, peer URLs, and time. This is used for adding new learner member.
func (m *Member) Clone() *Member
func (m *Member) IsStarted() bool
func (m *Member) PickPeerURL() string
PickPeerURL chooses a random address from a given Member's PeerURLs. It will panic if there is no PeerURLs available in Member.
MembersByID implements sort by ID interface
type MembersByID []*Member
func (ms MembersByID) Len() int
func (ms MembersByID) Less(i, j int) bool
func (ms MembersByID) Swap(i, j int)
MembersByPeerURLs implements sort by peer urls interface
type MembersByPeerURLs []*Member
func (ms MembersByPeerURLs) Len() int
func (ms MembersByPeerURLs) Less(i, j int) bool
func (ms MembersByPeerURLs) Swap(i, j int)
RaftAttributes represents the raft related attributes of an etcd member.
type RaftAttributes struct {
// PeerURLs is the list of peers in the raft cluster.
// TODO(philips): ensure these are URLs
PeerURLs []string `json:"peerURLs"`
// IsLearner indicates if the member is raft learner.
IsLearner bool `json:"isLearner,omitempty"`
}
RaftCluster is a list of Members that belong to the same raft cluster
type RaftCluster struct {
sync.Mutex // guards the fields below
// contains filtered or unexported fields
}
func NewCluster(lg *zap.Logger) *RaftCluster
func NewClusterFromMembers(lg *zap.Logger, id types.ID, membs []*Member) *RaftCluster
func NewClusterFromURLsMap(lg *zap.Logger, token string, urlsmap types.URLsMap) (*RaftCluster, error)
NewClusterFromURLsMap creates a new raft cluster using provided urls map. Currently, it does not support creating cluster with raft learner member.
func (c *RaftCluster) AddMember(m *Member, shouldApplyV3 ShouldApplyV3)
AddMember adds a new Member into the cluster, and saves the given member's raftAttributes into the store. The given member should have empty attributes. A Member with a matching id must not exist.
func (c *RaftCluster) ClientURLs() []string
ClientURLs returns a list of all client addresses. The returned list is sorted in ascending lexicographical order.
func (c *RaftCluster) DowngradeInfo() *DowngradeInfo
DowngradeInfo returns the downgrade status of the cluster
func (c *RaftCluster) ID() types.ID
func (c *RaftCluster) IsIDRemoved(id types.ID) bool
func (c *RaftCluster) IsLocalMemberLearner() bool
IsLocalMemberLearner returns if the local member is raft learner
func (c *RaftCluster) IsMemberExist(id types.ID) bool
IsMemberExist returns if the member with the given id exists in cluster.
func (c *RaftCluster) IsReadyToAddVotingMember() bool
func (c *RaftCluster) IsReadyToPromoteMember(id uint64) bool
func (c *RaftCluster) IsReadyToRemoveVotingMember(id uint64) bool
func (c *RaftCluster) Member(id types.ID) *Member
func (c *RaftCluster) MemberByName(name string) *Member
MemberByName returns a Member with the given name if exists. If more than one member has the given name, it will panic.
func (c *RaftCluster) MemberIDs() []types.ID
func (c *RaftCluster) Members() []*Member
func (c *RaftCluster) PeerURLs() []string
PeerURLs returns a list of all peer addresses. The returned list is sorted in ascending lexicographical order.
func (c *RaftCluster) PromoteMember(id types.ID, shouldApplyV3 ShouldApplyV3)
PromoteMember marks the member's IsLearner RaftAttributes to false.
func (c *RaftCluster) PushMembershipToStorage()
PushMembershipToStorage is overriding storage information about cluster's members, such that they fully reflect internal RaftCluster's storage.
func (c *RaftCluster) Recover(onSet func(*zap.Logger, *semver.Version))
func (c *RaftCluster) RemoveMember(id types.ID, shouldApplyV3 ShouldApplyV3)
RemoveMember removes a member from the store. The given id MUST exist, or the function panics.
func (c *RaftCluster) SetBackend(be backend.Backend)
func (c *RaftCluster) SetDowngradeInfo(d *DowngradeInfo, shouldApplyV3 ShouldApplyV3)
func (c *RaftCluster) SetID(localID, cid types.ID)
func (c *RaftCluster) SetStore(st v2store.Store)
func (c *RaftCluster) SetVersion(ver *semver.Version, onSet func(*zap.Logger, *semver.Version), shouldApplyV3 ShouldApplyV3)
func (c *RaftCluster) String() string
func (c *RaftCluster) UpdateAttributes(id types.ID, attr Attributes, shouldApplyV3 ShouldApplyV3)
func (c *RaftCluster) UpdateRaftAttributes(id types.ID, raftAttr RaftAttributes, shouldApplyV3 ShouldApplyV3)
func (c *RaftCluster) ValidateConfigurationChange(cc raftpb.ConfChange) error
ValidateConfigurationChange takes a proposed ConfChange and ensures that it is still valid.
func (c *RaftCluster) Version() *semver.Version
func (c *RaftCluster) VotingMemberIDs() []types.ID
VotingMemberIDs returns the ID of voting members in cluster.
func (c *RaftCluster) VotingMembers() []*Member
type ShouldApplyV3 bool