-
Notifications
You must be signed in to change notification settings - Fork 3.9k
/
Copy pathconfig.go
671 lines (587 loc) · 22.7 KB
/
config.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
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
// Copyright 2015 The Cockroach 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 base
import (
"context"
"crypto/tls"
"net/http"
"net/url"
"sync"
"time"
"github.com/cockroachdb/cockroach/pkg/security"
"github.com/cockroachdb/cockroach/pkg/settings/cluster"
"github.com/cockroachdb/cockroach/pkg/util/envutil"
"github.com/cockroachdb/cockroach/pkg/util/mon"
"github.com/cockroachdb/cockroach/pkg/util/retry"
"github.com/cockroachdb/cockroach/pkg/util/stop"
)
// Base config defaults.
const (
defaultInsecure = false
defaultUser = security.RootUser
httpScheme = "http"
httpsScheme = "https"
// From IANA Service Name and Transport Protocol Port Number Registry. See
// https://www.iana.org/assignments/service-names-port-numbers/service-names-port-numbers.xhtml?search=cockroachdb
DefaultPort = "26257"
// The default port for HTTP-for-humans.
DefaultHTTPPort = "8080"
// NB: net.JoinHostPort is not a constant.
defaultAddr = ":" + DefaultPort
defaultHTTPAddr = ":" + DefaultHTTPPort
// NetworkTimeout is the timeout used for network operations.
NetworkTimeout = 3 * time.Second
// DefaultCertsDirectory is the default value for the cert directory flag.
DefaultCertsDirectory = "${HOME}/.cockroach-certs"
// defaultRaftTickInterval is the default resolution of the Raft timer.
defaultRaftTickInterval = 200 * time.Millisecond
// defaultRangeLeaseRaftElectionTimeoutMultiplier specifies what multiple the
// leader lease active duration should be of the raft election timeout.
defaultRangeLeaseRaftElectionTimeoutMultiplier = 3
// rangeLeaseRenewalFraction specifies what fraction the range lease
// renewal duration should be of the range lease active time. For example,
// with a value of 0.2 and a lease duration of 10 seconds, leases would be
// eagerly renewed 2 seconds into each lease.
rangeLeaseRenewalFraction = 0.5
// livenessRenewalFraction specifies what fraction the node liveness
// renewal duration should be of the node liveness duration. For example,
// with a value of 0.2 and a liveness duration of 10 seconds, each node's
// liveness record would be eagerly renewed after 2 seconds.
livenessRenewalFraction = 0.5
// DefaultTableDescriptorLeaseDuration is the default mean duration a
// lease will be acquired for. The actual duration is jittered using
// the jitter fraction. Jittering is done to prevent multiple leases
// from being renewed simultaneously if they were all acquired
// simultaneously.
DefaultTableDescriptorLeaseDuration = 5 * time.Minute
// DefaultTableDescriptorLeaseJitterFraction is the default factor
// that we use to randomly jitter the lease duration when acquiring a
// new lease and the lease renewal timeout.
DefaultTableDescriptorLeaseJitterFraction = 0.25
// DefaultTableDescriptorLeaseRenewalTimeout is the default time
// before a lease expires when acquisition to renew the lease begins.
DefaultTableDescriptorLeaseRenewalTimeout = time.Minute
)
var (
// defaultRaftElectionTimeoutTicks specifies the number of Raft Tick
// invocations that must pass between elections.
defaultRaftElectionTimeoutTicks = envutil.EnvOrDefaultInt(
"COCKROACH_RAFT_ELECTION_TIMEOUT_TICKS", 15)
// defaultRaftLogMaxSize specifies the upper bound that a single Range's
// Raft log is limited to.
defaultRaftLogMaxSize = envutil.EnvOrDefaultInt64(
"COCKROACH_RAFT_LOG_MAX_SIZE", 4<<20 /* 4 MB */)
// defaultRaftMaxSizePerMsg specifies the maximum number of Raft log entries
// that a leader will send to followers in a single MsgApp.
defaultRaftMaxSizePerMsg = envutil.EnvOrDefaultInt(
"COCKROACH_RAFT_MAX_SIZE_PER_MSG", 16*1024)
// defaultRaftMaxSizePerMsg specifies how many "inflight" messages a leader
// will send to a follower without hearing a response.
defaultRaftMaxInflightMsgs = envutil.EnvOrDefaultInt(
"COCKROACH_RAFT_MAX_INFLIGHT_MSGS", 64)
)
type lazyHTTPClient struct {
once sync.Once
httpClient http.Client
err error
}
type lazyCertificateManager struct {
once sync.Once
cm *security.CertificateManager
err error
}
// Config is embedded by server.Config. A base config is not meant to be used
// directly, but embedding configs should call cfg.InitDefaults().
type Config struct {
// Insecure specifies whether to use SSL or not.
// This is really not recommended.
Insecure bool
// SSLCAKey is used to sign new certs.
SSLCAKey string
// SSLCertsDir is the path to the certificate/key directory.
SSLCertsDir string
// User running this process. It could be the user under which
// the server is running or the user passed in client calls.
User string
// Addr is the address the server is listening on.
Addr string
// AdvertiseAddr is the address advertised by the server to other nodes
// in the cluster. It should be reachable by all other nodes and should
// route to an interface that Addr is listening on.
AdvertiseAddr string
// HTTPAddr is the configured HTTP listen address.
//
// This is temporary, and will be removed when grpc.(*Server).ServeHTTP
// performance problems are addressed upstream.
//
// See https://github.com/grpc/grpc-go/issues/586.
HTTPAddr string
// HTTPAdvertiseAddr is the advertised HTTP address.
// This is computed from HTTPAddr if specified otherwise Addr.
HTTPAdvertiseAddr string
// The certificate manager. Must be accessed through GetCertificateManager.
certificateManager lazyCertificateManager
// httpClient uses the client TLS config. It is initialized lazily.
httpClient lazyHTTPClient
// HistogramWindowInterval is used to determine the approximate length of time
// that individual samples are retained in in-memory histograms. Currently,
// it is set to the arbitrary length of six times the Metrics sample interval.
// See the comment in server.Config for more details.
HistogramWindowInterval time.Duration
}
func wrapError(err error) error {
if _, ok := err.(*security.Error); !ok {
return &security.Error{
Message: "problem using security settings",
Err: err,
}
}
return err
}
// InitDefaults sets up the default values for a config.
// This is also used in tests to reset global objects.
func (cfg *Config) InitDefaults() {
cfg.Insecure = defaultInsecure
cfg.User = defaultUser
cfg.Addr = defaultAddr
cfg.AdvertiseAddr = cfg.Addr
cfg.HTTPAddr = defaultHTTPAddr
cfg.SSLCertsDir = DefaultCertsDirectory
cfg.certificateManager = lazyCertificateManager{}
}
// HTTPRequestScheme returns "http" or "https" based on the value of Insecure.
func (cfg *Config) HTTPRequestScheme() string {
if cfg.Insecure {
return httpScheme
}
return httpsScheme
}
// AdminURL returns the URL for the admin UI.
func (cfg *Config) AdminURL() *url.URL {
return &url.URL{
Scheme: cfg.HTTPRequestScheme(),
Host: cfg.HTTPAdvertiseAddr,
}
}
// GetClientCertPaths returns the paths to the client cert and key.
func (cfg *Config) GetClientCertPaths(user string) (string, string, error) {
cm, err := cfg.GetCertificateManager()
if err != nil {
return "", "", err
}
return cm.GetClientCertPaths(user)
}
// GetCACertPath returns the path to the CA certificate.
func (cfg *Config) GetCACertPath() (string, error) {
cm, err := cfg.GetCertificateManager()
if err != nil {
return "", err
}
return cm.GetCACertPath()
}
// LoadSecurityOptions extends a url.Values with SSL settings suitable for
// the given server config. It returns true if and only if the URL
// already contained SSL config options.
func (cfg *Config) LoadSecurityOptions(options url.Values, username string) error {
if cfg.Insecure {
options.Set("sslmode", "disable")
options.Del("sslrootcert")
options.Del("sslcert")
options.Del("sslkey")
} else {
sslMode := options.Get("sslmode")
if sslMode == "" || sslMode == "disable" {
options.Set("sslmode", "verify-full")
}
if sslMode != "require" {
// verify-ca and verify-full need a CA certificate.
if options.Get("sslrootcert") == "" {
// Fetch CA cert. This is required.
caCertPath, err := cfg.GetCACertPath()
if err != nil {
return wrapError(err)
}
options.Set("sslrootcert", caCertPath)
}
} else {
// require does not check the CA.
options.Del("sslrootcert")
}
// Fetch certs, but don't fail, we may be using a password.
certPath, keyPath, err := cfg.GetClientCertPaths(username)
if err == nil {
if options.Get("sslcert") == "" {
options.Set("sslcert", certPath)
}
if options.Get("sslkey") == "" {
options.Set("sslkey", keyPath)
}
}
}
return nil
}
// PGURL constructs a URL for the postgres endpoint, given a server
// config. There is no default database set.
func (cfg *Config) PGURL(user *url.Userinfo) (*url.URL, error) {
options := url.Values{}
if err := cfg.LoadSecurityOptions(options, user.Username()); err != nil {
return nil, err
}
return &url.URL{
Scheme: "postgresql",
User: user,
Host: cfg.AdvertiseAddr,
RawQuery: options.Encode(),
}, nil
}
// GetCertificateManager returns the certificate manager, initializing it
// on the first call.
func (cfg *Config) GetCertificateManager() (*security.CertificateManager, error) {
cfg.certificateManager.once.Do(func() {
cfg.certificateManager.cm, cfg.certificateManager.err =
security.NewCertificateManager(cfg.SSLCertsDir)
})
return cfg.certificateManager.cm, cfg.certificateManager.err
}
// InitializeNodeTLSConfigs tries to load client and server-side TLS configs.
// It also enables the reload-on-SIGHUP functionality on the certificate manager.
// This should be called early in the life of the server to make sure there are no
// issues with TLS configs.
// Returns the certificate manager if successfully created and in secure mode.
func (cfg *Config) InitializeNodeTLSConfigs(
stopper *stop.Stopper,
) (*security.CertificateManager, error) {
if cfg.Insecure {
return nil, nil
}
if _, err := cfg.GetServerTLSConfig(); err != nil {
return nil, err
}
if _, err := cfg.GetUIServerTLSConfig(); err != nil {
return nil, err
}
if _, err := cfg.GetClientTLSConfig(); err != nil {
return nil, err
}
cm, err := cfg.GetCertificateManager()
if err != nil {
return nil, err
}
cm.RegisterSignalHandler(stopper)
return cm, nil
}
// GetClientTLSConfig returns the client TLS config, initializing it if needed.
// If Insecure is true, return a nil config, otherwise ask the certificate
// manager for a TLS config using certs for the config.User.
// This TLSConfig might **NOT** be suitable to talk to the Admin UI, use GetUIClientTLSConfig instead.
func (cfg *Config) GetClientTLSConfig() (*tls.Config, error) {
// Early out.
if cfg.Insecure {
return nil, nil
}
cm, err := cfg.GetCertificateManager()
if err != nil {
return nil, wrapError(err)
}
tlsCfg, err := cm.GetClientTLSConfig(cfg.User)
if err != nil {
return nil, wrapError(err)
}
return tlsCfg, nil
}
// GetUIClientTLSConfig returns the client TLS config for Admin UI clients, initializing it if needed.
// If Insecure is true, return a nil config, otherwise ask the certificate
// manager for a TLS config configured to talk to the Admin UI.
// This TLSConfig is **NOT** suitable to talk to the GRPC or SQL servers, use GetClientTLSConfig instead.
func (cfg *Config) GetUIClientTLSConfig() (*tls.Config, error) {
// Early out.
if cfg.Insecure {
return nil, nil
}
cm, err := cfg.GetCertificateManager()
if err != nil {
return nil, wrapError(err)
}
tlsCfg, err := cm.GetUIClientTLSConfig()
if err != nil {
return nil, wrapError(err)
}
return tlsCfg, nil
}
// GetServerTLSConfig returns the server TLS config, initializing it if needed.
// If Insecure is true, return a nil config, otherwise ask the certificate
// manager for a server TLS config.
func (cfg *Config) GetServerTLSConfig() (*tls.Config, error) {
// Early out.
if cfg.Insecure {
return nil, nil
}
cm, err := cfg.GetCertificateManager()
if err != nil {
return nil, wrapError(err)
}
tlsCfg, err := cm.GetServerTLSConfig()
if err != nil {
return nil, wrapError(err)
}
return tlsCfg, nil
}
// GetUIServerTLSConfig returns the server TLS config for the Admin UI, initializing it if needed.
// If Insecure is true, return a nil config, otherwise ask the certificate
// manager for a server UI TLS config.
func (cfg *Config) GetUIServerTLSConfig() (*tls.Config, error) {
// Early out.
if cfg.Insecure {
return nil, nil
}
cm, err := cfg.GetCertificateManager()
if err != nil {
return nil, wrapError(err)
}
tlsCfg, err := cm.GetUIServerTLSConfig()
if err != nil {
return nil, wrapError(err)
}
return tlsCfg, nil
}
// GetHTTPClient returns the http client, initializing it
// if needed. It uses the client TLS config.
func (cfg *Config) GetHTTPClient() (http.Client, error) {
cfg.httpClient.once.Do(func() {
cfg.httpClient.httpClient.Timeout = 10 * time.Second
var transport http.Transport
cfg.httpClient.httpClient.Transport = &transport
transport.TLSClientConfig, cfg.httpClient.err = cfg.GetUIClientTLSConfig()
})
return cfg.httpClient.httpClient, cfg.httpClient.err
}
// RaftConfig holds raft tuning parameters.
type RaftConfig struct {
// RaftTickInterval is the resolution of the Raft timer.
RaftTickInterval time.Duration
// RaftElectionTimeoutTicks is the number of raft ticks before the
// previous election expires. This value is inherited by individual stores
// unless overridden.
RaftElectionTimeoutTicks int
// RangeLeaseRaftElectionTimeoutMultiplier specifies what multiple the leader
// lease active duration should be of the raft election timeout.
RangeLeaseRaftElectionTimeoutMultiplier float64
// RaftLogMaxSize controls how large a single Range's Raft log can grow.
// When a Range's Raft log grows above this size, the Range will begin
// performing log truncations.
RaftLogMaxSize int64
// RaftProposalQuota controls the maximum aggregate size of Raft commands
// that a leader is allowed to propose concurrently.
//
// By default, the quota is set to a fraction of the RaftLogMaxSize. In
// doing so, we ensure all replicas have sufficiently up to date logs so
// that when the log gets truncated, the followers do not need
// non-preemptive snapshots. Changing this deserves care. Too low and
// everything comes to a grinding halt, too high and we're not really
// throttling anything (we'll still generate snapshots).
RaftProposalQuota int64
// RaftMaxUncommittedEntriesSize controls how large the uncommitted tail of
// the Raft log can grow. The limit is meant to provide protection against
// unbounded Raft log growth when quorum is lost and entries stop being
// committed but continue to be proposed.
RaftMaxUncommittedEntriesSize uint64
// RaftMaxSizePerMsg controls how many Raft log entries the leader will send to
// followers in a single MsgApp.
RaftMaxSizePerMsg uint64
// RaftMaxInflightMsgs controls how many "inflight" messages Raft will send
// to a follower without hearing a response. The total number of Raft log
// entries is a combination of this setting and RaftMaxSizePerMsg. The
// current default settings provide for up to 1 MB of raft log to be sent
// without acknowledgement. With an average entry size of 1 KB that
// translates to ~1024 commands that might be executed in the handling of a
// single raft.Ready operation.
RaftMaxInflightMsgs int
}
// SetDefaults initializes unset fields.
func (cfg *RaftConfig) SetDefaults() {
if cfg.RaftTickInterval == 0 {
cfg.RaftTickInterval = defaultRaftTickInterval
}
if cfg.RaftElectionTimeoutTicks == 0 {
cfg.RaftElectionTimeoutTicks = defaultRaftElectionTimeoutTicks
}
if cfg.RangeLeaseRaftElectionTimeoutMultiplier == 0 {
cfg.RangeLeaseRaftElectionTimeoutMultiplier = defaultRangeLeaseRaftElectionTimeoutMultiplier
}
if cfg.RaftLogMaxSize == 0 {
cfg.RaftLogMaxSize = defaultRaftLogMaxSize
}
if cfg.RaftProposalQuota == 0 {
// By default, set this to a fraction of RaftLogMaxSize. See comment
// above for the tradeoffs of setting this higher or lower.
cfg.RaftProposalQuota = cfg.RaftLogMaxSize / 4
}
if cfg.RaftMaxUncommittedEntriesSize == 0 {
// By default, set this to twice the RaftProposalQuota. The logic here
// is that the quotaPool should be responsible for throttling proposals
// in all cases except for unbounded Raft re-proposals because it queues
// efficiently instead of dropping proposals on the floor indiscriminately.
cfg.RaftMaxUncommittedEntriesSize = uint64(2 * cfg.RaftProposalQuota)
}
if cfg.RaftMaxSizePerMsg == 0 {
cfg.RaftMaxSizePerMsg = uint64(defaultRaftMaxSizePerMsg)
}
if cfg.RaftMaxInflightMsgs == 0 {
cfg.RaftMaxInflightMsgs = defaultRaftMaxInflightMsgs
}
}
// RaftElectionTimeout returns the raft election timeout, as computed from the
// tick interval and number of election timeout ticks.
func (cfg RaftConfig) RaftElectionTimeout() time.Duration {
return time.Duration(cfg.RaftElectionTimeoutTicks) * cfg.RaftTickInterval
}
// RangeLeaseDurations computes durations for range lease expiration and
// renewal based on a default multiple of Raft election timeout.
func (cfg RaftConfig) RangeLeaseDurations() (rangeLeaseActive, rangeLeaseRenewal time.Duration) {
rangeLeaseActive = time.Duration(cfg.RangeLeaseRaftElectionTimeoutMultiplier *
float64(cfg.RaftElectionTimeout()))
rangeLeaseRenewal = time.Duration(float64(rangeLeaseActive) * rangeLeaseRenewalFraction)
return
}
// RangeLeaseActiveDuration is the duration of the active period of leader
// leases requested.
func (cfg RaftConfig) RangeLeaseActiveDuration() time.Duration {
rangeLeaseActive, _ := cfg.RangeLeaseDurations()
return rangeLeaseActive
}
// RangeLeaseRenewalDuration specifies a time interval at the end of the
// active lease interval (i.e. bounded to the right by the start of the stasis
// period) during which operations will trigger an asynchronous renewal of the
// lease.
func (cfg RaftConfig) RangeLeaseRenewalDuration() time.Duration {
_, rangeLeaseRenewal := cfg.RangeLeaseDurations()
return rangeLeaseRenewal
}
// NodeLivenessDurations computes durations for node liveness expiration and
// renewal based on a default multiple of Raft election timeout.
func (cfg RaftConfig) NodeLivenessDurations() (livenessActive, livenessRenewal time.Duration) {
livenessActive = cfg.RangeLeaseActiveDuration()
livenessRenewal = time.Duration(float64(livenessActive) * livenessRenewalFraction)
return
}
// SentinelGossipTTL is time-to-live for the gossip sentinel. The sentinel
// informs a node whether or not it's connected to the primary gossip network
// and not just a partition. As such it must expire fairly quickly and be
// continually re-gossiped as a connected gossip network is necessary to
// propagate liveness. The replica which is the lease holder of the first range
// gossips it.
func (cfg RaftConfig) SentinelGossipTTL() time.Duration {
return cfg.RangeLeaseActiveDuration() / 2
}
// DefaultRetryOptions should be used for retrying most
// network-dependent operations.
func DefaultRetryOptions() retry.Options {
// TODO(bdarnell): This should vary with network latency.
// Derive the retry options from a configured or measured
// estimate of latency.
return retry.Options{
InitialBackoff: 50 * time.Millisecond,
MaxBackoff: 1 * time.Second,
Multiplier: 2,
}
}
const (
// DefaultTempStorageMaxSizeBytes is the default maximum budget
// for temp storage.
DefaultTempStorageMaxSizeBytes = 32 * 1024 * 1024 * 1024 /* 32GB */
// DefaultInMemTempStorageMaxSizeBytes is the default maximum budget
// for in-memory temp storages.
DefaultInMemTempStorageMaxSizeBytes = 100 * 1024 * 1024 /* 100MB */
)
// TempStorageConfig contains the details that can be specified in the cli
// pertaining to temp storage flags, specifically --temp-dir and
// --max-disk-temp-storage.
type TempStorageConfig struct {
// InMemory specifies whether the temporary storage will remain
// in-memory or occupy a temporary subdirectory on-disk.
InMemory bool
// Path is the filepath of the temporary subdirectory created for
// the temp storage.
Path string
// Mon will be used by the temp storage to register all its capacity requests.
// It can be used to limit the disk or memory that temp storage is allowed to
// use. If InMemory is set, than this has to be a memory monitor; otherwise it
// has to be a disk monitor.
Mon *mon.BytesMonitor
// StoreIdx stores the index of the StoreSpec this TempStorageConfig will use.
SpecIdx int
}
// TempStorageConfigFromEnv creates a TempStorageConfig.
// If parentDir is not specified and the specified store is in-memory,
// then the temp storage will also be in-memory.
func TempStorageConfigFromEnv(
ctx context.Context,
st *cluster.Settings,
firstStore StoreSpec,
parentDir string,
maxSizeBytes int64,
specIdx int,
) TempStorageConfig {
inMem := parentDir == "" && firstStore.InMemory
var monitor mon.BytesMonitor
if inMem {
monitor = mon.MakeMonitor(
"in-mem temp storage",
mon.MemoryResource,
nil, /* curCount */
nil, /* maxHist */
1024*1024, /* increment */
maxSizeBytes/10, /* noteworthy */
st,
)
monitor.Start(ctx, nil /* pool */, mon.MakeStandaloneBudget(maxSizeBytes))
} else {
monitor = mon.MakeMonitor(
"temp disk storage",
mon.DiskResource,
nil, /* curCount */
nil, /* maxHist */
1024*1024, /* increment */
maxSizeBytes/10, /* noteworthy */
st,
)
monitor.Start(ctx, nil /* pool */, mon.MakeStandaloneBudget(maxSizeBytes))
}
return TempStorageConfig{
InMemory: inMem,
Mon: &monitor,
SpecIdx: specIdx,
}
}
// LeaseManagerConfig holds table lease manager parameters.
type LeaseManagerConfig struct {
// TableDescriptorLeaseDuration is the mean duration a lease will be
// acquired for.
TableDescriptorLeaseDuration time.Duration
// TableDescriptorLeaseJitterFraction is the factor that we use to
// randomly jitter the lease duration when acquiring a new lease and
// the lease renewal timeout.
TableDescriptorLeaseJitterFraction float64
// DefaultTableDescriptorLeaseRenewalTimeout is the default time
// before a lease expires when acquisition to renew the lease begins.
TableDescriptorLeaseRenewalTimeout time.Duration
}
// NewLeaseManagerConfig initializes a LeaseManagerConfig with default values.
func NewLeaseManagerConfig() *LeaseManagerConfig {
return &LeaseManagerConfig{
TableDescriptorLeaseDuration: DefaultTableDescriptorLeaseDuration,
TableDescriptorLeaseJitterFraction: DefaultTableDescriptorLeaseJitterFraction,
TableDescriptorLeaseRenewalTimeout: DefaultTableDescriptorLeaseRenewalTimeout,
}
}