-
Notifications
You must be signed in to change notification settings - Fork 792
/
cluster.go
178 lines (160 loc) · 7.38 KB
/
cluster.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
// Copyright (c) 2021 Uber Technologies, Inc.
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.
package config
import (
"errors"
"fmt"
"log"
"go.uber.org/yarpc/transport/grpc"
"go.uber.org/yarpc/transport/tchannel"
"go.uber.org/multierr"
)
type (
// ClusterGroupMetadata contains all the clusters participating in a replication group(aka XDC/GlobalDomain)
ClusterGroupMetadata struct {
// FailoverVersionIncrement is the increment of each cluster version when failover happens
// It decides the maximum number clusters in this replication groups
FailoverVersionIncrement int64 `yaml:"failoverVersionIncrement"`
// PrimaryClusterName is the primary cluster name, only the primary cluster can register / update domain
// all clusters can do domain failover
PrimaryClusterName string `yaml:"primaryClusterName"`
// Deprecated: please use PrimaryClusterName
MasterClusterName string `yaml:"masterClusterName"`
// CurrentClusterName is the name of the cluster of current deployment
CurrentClusterName string `yaml:"currentClusterName"`
// ClusterRedirectionPolicy contains the cluster redirection policy for global domains
ClusterRedirectionPolicy *ClusterRedirectionPolicy `yaml:"clusterRedirectionPolicy"`
// ClusterGroup contains information for each cluster within the replication group
// Key is the clusterName
ClusterGroup map[string]ClusterInformation `yaml:"clusterGroup"`
// Deprecated: please use ClusterGroup
ClusterInformation map[string]ClusterInformation `yaml:"clusterInformation"`
}
// ClusterInformation contains the information about each cluster participating in cross DC
ClusterInformation struct {
Enabled bool `yaml:"enabled"`
// InitialFailoverVersion is the identifier of each cluster. 0 <= the value < failoverVersionIncrement
InitialFailoverVersion int64 `yaml:"initialFailoverVersion"`
// NewInitialFailoverVersion is a new failover version for an initialFailoverVersion migration
// for when it's necessary to migrate between two values.
//
// this is a pointer to imply optionality, it's an optional field and its lack
// is indicated by a nil pointer. Zero is a valid field
NewInitialFailoverVersion *int64 `yaml:"newInitialFailoverVersion"`
// RPCName indicate the remote service name
RPCName string `yaml:"rpcName"`
// Address indicate the remote service address(Host:Port). Host can be DNS name.
// For currentCluster, it's usually the same as publicClient.hostPort
RPCAddress string `yaml:"rpcAddress" validate:"nonzero"`
// RPCTransport specifies transport to use for replication traffic.
// Allowed values: tchannel|grpc
// Default: tchannel
RPCTransport string `yaml:"rpcTransport"`
// AuthorizationProvider contains the information to authorize the cluster
AuthorizationProvider AuthorizationProvider `yaml:"authorizationProvider"`
// TLS configures client TLS/SSL authentication for connections to this cluster
TLS TLS `yaml:"tls"`
}
AuthorizationProvider struct {
// Enable indicates if the auth provider is enabled
Enable bool `yaml:"enable"`
// Type auth provider type
Type string `yaml:"type"` // only supports OAuthAuthorization
// PrivateKey is the private key path
PrivateKey string `yaml:"privateKey"`
}
)
// Validate validates ClusterGroupMetadata
func (m *ClusterGroupMetadata) Validate() error {
if m == nil {
return errors.New("ClusterGroupMetadata cannot be empty")
}
var errs error
if len(m.PrimaryClusterName) == 0 {
errs = multierr.Append(errs, errors.New("primary cluster name is empty"))
}
if len(m.CurrentClusterName) == 0 {
errs = multierr.Append(errs, errors.New("current cluster name is empty"))
}
if m.FailoverVersionIncrement == 0 {
errs = multierr.Append(errs, errors.New("version increment is 0"))
}
if len(m.ClusterGroup) == 0 {
errs = multierr.Append(errs, errors.New("empty cluster group"))
}
if _, ok := m.ClusterGroup[m.PrimaryClusterName]; len(m.PrimaryClusterName) > 0 && !ok {
errs = multierr.Append(errs, errors.New("primary cluster is not specified in the cluster group"))
}
if _, ok := m.ClusterGroup[m.CurrentClusterName]; len(m.CurrentClusterName) > 0 && !ok {
errs = multierr.Append(errs, errors.New("current cluster is not specified in the cluster group"))
}
versionToClusterName := make(map[int64]string)
for clusterName, info := range m.ClusterGroup {
if len(clusterName) == 0 {
errs = multierr.Append(errs, errors.New("cluster with empty name defined"))
}
versionToClusterName[info.InitialFailoverVersion] = clusterName
if m.FailoverVersionIncrement <= info.InitialFailoverVersion || info.InitialFailoverVersion < 0 {
errs = multierr.Append(errs, fmt.Errorf(
"cluster %s: version increment %v is smaller than initial version: %v",
clusterName,
m.FailoverVersionIncrement,
info.InitialFailoverVersion,
))
}
if info.Enabled && (len(info.RPCName) == 0 || len(info.RPCAddress) == 0) {
errs = multierr.Append(errs, fmt.Errorf("cluster %v: rpc name / address is empty", clusterName))
}
if info.RPCTransport != tchannel.TransportName && info.RPCTransport != grpc.TransportName {
errs = multierr.Append(errs, fmt.Errorf("cluster %v: rpc transport must %v or %v",
clusterName, tchannel.TransportName, grpc.TransportName))
}
}
if len(versionToClusterName) != len(m.ClusterGroup) {
errs = multierr.Append(errs, errors.New("initial versions of the cluster group have duplicates"))
}
return errs
}
// FillDefaults populates default values for unspecified fields
func (m *ClusterGroupMetadata) FillDefaults() {
if m == nil {
log.Fatal("ClusterGroupMetadata cannot be empty")
}
// TODO: remove this after 0.23 and mention a breaking change in config.
if len(m.PrimaryClusterName) == 0 && len(m.MasterClusterName) != 0 {
m.PrimaryClusterName = m.MasterClusterName
log.Println("[WARN] masterClusterName config is deprecated. Please replace it with primaryClusterName.")
}
// TODO: remove this after 0.23 and mention a breaking change in config.
if len(m.ClusterGroup) == 0 && len(m.ClusterInformation) != 0 {
m.ClusterGroup = m.ClusterInformation
log.Println("[WARN] clusterInformation config is deprecated. Please replace it with clusterGroup.")
}
for name, cluster := range m.ClusterGroup {
if cluster.RPCName == "" {
// filling RPCName with a default value if empty
cluster.RPCName = "cadence-frontend"
}
if cluster.RPCTransport == "" {
cluster.RPCTransport = tchannel.TransportName
}
m.ClusterGroup[name] = cluster
}
}