khenaidoo | ab1f7bd | 2019-11-14 14:00:27 -0500 | [diff] [blame] | 1 | // Copyright 2015 The etcd Authors |
| 2 | // |
| 3 | // Licensed under the Apache License, Version 2.0 (the "License"); |
| 4 | // you may not use this file except in compliance with the License. |
| 5 | // You may obtain a copy of the License at |
| 6 | // |
| 7 | // http://www.apache.org/licenses/LICENSE-2.0 |
| 8 | // |
| 9 | // Unless required by applicable law or agreed to in writing, software |
| 10 | // distributed under the License is distributed on an "AS IS" BASIS, |
| 11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 12 | // See the License for the specific language governing permissions and |
| 13 | // limitations under the License. |
| 14 | |
| 15 | package membership |
| 16 | |
| 17 | import ( |
| 18 | "bytes" |
| 19 | "context" |
| 20 | "crypto/sha1" |
| 21 | "encoding/binary" |
| 22 | "encoding/json" |
| 23 | "fmt" |
| 24 | "path" |
| 25 | "sort" |
| 26 | "strings" |
| 27 | "sync" |
| 28 | "time" |
| 29 | |
| 30 | "go.etcd.io/etcd/etcdserver/api/v2store" |
| 31 | "go.etcd.io/etcd/mvcc/backend" |
| 32 | "go.etcd.io/etcd/pkg/netutil" |
| 33 | "go.etcd.io/etcd/pkg/types" |
| 34 | "go.etcd.io/etcd/raft" |
| 35 | "go.etcd.io/etcd/raft/raftpb" |
| 36 | "go.etcd.io/etcd/version" |
| 37 | |
| 38 | "github.com/coreos/go-semver/semver" |
| 39 | "github.com/prometheus/client_golang/prometheus" |
| 40 | "go.uber.org/zap" |
| 41 | ) |
| 42 | |
| 43 | const maxLearners = 1 |
| 44 | |
| 45 | // RaftCluster is a list of Members that belong to the same raft cluster |
| 46 | type RaftCluster struct { |
| 47 | lg *zap.Logger |
| 48 | |
| 49 | localID types.ID |
| 50 | cid types.ID |
| 51 | token string |
| 52 | |
| 53 | v2store v2store.Store |
| 54 | be backend.Backend |
| 55 | |
| 56 | sync.Mutex // guards the fields below |
| 57 | version *semver.Version |
| 58 | members map[types.ID]*Member |
| 59 | // removed contains the ids of removed members in the cluster. |
| 60 | // removed id cannot be reused. |
| 61 | removed map[types.ID]bool |
| 62 | } |
| 63 | |
| 64 | // ConfigChangeContext represents a context for confChange. |
| 65 | type ConfigChangeContext struct { |
| 66 | Member |
| 67 | // IsPromote indicates if the config change is for promoting a learner member. |
| 68 | // This flag is needed because both adding a new member and promoting a learner member |
| 69 | // uses the same config change type 'ConfChangeAddNode'. |
| 70 | IsPromote bool `json:"isPromote"` |
| 71 | } |
| 72 | |
| 73 | // NewClusterFromURLsMap creates a new raft cluster using provided urls map. Currently, it does not support creating |
| 74 | // cluster with raft learner member. |
| 75 | func NewClusterFromURLsMap(lg *zap.Logger, token string, urlsmap types.URLsMap) (*RaftCluster, error) { |
| 76 | c := NewCluster(lg, token) |
| 77 | for name, urls := range urlsmap { |
| 78 | m := NewMember(name, urls, token, nil) |
| 79 | if _, ok := c.members[m.ID]; ok { |
| 80 | return nil, fmt.Errorf("member exists with identical ID %v", m) |
| 81 | } |
| 82 | if uint64(m.ID) == raft.None { |
| 83 | return nil, fmt.Errorf("cannot use %x as member id", raft.None) |
| 84 | } |
| 85 | c.members[m.ID] = m |
| 86 | } |
| 87 | c.genID() |
| 88 | return c, nil |
| 89 | } |
| 90 | |
| 91 | func NewClusterFromMembers(lg *zap.Logger, token string, id types.ID, membs []*Member) *RaftCluster { |
| 92 | c := NewCluster(lg, token) |
| 93 | c.cid = id |
| 94 | for _, m := range membs { |
| 95 | c.members[m.ID] = m |
| 96 | } |
| 97 | return c |
| 98 | } |
| 99 | |
| 100 | func NewCluster(lg *zap.Logger, token string) *RaftCluster { |
| 101 | return &RaftCluster{ |
| 102 | lg: lg, |
| 103 | token: token, |
| 104 | members: make(map[types.ID]*Member), |
| 105 | removed: make(map[types.ID]bool), |
| 106 | } |
| 107 | } |
| 108 | |
| 109 | func (c *RaftCluster) ID() types.ID { return c.cid } |
| 110 | |
| 111 | func (c *RaftCluster) Members() []*Member { |
| 112 | c.Lock() |
| 113 | defer c.Unlock() |
| 114 | var ms MembersByID |
| 115 | for _, m := range c.members { |
| 116 | ms = append(ms, m.Clone()) |
| 117 | } |
| 118 | sort.Sort(ms) |
| 119 | return []*Member(ms) |
| 120 | } |
| 121 | |
| 122 | func (c *RaftCluster) Member(id types.ID) *Member { |
| 123 | c.Lock() |
| 124 | defer c.Unlock() |
| 125 | return c.members[id].Clone() |
| 126 | } |
| 127 | |
| 128 | func (c *RaftCluster) VotingMembers() []*Member { |
| 129 | c.Lock() |
| 130 | defer c.Unlock() |
| 131 | var ms MembersByID |
| 132 | for _, m := range c.members { |
| 133 | if !m.IsLearner { |
| 134 | ms = append(ms, m.Clone()) |
| 135 | } |
| 136 | } |
| 137 | sort.Sort(ms) |
| 138 | return []*Member(ms) |
| 139 | } |
| 140 | |
| 141 | // MemberByName returns a Member with the given name if exists. |
| 142 | // If more than one member has the given name, it will panic. |
| 143 | func (c *RaftCluster) MemberByName(name string) *Member { |
| 144 | c.Lock() |
| 145 | defer c.Unlock() |
| 146 | var memb *Member |
| 147 | for _, m := range c.members { |
| 148 | if m.Name == name { |
| 149 | if memb != nil { |
| 150 | if c.lg != nil { |
| 151 | c.lg.Panic("two member with same name found", zap.String("name", name)) |
| 152 | } else { |
| 153 | plog.Panicf("two members with the given name %q exist", name) |
| 154 | } |
| 155 | } |
| 156 | memb = m |
| 157 | } |
| 158 | } |
| 159 | return memb.Clone() |
| 160 | } |
| 161 | |
| 162 | func (c *RaftCluster) MemberIDs() []types.ID { |
| 163 | c.Lock() |
| 164 | defer c.Unlock() |
| 165 | var ids []types.ID |
| 166 | for _, m := range c.members { |
| 167 | ids = append(ids, m.ID) |
| 168 | } |
| 169 | sort.Sort(types.IDSlice(ids)) |
| 170 | return ids |
| 171 | } |
| 172 | |
| 173 | func (c *RaftCluster) IsIDRemoved(id types.ID) bool { |
| 174 | c.Lock() |
| 175 | defer c.Unlock() |
| 176 | return c.removed[id] |
| 177 | } |
| 178 | |
| 179 | // PeerURLs returns a list of all peer addresses. |
| 180 | // The returned list is sorted in ascending lexicographical order. |
| 181 | func (c *RaftCluster) PeerURLs() []string { |
| 182 | c.Lock() |
| 183 | defer c.Unlock() |
| 184 | urls := make([]string, 0) |
| 185 | for _, p := range c.members { |
| 186 | urls = append(urls, p.PeerURLs...) |
| 187 | } |
| 188 | sort.Strings(urls) |
| 189 | return urls |
| 190 | } |
| 191 | |
| 192 | // ClientURLs returns a list of all client addresses. |
| 193 | // The returned list is sorted in ascending lexicographical order. |
| 194 | func (c *RaftCluster) ClientURLs() []string { |
| 195 | c.Lock() |
| 196 | defer c.Unlock() |
| 197 | urls := make([]string, 0) |
| 198 | for _, p := range c.members { |
| 199 | urls = append(urls, p.ClientURLs...) |
| 200 | } |
| 201 | sort.Strings(urls) |
| 202 | return urls |
| 203 | } |
| 204 | |
| 205 | func (c *RaftCluster) String() string { |
| 206 | c.Lock() |
| 207 | defer c.Unlock() |
| 208 | b := &bytes.Buffer{} |
| 209 | fmt.Fprintf(b, "{ClusterID:%s ", c.cid) |
| 210 | var ms []string |
| 211 | for _, m := range c.members { |
| 212 | ms = append(ms, fmt.Sprintf("%+v", m)) |
| 213 | } |
| 214 | fmt.Fprintf(b, "Members:[%s] ", strings.Join(ms, " ")) |
| 215 | var ids []string |
| 216 | for id := range c.removed { |
| 217 | ids = append(ids, id.String()) |
| 218 | } |
| 219 | fmt.Fprintf(b, "RemovedMemberIDs:[%s]}", strings.Join(ids, " ")) |
| 220 | return b.String() |
| 221 | } |
| 222 | |
| 223 | func (c *RaftCluster) genID() { |
| 224 | mIDs := c.MemberIDs() |
| 225 | b := make([]byte, 8*len(mIDs)) |
| 226 | for i, id := range mIDs { |
| 227 | binary.BigEndian.PutUint64(b[8*i:], uint64(id)) |
| 228 | } |
| 229 | hash := sha1.Sum(b) |
| 230 | c.cid = types.ID(binary.BigEndian.Uint64(hash[:8])) |
| 231 | } |
| 232 | |
| 233 | func (c *RaftCluster) SetID(localID, cid types.ID) { |
| 234 | c.localID = localID |
| 235 | c.cid = cid |
| 236 | } |
| 237 | |
| 238 | func (c *RaftCluster) SetStore(st v2store.Store) { c.v2store = st } |
| 239 | |
| 240 | func (c *RaftCluster) SetBackend(be backend.Backend) { |
| 241 | c.be = be |
| 242 | mustCreateBackendBuckets(c.be) |
| 243 | } |
| 244 | |
| 245 | func (c *RaftCluster) Recover(onSet func(*zap.Logger, *semver.Version)) { |
| 246 | c.Lock() |
| 247 | defer c.Unlock() |
| 248 | |
| 249 | c.members, c.removed = membersFromStore(c.lg, c.v2store) |
| 250 | c.version = clusterVersionFromStore(c.lg, c.v2store) |
| 251 | mustDetectDowngrade(c.lg, c.version) |
| 252 | onSet(c.lg, c.version) |
| 253 | |
| 254 | for _, m := range c.members { |
| 255 | if c.lg != nil { |
| 256 | c.lg.Info( |
| 257 | "recovered/added member from store", |
| 258 | zap.String("cluster-id", c.cid.String()), |
| 259 | zap.String("local-member-id", c.localID.String()), |
| 260 | zap.String("recovered-remote-peer-id", m.ID.String()), |
| 261 | zap.Strings("recovered-remote-peer-urls", m.PeerURLs), |
| 262 | ) |
| 263 | } else { |
| 264 | plog.Infof("added member %s %v to cluster %s from store", m.ID, m.PeerURLs, c.cid) |
| 265 | } |
| 266 | } |
| 267 | if c.version != nil { |
| 268 | if c.lg != nil { |
| 269 | c.lg.Info( |
| 270 | "set cluster version from store", |
| 271 | zap.String("cluster-version", version.Cluster(c.version.String())), |
| 272 | ) |
| 273 | } else { |
| 274 | plog.Infof("set the cluster version to %v from store", version.Cluster(c.version.String())) |
| 275 | } |
| 276 | } |
| 277 | } |
| 278 | |
| 279 | // ValidateConfigurationChange takes a proposed ConfChange and |
| 280 | // ensures that it is still valid. |
| 281 | func (c *RaftCluster) ValidateConfigurationChange(cc raftpb.ConfChange) error { |
| 282 | members, removed := membersFromStore(c.lg, c.v2store) |
| 283 | id := types.ID(cc.NodeID) |
| 284 | if removed[id] { |
| 285 | return ErrIDRemoved |
| 286 | } |
| 287 | switch cc.Type { |
| 288 | case raftpb.ConfChangeAddNode, raftpb.ConfChangeAddLearnerNode: |
| 289 | confChangeContext := new(ConfigChangeContext) |
| 290 | if err := json.Unmarshal(cc.Context, confChangeContext); err != nil { |
| 291 | if c.lg != nil { |
| 292 | c.lg.Panic("failed to unmarshal confChangeContext", zap.Error(err)) |
| 293 | } else { |
| 294 | plog.Panicf("unmarshal confChangeContext should never fail: %v", err) |
| 295 | } |
| 296 | } |
| 297 | |
| 298 | if confChangeContext.IsPromote { // promoting a learner member to voting member |
| 299 | if members[id] == nil { |
| 300 | return ErrIDNotFound |
| 301 | } |
| 302 | if !members[id].IsLearner { |
| 303 | return ErrMemberNotLearner |
| 304 | } |
| 305 | } else { // adding a new member |
| 306 | if members[id] != nil { |
| 307 | return ErrIDExists |
| 308 | } |
| 309 | |
| 310 | urls := make(map[string]bool) |
| 311 | for _, m := range members { |
| 312 | for _, u := range m.PeerURLs { |
| 313 | urls[u] = true |
| 314 | } |
| 315 | } |
| 316 | for _, u := range confChangeContext.Member.PeerURLs { |
| 317 | if urls[u] { |
| 318 | return ErrPeerURLexists |
| 319 | } |
| 320 | } |
| 321 | |
| 322 | if confChangeContext.Member.IsLearner { // the new member is a learner |
| 323 | numLearners := 0 |
| 324 | for _, m := range members { |
| 325 | if m.IsLearner { |
| 326 | numLearners++ |
| 327 | } |
| 328 | } |
| 329 | if numLearners+1 > maxLearners { |
| 330 | return ErrTooManyLearners |
| 331 | } |
| 332 | } |
| 333 | } |
| 334 | case raftpb.ConfChangeRemoveNode: |
| 335 | if members[id] == nil { |
| 336 | return ErrIDNotFound |
| 337 | } |
| 338 | |
| 339 | case raftpb.ConfChangeUpdateNode: |
| 340 | if members[id] == nil { |
| 341 | return ErrIDNotFound |
| 342 | } |
| 343 | urls := make(map[string]bool) |
| 344 | for _, m := range members { |
| 345 | if m.ID == id { |
| 346 | continue |
| 347 | } |
| 348 | for _, u := range m.PeerURLs { |
| 349 | urls[u] = true |
| 350 | } |
| 351 | } |
| 352 | m := new(Member) |
| 353 | if err := json.Unmarshal(cc.Context, m); err != nil { |
| 354 | if c.lg != nil { |
| 355 | c.lg.Panic("failed to unmarshal member", zap.Error(err)) |
| 356 | } else { |
| 357 | plog.Panicf("unmarshal member should never fail: %v", err) |
| 358 | } |
| 359 | } |
| 360 | for _, u := range m.PeerURLs { |
| 361 | if urls[u] { |
| 362 | return ErrPeerURLexists |
| 363 | } |
| 364 | } |
| 365 | |
| 366 | default: |
| 367 | if c.lg != nil { |
| 368 | c.lg.Panic("unknown ConfChange type", zap.String("type", cc.Type.String())) |
| 369 | } else { |
| 370 | plog.Panicf("ConfChange type should be either AddNode, RemoveNode or UpdateNode") |
| 371 | } |
| 372 | } |
| 373 | return nil |
| 374 | } |
| 375 | |
| 376 | // AddMember adds a new Member into the cluster, and saves the given member's |
| 377 | // raftAttributes into the store. The given member should have empty attributes. |
| 378 | // A Member with a matching id must not exist. |
| 379 | func (c *RaftCluster) AddMember(m *Member) { |
| 380 | c.Lock() |
| 381 | defer c.Unlock() |
| 382 | if c.v2store != nil { |
| 383 | mustSaveMemberToStore(c.v2store, m) |
| 384 | } |
| 385 | if c.be != nil { |
| 386 | mustSaveMemberToBackend(c.be, m) |
| 387 | } |
| 388 | |
| 389 | c.members[m.ID] = m |
| 390 | |
| 391 | if c.lg != nil { |
| 392 | c.lg.Info( |
| 393 | "added member", |
| 394 | zap.String("cluster-id", c.cid.String()), |
| 395 | zap.String("local-member-id", c.localID.String()), |
| 396 | zap.String("added-peer-id", m.ID.String()), |
| 397 | zap.Strings("added-peer-peer-urls", m.PeerURLs), |
| 398 | ) |
| 399 | } else { |
| 400 | plog.Infof("added member %s %v to cluster %s", m.ID, m.PeerURLs, c.cid) |
| 401 | } |
| 402 | } |
| 403 | |
| 404 | // RemoveMember removes a member from the store. |
| 405 | // The given id MUST exist, or the function panics. |
| 406 | func (c *RaftCluster) RemoveMember(id types.ID) { |
| 407 | c.Lock() |
| 408 | defer c.Unlock() |
| 409 | if c.v2store != nil { |
| 410 | mustDeleteMemberFromStore(c.v2store, id) |
| 411 | } |
| 412 | if c.be != nil { |
| 413 | mustDeleteMemberFromBackend(c.be, id) |
| 414 | } |
| 415 | |
| 416 | m, ok := c.members[id] |
| 417 | delete(c.members, id) |
| 418 | c.removed[id] = true |
| 419 | |
| 420 | if c.lg != nil { |
| 421 | if ok { |
| 422 | c.lg.Info( |
| 423 | "removed member", |
| 424 | zap.String("cluster-id", c.cid.String()), |
| 425 | zap.String("local-member-id", c.localID.String()), |
| 426 | zap.String("removed-remote-peer-id", id.String()), |
| 427 | zap.Strings("removed-remote-peer-urls", m.PeerURLs), |
| 428 | ) |
| 429 | } else { |
| 430 | c.lg.Warn( |
| 431 | "skipped removing already removed member", |
| 432 | zap.String("cluster-id", c.cid.String()), |
| 433 | zap.String("local-member-id", c.localID.String()), |
| 434 | zap.String("removed-remote-peer-id", id.String()), |
| 435 | ) |
| 436 | } |
| 437 | } else { |
| 438 | plog.Infof("removed member %s from cluster %s", id, c.cid) |
| 439 | } |
| 440 | } |
| 441 | |
| 442 | func (c *RaftCluster) UpdateAttributes(id types.ID, attr Attributes) { |
| 443 | c.Lock() |
| 444 | defer c.Unlock() |
| 445 | |
| 446 | if m, ok := c.members[id]; ok { |
| 447 | m.Attributes = attr |
| 448 | if c.v2store != nil { |
| 449 | mustUpdateMemberAttrInStore(c.v2store, m) |
| 450 | } |
| 451 | if c.be != nil { |
| 452 | mustSaveMemberToBackend(c.be, m) |
| 453 | } |
| 454 | return |
| 455 | } |
| 456 | |
| 457 | _, ok := c.removed[id] |
| 458 | if !ok { |
| 459 | if c.lg != nil { |
| 460 | c.lg.Panic( |
| 461 | "failed to update; member unknown", |
| 462 | zap.String("cluster-id", c.cid.String()), |
| 463 | zap.String("local-member-id", c.localID.String()), |
| 464 | zap.String("unknown-remote-peer-id", id.String()), |
| 465 | ) |
| 466 | } else { |
| 467 | plog.Panicf("error updating attributes of unknown member %s", id) |
| 468 | } |
| 469 | } |
| 470 | |
| 471 | if c.lg != nil { |
| 472 | c.lg.Warn( |
| 473 | "skipped attributes update of removed member", |
| 474 | zap.String("cluster-id", c.cid.String()), |
| 475 | zap.String("local-member-id", c.localID.String()), |
| 476 | zap.String("updated-peer-id", id.String()), |
| 477 | ) |
| 478 | } else { |
| 479 | plog.Warningf("skipped updating attributes of removed member %s", id) |
| 480 | } |
| 481 | } |
| 482 | |
| 483 | // PromoteMember marks the member's IsLearner RaftAttributes to false. |
| 484 | func (c *RaftCluster) PromoteMember(id types.ID) { |
| 485 | c.Lock() |
| 486 | defer c.Unlock() |
| 487 | |
| 488 | c.members[id].RaftAttributes.IsLearner = false |
| 489 | if c.v2store != nil { |
| 490 | mustUpdateMemberInStore(c.v2store, c.members[id]) |
| 491 | } |
| 492 | if c.be != nil { |
| 493 | mustSaveMemberToBackend(c.be, c.members[id]) |
| 494 | } |
| 495 | |
| 496 | if c.lg != nil { |
| 497 | c.lg.Info( |
| 498 | "promote member", |
| 499 | zap.String("cluster-id", c.cid.String()), |
| 500 | zap.String("local-member-id", c.localID.String()), |
| 501 | ) |
| 502 | } else { |
| 503 | plog.Noticef("promote member %s in cluster %s", id, c.cid) |
| 504 | } |
| 505 | } |
| 506 | |
| 507 | func (c *RaftCluster) UpdateRaftAttributes(id types.ID, raftAttr RaftAttributes) { |
| 508 | c.Lock() |
| 509 | defer c.Unlock() |
| 510 | |
| 511 | c.members[id].RaftAttributes = raftAttr |
| 512 | if c.v2store != nil { |
| 513 | mustUpdateMemberInStore(c.v2store, c.members[id]) |
| 514 | } |
| 515 | if c.be != nil { |
| 516 | mustSaveMemberToBackend(c.be, c.members[id]) |
| 517 | } |
| 518 | |
| 519 | if c.lg != nil { |
| 520 | c.lg.Info( |
| 521 | "updated member", |
| 522 | zap.String("cluster-id", c.cid.String()), |
| 523 | zap.String("local-member-id", c.localID.String()), |
| 524 | zap.String("updated-remote-peer-id", id.String()), |
| 525 | zap.Strings("updated-remote-peer-urls", raftAttr.PeerURLs), |
| 526 | ) |
| 527 | } else { |
| 528 | plog.Noticef("updated member %s %v in cluster %s", id, raftAttr.PeerURLs, c.cid) |
| 529 | } |
| 530 | } |
| 531 | |
| 532 | func (c *RaftCluster) Version() *semver.Version { |
| 533 | c.Lock() |
| 534 | defer c.Unlock() |
| 535 | if c.version == nil { |
| 536 | return nil |
| 537 | } |
| 538 | return semver.Must(semver.NewVersion(c.version.String())) |
| 539 | } |
| 540 | |
| 541 | func (c *RaftCluster) SetVersion(ver *semver.Version, onSet func(*zap.Logger, *semver.Version)) { |
| 542 | c.Lock() |
| 543 | defer c.Unlock() |
| 544 | if c.version != nil { |
| 545 | if c.lg != nil { |
| 546 | c.lg.Info( |
| 547 | "updated cluster version", |
| 548 | zap.String("cluster-id", c.cid.String()), |
| 549 | zap.String("local-member-id", c.localID.String()), |
| 550 | zap.String("from", version.Cluster(c.version.String())), |
| 551 | zap.String("from", version.Cluster(ver.String())), |
| 552 | ) |
| 553 | } else { |
| 554 | plog.Noticef("updated the cluster version from %v to %v", version.Cluster(c.version.String()), version.Cluster(ver.String())) |
| 555 | } |
| 556 | } else { |
| 557 | if c.lg != nil { |
| 558 | c.lg.Info( |
| 559 | "set initial cluster version", |
| 560 | zap.String("cluster-id", c.cid.String()), |
| 561 | zap.String("local-member-id", c.localID.String()), |
| 562 | zap.String("cluster-version", version.Cluster(ver.String())), |
| 563 | ) |
| 564 | } else { |
| 565 | plog.Noticef("set the initial cluster version to %v", version.Cluster(ver.String())) |
| 566 | } |
| 567 | } |
| 568 | c.version = ver |
| 569 | mustDetectDowngrade(c.lg, c.version) |
| 570 | if c.v2store != nil { |
| 571 | mustSaveClusterVersionToStore(c.v2store, ver) |
| 572 | } |
| 573 | if c.be != nil { |
| 574 | mustSaveClusterVersionToBackend(c.be, ver) |
| 575 | } |
| 576 | ClusterVersionMetrics.With(prometheus.Labels{"cluster_version": ver.String()}).Set(1) |
| 577 | onSet(c.lg, ver) |
| 578 | } |
| 579 | |
| 580 | func (c *RaftCluster) IsReadyToAddVotingMember() bool { |
| 581 | nmembers := 1 |
| 582 | nstarted := 0 |
| 583 | |
| 584 | for _, member := range c.VotingMembers() { |
| 585 | if member.IsStarted() { |
| 586 | nstarted++ |
| 587 | } |
| 588 | nmembers++ |
| 589 | } |
| 590 | |
| 591 | if nstarted == 1 && nmembers == 2 { |
| 592 | // a case of adding a new node to 1-member cluster for restoring cluster data |
| 593 | // https://github.com/etcd-io/etcd/blob/master/Documentation/v2/admin_guide.md#restoring-the-cluster |
| 594 | if c.lg != nil { |
| 595 | c.lg.Debug("number of started member is 1; can accept add member request") |
| 596 | } else { |
| 597 | plog.Debugf("The number of started member is 1. This cluster can accept add member request.") |
| 598 | } |
| 599 | return true |
| 600 | } |
| 601 | |
| 602 | nquorum := nmembers/2 + 1 |
| 603 | if nstarted < nquorum { |
| 604 | if c.lg != nil { |
| 605 | c.lg.Warn( |
| 606 | "rejecting member add; started member will be less than quorum", |
| 607 | zap.Int("number-of-started-member", nstarted), |
| 608 | zap.Int("quorum", nquorum), |
| 609 | zap.String("cluster-id", c.cid.String()), |
| 610 | zap.String("local-member-id", c.localID.String()), |
| 611 | ) |
| 612 | } else { |
| 613 | plog.Warningf("Reject add member request: the number of started member (%d) will be less than the quorum number of the cluster (%d)", nstarted, nquorum) |
| 614 | } |
| 615 | return false |
| 616 | } |
| 617 | |
| 618 | return true |
| 619 | } |
| 620 | |
| 621 | func (c *RaftCluster) IsReadyToRemoveVotingMember(id uint64) bool { |
| 622 | nmembers := 0 |
| 623 | nstarted := 0 |
| 624 | |
| 625 | for _, member := range c.VotingMembers() { |
| 626 | if uint64(member.ID) == id { |
| 627 | continue |
| 628 | } |
| 629 | |
| 630 | if member.IsStarted() { |
| 631 | nstarted++ |
| 632 | } |
| 633 | nmembers++ |
| 634 | } |
| 635 | |
| 636 | nquorum := nmembers/2 + 1 |
| 637 | if nstarted < nquorum { |
| 638 | if c.lg != nil { |
| 639 | c.lg.Warn( |
| 640 | "rejecting member remove; started member will be less than quorum", |
| 641 | zap.Int("number-of-started-member", nstarted), |
| 642 | zap.Int("quorum", nquorum), |
| 643 | zap.String("cluster-id", c.cid.String()), |
| 644 | zap.String("local-member-id", c.localID.String()), |
| 645 | ) |
| 646 | } else { |
| 647 | plog.Warningf("Reject remove member request: the number of started member (%d) will be less than the quorum number of the cluster (%d)", nstarted, nquorum) |
| 648 | } |
| 649 | return false |
| 650 | } |
| 651 | |
| 652 | return true |
| 653 | } |
| 654 | |
| 655 | func (c *RaftCluster) IsReadyToPromoteMember(id uint64) bool { |
| 656 | nmembers := 1 |
| 657 | nstarted := 0 |
| 658 | |
| 659 | for _, member := range c.VotingMembers() { |
| 660 | if member.IsStarted() { |
| 661 | nstarted++ |
| 662 | } |
| 663 | nmembers++ |
| 664 | } |
| 665 | |
| 666 | nquorum := nmembers/2 + 1 |
| 667 | if nstarted < nquorum { |
| 668 | if c.lg != nil { |
| 669 | c.lg.Warn( |
| 670 | "rejecting member promote; started member will be less than quorum", |
| 671 | zap.Int("number-of-started-member", nstarted), |
| 672 | zap.Int("quorum", nquorum), |
| 673 | zap.String("cluster-id", c.cid.String()), |
| 674 | zap.String("local-member-id", c.localID.String()), |
| 675 | ) |
| 676 | } else { |
| 677 | plog.Warningf("Reject promote member request: the number of started member (%d) will be less than the quorum number of the cluster (%d)", nstarted, nquorum) |
| 678 | } |
| 679 | return false |
| 680 | } |
| 681 | |
| 682 | return true |
| 683 | } |
| 684 | |
| 685 | func membersFromStore(lg *zap.Logger, st v2store.Store) (map[types.ID]*Member, map[types.ID]bool) { |
| 686 | members := make(map[types.ID]*Member) |
| 687 | removed := make(map[types.ID]bool) |
| 688 | e, err := st.Get(StoreMembersPrefix, true, true) |
| 689 | if err != nil { |
| 690 | if isKeyNotFound(err) { |
| 691 | return members, removed |
| 692 | } |
| 693 | if lg != nil { |
| 694 | lg.Panic("failed to get members from store", zap.String("path", StoreMembersPrefix), zap.Error(err)) |
| 695 | } else { |
| 696 | plog.Panicf("get storeMembers should never fail: %v", err) |
| 697 | } |
| 698 | } |
| 699 | for _, n := range e.Node.Nodes { |
| 700 | var m *Member |
| 701 | m, err = nodeToMember(n) |
| 702 | if err != nil { |
| 703 | if lg != nil { |
| 704 | lg.Panic("failed to nodeToMember", zap.Error(err)) |
| 705 | } else { |
| 706 | plog.Panicf("nodeToMember should never fail: %v", err) |
| 707 | } |
| 708 | } |
| 709 | members[m.ID] = m |
| 710 | } |
| 711 | |
| 712 | e, err = st.Get(storeRemovedMembersPrefix, true, true) |
| 713 | if err != nil { |
| 714 | if isKeyNotFound(err) { |
| 715 | return members, removed |
| 716 | } |
| 717 | if lg != nil { |
| 718 | lg.Panic( |
| 719 | "failed to get removed members from store", |
| 720 | zap.String("path", storeRemovedMembersPrefix), |
| 721 | zap.Error(err), |
| 722 | ) |
| 723 | } else { |
| 724 | plog.Panicf("get storeRemovedMembers should never fail: %v", err) |
| 725 | } |
| 726 | } |
| 727 | for _, n := range e.Node.Nodes { |
| 728 | removed[MustParseMemberIDFromKey(n.Key)] = true |
| 729 | } |
| 730 | return members, removed |
| 731 | } |
| 732 | |
| 733 | func clusterVersionFromStore(lg *zap.Logger, st v2store.Store) *semver.Version { |
| 734 | e, err := st.Get(path.Join(storePrefix, "version"), false, false) |
| 735 | if err != nil { |
| 736 | if isKeyNotFound(err) { |
| 737 | return nil |
| 738 | } |
| 739 | if lg != nil { |
| 740 | lg.Panic( |
| 741 | "failed to get cluster version from store", |
| 742 | zap.String("path", path.Join(storePrefix, "version")), |
| 743 | zap.Error(err), |
| 744 | ) |
| 745 | } else { |
| 746 | plog.Panicf("unexpected error (%v) when getting cluster version from store", err) |
| 747 | } |
| 748 | } |
| 749 | return semver.Must(semver.NewVersion(*e.Node.Value)) |
| 750 | } |
| 751 | |
| 752 | // ValidateClusterAndAssignIDs validates the local cluster by matching the PeerURLs |
| 753 | // with the existing cluster. If the validation succeeds, it assigns the IDs |
| 754 | // from the existing cluster to the local cluster. |
| 755 | // If the validation fails, an error will be returned. |
| 756 | func ValidateClusterAndAssignIDs(lg *zap.Logger, local *RaftCluster, existing *RaftCluster) error { |
| 757 | ems := existing.Members() |
| 758 | lms := local.Members() |
| 759 | if len(ems) != len(lms) { |
| 760 | return fmt.Errorf("member count is unequal") |
| 761 | } |
| 762 | |
| 763 | ctx, cancel := context.WithTimeout(context.TODO(), 30*time.Second) |
| 764 | defer cancel() |
| 765 | for i := range ems { |
| 766 | var err error |
| 767 | ok := false |
| 768 | for j := range lms { |
| 769 | if ok, err = netutil.URLStringsEqual(ctx, lg, ems[i].PeerURLs, lms[j].PeerURLs); ok { |
| 770 | lms[j].ID = ems[i].ID |
| 771 | break |
| 772 | } |
| 773 | } |
| 774 | if !ok { |
| 775 | return fmt.Errorf("PeerURLs: no match found for existing member (%v, %v), last resolver error (%v)", ems[i].ID, ems[i].PeerURLs, err) |
| 776 | } |
| 777 | } |
| 778 | local.members = make(map[types.ID]*Member) |
| 779 | for _, m := range lms { |
| 780 | local.members[m.ID] = m |
| 781 | } |
| 782 | return nil |
| 783 | } |
| 784 | |
| 785 | func mustDetectDowngrade(lg *zap.Logger, cv *semver.Version) { |
| 786 | lv := semver.Must(semver.NewVersion(version.Version)) |
| 787 | // only keep major.minor version for comparison against cluster version |
| 788 | lv = &semver.Version{Major: lv.Major, Minor: lv.Minor} |
| 789 | if cv != nil && lv.LessThan(*cv) { |
| 790 | if lg != nil { |
| 791 | lg.Fatal( |
| 792 | "invalid downgrade; server version is lower than determined cluster version", |
| 793 | zap.String("current-server-version", version.Version), |
| 794 | zap.String("determined-cluster-version", version.Cluster(cv.String())), |
| 795 | ) |
| 796 | } else { |
| 797 | plog.Fatalf("cluster cannot be downgraded (current version: %s is lower than determined cluster version: %s).", version.Version, version.Cluster(cv.String())) |
| 798 | } |
| 799 | } |
| 800 | } |
| 801 | |
| 802 | // IsLocalMemberLearner returns if the local member is raft learner |
| 803 | func (c *RaftCluster) IsLocalMemberLearner() bool { |
| 804 | c.Lock() |
| 805 | defer c.Unlock() |
| 806 | localMember, ok := c.members[c.localID] |
| 807 | if !ok { |
| 808 | if c.lg != nil { |
| 809 | c.lg.Panic( |
| 810 | "failed to find local ID in cluster members", |
| 811 | zap.String("cluster-id", c.cid.String()), |
| 812 | zap.String("local-member-id", c.localID.String()), |
| 813 | ) |
| 814 | } else { |
| 815 | plog.Panicf("failed to find local ID %s in cluster %s", c.localID.String(), c.cid.String()) |
| 816 | } |
| 817 | } |
| 818 | return localMember.IsLearner |
| 819 | } |
| 820 | |
| 821 | // IsMemberExist returns if the member with the given id exists in cluster. |
| 822 | func (c *RaftCluster) IsMemberExist(id types.ID) bool { |
| 823 | c.Lock() |
| 824 | defer c.Unlock() |
| 825 | _, ok := c.members[id] |
| 826 | return ok |
| 827 | } |
| 828 | |
| 829 | // VotingMemberIDs returns the ID of voting members in cluster. |
| 830 | func (c *RaftCluster) VotingMemberIDs() []types.ID { |
| 831 | c.Lock() |
| 832 | defer c.Unlock() |
| 833 | var ids []types.ID |
| 834 | for _, m := range c.members { |
| 835 | if !m.IsLearner { |
| 836 | ids = append(ids, m.ID) |
| 837 | } |
| 838 | } |
| 839 | sort.Sort(types.IDSlice(ids)) |
| 840 | return ids |
| 841 | } |