// Copyright 2021 The etcd Authors // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at // // http://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. package version import ( "github.com/coreos/go-semver/semver" "go.etcd.io/etcd/api/v3/version" "go.uber.org/zap" ) // Monitor contains logic used by cluster leader to monitor version changes and decide on cluster version or downgrade progress. type Monitor struct { lg *zap.Logger s Server } // Server lists EtcdServer methods needed by Monitor type Server interface { GetClusterVersion() *semver.Version GetDowngradeInfo() *DowngradeInfo GetMembersVersions() map[string]*version.Versions UpdateClusterVersion(string) DowngradeCancel() GetStorageVersion() *semver.Version UpdateStorageVersion(semver.Version) Lock() Unlock() } func NewMonitor(lg *zap.Logger, storage Server) *Monitor { return &Monitor{ lg: lg, s: storage, } } // UpdateClusterVersionIfNeeded updates the cluster version. func (m *Monitor) UpdateClusterVersionIfNeeded() { newClusterVersion := m.decideClusterVersion() if newClusterVersion != nil { newClusterVersion = &semver.Version{Major: newClusterVersion.Major, Minor: newClusterVersion.Minor} m.s.UpdateClusterVersion(newClusterVersion.String()) } } // decideClusterVersion decides the cluster version based on the members versions if all members agree on a higher one. func (m *Monitor) decideClusterVersion() *semver.Version { clusterVersion := m.s.GetClusterVersion() membersMinimalVersion := m.membersMinimalVersion() if clusterVersion == nil { if membersMinimalVersion != nil { return membersMinimalVersion } return semver.New(version.MinClusterVersion) } if membersMinimalVersion != nil && clusterVersion.LessThan(*membersMinimalVersion) && IsValidVersionChange(clusterVersion, membersMinimalVersion) { return membersMinimalVersion } return nil } // UpdateStorageVersionIfNeeded updates the storage version if it differs from cluster version. func (m *Monitor) UpdateStorageVersionIfNeeded() { cv := m.s.GetClusterVersion() if cv == nil { return } m.s.Lock() defer m.s.Unlock() sv := m.s.GetStorageVersion() if sv == nil || sv.Major != cv.Major || sv.Minor != cv.Minor { if sv != nil { m.lg.Info("storage version differs from storage version.", zap.String("cluster-version", cv.String()), zap.String("storage-version", sv.String())) } m.s.UpdateStorageVersion(semver.Version{Major: cv.Major, Minor: cv.Minor}) } } func (m *Monitor) CancelDowngradeIfNeeded() { d := m.s.GetDowngradeInfo() if d == nil || !d.Enabled { return } targetVersion := d.TargetVersion v := semver.Must(semver.NewVersion(targetVersion)) if m.versionsMatchTarget(v) { m.lg.Info("the cluster has been downgraded", zap.String("cluster-version", targetVersion)) m.s.DowngradeCancel() } } // membersMinimalVersion returns the min server version in the map, or nil if the min // version in unknown. // It prints out log if there is a member with a higher version than the // local version. func (m *Monitor) membersMinimalVersion() *semver.Version { vers := m.s.GetMembersVersions() var minV *semver.Version lv := semver.Must(semver.NewVersion(version.Version)) for mid, ver := range vers { if ver == nil { return nil } v, err := semver.NewVersion(ver.Server) if err != nil { m.lg.Warn( "failed to parse server version of remote member", zap.String("remote-member-id", mid), zap.String("remote-member-version", ver.Server), zap.Error(err), ) return nil } if lv.LessThan(*v) { m.lg.Warn( "leader found higher-versioned member", zap.String("local-member-version", lv.String()), zap.String("remote-member-id", mid), zap.String("remote-member-version", ver.Server), ) } if minV == nil { minV = v } else if v.LessThan(*minV) { minV = v } } return minV } // versionsMatchTarget returns true if all server versions are equal to target version, otherwise return false. // It can be used to decide the whether the cluster finishes downgrading to target version. func (m *Monitor) versionsMatchTarget(targetVersion *semver.Version) bool { vers := m.s.GetMembersVersions() for mid, ver := range vers { if ver == nil { return false } v, err := semver.NewVersion(ver.Cluster) if err != nil { m.lg.Warn( "failed to parse server version of remote member", zap.String("remote-member-id", mid), zap.String("remote-member-version", ver.Server), zap.Error(err), ) return false } if !targetVersion.Equal(*v) { m.lg.Warn("remotes server has mismatching etcd version", zap.String("remote-member-id", mid), zap.String("current-server-version", v.String()), zap.String("target-version", targetVersion.String()), ) return false } } return true }