config: document config options

This commit is contained in:
Frank Schroeder 2017-10-18 17:31:00 +02:00
parent 3d68185206
commit 32ed645df5
No known key found for this signature in database
GPG Key ID: 4D65C6EAEC87DECD
1 changed files with 70 additions and 39 deletions

View File

@ -453,21 +453,40 @@ type RuntimeConfig struct {
Datacenter string Datacenter string
NodeName string NodeName string
AdvertiseAddrLAN *net.IPAddr AdvertiseAddrLAN *net.IPAddr
AdvertiseAddrWAN *net.IPAddr AdvertiseAddrWAN *net.IPAddr
BindAddr *net.IPAddr BindAddr *net.IPAddr
Bootstrap bool
BootstrapExpect int // Bootstrap is used to bring up the first Consul server, and
CAFile string // permits that node to elect itself leader
CAPath string //
CertFile string // hcl: bootstrap = (true|false)
CheckUpdateInterval time.Duration // flag: -bootstrap
Checks []*structs.CheckDefinition Bootstrap bool
ClientAddrs []*net.IPAddr
DNSAddrs []net.Addr // BootstrapExpect tries to automatically bootstrap the Consul cluster,
DNSPort int // by withholding peers until enough servers join.
DataDir string //
DevMode bool // hcl: bootstrap_expect = int
// flag: -bootstrap-expect=int
BootstrapExpect int
CAFile string
CAPath string
CertFile string
CheckUpdateInterval time.Duration
Checks []*structs.CheckDefinition
ClientAddrs []*net.IPAddr
DNSAddrs []net.Addr
DNSPort int
DataDir string
// DevMode enables a fast-path mode of operation to bring up an in-memory
// server with minimal configuration. Useful for developing Consul.
//
// flag: -dev
DevMode bool
DisableAnonymousSignature bool DisableAnonymousSignature bool
DisableCoordinates bool DisableCoordinates bool
DisableHostNodeID bool DisableHostNodeID bool
@ -485,31 +504,43 @@ type RuntimeConfig struct {
// todo(fs): rename to ACLEnableReplication // todo(fs): rename to ACLEnableReplication
EnableACLReplication bool EnableACLReplication bool
EnableDebug bool EnableDebug bool
EnableScriptChecks bool EnableScriptChecks bool
EnableSyslog bool EnableSyslog bool
EnableUI bool EnableUI bool
EncryptKey string EncryptKey string
EncryptVerifyIncoming bool EncryptVerifyIncoming bool
EncryptVerifyOutgoing bool EncryptVerifyOutgoing bool
HTTPAddrs []net.Addr HTTPAddrs []net.Addr
HTTPPort int HTTPPort int
HTTPSAddrs []net.Addr HTTPSAddrs []net.Addr
HTTPSPort int HTTPSPort int
KeyFile string KeyFile string
LeaveDrainTime time.Duration LeaveDrainTime time.Duration
LeaveOnTerm bool LeaveOnTerm bool
LogLevel string LogLevel string
NodeID types.NodeID NodeID types.NodeID
NodeMeta map[string]string NodeMeta map[string]string
NonVotingServer bool NonVotingServer bool
PidFile string PidFile string
RPCAdvertiseAddr *net.TCPAddr RPCAdvertiseAddr *net.TCPAddr
RPCBindAddr *net.TCPAddr RPCBindAddr *net.TCPAddr
RPCHoldTimeout time.Duration RPCHoldTimeout time.Duration
RPCMaxBurst int
// RPCRateLimit and RPCMaxBurst control how frequently RPC calls are allowed
// to happen. In any large enough time interval, rate limiter limits the
// rate to RPCRate tokens per second, with a maximum burst size of
// RPCMaxBurst events. As a special case, if RPCRate == Inf (the infinite
// rate), RPCMaxBurst is ignored.
//
// See https://en.wikipedia.org/wiki/Token_bucket for more about token
// buckets.
//
// hcl: limit { rpc_rate = (float64|MaxFloat64) rpc_max_burst = int }
RPCRateLimit rate.Limit
RPCMaxBurst int
RPCProtocol int RPCProtocol int
RPCRateLimit rate.Limit
RaftProtocol int RaftProtocol int
ReconnectTimeoutLAN time.Duration ReconnectTimeoutLAN time.Duration
ReconnectTimeoutWAN time.Duration ReconnectTimeoutWAN time.Duration