membership

package
v3.5.9 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: May 11, 2023 License: Apache-2.0 Imports: 26 Imported by: 23

Documentation

Overview

Package membership describes individual etcd members and clusters of members.

Index

Constants

View Source 
const (
	ApplyBoth        = ShouldApplyV3(true)
	ApplyV2storeOnly = ShouldApplyV3(false)
)

Variables

View Source 
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")
)
View Source 
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"})
)
View Source 
var (
	StoreMembersPrefix = path.Join(storePrefix, "members")
)

Functions

func AllowedDowngradeVersion 

func AllowedDowngradeVersion(ver *semver.Version) *semver.Version

func IsMetaStoreOnly 

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 

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 

func MemberAttributesStorePath(id types.ID) string

func MemberStoreKey 

func MemberStoreKey(id types.ID) string

func MustParseMemberIDFromKey 

func MustParseMemberIDFromKey(lg *zap.Logger, key string) types.ID

func MustUnsafeSaveConfStateToBackend 

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 

func RemovedMemberStoreKey(id types.ID) string

func StoreClusterVersionKey 

func StoreClusterVersionKey() string

func TrimClusterFromBackend 

func TrimClusterFromBackend(be backend.Backend) error

TrimClusterFromBackend removes all information about cluster (versions) from the v3 backend.

func TrimMembershipFromBackend 

func TrimMembershipFromBackend(lg *zap.Logger, be backend.Backend) error

TrimMembershipFromBackend removes all information about members & removed_members from the v3 backend.

func TrimMembershipFromV2Store 

func TrimMembershipFromV2Store(lg *zap.Logger, s v2store.Store) error

TrimMembershipFromV2Store removes all information about members & removed_members from the v2 store.

func UnsafeConfStateFromBackend 

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 

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.

Types

type Attributes 

type Attributes struct {
	Name       string   `json:"name,omitempty"`
	ClientURLs []string `json:"clientURLs,omitempty"`
}

Attributes represents all the non-raft related attributes of an etcd member.

type ConfigChangeContext 

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"`
}

ConfigChangeContext represents a context for confChange.

type DowngradeInfo 

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 (*DowngradeInfo) GetTargetVersion 

func (d *DowngradeInfo) GetTargetVersion() *semver.Version

type Member 

type Member struct {
	ID types.ID `json:"id"`
	RaftAttributes
	Attributes
}

func NewMember 

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 

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 (*Member) Clone 

func (m *Member) Clone() *Member

func (*Member) IsStarted 

func (m *Member) IsStarted() bool

func (*Member) PickPeerURL 

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.

type MembersByID 

type MembersByID []*Member

MembersByID implements sort by ID interface

func (MembersByID) Len 

func (ms MembersByID) Len() int

func (MembersByID) Less 

func (ms MembersByID) Less(i, j int) bool

func (MembersByID) Swap 

func (ms MembersByID) Swap(i, j int)

type MembersByPeerURLs 

type MembersByPeerURLs []*Member

MembersByPeerURLs implements sort by peer urls interface

func (MembersByPeerURLs) Len 

func (ms MembersByPeerURLs) Len() int

func (MembersByPeerURLs) Less 

func (ms MembersByPeerURLs) Less(i, j int) bool

func (MembersByPeerURLs) Swap 

func (ms MembersByPeerURLs) Swap(i, j int)

type RaftAttributes 

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"`
}

RaftAttributes represents the raft related attributes of an etcd member.

type RaftCluster 

type RaftCluster struct {
	sync.Mutex // guards the fields below
	// contains filtered or unexported fields
}

RaftCluster is a list of Members that belong to the same raft cluster

func NewCluster 

func NewCluster(lg *zap.Logger) *RaftCluster

func NewClusterFromMembers 

func NewClusterFromMembers(lg *zap.Logger, id types.ID, membs []*Member) *RaftCluster

func NewClusterFromURLsMap 

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 (*RaftCluster) AddMember 

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 (*RaftCluster) ClientURLs 

func (c *RaftCluster) ClientURLs() []string

ClientURLs returns a list of all client addresses. The returned list is sorted in ascending lexicographical order.

func (*RaftCluster) DowngradeInfo 

func (c *RaftCluster) DowngradeInfo() *DowngradeInfo

DowngradeInfo returns the downgrade status of the cluster

func (*RaftCluster) ID 

func (c *RaftCluster) ID() types.ID

func (*RaftCluster) IsIDRemoved 

func (c *RaftCluster) IsIDRemoved(id types.ID) bool

func (*RaftCluster) IsLocalMemberLearner 

func (c *RaftCluster) IsLocalMemberLearner() bool

IsLocalMemberLearner returns if the local member is raft learner

func (*RaftCluster) IsMemberExist 

func (c *RaftCluster) IsMemberExist(id types.ID) bool

IsMemberExist returns if the member with the given id exists in cluster.

func (*RaftCluster) IsReadyToAddVotingMember 

func (c *RaftCluster) IsReadyToAddVotingMember() bool

func (*RaftCluster) IsReadyToPromoteMember 

func (c *RaftCluster) IsReadyToPromoteMember(id uint64) bool

func (*RaftCluster) IsReadyToRemoveVotingMember 

func (c *RaftCluster) IsReadyToRemoveVotingMember(id uint64) bool

func (*RaftCluster) Member 

func (c *RaftCluster) Member(id types.ID) *Member

func (*RaftCluster) MemberByName 

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 (*RaftCluster) MemberIDs 

func (c *RaftCluster) MemberIDs() []types.ID

func (*RaftCluster) Members 

func (c *RaftCluster) Members() []*Member

func (*RaftCluster) PeerURLs 

func (c *RaftCluster) PeerURLs() []string

PeerURLs returns a list of all peer addresses. The returned list is sorted in ascending lexicographical order.

func (*RaftCluster) PromoteMember 

func (c *RaftCluster) PromoteMember(id types.ID, shouldApplyV3 ShouldApplyV3)

PromoteMember marks the member's IsLearner RaftAttributes to false.

func (*RaftCluster) PushMembershipToStorage 

func (c *RaftCluster) PushMembershipToStorage()

PushMembershipToStorage is overriding storage information about cluster's members, such that they fully reflect internal RaftCluster's storage.

func (*RaftCluster) Recover 

func (c *RaftCluster) Recover(onSet func(*zap.Logger, *semver.Version))

func (*RaftCluster) RemoveMember 

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 (*RaftCluster) SetBackend 

func (c *RaftCluster) SetBackend(be backend.Backend)

func (*RaftCluster) SetDowngradeInfo 

func (c *RaftCluster) SetDowngradeInfo(d *DowngradeInfo, shouldApplyV3 ShouldApplyV3)

func (*RaftCluster) SetID 

func (c *RaftCluster) SetID(localID, cid types.ID)

func (*RaftCluster) SetStore 

func (c *RaftCluster) SetStore(st v2store.Store)

func (*RaftCluster) SetVersion 

func (c *RaftCluster) SetVersion(ver *semver.Version, onSet func(*zap.Logger, *semver.Version), shouldApplyV3 ShouldApplyV3)

func (*RaftCluster) String 

func (c *RaftCluster) String() string

func (*RaftCluster) UpdateAttributes 

func (c *RaftCluster) UpdateAttributes(id types.ID, attr Attributes, shouldApplyV3 ShouldApplyV3)

func (*RaftCluster) UpdateRaftAttributes 

func (c *RaftCluster) UpdateRaftAttributes(id types.ID, raftAttr RaftAttributes, shouldApplyV3 ShouldApplyV3)

func (*RaftCluster) ValidateConfigurationChange 

func (c *RaftCluster) ValidateConfigurationChange(cc raftpb.ConfChange) error

ValidateConfigurationChange takes a proposed ConfChange and ensures that it is still valid.

func (*RaftCluster) Version 

func (c *RaftCluster) Version() *semver.Version

func (*RaftCluster) VotingMemberIDs 

func (c *RaftCluster) VotingMemberIDs() []types.ID

VotingMemberIDs returns the ID of voting members in cluster.

func (*RaftCluster) VotingMembers 

func (c *RaftCluster) VotingMembers() []*Member

type ShouldApplyV3 

type ShouldApplyV3 bool

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.