luxolus
/
open-consul
2
0
Fork 0
Code Issues 1 Pull Requests Packages Releases Wiki Activity

tlsutil: document Configurator and some of its fields

This commit is contained in:
Daniel Nephin 2021-06-21 12:29:07 -04:00
parent 96a1335874
commit 106384a835
1 changed files with 11 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
tlsutil/config.go
View File

@ -168,16 +168,20 @@ type manual struct {
cert *tls.Certificate cert *tls.Certificate
} }
// Configurator holds a Config and is responsible for generating all the // Configurator provides tls.Config and net.Dial wrappers to enable TLS for
// *tls.Config necessary for Consul. Except the one in the api package. // clients and servers, for both HTTPS and RPC requests.
// Configurator receives an initial TLS configuration from agent configuration,
// and receives updates from config reloads, auto-encrypt, and auto-config.
type Configurator struct { type Configurator struct {
// lock synchronizes access to all fields on this struct except for logger and version. // lock synchronizes access to all fields on this struct except for logger and version.
lock sync.RWMutex lock sync.RWMutex
base *Config base *Config
autoTLS autoTLS autoTLS autoTLS
manual *manual manual *manual
caPool *x509.CertPool
// peerDatacenterUseTLS is a map of DC name to a bool indicating if the DC
// uses TLS for RPC requests.
peerDatacenterUseTLS map[string]bool peerDatacenterUseTLS map[string]bool
caPool *x509.CertPool
// logger is not protected by a lock. It must never be changed after // logger is not protected by a lock. It must never be changed after
// Configurator is created. // Configurator is created.