2017-09-25 18:40:42 +00:00
|
|
|
package config
|
|
|
|
|
|
|
|
import (
|
2017-09-27 18:47:40 +00:00
|
|
|
"fmt"
|
2017-09-25 18:40:42 +00:00
|
|
|
"net"
|
|
|
|
"reflect"
|
|
|
|
"strings"
|
|
|
|
"time"
|
|
|
|
|
2020-10-05 20:28:13 +00:00
|
|
|
"github.com/hashicorp/go-uuid"
|
|
|
|
"golang.org/x/time/rate"
|
|
|
|
|
2020-07-27 21:11:11 +00:00
|
|
|
"github.com/hashicorp/consul/agent/cache"
|
2020-10-05 20:28:13 +00:00
|
|
|
"github.com/hashicorp/consul/agent/consul"
|
2021-07-19 22:22:51 +00:00
|
|
|
"github.com/hashicorp/consul/agent/dns"
|
2017-09-25 18:40:42 +00:00
|
|
|
"github.com/hashicorp/consul/agent/structs"
|
2020-08-17 23:30:25 +00:00
|
|
|
"github.com/hashicorp/consul/agent/token"
|
2018-07-10 16:13:51 +00:00
|
|
|
"github.com/hashicorp/consul/api"
|
2018-06-14 12:52:48 +00:00
|
|
|
"github.com/hashicorp/consul/lib"
|
2020-08-19 17:17:05 +00:00
|
|
|
"github.com/hashicorp/consul/logging"
|
2017-09-25 18:40:42 +00:00
|
|
|
"github.com/hashicorp/consul/tlsutil"
|
|
|
|
"github.com/hashicorp/consul/types"
|
|
|
|
)
|
|
|
|
|
Added SOA configuration for DNS settings. (#4714)
This will allow to fine TUNE SOA settings sent by Consul in DNS responses,
for instance to be able to control negative ttl.
Will fix: https://github.com/hashicorp/consul/issues/4713
# Example
Override all settings:
* min_ttl: 0 => 60s
* retry: 600 (10m) => 300s (5 minutes),
* expire: 86400 (24h) => 43200 (12h)
* refresh: 3600 (1h) => 1800 (30 minutes)
```
consul agent -dev -hcl 'dns_config={soa={min_ttl=60,retry=300,expire=43200,refresh=1800}}'
```
Result:
```
dig +multiline @localhost -p 8600 service.consul
; <<>> DiG 9.12.1 <<>> +multiline @localhost -p 8600 service.consul
; (2 servers found)
;; global options: +cmd
;; Got answer:
;; ->>HEADER<<- opcode: QUERY, status: NXDOMAIN, id: 36557
;; flags: qr aa rd; QUERY: 1, ANSWER: 0, AUTHORITY: 1, ADDITIONAL: 1
;; WARNING: recursion requested but not available
;; OPT PSEUDOSECTION:
; EDNS: version: 0, flags:; udp: 4096
;; QUESTION SECTION:
;service.consul. IN A
;; AUTHORITY SECTION:
consul. 0 IN SOA ns.consul. hostmaster.consul. (
1537959133 ; serial
1800 ; refresh (30 minutes)
300 ; retry (5 minutes)
43200 ; expire (12 hours)
60 ; minimum (1 minute)
)
;; Query time: 4 msec
;; SERVER: 127.0.0.1#8600(127.0.0.1)
;; WHEN: Wed Sep 26 12:52:13 CEST 2018
;; MSG SIZE rcvd: 93
```
2018-10-10 19:50:56 +00:00
|
|
|
type RuntimeSOAConfig struct {
|
|
|
|
Refresh uint32 // 3600 by default
|
|
|
|
Retry uint32 // 600
|
|
|
|
Expire uint32 // 86400
|
|
|
|
Minttl uint32 // 0,
|
|
|
|
}
|
|
|
|
|
2022-03-31 19:11:49 +00:00
|
|
|
// StaticRuntimeConfig specifies the subset of configuration the consul agent actually
|
|
|
|
// uses and that are not reloadable by configuration auto reload.
|
|
|
|
type StaticRuntimeConfig struct {
|
|
|
|
// EncryptVerifyIncoming enforces incoming gossip encryption and can be
|
|
|
|
// used to upshift to encrypted gossip on a running cluster.
|
|
|
|
//
|
|
|
|
// hcl: encrypt_verify_incoming = (true|false)
|
|
|
|
EncryptVerifyIncoming bool
|
|
|
|
|
|
|
|
// EncryptVerifyOutgoing enforces outgoing gossip encryption and can be
|
|
|
|
// used to upshift to encrypted gossip on a running cluster.
|
|
|
|
//
|
|
|
|
// hcl: encrypt_verify_outgoing = (true|false)
|
|
|
|
EncryptVerifyOutgoing bool
|
|
|
|
}
|
|
|
|
|
2017-09-25 18:40:42 +00:00
|
|
|
// RuntimeConfig specifies the configuration the consul agent actually
|
|
|
|
// uses. Is is derived from one or more Config structures which can come
|
|
|
|
// from files, flags and/or environment variables.
|
|
|
|
type RuntimeConfig struct {
|
|
|
|
// non-user configurable values
|
2017-10-18 15:23:56 +00:00
|
|
|
AEInterval time.Duration
|
|
|
|
|
2017-09-25 18:40:42 +00:00
|
|
|
CheckDeregisterIntervalMin time.Duration
|
|
|
|
CheckReapInterval time.Duration
|
|
|
|
SegmentLimit int
|
|
|
|
SegmentNameLimit int
|
|
|
|
SyncCoordinateRateTarget float64
|
|
|
|
SyncCoordinateIntervalMin time.Duration
|
|
|
|
Revision string
|
|
|
|
Version string
|
|
|
|
VersionPrerelease string
|
|
|
|
|
|
|
|
// consul config
|
|
|
|
ConsulCoordinateUpdateMaxBatches int
|
|
|
|
ConsulCoordinateUpdateBatchSize int
|
|
|
|
ConsulCoordinateUpdatePeriod time.Duration
|
|
|
|
ConsulRaftElectionTimeout time.Duration
|
|
|
|
ConsulRaftHeartbeatTimeout time.Duration
|
|
|
|
ConsulRaftLeaderLeaseTimeout time.Duration
|
|
|
|
ConsulServerHealthInterval time.Duration
|
|
|
|
|
2018-10-19 16:04:07 +00:00
|
|
|
// ACLsEnabled is used to determine whether ACLs should be enabled
|
|
|
|
//
|
|
|
|
// hcl: acl.enabled = boolean
|
|
|
|
ACLsEnabled bool
|
|
|
|
|
2020-08-17 23:30:25 +00:00
|
|
|
ACLTokens token.Config
|
|
|
|
|
2021-08-06 22:59:05 +00:00
|
|
|
ACLResolverSettings consul.ACLResolverSettings
|
2017-10-18 15:23:56 +00:00
|
|
|
|
2017-10-19 07:03:17 +00:00
|
|
|
// ACLEnableKeyListPolicy is used to opt-in to the "list" policy added to
|
|
|
|
// KV ACLs in Consul 1.0.
|
|
|
|
//
|
|
|
|
// See https://www.consul.io/docs/guides/acl.html#list-policy-for-keys for
|
|
|
|
// more details.
|
2017-10-18 15:23:56 +00:00
|
|
|
//
|
2018-10-19 16:04:07 +00:00
|
|
|
// hcl: acl.enable_key_list_policy = (true|false)
|
2017-10-02 22:10:21 +00:00
|
|
|
ACLEnableKeyListPolicy bool
|
2017-10-18 15:23:56 +00:00
|
|
|
|
2021-12-07 12:39:28 +00:00
|
|
|
// ACLInitialManagementToken is used to bootstrap the ACL system. It should be specified
|
2021-08-06 22:00:58 +00:00
|
|
|
// on the servers in the PrimaryDatacenter. When the leader comes online, it ensures
|
2021-12-07 12:39:28 +00:00
|
|
|
// that the initial management token is available. This provides the initial token.
|
2017-10-18 15:23:56 +00:00
|
|
|
//
|
2021-12-01 21:08:14 +00:00
|
|
|
// hcl: acl.tokens.initial_management = string
|
2021-12-07 12:39:28 +00:00
|
|
|
ACLInitialManagementToken string
|
2017-10-18 15:23:56 +00:00
|
|
|
|
2018-10-19 16:04:07 +00:00
|
|
|
// ACLtokenReplication is used to indicate that both tokens and policies
|
|
|
|
// should be replicated instead of just policies
|
|
|
|
//
|
|
|
|
// hcl: acl.token_replication = boolean
|
|
|
|
ACLTokenReplication bool
|
|
|
|
|
2017-10-18 10:32:39 +00:00
|
|
|
// AutopilotCleanupDeadServers enables the automatic cleanup of dead servers when new ones
|
|
|
|
// are added to the peer list. Defaults to true.
|
|
|
|
//
|
|
|
|
// hcl: autopilot { cleanup_dead_servers = (true|false) }
|
|
|
|
AutopilotCleanupDeadServers bool
|
|
|
|
|
|
|
|
// AutopilotDisableUpgradeMigration will disable Autopilot's upgrade migration
|
|
|
|
// strategy of waiting until enough newer-versioned servers have been added to the
|
|
|
|
// cluster before promoting them to voters. (Enterprise-only)
|
|
|
|
//
|
|
|
|
// hcl: autopilot { disable_upgrade_migration = (true|false)
|
2017-09-25 18:40:42 +00:00
|
|
|
AutopilotDisableUpgradeMigration bool
|
2017-10-18 10:32:39 +00:00
|
|
|
|
|
|
|
// AutopilotLastContactThreshold is the limit on the amount of time a server can go
|
|
|
|
// without leader contact before being considered unhealthy.
|
|
|
|
//
|
|
|
|
// hcl: autopilot { last_contact_threshold = "duration" }
|
|
|
|
AutopilotLastContactThreshold time.Duration
|
|
|
|
|
|
|
|
// AutopilotMaxTrailingLogs is the amount of entries in the Raft Log that a server can
|
|
|
|
// be behind before being considered unhealthy. The value must be positive.
|
|
|
|
//
|
|
|
|
// hcl: autopilot { max_trailing_logs = int }
|
|
|
|
AutopilotMaxTrailingLogs int
|
|
|
|
|
2019-10-29 14:04:41 +00:00
|
|
|
// AutopilotMinQuorum sets the minimum number of servers required in a cluster
|
|
|
|
// before autopilot can prune dead servers.
|
|
|
|
//
|
|
|
|
//hcl: autopilot { min_quorum = int }
|
|
|
|
AutopilotMinQuorum uint
|
|
|
|
|
2017-10-18 10:32:39 +00:00
|
|
|
// AutopilotRedundancyZoneTag is the Meta tag to use for separating servers
|
|
|
|
// into zones for redundancy. If left blank, this feature will be disabled.
|
|
|
|
// (Enterprise-only)
|
|
|
|
//
|
|
|
|
// hcl: autopilot { redundancy_zone_tag = string }
|
|
|
|
AutopilotRedundancyZoneTag string
|
|
|
|
|
|
|
|
// AutopilotServerStabilizationTime is the minimum amount of time a server must be
|
|
|
|
// in a stable, healthy state before it can be added to the cluster. Only
|
|
|
|
// applicable with Raft protocol version 3 or higher.
|
|
|
|
//
|
|
|
|
// hcl: autopilot { server_stabilization_time = "duration" }
|
2017-09-25 18:40:42 +00:00
|
|
|
AutopilotServerStabilizationTime time.Duration
|
2017-10-18 10:32:39 +00:00
|
|
|
|
|
|
|
// AutopilotUpgradeVersionTag is the node tag to use for version info when
|
|
|
|
// performing upgrade migrations. If left blank, the Consul version will be used.
|
|
|
|
//
|
2018-03-19 16:56:00 +00:00
|
|
|
// (Enterprise-only)
|
2017-10-18 10:32:39 +00:00
|
|
|
//
|
|
|
|
// hcl: autopilot { upgrade_version_tag = string }
|
|
|
|
AutopilotUpgradeVersionTag string
|
2017-09-25 18:40:42 +00:00
|
|
|
|
2017-10-18 10:20:26 +00:00
|
|
|
// DNSAllowStale is used to enable lookups with stale
|
|
|
|
// data. This gives horizontal read scalability since
|
|
|
|
// any Consul server can service the query instead of
|
|
|
|
// only the leader.
|
|
|
|
//
|
|
|
|
// hcl: dns_config { allow_stale = (true|false) }
|
|
|
|
DNSAllowStale bool
|
|
|
|
|
2018-03-06 01:07:42 +00:00
|
|
|
// DNSARecordLimit is used to limit the maximum number of DNS Resource
|
|
|
|
// Records returned in the ANSWER section of a DNS response for A or AAAA
|
|
|
|
// records for both UDP and TCP queries.
|
|
|
|
//
|
|
|
|
// This is not normally useful and will be limited based on the querying
|
|
|
|
// protocol, however systems that implemented §6 Rule 9 in RFC3484
|
|
|
|
// may want to set this to `1` in order to subvert §6 Rule 9 and
|
|
|
|
// re-obtain the effect of randomized resource records (i.e. each
|
|
|
|
// answer contains only one IP, but the IP changes every request).
|
|
|
|
// RFC3484 sorts answers in a deterministic order, which defeats the
|
|
|
|
// purpose of randomized DNS responses. This RFC has been obsoleted
|
|
|
|
// by RFC6724 and restores the desired behavior of randomized
|
|
|
|
// responses, however a large number of Linux hosts using glibc(3)
|
|
|
|
// implemented §6 Rule 9 and may need this option (e.g. CentOS 5-6,
|
|
|
|
// Debian Squeeze, etc).
|
|
|
|
//
|
|
|
|
// hcl: dns_config { a_record_limit = int }
|
|
|
|
DNSARecordLimit int
|
|
|
|
|
2017-10-18 10:20:26 +00:00
|
|
|
// DNSDisableCompression is used to control whether DNS responses are
|
|
|
|
// compressed. In Consul 0.7 this was turned on by default and this
|
|
|
|
// config was added as an opt-out.
|
|
|
|
//
|
|
|
|
// hcl: dns_config { disable_compression = (true|false) }
|
2017-09-25 18:40:42 +00:00
|
|
|
DNSDisableCompression bool
|
2017-10-18 10:20:26 +00:00
|
|
|
|
|
|
|
// DNSDomain is the DNS domain for the records. Should end with a dot.
|
|
|
|
// Defaults to "consul."
|
|
|
|
//
|
|
|
|
// hcl: domain = string
|
|
|
|
// flag: -domain string
|
|
|
|
DNSDomain string
|
|
|
|
|
2019-06-27 10:00:37 +00:00
|
|
|
// DNSAltDomain can be set to support resolution on an additional
|
|
|
|
// consul domain. Should end with a dot.
|
|
|
|
// If left blank, only the primary domain will be used.
|
|
|
|
//
|
|
|
|
// hcl: alt_domain = string
|
|
|
|
// flag: -alt-domain string
|
|
|
|
DNSAltDomain string
|
|
|
|
|
2017-10-18 10:20:26 +00:00
|
|
|
// DNSEnableTruncate is used to enable setting the truncate
|
|
|
|
// flag for UDP DNS queries. This allows unmodified
|
|
|
|
// clients to re-query the consul server using TCP
|
|
|
|
// when the total number of records exceeds the number
|
|
|
|
// returned by default for UDP.
|
|
|
|
//
|
|
|
|
// hcl: dns_config { enable_truncate = (true|false) }
|
|
|
|
DNSEnableTruncate bool
|
|
|
|
|
|
|
|
// DNSMaxStale is used to bound how stale of a result is
|
|
|
|
// accepted for a DNS lookup. This can be used with
|
|
|
|
// AllowStale to limit how old of a value is served up.
|
|
|
|
// If the stale result exceeds this, another non-stale
|
|
|
|
// stale read is performed.
|
|
|
|
//
|
|
|
|
// hcl: dns_config { max_stale = "duration" }
|
|
|
|
DNSMaxStale time.Duration
|
|
|
|
|
|
|
|
// DNSNodeTTL provides the TTL value for a node query.
|
|
|
|
//
|
|
|
|
// hcl: dns_config { node_ttl = "duration" }
|
|
|
|
DNSNodeTTL time.Duration
|
|
|
|
|
|
|
|
// DNSOnlyPassing is used to determine whether to filter nodes
|
|
|
|
// whose health checks are in any non-passing state. By
|
|
|
|
// default, only nodes in a critical state are excluded.
|
|
|
|
//
|
2020-07-16 13:47:33 +00:00
|
|
|
// hcl: dns_config { only_passing = (true|false) }
|
2017-10-18 10:20:26 +00:00
|
|
|
DNSOnlyPassing bool
|
|
|
|
|
2021-07-19 22:22:51 +00:00
|
|
|
// DNSRecursorStrategy controls the order in which DNS recursors are queried.
|
|
|
|
// 'sequential' queries recursors in the order they are listed under `recursors`.
|
|
|
|
// 'random' causes random selection of recursors which has the effect of
|
|
|
|
// spreading the query load among all listed servers, rather than having
|
|
|
|
// client agents try the first server in the list every time.
|
|
|
|
//
|
|
|
|
// hcl: dns_config { recursor_strategy = "(random|sequential)" }
|
|
|
|
DNSRecursorStrategy dns.RecursorStrategy
|
|
|
|
|
2017-10-18 10:20:26 +00:00
|
|
|
// DNSRecursorTimeout specifies the timeout in seconds
|
|
|
|
// for Consul's internal dns client used for recursion.
|
|
|
|
// This value is used for the connection, read and write timeout.
|
|
|
|
//
|
|
|
|
// hcl: dns_config { recursor_timeout = "duration" }
|
|
|
|
DNSRecursorTimeout time.Duration
|
|
|
|
|
|
|
|
// DNSServiceTTL provides the TTL value for a service
|
|
|
|
// query for given service. The "*" wildcard can be used
|
|
|
|
// to set a default for all services.
|
|
|
|
//
|
|
|
|
// hcl: dns_config { service_ttl = map[string]"duration" }
|
|
|
|
DNSServiceTTL map[string]time.Duration
|
|
|
|
|
|
|
|
// DNSUDPAnswerLimit is used to limit the maximum number of DNS Resource
|
2018-03-06 01:07:42 +00:00
|
|
|
// Records returned in the ANSWER section of a DNS response for UDP
|
|
|
|
// responses without EDNS support (limited to 512 bytes).
|
|
|
|
// This parameter is deprecated, if you want to limit the number of
|
|
|
|
// records returned by A or AAAA questions, please use DNSARecordLimit
|
|
|
|
// instead.
|
2017-10-18 10:20:26 +00:00
|
|
|
//
|
|
|
|
// hcl: dns_config { udp_answer_limit = int }
|
|
|
|
DNSUDPAnswerLimit int
|
|
|
|
|
2018-06-11 15:49:04 +00:00
|
|
|
// DNSNodeMetaTXT controls whether DNS queries will synthesize
|
|
|
|
// TXT records for the node metadata and add them when not specifically
|
|
|
|
// request (query type = TXT). If unset this will default to true
|
|
|
|
DNSNodeMetaTXT bool
|
|
|
|
|
2017-10-18 10:20:26 +00:00
|
|
|
// DNSRecursors can be set to allow the DNS servers to recursively
|
|
|
|
// resolve non-consul domains.
|
|
|
|
//
|
|
|
|
// hcl: recursors = []string
|
|
|
|
// flag: -recursor string [-recursor string]
|
|
|
|
DNSRecursors []string
|
2017-09-25 18:40:42 +00:00
|
|
|
|
2020-01-27 13:00:33 +00:00
|
|
|
// DNSUseCache whether or not to use cache for dns queries
|
2019-02-25 19:06:01 +00:00
|
|
|
//
|
|
|
|
// hcl: dns_config { use_cache = (true|false) }
|
|
|
|
DNSUseCache bool
|
|
|
|
|
2020-01-27 13:00:33 +00:00
|
|
|
// DNSUseCache whether or not to use cache for dns queries
|
2019-02-25 19:06:01 +00:00
|
|
|
//
|
|
|
|
// hcl: dns_config { cache_max_age = "duration" }
|
|
|
|
DNSCacheMaxAge time.Duration
|
|
|
|
|
2020-06-08 08:08:12 +00:00
|
|
|
// HTTPUseCache whether or not to use cache for http queries. Defaults
|
|
|
|
// to true.
|
|
|
|
//
|
|
|
|
// hcl: http_config { use_cache = (true|false) }
|
|
|
|
HTTPUseCache bool
|
|
|
|
|
2017-10-18 10:20:10 +00:00
|
|
|
// HTTPBlockEndpoints is a list of endpoint prefixes to block in the
|
|
|
|
// HTTP API. Any requests to these will get a 403 response.
|
|
|
|
//
|
|
|
|
// hcl: http_config { block_endpoints = []string }
|
|
|
|
HTTPBlockEndpoints []string
|
|
|
|
|
2019-01-10 14:27:26 +00:00
|
|
|
// AllowWriteHTTPFrom restricts the agent write endpoints to the given
|
|
|
|
// networks. Any request to a protected endpoint that is not mactched
|
|
|
|
// by one of these networks will get a 403 response.
|
|
|
|
// An empty slice means no restriction.
|
|
|
|
//
|
|
|
|
// hcl: http_config { allow_write_http_from = []string }
|
|
|
|
AllowWriteHTTPFrom []*net.IPNet
|
|
|
|
|
2017-10-18 10:20:10 +00:00
|
|
|
// HTTPResponseHeaders are used to add HTTP header response fields to the HTTP API responses.
|
|
|
|
//
|
|
|
|
// hcl: http_config { response_headers = map[string]string }
|
2017-09-25 18:40:42 +00:00
|
|
|
HTTPResponseHeaders map[string]string
|
|
|
|
|
2018-06-14 12:52:48 +00:00
|
|
|
// Embed Telemetry Config
|
|
|
|
Telemetry lib.TelemetryConfig
|
2017-09-25 18:40:42 +00:00
|
|
|
|
2017-10-19 07:47:22 +00:00
|
|
|
// Datacenter is the datacenter this node is in. Defaults to "dc1".
|
|
|
|
//
|
|
|
|
// Datacenter is exposed via /v1/agent/self from here and
|
2017-09-27 18:59:22 +00:00
|
|
|
// used in lots of places like CLI commands. Treat this as an interface
|
|
|
|
// that must be stable.
|
2017-10-19 07:47:22 +00:00
|
|
|
//
|
|
|
|
// hcl: datacenter = string
|
|
|
|
// flag: -datacenter string
|
2017-09-27 18:59:22 +00:00
|
|
|
Datacenter string
|
2017-10-19 07:47:22 +00:00
|
|
|
|
2019-03-06 17:13:28 +00:00
|
|
|
// Defines the maximum stale value for discovery path. Defaults to "0s".
|
2018-03-30 15:14:44 +00:00
|
|
|
// Discovery paths are /v1/heath/ paths
|
|
|
|
//
|
|
|
|
// If not set to 0, it will try to perform stale read and perform only a
|
|
|
|
// consistent read whenever the value is too old.
|
|
|
|
// hcl: discovery_max_stale = "duration"
|
|
|
|
DiscoveryMaxStale time.Duration
|
|
|
|
|
2017-10-19 07:47:22 +00:00
|
|
|
// Node name is the name we use to advertise. Defaults to hostname.
|
|
|
|
//
|
|
|
|
// NodeName is exposed via /v1/agent/self from here and
|
|
|
|
// used in lots of places like CLI commands. Treat this as an interface
|
|
|
|
// that must be stable.
|
|
|
|
//
|
|
|
|
// hcl: node_name = string
|
|
|
|
// flag: -node string
|
|
|
|
NodeName string
|
2017-09-27 18:59:22 +00:00
|
|
|
|
2017-10-20 12:00:04 +00:00
|
|
|
// AdvertiseAddrLAN is the address we use for advertising our Serf, and
|
|
|
|
// Consul RPC IP. The address can be specified as an ip address or as a
|
|
|
|
// go-sockaddr template which resolves to a single ip address. If not
|
|
|
|
// specified, the bind address is used.
|
|
|
|
//
|
|
|
|
// hcl: advertise_addr = string
|
2017-10-18 15:31:00 +00:00
|
|
|
AdvertiseAddrLAN *net.IPAddr
|
2017-10-20 12:00:04 +00:00
|
|
|
|
|
|
|
// AdvertiseAddrWAN is the address we use for advertising our Serf, and
|
|
|
|
// Consul RPC IP. The address can be specified as an ip address or as a
|
|
|
|
// go-sockaddr template which resolves to a single ip address. If not
|
|
|
|
// specified, the bind address is used.
|
|
|
|
//
|
|
|
|
// hcl: advertise_addr_wan = string
|
2017-10-18 15:31:00 +00:00
|
|
|
AdvertiseAddrWAN *net.IPAddr
|
2017-10-19 07:47:22 +00:00
|
|
|
|
|
|
|
// BindAddr is used to control the address we bind to.
|
|
|
|
// If not specified, the first private IP we find is used.
|
|
|
|
// This controls the address we use for cluster facing
|
|
|
|
// services (Gossip, Server RPC)
|
|
|
|
//
|
|
|
|
// The value can be either an ip address or a go-sockaddr
|
|
|
|
// template which resolves to a single ip address.
|
|
|
|
//
|
|
|
|
// hcl: bind_addr = string
|
|
|
|
// flag: -bind string
|
|
|
|
BindAddr *net.IPAddr
|
2017-10-18 15:31:00 +00:00
|
|
|
|
|
|
|
// Bootstrap is used to bring up the first Consul server, and
|
|
|
|
// permits that node to elect itself leader
|
|
|
|
//
|
|
|
|
// hcl: bootstrap = (true|false)
|
|
|
|
// flag: -bootstrap
|
|
|
|
Bootstrap bool
|
|
|
|
|
2017-10-23 06:05:47 +00:00
|
|
|
// BootstrapExpect tries to automatically bootstrap the Consul cluster, by
|
|
|
|
// having servers wait to bootstrap until enough servers join, and then
|
|
|
|
// performing the bootstrap process automatically. They will disable their
|
|
|
|
// automatic bootstrap process if they detect any servers that are part of
|
|
|
|
// an existing cluster, so it's safe to leave this set to a non-zero value.
|
2017-10-18 15:31:00 +00:00
|
|
|
//
|
|
|
|
// hcl: bootstrap_expect = int
|
|
|
|
// flag: -bootstrap-expect=int
|
|
|
|
BootstrapExpect int
|
|
|
|
|
2020-07-27 21:11:11 +00:00
|
|
|
// Cache represent cache configuration of agent
|
|
|
|
Cache cache.Options
|
|
|
|
|
2017-10-19 19:26:02 +00:00
|
|
|
// CheckUpdateInterval controls the interval on which the output of a health check
|
|
|
|
// is updated if there is no change to the state. For example, a check in a steady
|
|
|
|
// state may run every 5 second generating a unique output (timestamp, etc), forcing
|
|
|
|
// constant writes. This allows Consul to defer the write for some period of time,
|
|
|
|
// reducing the write pressure when the state is steady.
|
|
|
|
//
|
|
|
|
// See also: DiscardCheckOutput
|
|
|
|
//
|
|
|
|
// hcl: check_update_interval = "duration"
|
2017-10-18 15:31:00 +00:00
|
|
|
CheckUpdateInterval time.Duration
|
2017-10-19 19:26:02 +00:00
|
|
|
|
2019-06-26 15:43:25 +00:00
|
|
|
// Maximum size for the output of a healtcheck
|
|
|
|
// hcl check_output_max_size int
|
|
|
|
// flag: -check_output_max_size int
|
|
|
|
CheckOutputMaxSize int
|
|
|
|
|
2017-10-20 12:00:04 +00:00
|
|
|
// Checks contains the provided check definitions.
|
|
|
|
//
|
|
|
|
// hcl: checks = [
|
|
|
|
// {
|
|
|
|
// id = string
|
|
|
|
// name = string
|
|
|
|
// notes = string
|
|
|
|
// service_id = string
|
|
|
|
// token = string
|
|
|
|
// status = string
|
|
|
|
// script = string
|
|
|
|
// args = string
|
|
|
|
// http = string
|
|
|
|
// header = map[string][]string
|
|
|
|
// method = string
|
|
|
|
// tcp = string
|
2021-04-09 19:12:10 +00:00
|
|
|
// h2ping = string
|
2017-10-20 12:00:04 +00:00
|
|
|
// interval = string
|
|
|
|
// docker_container_id = string
|
|
|
|
// shell = string
|
|
|
|
// tls_skip_verify = (true|false)
|
|
|
|
// timeout = "duration"
|
|
|
|
// ttl = "duration"
|
2021-09-14 16:47:52 +00:00
|
|
|
// success_before_passing = int
|
|
|
|
// failures_before_warning = int
|
|
|
|
// failures_before_critical = int
|
2017-10-20 12:00:04 +00:00
|
|
|
// deregister_critical_service_after = "duration"
|
|
|
|
// },
|
|
|
|
// ...
|
|
|
|
// ]
|
2017-10-19 19:26:02 +00:00
|
|
|
Checks []*structs.CheckDefinition
|
|
|
|
|
|
|
|
// ClientAddrs contains the list of ip addresses the DNS, HTTP and HTTPS
|
|
|
|
// endpoints will bind to if the endpoints are enabled (ports > 0) and the
|
|
|
|
// addresses are not overwritten.
|
|
|
|
//
|
|
|
|
// The ip addresses must be provided as a space separated list of ip
|
|
|
|
// addresses and go-sockaddr templates.
|
|
|
|
//
|
|
|
|
// Client addresses cannot contain UNIX socket addresses since a socket
|
|
|
|
// cannot be shared across multiple endpoints (no ports). To use UNIX
|
|
|
|
// sockets configure it in 'addresses'.
|
|
|
|
//
|
|
|
|
// hcl: client_addr = string
|
|
|
|
// flag: -client string
|
|
|
|
ClientAddrs []*net.IPAddr
|
|
|
|
|
2019-04-26 18:25:03 +00:00
|
|
|
// ConfigEntryBootstrap contains a list of ConfigEntries to ensure are created
|
|
|
|
// If entries of the same Kind/Name exist already these will not update them.
|
|
|
|
ConfigEntryBootstrap []structs.ConfigEntry
|
|
|
|
|
2019-06-27 20:22:07 +00:00
|
|
|
// AutoEncryptTLS requires the client to acquire TLS certificates from
|
|
|
|
// servers.
|
|
|
|
AutoEncryptTLS bool
|
|
|
|
|
2020-01-17 22:25:26 +00:00
|
|
|
// Additional DNS SAN entries that clients request during auto_encrypt
|
|
|
|
// flow for their certificates.
|
|
|
|
AutoEncryptDNSSAN []string
|
|
|
|
|
|
|
|
// Additional IP SAN entries that clients request during auto_encrypt
|
|
|
|
// flow for their certificates.
|
|
|
|
AutoEncryptIPSAN []net.IP
|
|
|
|
|
2019-06-27 20:22:07 +00:00
|
|
|
// AutoEncryptAllowTLS enables the server to respond to
|
|
|
|
// AutoEncrypt.Sign requests.
|
|
|
|
AutoEncryptAllowTLS bool
|
|
|
|
|
2020-06-16 19:03:22 +00:00
|
|
|
// AutoConfig is a grouping of the configurations around the agent auto configuration
|
|
|
|
// process including how servers can authorize requests.
|
|
|
|
AutoConfig AutoConfig
|
|
|
|
|
2018-04-16 15:00:20 +00:00
|
|
|
// ConnectEnabled opts the agent into connect. It should be set on all clients
|
2018-06-07 09:17:44 +00:00
|
|
|
// and servers in a cluster for correct connect operation.
|
2018-04-16 15:00:20 +00:00
|
|
|
ConnectEnabled bool
|
|
|
|
|
2022-03-08 18:37:56 +00:00
|
|
|
// ConnectServerlessPluginEnabled opts the agent into the serverless plugin.
|
|
|
|
// This plugin allows services to be configured as AWS Lambdas. After the
|
|
|
|
// Lambda service is configured, Connect services can invoke the Lambda
|
|
|
|
// service like any other upstream.
|
|
|
|
ConnectServerlessPluginEnabled bool
|
|
|
|
|
2018-09-27 13:33:12 +00:00
|
|
|
// ConnectSidecarMinPort is the inclusive start of the range of ports
|
|
|
|
// allocated to the agent for asigning to sidecar services where no port is
|
|
|
|
// specified.
|
|
|
|
ConnectSidecarMinPort int
|
|
|
|
|
|
|
|
// ConnectSidecarMaxPort is the inclusive end of the range of ports
|
|
|
|
// allocated to the agent for asigning to sidecar services where no port is
|
|
|
|
// specified
|
|
|
|
ConnectSidecarMaxPort int
|
|
|
|
|
2019-09-26 02:55:52 +00:00
|
|
|
// ExposeMinPort is the inclusive start of the range of ports
|
|
|
|
// allocated to the agent for exposing checks through a proxy
|
|
|
|
ExposeMinPort int
|
|
|
|
|
|
|
|
// ExposeMinPort is the inclusive start of the range of ports
|
|
|
|
// allocated to the agent for exposing checks through a proxy
|
|
|
|
ExposeMaxPort int
|
|
|
|
|
2018-04-25 18:34:08 +00:00
|
|
|
// ConnectCAProvider is the type of CA provider to use with Connect.
|
|
|
|
ConnectCAProvider string
|
|
|
|
|
|
|
|
// ConnectCAConfig is the config to use for the CA provider.
|
|
|
|
ConnectCAConfig map[string]interface{}
|
|
|
|
|
2020-03-09 20:59:02 +00:00
|
|
|
// ConnectMeshGatewayWANFederationEnabled determines if wan federation of
|
|
|
|
// datacenters should exclusively traverse mesh gateways.
|
|
|
|
ConnectMeshGatewayWANFederationEnabled bool
|
|
|
|
|
2019-01-10 12:46:11 +00:00
|
|
|
// ConnectTestCALeafRootChangeSpread is used to control how long the CA leaf
|
|
|
|
// cache with spread CSRs over when a root change occurs. For now we don't
|
|
|
|
// expose this in public config intentionally but could later with a rename.
|
|
|
|
// We only set this from during tests to effectively make CA rotation tests
|
|
|
|
// deterministic again.
|
|
|
|
ConnectTestCALeafRootChangeSpread time.Duration
|
|
|
|
|
2017-10-19 19:26:02 +00:00
|
|
|
// DNSAddrs contains the list of TCP and UDP addresses the DNS server will
|
|
|
|
// bind to. If the DNS endpoint is disabled (ports.dns <= 0) the list is
|
|
|
|
// empty.
|
|
|
|
//
|
|
|
|
// The ip addresses are taken from 'addresses.dns' which should contain a
|
|
|
|
// space separated list of ip addresses and/or go-sockaddr templates.
|
|
|
|
//
|
|
|
|
// If 'addresses.dns' was not provided the 'client_addr' addresses are
|
|
|
|
// used.
|
|
|
|
//
|
|
|
|
// The DNS server cannot be bound to UNIX sockets.
|
|
|
|
//
|
|
|
|
// hcl: client_addr = string addresses { dns = string } ports { dns = int }
|
|
|
|
DNSAddrs []net.Addr
|
|
|
|
|
|
|
|
// DNSPort is the port the DNS server listens on. The default is 8600.
|
|
|
|
// Setting this to a value <= 0 disables the endpoint.
|
|
|
|
//
|
|
|
|
// hcl: ports { dns = int }
|
|
|
|
// flags: -dns-port int
|
|
|
|
DNSPort int
|
2017-10-19 07:47:22 +00:00
|
|
|
|
Added SOA configuration for DNS settings. (#4714)
This will allow to fine TUNE SOA settings sent by Consul in DNS responses,
for instance to be able to control negative ttl.
Will fix: https://github.com/hashicorp/consul/issues/4713
# Example
Override all settings:
* min_ttl: 0 => 60s
* retry: 600 (10m) => 300s (5 minutes),
* expire: 86400 (24h) => 43200 (12h)
* refresh: 3600 (1h) => 1800 (30 minutes)
```
consul agent -dev -hcl 'dns_config={soa={min_ttl=60,retry=300,expire=43200,refresh=1800}}'
```
Result:
```
dig +multiline @localhost -p 8600 service.consul
; <<>> DiG 9.12.1 <<>> +multiline @localhost -p 8600 service.consul
; (2 servers found)
;; global options: +cmd
;; Got answer:
;; ->>HEADER<<- opcode: QUERY, status: NXDOMAIN, id: 36557
;; flags: qr aa rd; QUERY: 1, ANSWER: 0, AUTHORITY: 1, ADDITIONAL: 1
;; WARNING: recursion requested but not available
;; OPT PSEUDOSECTION:
; EDNS: version: 0, flags:; udp: 4096
;; QUESTION SECTION:
;service.consul. IN A
;; AUTHORITY SECTION:
consul. 0 IN SOA ns.consul. hostmaster.consul. (
1537959133 ; serial
1800 ; refresh (30 minutes)
300 ; retry (5 minutes)
43200 ; expire (12 hours)
60 ; minimum (1 minute)
)
;; Query time: 4 msec
;; SERVER: 127.0.0.1#8600(127.0.0.1)
;; WHEN: Wed Sep 26 12:52:13 CEST 2018
;; MSG SIZE rcvd: 93
```
2018-10-10 19:50:56 +00:00
|
|
|
// DNSSOA is the settings applied for DNS SOA
|
|
|
|
// hcl: soa {}
|
|
|
|
DNSSOA RuntimeSOAConfig
|
|
|
|
|
2017-10-19 07:47:22 +00:00
|
|
|
// DataDir is the path to the directory where the local state is stored.
|
|
|
|
//
|
|
|
|
// hcl: data_dir = string
|
|
|
|
// flag: -data-dir string
|
|
|
|
DataDir string
|
2017-10-18 15:31:00 +00:00
|
|
|
|
2020-01-17 13:20:57 +00:00
|
|
|
// DefaultQueryTime is the amount of time a blocking query will wait before
|
|
|
|
// Consul will force a response. This value can be overridden by the 'wait'
|
|
|
|
// query parameter.
|
|
|
|
//
|
|
|
|
// hcl: default_query_time = "duration"
|
|
|
|
// flag: -default-query-time string
|
|
|
|
DefaultQueryTime time.Duration
|
|
|
|
|
2017-10-18 15:31:00 +00:00
|
|
|
// 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
|
|
|
|
|
2017-10-19 19:26:02 +00:00
|
|
|
// DisableAnonymousSignature is used to turn off the anonymous signature
|
|
|
|
// send with the update check. This is used to deduplicate messages.
|
|
|
|
//
|
|
|
|
// hcl: disable_anonymous_signature = (true|false)
|
2017-10-18 15:23:56 +00:00
|
|
|
DisableAnonymousSignature bool
|
2017-10-19 19:26:02 +00:00
|
|
|
|
|
|
|
// DisableCoordinates controls features related to network coordinates.
|
|
|
|
//
|
|
|
|
// hcl: disable_coordinates = (true|false)
|
|
|
|
DisableCoordinates bool
|
2017-10-19 07:47:22 +00:00
|
|
|
|
|
|
|
// DisableHostNodeID will prevent Consul from using information from the
|
|
|
|
// host to generate a node ID, and will cause Consul to generate a
|
|
|
|
// random ID instead.
|
|
|
|
//
|
|
|
|
// hcl: disable_host_node_id = (true|false)
|
2017-10-19 19:26:02 +00:00
|
|
|
// flag: -disable-host-node-id
|
2017-10-19 07:47:22 +00:00
|
|
|
DisableHostNodeID bool
|
|
|
|
|
2018-07-26 12:53:39 +00:00
|
|
|
// DisableHTTPUnprintableCharFilter will bypass the filter preventing HTTP
|
|
|
|
// URLs from containing unprintable chars. This filter was added in 1.0.3 as a
|
|
|
|
// response to a vulnerability report. Disabling this is never recommended in
|
|
|
|
// general however some users who have keys written in older versions of
|
|
|
|
// Consul may use this to temporarily disable the filter such that they can
|
|
|
|
// delete those keys again! We do not recommend leaving it disabled long term.
|
|
|
|
//
|
|
|
|
// hcl: disable_http_unprintable_char_filter
|
|
|
|
DisableHTTPUnprintableCharFilter bool
|
|
|
|
|
2017-10-19 07:47:22 +00:00
|
|
|
// DisableKeyringFile disables writing the keyring to a file.
|
|
|
|
//
|
|
|
|
// hcl: disable_keyring_file = (true|false)
|
|
|
|
// flag: -disable-keyring-file
|
|
|
|
DisableKeyringFile bool
|
|
|
|
|
2017-10-19 19:26:02 +00:00
|
|
|
// DisableRemoteExec is used to turn off the remote execution
|
|
|
|
// feature. This is for security to prevent unknown scripts from running.
|
|
|
|
//
|
|
|
|
// hcl: disable_remote_exec = (true|false)
|
|
|
|
DisableRemoteExec bool
|
|
|
|
|
|
|
|
// DisableUpdateCheck is used to turn off the automatic update and
|
|
|
|
// security bulletin checking.
|
|
|
|
//
|
|
|
|
// hcl: disable_update_check = (true|false)
|
2017-10-19 07:47:22 +00:00
|
|
|
DisableUpdateCheck bool
|
2017-10-19 19:26:02 +00:00
|
|
|
|
|
|
|
// DiscardCheckOutput is used to turn off storing and comparing the
|
|
|
|
// output of health checks. This reduces the write rate on the server
|
|
|
|
// for checks with highly volatile output. (reloadable)
|
|
|
|
//
|
|
|
|
// See also: CheckUpdateInterval
|
|
|
|
//
|
|
|
|
// hcl: discard_check_output = (true|false)
|
2017-10-19 07:47:22 +00:00
|
|
|
DiscardCheckOutput bool
|
2017-10-18 15:23:56 +00:00
|
|
|
|
2017-11-08 02:22:09 +00:00
|
|
|
// EnableAgentTLSForChecks is used to apply the agent's TLS settings in
|
|
|
|
// order to configure the HTTP client used for health checks. Enabling
|
|
|
|
// this allows HTTP checks to present a client certificate and verify
|
|
|
|
// the server using the same TLS configuration as the agent (CA, cert,
|
|
|
|
// and key).
|
|
|
|
EnableAgentTLSForChecks bool
|
|
|
|
|
2019-04-24 13:11:08 +00:00
|
|
|
// EnableCentralServiceConfig controls whether the agent should incorporate
|
|
|
|
// centralized config such as service-defaults into local service registrations.
|
|
|
|
//
|
2019-04-25 09:11:07 +00:00
|
|
|
// hcl: enable_central_service_config = (true|false)
|
2019-04-24 13:11:08 +00:00
|
|
|
EnableCentralServiceConfig bool
|
|
|
|
|
2017-10-19 07:47:22 +00:00
|
|
|
// EnableDebug is used to enable various debugging features.
|
|
|
|
//
|
|
|
|
// hcl: enable_debug = (true|false)
|
|
|
|
EnableDebug bool
|
|
|
|
|
2018-10-11 12:22:11 +00:00
|
|
|
// EnableLocalScriptChecks controls whether health checks declared from the local
|
|
|
|
// config file which execute scripts are enabled. This includes regular script
|
|
|
|
// checks and Docker checks.
|
|
|
|
//
|
|
|
|
// hcl: (enable_script_checks|enable_local_script_checks) = (true|false)
|
|
|
|
// flag: -enable-script-checks, -enable-local-script-checks
|
|
|
|
EnableLocalScriptChecks bool
|
|
|
|
|
|
|
|
// EnableRemoeScriptChecks controls whether health checks declared from the http API
|
|
|
|
// which execute scripts are enabled. This includes regular script checks and Docker
|
2017-10-19 19:26:02 +00:00
|
|
|
// checks.
|
|
|
|
//
|
|
|
|
// hcl: enable_script_checks = (true|false)
|
|
|
|
// flag: -enable-script-checks
|
2018-10-11 12:22:11 +00:00
|
|
|
EnableRemoteScriptChecks bool
|
2017-10-19 19:26:02 +00:00
|
|
|
|
2017-10-19 07:47:22 +00:00
|
|
|
// EncryptKey contains the encryption key to use for the Serf communication.
|
|
|
|
//
|
|
|
|
// hcl: encrypt = string
|
|
|
|
// flag: -encrypt string
|
|
|
|
EncryptKey string
|
|
|
|
|
2021-09-08 15:48:41 +00:00
|
|
|
// GRPCPort is the port the gRPC server listens on. Currently this only
|
2018-10-09 16:57:26 +00:00
|
|
|
// exposes the xDS and ext_authz APIs for Envoy and it is disabled by default.
|
2018-10-03 13:05:28 +00:00
|
|
|
//
|
2021-09-08 15:48:41 +00:00
|
|
|
// hcl: ports { grpc = int }
|
|
|
|
// flags: -grpc-port int
|
|
|
|
GRPCPort int
|
2018-10-03 13:05:28 +00:00
|
|
|
|
2021-09-08 15:48:41 +00:00
|
|
|
// GRPCAddrs contains the list of TCP addresses and UNIX sockets the gRPC
|
|
|
|
// server will bind to. If the gRPC endpoint is disabled (ports.grpc <= 0)
|
2018-10-03 13:05:28 +00:00
|
|
|
// the list is empty.
|
|
|
|
//
|
2021-09-08 15:48:41 +00:00
|
|
|
// The addresses are taken from 'addresses.grpc' which should contain a
|
2018-10-03 13:05:28 +00:00
|
|
|
// space separated list of ip addresses, UNIX socket paths and/or
|
|
|
|
// go-sockaddr templates. UNIX socket paths must be written as
|
2021-09-08 15:48:41 +00:00
|
|
|
// 'unix://<full path>', e.g. 'unix:///var/run/consul-grpc.sock'.
|
2018-10-03 13:05:28 +00:00
|
|
|
//
|
2021-09-08 15:48:41 +00:00
|
|
|
// If 'addresses.grpc' was not provided the 'client_addr' addresses are
|
2018-10-03 13:05:28 +00:00
|
|
|
// used.
|
|
|
|
//
|
2021-09-08 15:48:41 +00:00
|
|
|
// hcl: client_addr = string addresses { grpc = string } ports { grpc = int }
|
|
|
|
GRPCAddrs []net.Addr
|
2018-10-03 13:05:28 +00:00
|
|
|
|
2017-10-20 12:00:04 +00:00
|
|
|
// HTTPAddrs contains the list of TCP addresses and UNIX sockets the HTTP
|
|
|
|
// server will bind to. If the HTTP endpoint is disabled (ports.http <= 0)
|
|
|
|
// the list is empty.
|
|
|
|
//
|
|
|
|
// The addresses are taken from 'addresses.http' which should contain a
|
|
|
|
// space separated list of ip addresses, UNIX socket paths and/or
|
|
|
|
// go-sockaddr templates. UNIX socket paths must be written as
|
|
|
|
// 'unix://<full path>', e.g. 'unix:///var/run/consul-http.sock'.
|
|
|
|
//
|
|
|
|
// If 'addresses.http' was not provided the 'client_addr' addresses are
|
|
|
|
// used.
|
|
|
|
//
|
|
|
|
// hcl: client_addr = string addresses { http = string } ports { http = int }
|
2017-10-19 19:26:02 +00:00
|
|
|
HTTPAddrs []net.Addr
|
|
|
|
|
|
|
|
// HTTPPort is the port the HTTP server listens on. The default is 8500.
|
|
|
|
// Setting this to a value <= 0 disables the endpoint.
|
|
|
|
//
|
|
|
|
// hcl: ports { http = int }
|
|
|
|
// flags: -http-port int
|
|
|
|
HTTPPort int
|
|
|
|
|
2017-10-20 12:00:04 +00:00
|
|
|
// HTTPSAddrs contains the list of TCP addresses and UNIX sockets the HTTPS
|
|
|
|
// server will bind to. If the HTTPS endpoint is disabled (ports.https <=
|
|
|
|
// 0) the list is empty.
|
|
|
|
//
|
|
|
|
// The addresses are taken from 'addresses.https' which should contain a
|
|
|
|
// space separated list of ip addresses, UNIX socket paths and/or
|
|
|
|
// go-sockaddr templates. UNIX socket paths must be written as
|
|
|
|
// 'unix://<full path>', e.g. 'unix:///var/run/consul-https.sock'.
|
|
|
|
//
|
|
|
|
// If 'addresses.https' was not provided the 'client_addr' addresses are
|
|
|
|
// used.
|
|
|
|
//
|
|
|
|
// hcl: client_addr = string addresses { https = string } ports { https = int }
|
2017-10-19 07:47:22 +00:00
|
|
|
HTTPSAddrs []net.Addr
|
2017-10-19 19:26:02 +00:00
|
|
|
|
2020-01-31 16:19:37 +00:00
|
|
|
// HTTPMaxConnsPerClient limits the number of concurrent TCP connections the
|
|
|
|
// HTTP(S) server will accept from any single source IP address.
|
|
|
|
//
|
2020-02-13 15:27:33 +00:00
|
|
|
// hcl: limits{ http_max_conns_per_client = 200 }
|
2020-01-31 16:19:37 +00:00
|
|
|
HTTPMaxConnsPerClient int
|
|
|
|
|
2020-10-29 17:38:19 +00:00
|
|
|
// HTTPMaxHeaderBytes controls the maximum number of bytes the
|
|
|
|
// server will read parsing the request header's keys and
|
|
|
|
// values, including the request line. It does not limit the
|
|
|
|
// size of the request body.
|
|
|
|
//
|
|
|
|
// If zero, or negative, http.DefaultMaxHeaderBytes is used.
|
|
|
|
HTTPMaxHeaderBytes int
|
|
|
|
|
2020-01-31 16:19:37 +00:00
|
|
|
// HTTPSHandshakeTimeout is the time allowed for HTTPS client to complete the
|
|
|
|
// TLS handshake and send first bytes of the request.
|
|
|
|
//
|
|
|
|
// hcl: limits{ https_handshake_timeout = "5s" }
|
|
|
|
HTTPSHandshakeTimeout time.Duration
|
|
|
|
|
2017-10-19 19:26:02 +00:00
|
|
|
// HTTPSPort is the port the HTTP server listens on. The default is -1.
|
|
|
|
// Setting this to a value <= 0 disables the endpoint.
|
|
|
|
//
|
|
|
|
// hcl: ports { https = int }
|
2020-01-22 10:32:17 +00:00
|
|
|
// flags: -https-port int
|
2017-10-19 19:26:02 +00:00
|
|
|
HTTPSPort int
|
2017-10-19 07:47:22 +00:00
|
|
|
|
2019-07-24 21:06:39 +00:00
|
|
|
// KVMaxValueSize controls the max allowed value size. If not set defaults
|
|
|
|
// to raft's suggested max value size.
|
|
|
|
//
|
2019-07-25 19:38:57 +00:00
|
|
|
// hcl: limits { kv_max_value_size = uint64 }
|
2019-07-24 21:06:39 +00:00
|
|
|
KVMaxValueSize uint64
|
|
|
|
|
2017-10-20 12:00:04 +00:00
|
|
|
// LeaveDrainTime is used to wait after a server has left the LAN Serf
|
|
|
|
// pool for RPCs to drain and new requests to be sent to other servers.
|
2017-10-19 19:26:02 +00:00
|
|
|
//
|
2017-10-20 12:00:04 +00:00
|
|
|
// hcl: performance { leave_drain_time = "duration" }
|
2017-10-19 07:47:22 +00:00
|
|
|
LeaveDrainTime time.Duration
|
|
|
|
|
|
|
|
// LeaveOnTerm controls if Serf does a graceful leave when receiving
|
|
|
|
// the TERM signal. Defaults true on clients, false on servers. (reloadable)
|
|
|
|
//
|
|
|
|
// hcl: leave_on_terminate = (true|false)
|
|
|
|
LeaveOnTerm bool
|
|
|
|
|
2020-08-19 17:17:05 +00:00
|
|
|
// Logging configuration used to initialize agent logging.
|
|
|
|
Logging logging.Config
|
2019-07-19 21:36:34 +00:00
|
|
|
|
2020-01-17 13:20:57 +00:00
|
|
|
// MaxQueryTime is the maximum amount of time a blocking query can wait
|
|
|
|
// before Consul will force a response. Consul applies jitter to the wait
|
|
|
|
// time. The jittered time will be capped to MaxQueryTime.
|
|
|
|
//
|
|
|
|
// hcl: max_query_time = "duration"
|
|
|
|
// flags: -max-query-time string
|
|
|
|
MaxQueryTime time.Duration
|
|
|
|
|
2017-10-19 07:47:22 +00:00
|
|
|
// Node ID is a unique ID for this node across space and time. Defaults
|
|
|
|
// to a randomly-generated ID that persists in the data-dir.
|
|
|
|
//
|
|
|
|
// todo(fs): don't we have a requirement for this to be a UUID in a specific format?
|
|
|
|
//
|
|
|
|
// hcl: node_id = string
|
|
|
|
// flag: -node-id string
|
|
|
|
NodeID types.NodeID
|
|
|
|
|
|
|
|
// NodeMeta contains metadata key/value pairs. These are excluded from JSON output
|
|
|
|
// because they can be reloaded and might be stale when shown from the
|
|
|
|
// config instead of the local state.
|
|
|
|
// todo(fs): should the sanitizer omit them from output as well since they could be stale?
|
|
|
|
//
|
|
|
|
// hcl: node_meta = map[string]string
|
|
|
|
// flag: -node-meta "key:value" -node-meta "key:value" ...
|
|
|
|
NodeMeta map[string]string
|
|
|
|
|
2020-11-17 15:53:57 +00:00
|
|
|
// ReadReplica is whether this server will act as a non-voting member
|
2017-10-19 07:47:22 +00:00
|
|
|
// of the cluster to help provide read scalability. (Enterprise-only)
|
|
|
|
//
|
|
|
|
// hcl: non_voting_server = (true|false)
|
|
|
|
// flag: -non-voting-server
|
2020-11-17 15:53:57 +00:00
|
|
|
ReadReplica bool
|
2017-10-19 07:47:22 +00:00
|
|
|
|
2017-10-19 19:26:02 +00:00
|
|
|
// PidFile is the file to store our PID in.
|
|
|
|
//
|
|
|
|
// hcl: pid_file = string
|
|
|
|
PidFile string
|
|
|
|
|
2018-10-15 16:17:48 +00:00
|
|
|
// PrimaryDatacenter is the central datacenter that holds authoritative
|
|
|
|
// ACL records, replicates intentions and holds the root CA for Connect.
|
|
|
|
// This must be the same for the entire cluster. Off by default.
|
|
|
|
//
|
|
|
|
// hcl: primary_datacenter = string
|
|
|
|
PrimaryDatacenter string
|
|
|
|
|
2020-03-09 20:59:02 +00:00
|
|
|
// PrimaryGateways is a list of addresses and/or go-discover expressions to
|
|
|
|
// discovery the mesh gateways in the primary datacenter. See
|
2022-03-15 23:13:58 +00:00
|
|
|
// https://www.consul.io/docs/agent/options.html#cloud-auto-joining for
|
2020-03-09 20:59:02 +00:00
|
|
|
// details.
|
|
|
|
//
|
|
|
|
// hcl: primary_gateways = []string
|
|
|
|
// flag: -primary-gateway string -primary-gateway string
|
|
|
|
PrimaryGateways []string
|
|
|
|
|
|
|
|
// PrimaryGatewaysInterval specifies the amount of time to wait in between discovery
|
|
|
|
// attempts on agent start. The minimum allowed value is 1 second and
|
|
|
|
// the default is 30s.
|
|
|
|
//
|
|
|
|
// hcl: primary_gateways_interval = "duration"
|
|
|
|
PrimaryGatewaysInterval time.Duration
|
|
|
|
|
2017-10-20 12:00:04 +00:00
|
|
|
// RPCAdvertiseAddr is the TCP address Consul advertises for its RPC endpoint.
|
|
|
|
// By default this is the bind address on the default RPC Server port. If the
|
|
|
|
// advertise address is specified then it is used.
|
|
|
|
//
|
|
|
|
// hcl: bind_addr = string advertise_addr = string ports { server = int }
|
2017-10-19 07:47:22 +00:00
|
|
|
RPCAdvertiseAddr *net.TCPAddr
|
2017-10-19 19:26:02 +00:00
|
|
|
|
2017-10-20 12:00:04 +00:00
|
|
|
// RPCBindAddr is the TCP address Consul will bind to for its RPC endpoint.
|
|
|
|
// By default this is the bind address on the default RPC Server port.
|
2017-10-19 19:26:02 +00:00
|
|
|
//
|
2017-10-20 12:00:04 +00:00
|
|
|
// hcl: bind_addr = string ports { server = int }
|
|
|
|
RPCBindAddr *net.TCPAddr
|
|
|
|
|
2020-01-31 16:19:37 +00:00
|
|
|
// RPCHandshakeTimeout is the timeout for reading the initial magic byte on a
|
|
|
|
// new RPC connection. If this is set high it may allow unauthenticated users
|
|
|
|
// to hold connections open arbitrarily long, even when mutual TLS is being
|
|
|
|
// enforced. It may be set to 0 explicitly to disable the timeout but this
|
|
|
|
// should never be used in production. Default is 5 seconds.
|
|
|
|
//
|
|
|
|
// hcl: limits { rpc_handshake_timeout = "duration" }
|
|
|
|
RPCHandshakeTimeout time.Duration
|
|
|
|
|
2017-10-20 12:00:04 +00:00
|
|
|
// RPCHoldTimeout is how long an RPC can be "held" before it is errored.
|
|
|
|
// This is used to paper over a loss of leadership by instead holding RPCs,
|
|
|
|
// so that the caller experiences a slow response rather than an error.
|
|
|
|
// This period is meant to be long enough for a leader election to take
|
|
|
|
// place, and a small jitter is applied to avoid a thundering herd.
|
|
|
|
//
|
|
|
|
// hcl: performance { rpc_hold_timeout = "duration" }
|
2017-10-19 19:26:02 +00:00
|
|
|
RPCHoldTimeout time.Duration
|
2017-10-18 15:31:00 +00:00
|
|
|
|
|
|
|
// RPCRateLimit and RPCMaxBurst control how frequently RPC calls are allowed
|
|
|
|
// to happen. In any large enough time interval, rate limiter limits the
|
2020-09-16 17:29:59 +00:00
|
|
|
// rate to RPCRateLimit tokens per second, with a maximum burst size of
|
|
|
|
// RPCMaxBurst events. As a special case, if RPCRateLimit == Inf (the infinite
|
2017-10-18 15:31:00 +00:00
|
|
|
// 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
|
|
|
|
|
2020-01-31 16:19:37 +00:00
|
|
|
// RPCMaxConnsPerClient limits the number of concurrent TCP connections the
|
|
|
|
// RPC server will accept from any single source IP address.
|
|
|
|
//
|
|
|
|
// hcl: limits{ rpc_max_conns_per_client = 100 }
|
|
|
|
RPCMaxConnsPerClient int
|
|
|
|
|
2017-10-19 07:47:22 +00:00
|
|
|
// RPCProtocol is the Consul protocol version to use.
|
|
|
|
//
|
|
|
|
// hcl: protocol = int
|
|
|
|
RPCProtocol int
|
|
|
|
|
2020-10-05 20:28:13 +00:00
|
|
|
RPCConfig consul.RPCConfig
|
|
|
|
|
2020-10-23 21:47:01 +00:00
|
|
|
// UseStreamingBackend enables streaming as a replacement for agent/cache
|
|
|
|
// in the client agent for endpoints which support streaming.
|
|
|
|
UseStreamingBackend bool
|
2020-10-05 21:31:35 +00:00
|
|
|
|
2017-10-19 07:47:22 +00:00
|
|
|
// RaftProtocol sets the Raft protocol version to use on this server.
|
|
|
|
// Defaults to 3.
|
|
|
|
//
|
|
|
|
// hcl: raft_protocol = int
|
|
|
|
RaftProtocol int
|
|
|
|
|
2018-05-10 15:16:38 +00:00
|
|
|
// RaftSnapshotThreshold sets the minimum threshold of raft commits after which
|
|
|
|
// a snapshot is created. Defaults to 8192
|
|
|
|
//
|
|
|
|
// hcl: raft_snapshot_threshold = int
|
|
|
|
RaftSnapshotThreshold int
|
|
|
|
|
2018-05-10 22:06:47 +00:00
|
|
|
// RaftSnapshotInterval sets the interval to use when checking whether to create
|
|
|
|
// a new snapshot. Defaults to 5 seconds.
|
|
|
|
// hcl: raft_snapshot_threshold = int
|
|
|
|
RaftSnapshotInterval time.Duration
|
|
|
|
|
2019-07-23 14:19:57 +00:00
|
|
|
// RaftTrailingLogs sets the number of log entries that will be left in the
|
|
|
|
// log store after a snapshot. This must be large enough that a follower can
|
|
|
|
// transfer and restore an entire snapshot of the state before this many new
|
|
|
|
// entries have been appended. In vast majority of cases the default is plenty
|
|
|
|
// but if there is a sustained high write throughput coupled with a huge
|
|
|
|
// multi-gigabyte snapshot setting this higher may be necessary to allow
|
|
|
|
// followers time to reload from snapshot without becoming unhealthy. If it's
|
|
|
|
// too low then followers are unable to ever recover from a restart and will
|
|
|
|
// enter a loop of constantly downloading full snapshots and never catching
|
|
|
|
// up. If you need to change this you should reconsider your usage of Consul
|
|
|
|
// as it is not designed to store multiple-gigabyte data sets with high write
|
|
|
|
// throughput. Defaults to 10000.
|
|
|
|
//
|
|
|
|
// hcl: raft_trailing_logs = int
|
|
|
|
RaftTrailingLogs int
|
|
|
|
|
2021-11-17 23:15:19 +00:00
|
|
|
RaftBoltDBConfig consul.RaftBoltDBConfig
|
|
|
|
|
2017-10-19 19:26:02 +00:00
|
|
|
// ReconnectTimeoutLAN specifies the amount of time to wait to reconnect with
|
|
|
|
// another agent before deciding it's permanently gone. This can be used to
|
|
|
|
// control the time it takes to reap failed nodes from the cluster.
|
|
|
|
//
|
|
|
|
// hcl: reconnect_timeout = "duration"
|
|
|
|
ReconnectTimeoutLAN time.Duration
|
|
|
|
|
|
|
|
// ReconnectTimeoutWAN specifies the amount of time to wait to reconnect with
|
|
|
|
// another agent before deciding it's permanently gone. This can be used to
|
|
|
|
// control the time it takes to reap failed nodes from the cluster.
|
|
|
|
//
|
|
|
|
// hcl: reconnect_timeout = "duration"
|
|
|
|
ReconnectTimeoutWAN time.Duration
|
|
|
|
|
2020-10-08 19:02:19 +00:00
|
|
|
// AdvertiseReconnectTimeout specifies the amount of time other agents should
|
|
|
|
// wait for us to reconnect before deciding we are permanently gone. This
|
|
|
|
// should only be set for client agents that are run in a stateless or
|
|
|
|
// ephemeral manner in order to realize their deletion sooner than we
|
|
|
|
// would otherwise.
|
|
|
|
AdvertiseReconnectTimeout time.Duration
|
|
|
|
|
2017-10-19 19:26:02 +00:00
|
|
|
// RejoinAfterLeave controls our interaction with the cluster after leave.
|
|
|
|
// When set to false (default), a leave causes Consul to not rejoin
|
|
|
|
// the cluster until an explicit join is received. If this is set to
|
|
|
|
// true, we ignore the leave, and rejoin the cluster on start.
|
|
|
|
//
|
|
|
|
// hcl: rejoin_after_leave = (true|false)
|
|
|
|
// flag: -rejoin
|
|
|
|
RejoinAfterLeave bool
|
|
|
|
|
|
|
|
// RetryJoinIntervalLAN specifies the amount of time to wait in between join
|
|
|
|
// attempts on agent start. The minimum allowed value is 1 second and
|
|
|
|
// the default is 30s.
|
|
|
|
//
|
2020-03-09 20:59:02 +00:00
|
|
|
// hcl: retry_interval = "duration"
|
2017-10-19 19:26:02 +00:00
|
|
|
RetryJoinIntervalLAN time.Duration
|
|
|
|
|
|
|
|
// RetryJoinIntervalWAN specifies the amount of time to wait in between join
|
|
|
|
// attempts on agent start. The minimum allowed value is 1 second and
|
|
|
|
// the default is 30s.
|
|
|
|
//
|
2020-03-09 20:59:02 +00:00
|
|
|
// hcl: retry_interval_wan = "duration"
|
2017-10-19 19:26:02 +00:00
|
|
|
RetryJoinIntervalWAN time.Duration
|
|
|
|
|
|
|
|
// RetryJoinLAN is a list of addresses and/or go-discover expressions to
|
|
|
|
// join with retry enabled. See
|
2022-03-15 23:13:58 +00:00
|
|
|
// https://www.consul.io/docs/agent/options.html#cloud-auto-joining for
|
2017-10-19 19:26:02 +00:00
|
|
|
// details.
|
|
|
|
//
|
|
|
|
// hcl: retry_join = []string
|
|
|
|
// flag: -retry-join string -retry-join string
|
|
|
|
RetryJoinLAN []string
|
|
|
|
|
|
|
|
// RetryJoinMaxAttemptsLAN specifies the maximum number of times to retry
|
|
|
|
// joining a host on startup. This is useful for cases where we know the
|
|
|
|
// node will be online eventually.
|
|
|
|
//
|
|
|
|
// hcl: retry_max = int
|
|
|
|
// flag: -retry-max int
|
2017-10-19 07:47:22 +00:00
|
|
|
RetryJoinMaxAttemptsLAN int
|
2017-10-19 19:26:02 +00:00
|
|
|
|
|
|
|
// RetryJoinMaxAttemptsWAN specifies the maximum number of times to retry
|
|
|
|
// joining a host on startup. This is useful for cases where we know the
|
|
|
|
// node will be online eventually.
|
|
|
|
//
|
|
|
|
// hcl: retry_max_wan = int
|
|
|
|
// flag: -retry-max-wan int
|
2017-10-19 07:47:22 +00:00
|
|
|
RetryJoinMaxAttemptsWAN int
|
2017-10-19 19:26:02 +00:00
|
|
|
|
|
|
|
// RetryJoinWAN is a list of addresses and/or go-discover expressions to
|
|
|
|
// join -wan with retry enabled. See
|
2022-03-15 23:13:58 +00:00
|
|
|
// https://www.consul.io/docs/agent/options.html#cloud-auto-joining for
|
2017-10-19 19:26:02 +00:00
|
|
|
// details.
|
|
|
|
//
|
|
|
|
// hcl: retry_join_wan = []string
|
|
|
|
// flag: -retry-join-wan string -retry-join-wan string
|
|
|
|
RetryJoinWAN []string
|
2017-10-19 07:47:22 +00:00
|
|
|
|
|
|
|
// SegmentName is the network segment for this client to join.
|
|
|
|
// (Enterprise-only)
|
|
|
|
//
|
|
|
|
// hcl: segment = string
|
|
|
|
SegmentName string
|
|
|
|
|
|
|
|
// Segments is the list of network segments for this server to
|
|
|
|
// initialize.
|
|
|
|
//
|
|
|
|
// hcl: segment = [
|
|
|
|
// {
|
|
|
|
// # name is the name of the segment
|
|
|
|
// name = string
|
|
|
|
//
|
|
|
|
// # bind is the bind ip address for this segment.
|
|
|
|
// bind = string
|
|
|
|
//
|
|
|
|
// # port is the bind port for this segment.
|
|
|
|
// port = int
|
|
|
|
//
|
|
|
|
// # advertise is the advertise ip address for this segment.
|
|
|
|
// # Defaults to the bind address if not set.
|
|
|
|
// advertise = string
|
|
|
|
//
|
|
|
|
// # rpc_listener controls whether or not to bind a separate
|
|
|
|
// # RPC listener to the bind address.
|
|
|
|
// rpc_listener = (true|false)
|
|
|
|
// },
|
|
|
|
// ...
|
|
|
|
// ]
|
|
|
|
Segments []structs.NetworkSegment
|
|
|
|
|
2017-10-20 12:00:04 +00:00
|
|
|
// SerfAdvertiseAddrLAN is the TCP address which is used for advertising
|
|
|
|
// the LAN Gossip pool for both client and server. The address is the
|
|
|
|
// combination of AdvertiseAddrLAN and the SerfPortLAN. If the advertise
|
|
|
|
// address is not given the bind address is used.
|
|
|
|
//
|
|
|
|
// hcl: bind_addr = string advertise_addr = string ports { serf_lan = int }
|
2017-10-19 07:47:22 +00:00
|
|
|
SerfAdvertiseAddrLAN *net.TCPAddr
|
2017-10-20 12:00:04 +00:00
|
|
|
|
|
|
|
// SerfAdvertiseAddrWAN is the TCP address which is used for advertising
|
|
|
|
// the WAN Gossip pool on the server only. The address is the combination
|
|
|
|
// of AdvertiseAddrWAN and the SerfPortWAN. If the advertise address is not
|
|
|
|
// given the bind address is used.
|
|
|
|
//
|
|
|
|
// hcl: bind_addr = string advertise_addr_wan = string ports { serf_wan = int }
|
2017-10-19 07:47:22 +00:00
|
|
|
SerfAdvertiseAddrWAN *net.TCPAddr
|
2017-10-20 12:00:04 +00:00
|
|
|
|
2020-05-20 09:31:19 +00:00
|
|
|
// SerfAllowedCIDRsLAN if set to a non-empty value, will restrict which networks
|
|
|
|
// are allowed to connect to Serf on the LAN.
|
|
|
|
// hcl: serf_lan_allowed_cidrs = []string
|
|
|
|
// flag: serf-lan-allowed-cidrs string (can be specified multiple times)
|
|
|
|
SerfAllowedCIDRsLAN []net.IPNet
|
|
|
|
|
|
|
|
// SerfAllowedCIDRsWAN if set to a non-empty value, will restrict which networks
|
|
|
|
// are allowed to connect to Serf on the WAN.
|
|
|
|
// hcl: serf_wan_allowed_cidrs = []string
|
|
|
|
// flag: serf-wan-allowed-cidrs string (can be specified multiple times)
|
|
|
|
SerfAllowedCIDRsWAN []net.IPNet
|
|
|
|
|
2017-10-20 12:00:04 +00:00
|
|
|
// SerfBindAddrLAN is the address to bind the Serf LAN TCP and UDP
|
|
|
|
// listeners to. The ip address is either the default bind address or the
|
|
|
|
// 'serf_lan' address which can be either an ip address or a go-sockaddr
|
|
|
|
// template which resolves to a single ip address.
|
|
|
|
//
|
|
|
|
// hcl: bind_addr = string serf_lan = string ports { serf_lan = int }
|
|
|
|
// flag: -serf-lan string
|
|
|
|
SerfBindAddrLAN *net.TCPAddr
|
|
|
|
|
|
|
|
// SerfBindAddrWAN is the address to bind the Serf WAN TCP and UDP
|
|
|
|
// listeners to. The ip address is either the default bind address or the
|
|
|
|
// 'serf_wan' address which can be either an ip address or a go-sockaddr
|
|
|
|
// template which resolves to a single ip address.
|
|
|
|
//
|
|
|
|
// hcl: bind_addr = string serf_wan = string ports { serf_wan = int }
|
|
|
|
// flag: -serf-wan string
|
|
|
|
SerfBindAddrWAN *net.TCPAddr
|
|
|
|
|
|
|
|
// SerfPortLAN is the port used for the LAN Gossip pool for both client and server.
|
|
|
|
// The default is 8301.
|
|
|
|
//
|
|
|
|
// hcl: ports { serf_lan = int }
|
|
|
|
SerfPortLAN int
|
|
|
|
|
|
|
|
// SerfPortWAN is the port used for the WAN Gossip pool for the server only.
|
|
|
|
// The default is 8302.
|
|
|
|
//
|
|
|
|
// hcl: ports { serf_wan = int }
|
|
|
|
SerfPortWAN int
|
2017-10-19 07:47:22 +00:00
|
|
|
|
2018-07-26 15:39:49 +00:00
|
|
|
// GossipLANGossipInterval is the interval between sending messages that need
|
|
|
|
// to be gossiped that haven't been able to piggyback on probing messages.
|
|
|
|
// If this is set to zero, non-piggyback gossip is disabled. By lowering
|
|
|
|
// this value (more frequent) gossip messages are propagated across
|
|
|
|
// the cluster more quickly at the expense of increased bandwidth. This
|
|
|
|
// configuration only applies to LAN gossip communications
|
|
|
|
//
|
|
|
|
// The default is: 200ms
|
|
|
|
//
|
|
|
|
// hcl: gossip_lan { gossip_interval = duration}
|
|
|
|
GossipLANGossipInterval time.Duration
|
|
|
|
|
|
|
|
// GossipLANGossipNodes is the number of random nodes to send gossip messages to
|
|
|
|
// per GossipInterval. Increasing this number causes the gossip messages to
|
|
|
|
// propagate across the cluster more quickly at the expense of increased
|
|
|
|
// bandwidth. This configuration only applies to LAN gossip communications
|
|
|
|
//
|
|
|
|
// The default is: 3
|
|
|
|
//
|
|
|
|
// hcl: gossip_lan { gossip_nodes = int }
|
|
|
|
GossipLANGossipNodes int
|
|
|
|
|
|
|
|
// GossipLANProbeInterval is the interval between random node probes. Setting
|
|
|
|
// this lower (more frequent) will cause the memberlist cluster to detect
|
|
|
|
// failed nodes more quickly at the expense of increased bandwidth usage.
|
|
|
|
// This configuration only applies to LAN gossip communications
|
|
|
|
//
|
|
|
|
// The default is: 1s
|
|
|
|
//
|
|
|
|
// hcl: gossip_lan { probe_interval = duration }
|
|
|
|
GossipLANProbeInterval time.Duration
|
|
|
|
|
|
|
|
// GossipLANProbeTimeout is the timeout to wait for an ack from a probed node
|
|
|
|
// before assuming it is unhealthy. This should be set to 99-percentile
|
|
|
|
// of RTT (round-trip time) on your network. This configuration
|
|
|
|
// only applies to the LAN gossip communications
|
|
|
|
//
|
|
|
|
// The default is: 500ms
|
|
|
|
//
|
|
|
|
// hcl: gossip_lan { probe_timeout = duration }
|
|
|
|
GossipLANProbeTimeout time.Duration
|
|
|
|
|
|
|
|
// GossipLANSuspicionMult is the multiplier for determining the time an
|
|
|
|
// inaccessible node is considered suspect before declaring it dead. This
|
|
|
|
// configuration only applies to LAN gossip communications
|
|
|
|
//
|
|
|
|
// The actual timeout is calculated using the formula:
|
|
|
|
//
|
|
|
|
// SuspicionTimeout = SuspicionMult * log(N+1) * ProbeInterval
|
|
|
|
//
|
|
|
|
// This allows the timeout to scale properly with expected propagation
|
|
|
|
// delay with a larger cluster size. The higher the multiplier, the longer
|
|
|
|
// an inaccessible node is considered part of the cluster before declaring
|
|
|
|
// it dead, giving that suspect node more time to refute if it is indeed
|
|
|
|
// still alive.
|
|
|
|
//
|
|
|
|
// The default is: 4
|
|
|
|
//
|
|
|
|
// hcl: gossip_lan { suspicion_mult = int }
|
|
|
|
GossipLANSuspicionMult int
|
|
|
|
|
|
|
|
// GossipLANRetransmitMult is the multiplier for the number of retransmissions
|
|
|
|
// that are attempted for messages broadcasted over gossip. This
|
|
|
|
// configuration only applies to LAN gossip communications. The actual
|
|
|
|
// count of retransmissions is calculated using the formula:
|
|
|
|
//
|
|
|
|
// Retransmits = RetransmitMult * log(N+1)
|
|
|
|
//
|
|
|
|
// This allows the retransmits to scale properly with cluster size. The
|
|
|
|
// higher the multiplier, the more likely a failed broadcast is to converge
|
|
|
|
// at the expense of increased bandwidth.
|
|
|
|
//
|
|
|
|
// The default is: 4
|
|
|
|
//
|
|
|
|
// hcl: gossip_lan { retransmit_mult = int }
|
|
|
|
GossipLANRetransmitMult int
|
|
|
|
|
|
|
|
// GossipWANGossipInterval is the interval between sending messages that need
|
|
|
|
// to be gossiped that haven't been able to piggyback on probing messages.
|
|
|
|
// If this is set to zero, non-piggyback gossip is disabled. By lowering
|
|
|
|
// this value (more frequent) gossip messages are propagated across
|
|
|
|
// the cluster more quickly at the expense of increased bandwidth. This
|
|
|
|
// configuration only applies to WAN gossip communications
|
|
|
|
//
|
2020-11-27 19:49:43 +00:00
|
|
|
// The default is: 500ms
|
2018-07-26 15:39:49 +00:00
|
|
|
//
|
|
|
|
// hcl: gossip_wan { gossip_interval = duration}
|
|
|
|
GossipWANGossipInterval time.Duration
|
|
|
|
|
|
|
|
// GossipWANGossipNodes is the number of random nodes to send gossip messages to
|
|
|
|
// per GossipInterval. Increasing this number causes the gossip messages to
|
|
|
|
// propagate across the cluster more quickly at the expense of increased
|
|
|
|
// bandwidth. This configuration only applies to WAN gossip communications
|
|
|
|
//
|
2020-11-27 19:49:43 +00:00
|
|
|
// The default is: 4
|
2018-07-26 15:39:49 +00:00
|
|
|
//
|
|
|
|
// hcl: gossip_wan { gossip_nodes = int }
|
|
|
|
GossipWANGossipNodes int
|
|
|
|
|
|
|
|
// GossipWANProbeInterval is the interval between random node probes. Setting
|
|
|
|
// this lower (more frequent) will cause the memberlist cluster to detect
|
|
|
|
// failed nodes more quickly at the expense of increased bandwidth usage.
|
|
|
|
// This configuration only applies to WAN gossip communications
|
|
|
|
//
|
2020-11-27 19:49:43 +00:00
|
|
|
// The default is: 5s
|
2018-07-26 15:39:49 +00:00
|
|
|
//
|
|
|
|
// hcl: gossip_wan { probe_interval = duration }
|
|
|
|
GossipWANProbeInterval time.Duration
|
|
|
|
|
|
|
|
// GossipWANProbeTimeout is the timeout to wait for an ack from a probed node
|
|
|
|
// before assuming it is unhealthy. This should be set to 99-percentile
|
|
|
|
// of RTT (round-trip time) on your network. This configuration
|
|
|
|
// only applies to the WAN gossip communications
|
|
|
|
//
|
2020-11-27 19:49:43 +00:00
|
|
|
// The default is: 3s
|
2018-07-26 15:39:49 +00:00
|
|
|
//
|
|
|
|
// hcl: gossip_wan { probe_timeout = duration }
|
|
|
|
GossipWANProbeTimeout time.Duration
|
|
|
|
|
|
|
|
// GossipWANSuspicionMult is the multiplier for determining the time an
|
|
|
|
// inaccessible node is considered suspect before declaring it dead. This
|
|
|
|
// configuration only applies to WAN gossip communications
|
|
|
|
//
|
|
|
|
// The actual timeout is calculated using the formula:
|
|
|
|
//
|
|
|
|
// SuspicionTimeout = SuspicionMult * log(N+1) * ProbeInterval
|
|
|
|
//
|
|
|
|
// This allows the timeout to scale properly with expected propagation
|
|
|
|
// delay with a larger cluster size. The higher the multiplier, the longer
|
|
|
|
// an inaccessible node is considered part of the cluster before declaring
|
|
|
|
// it dead, giving that suspect node more time to refute if it is indeed
|
|
|
|
// still alive.
|
|
|
|
//
|
2020-11-27 19:49:43 +00:00
|
|
|
// The default is: 6
|
2018-07-26 15:39:49 +00:00
|
|
|
//
|
|
|
|
// hcl: gossip_wan { suspicion_mult = int }
|
|
|
|
GossipWANSuspicionMult int
|
|
|
|
|
|
|
|
// GossipWANRetransmitMult is the multiplier for the number of retransmissions
|
|
|
|
// that are attempted for messages broadcasted over gossip. This
|
|
|
|
// configuration only applies to WAN gossip communications. The actual
|
|
|
|
// count of retransmissions is calculated using the formula:
|
|
|
|
//
|
|
|
|
// Retransmits = RetransmitMult * log(N+1)
|
|
|
|
//
|
|
|
|
// This allows the retransmits to scale properly with cluster size. The
|
|
|
|
// higher the multiplier, the more likely a failed broadcast is to converge
|
|
|
|
// at the expense of increased bandwidth.
|
|
|
|
//
|
|
|
|
// The default is: 4
|
|
|
|
//
|
|
|
|
// hcl: gossip_wan { retransmit_mult = int }
|
|
|
|
GossipWANRetransmitMult int
|
|
|
|
|
2017-10-19 07:47:22 +00:00
|
|
|
// ServerMode controls if this agent acts like a Consul server,
|
|
|
|
// or merely as a client. Servers have more state, take part
|
|
|
|
// in leader election, etc.
|
|
|
|
//
|
|
|
|
// hcl: server = (true|false)
|
|
|
|
// flag: -server
|
|
|
|
ServerMode bool
|
|
|
|
|
|
|
|
// ServerName is used with the TLS certificates to ensure the name we
|
|
|
|
// provide matches the certificate.
|
|
|
|
//
|
|
|
|
// hcl: server_name = string
|
|
|
|
ServerName string
|
|
|
|
|
2017-10-20 12:00:04 +00:00
|
|
|
// ServerPort is the port the RPC server will bind to.
|
|
|
|
// The default is 8300.
|
|
|
|
//
|
|
|
|
// hcl: ports { server = int }
|
2017-10-19 19:26:02 +00:00
|
|
|
ServerPort int
|
2017-10-20 12:00:04 +00:00
|
|
|
|
|
|
|
// Services contains the provided service definitions:
|
|
|
|
//
|
|
|
|
// hcl: services = [
|
|
|
|
// {
|
|
|
|
// id = string
|
|
|
|
// name = string
|
|
|
|
// tags = []string
|
|
|
|
// address = string
|
2018-03-19 16:56:00 +00:00
|
|
|
// check = { check definition }
|
2017-10-20 12:00:04 +00:00
|
|
|
// checks = [ { check definition}, ... ]
|
|
|
|
// token = string
|
|
|
|
// enable_tag_override = (true|false)
|
|
|
|
// },
|
|
|
|
// ...
|
|
|
|
// ]
|
|
|
|
Services []*structs.ServiceDefinition
|
2017-10-19 19:26:02 +00:00
|
|
|
|
|
|
|
// Minimum Session TTL.
|
|
|
|
//
|
|
|
|
// hcl: session_ttl_min = "duration"
|
2017-10-19 07:47:22 +00:00
|
|
|
SessionTTLMin time.Duration
|
|
|
|
|
|
|
|
// SkipLeaveOnInt controls if Serf skips a graceful leave when
|
|
|
|
// receiving the INT signal. Defaults false on clients, true on
|
|
|
|
// servers. (reloadable)
|
|
|
|
//
|
|
|
|
// hcl: skip_leave_on_interrupt = (true|false)
|
|
|
|
SkipLeaveOnInt bool
|
|
|
|
|
2022-03-31 19:11:49 +00:00
|
|
|
// AutoReloadConfig indicate if the config will be
|
|
|
|
//auto reloaded bases on config file modification
|
|
|
|
// hcl: auto_reload_config = (true|false)
|
|
|
|
AutoReloadConfig bool
|
|
|
|
|
2019-06-27 20:22:07 +00:00
|
|
|
// StartJoinAddrsLAN is a list of addresses to attempt to join -lan when the
|
2017-10-19 19:26:02 +00:00
|
|
|
// agent starts. If Serf is unable to communicate with any of these
|
|
|
|
// addresses, then the agent will error and exit.
|
|
|
|
//
|
|
|
|
// hcl: start_join = []string
|
|
|
|
// flag: -join string -join string
|
2017-10-19 07:47:22 +00:00
|
|
|
StartJoinAddrsLAN []string
|
2017-10-19 19:26:02 +00:00
|
|
|
|
|
|
|
// StartJoinWAN is a list of addresses to attempt to join -wan when the
|
|
|
|
// agent starts. If Serf is unable to communicate with any of these
|
|
|
|
// addresses, then the agent will error and exit.
|
|
|
|
//
|
|
|
|
// hcl: start_join_wan = []string
|
|
|
|
// flag: -join-wan string -join-wan string
|
2017-10-19 07:47:22 +00:00
|
|
|
StartJoinAddrsWAN []string
|
2017-10-19 19:26:02 +00:00
|
|
|
|
2022-03-18 10:46:58 +00:00
|
|
|
// TLS configures certificates, CA, cipher suites, and other TLS settings
|
|
|
|
// on Consul's listeners (i.e. Internal multiplexed RPC, HTTPS and gRPC).
|
2017-10-19 07:47:22 +00:00
|
|
|
//
|
2022-03-18 10:46:58 +00:00
|
|
|
// hcl: tls { ... }
|
|
|
|
TLS tlsutil.Config
|
2017-10-19 07:47:22 +00:00
|
|
|
|
|
|
|
// TaggedAddresses are used to publish a set of addresses for
|
|
|
|
// for a node, which can be used by the remote agent. We currently
|
|
|
|
// populate only the "wan" tag based on the SerfWan advertise address,
|
|
|
|
// but this structure is here for possible future features with other
|
|
|
|
// user-defined tags. The "wan" tag will be used by remote agents if
|
|
|
|
// they are configured with TranslateWANAddrs set to true.
|
|
|
|
//
|
|
|
|
// hcl: tagged_addresses = map[string]string
|
|
|
|
TaggedAddresses map[string]string
|
|
|
|
|
|
|
|
// TranslateWANAddrs controls whether or not Consul should prefer
|
|
|
|
// the "wan" tagged address when doing lookups in remote datacenters.
|
|
|
|
// See TaggedAddresses below for more details.
|
|
|
|
//
|
|
|
|
// hcl: translate_wan_addrs = (true|false)
|
|
|
|
TranslateWANAddrs bool
|
|
|
|
|
2020-03-05 21:42:37 +00:00
|
|
|
// TxnMaxReqLen configures the upper limit for the size (in bytes) of the
|
|
|
|
// incoming request bodies for transactions to the /txn endpoint.
|
|
|
|
//
|
|
|
|
// hcl: limits { txn_max_req_len = uint64 }
|
|
|
|
TxnMaxReqLen uint64
|
|
|
|
|
2020-09-10 16:25:56 +00:00
|
|
|
// UIConfig holds various runtime options that control both the agent's
|
|
|
|
// behavior while serving the UI (e.g. whether it's enabled, what path it's
|
|
|
|
// mounted on) as well as options that enable or disable features within the
|
|
|
|
// UI.
|
2017-10-19 19:26:02 +00:00
|
|
|
//
|
2020-09-10 16:25:56 +00:00
|
|
|
// NOTE: Never read from this field directly once the agent has started up
|
|
|
|
// since the UI config is reloadable. The on in the agent's config field may
|
|
|
|
// be out of date. Use the agent.getUIConfig() method to get the latest config
|
|
|
|
// in a thread-safe way.
|
|
|
|
//
|
|
|
|
// hcl: ui_config { ... }
|
|
|
|
UIConfig UIConfig
|
ui: modify content path (#5950)
* Add ui-content-path flag
* tests complete, regex validator on string, index.html updated
* cleaning up debugging stuff
* ui: Enable ember environment configuration to be set via the go binary at runtime (#5934)
* ui: Only inject {{.ContentPath}} if we are makeing a prod build...
...otherwise we just use the current rootURL
This gets injected into a <base /> node which solves the assets path
problem but not the ember problem
* ui: Pull out the <base href=""> value and inject it into ember env
See previous commit:
The <base href=""> value is 'sometimes' injected from go at index
serve time. We pass this value down to ember by overwriting the ember
config that is injected via a <meta> tag. This has to be done before
ember bootup.
Sometimes (during testing and development, basically not production)
this is injected with the already existing value, in which case this
essentially changes nothing.
The code here is slightly abstracted away from our specific usage to
make it easier for anyone else to use, and also make sure we can cope
with using this same method to pass variables down from the CLI through
to ember in the future.
* ui: We can't use <base /> move everything to javascript (#5941)
Unfortuantely we can't seem to be able to use <base> and rootURL
together as URL paths will get doubled up (`ui/ui/`).
This moves all the things that we need to interpolate with .ContentPath
to the `startup` javascript so we can conditionally print out
`{{.ContentPath}}` in lots of places (now we can't use base)
* fixed when we serve index.html
* ui: For writing a ContentPath, we also need to cope with testing... (#5945)
...and potentially more environments
Testing has more additional things in a separate index.html in `tests/`
This make the entire thing a little saner and uses just javascriopt
template literals instead of a pseudo handbrake synatx for our
templating of these files.
Intead of just templating the entire file this way, we still only
template `{{content-for 'head'}}` and `{{content-for 'body'}}`
in this way to ensure we support other plugins/addons
* build: Loosen up the regex for retrieving the CONSUL_VERSION (#5946)
* build: Loosen up the regex for retrieving the CONSUL_VERSION
1. Previously the `sed` replacement was searching for the CONSUL_VERSION
comment at the start of a line, it no longer does this to allow for
indentation.
2. Both `grep` and `sed` where looking for the omment at the end of the
line. We've removed this restriction here. We don't need to remove it
right now, but if we ever put the comment followed by something here the
searching would break.
3. Added `xargs` for trimming the resulting version string. We aren't
using this already in the rest of the scripts, but we are pretty sure
this is available on most systems.
* ui: Fix erroneous variable, and also force an ember cache clean on build
1. We referenced a variable incorrectly here, this fixes that.
2. We also made sure that every `make` target clears ember's `tmp` cache
to ensure that its not using any caches that have since been edited
everytime we call a `make` target.
* added docs, fixed encoding
* fixed go fmt
* Update agent/config/config.go
Co-Authored-By: R.B. Boyer <public@richardboyer.net>
* Completed Suggestions
* run gofmt on http.go
* fix testsanitize
* fix fullconfig/hcl by setting correct 'want'
* ran gofmt on agent/config/runtime_test.go
* Update website/source/docs/agent/options.html.md
Co-Authored-By: Hans Hasselberg <me@hans.io>
* Update website/source/docs/agent/options.html.md
Co-Authored-By: kaitlincarter-hc <43049322+kaitlincarter-hc@users.noreply.github.com>
* remove contentpath from redirectFS struct
2019-06-26 16:43:30 +00:00
|
|
|
|
2017-10-19 19:26:02 +00:00
|
|
|
// UnixSocketGroup contains the group of the file permissions when
|
|
|
|
// Consul binds to UNIX sockets.
|
|
|
|
//
|
|
|
|
// hcl: unix_sockets { group = string }
|
2017-10-19 07:47:22 +00:00
|
|
|
UnixSocketGroup string
|
2017-10-19 19:26:02 +00:00
|
|
|
|
|
|
|
// UnixSocketMode contains the mode of the file permissions when
|
|
|
|
// Consul binds to UNIX sockets.
|
|
|
|
//
|
|
|
|
// hcl: unix_sockets { mode = string }
|
|
|
|
UnixSocketMode string
|
|
|
|
|
|
|
|
// UnixSocketUser contains the user of the file permissions when
|
|
|
|
// Consul binds to UNIX sockets.
|
|
|
|
//
|
|
|
|
// hcl: unix_sockets { user = string }
|
|
|
|
UnixSocketUser string
|
2017-10-19 07:47:22 +00:00
|
|
|
|
2022-03-31 19:11:49 +00:00
|
|
|
StaticRuntimeConfig StaticRuntimeConfig
|
|
|
|
|
2017-10-20 12:00:04 +00:00
|
|
|
// Watches are used to monitor various endpoints and to invoke a
|
|
|
|
// handler to act appropriately. These are managed entirely in the
|
|
|
|
// agent layer using the standard APIs.
|
|
|
|
//
|
|
|
|
// See https://www.consul.io/docs/agent/watches.html for details.
|
|
|
|
//
|
|
|
|
// hcl: watches = [
|
|
|
|
// { type=string ... },
|
|
|
|
// { type=string ... },
|
|
|
|
// ...
|
|
|
|
// ]
|
|
|
|
//
|
2017-10-19 07:47:22 +00:00
|
|
|
Watches []map[string]interface{}
|
2019-12-10 02:26:41 +00:00
|
|
|
|
2022-04-04 15:31:39 +00:00
|
|
|
// AutoReloadConfigCoalesceInterval Coalesce Interval for auto reload config
|
|
|
|
AutoReloadConfigCoalesceInterval time.Duration
|
|
|
|
|
2019-12-10 02:26:41 +00:00
|
|
|
EnterpriseRuntimeConfig
|
2017-09-25 18:40:42 +00:00
|
|
|
}
|
|
|
|
|
2020-06-16 19:03:22 +00:00
|
|
|
type AutoConfig struct {
|
|
|
|
Enabled bool
|
|
|
|
IntroToken string
|
|
|
|
IntroTokenFile string
|
|
|
|
ServerAddresses []string
|
|
|
|
DNSSANs []string
|
|
|
|
IPSANs []net.IP
|
|
|
|
Authorizer AutoConfigAuthorizer
|
|
|
|
}
|
|
|
|
|
|
|
|
type AutoConfigAuthorizer struct {
|
|
|
|
Enabled bool
|
|
|
|
AuthMethod structs.ACLAuthMethod
|
|
|
|
// AuthMethodConfig ssoauth.Config
|
|
|
|
ClaimAssertions []string
|
|
|
|
AllowReuse bool
|
|
|
|
}
|
|
|
|
|
2020-09-10 16:25:56 +00:00
|
|
|
type UIConfig struct {
|
|
|
|
Enabled bool
|
|
|
|
Dir string
|
|
|
|
ContentPath string
|
|
|
|
MetricsProvider string
|
|
|
|
MetricsProviderFiles []string
|
|
|
|
MetricsProviderOptionsJSON string
|
|
|
|
MetricsProxy UIMetricsProxy
|
|
|
|
DashboardURLTemplates map[string]string
|
|
|
|
}
|
|
|
|
|
|
|
|
type UIMetricsProxy struct {
|
2020-10-30 21:49:54 +00:00
|
|
|
BaseURL string
|
|
|
|
AddHeaders []UIMetricsProxyAddHeader
|
|
|
|
PathAllowlist []string
|
2020-09-10 16:25:56 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
type UIMetricsProxyAddHeader struct {
|
|
|
|
Name string
|
|
|
|
Value string
|
|
|
|
}
|
|
|
|
|
2018-07-10 16:13:51 +00:00
|
|
|
func (c *RuntimeConfig) apiAddresses(maxPerType int) (unixAddrs, httpAddrs, httpsAddrs []string) {
|
|
|
|
if len(c.HTTPSAddrs) > 0 {
|
|
|
|
for i, addr := range c.HTTPSAddrs {
|
2018-07-16 20:30:15 +00:00
|
|
|
if maxPerType < 1 || i < maxPerType {
|
2018-07-10 16:13:51 +00:00
|
|
|
httpsAddrs = append(httpsAddrs, addr.String())
|
|
|
|
} else {
|
|
|
|
break
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
if len(c.HTTPAddrs) > 0 {
|
|
|
|
unix_count := 0
|
|
|
|
http_count := 0
|
|
|
|
for _, addr := range c.HTTPAddrs {
|
2018-07-12 11:30:17 +00:00
|
|
|
switch addr.(type) {
|
|
|
|
case *net.UnixAddr:
|
2018-07-16 20:30:15 +00:00
|
|
|
if maxPerType < 1 || unix_count < maxPerType {
|
2018-07-12 11:30:17 +00:00
|
|
|
unixAddrs = append(unixAddrs, addr.String())
|
|
|
|
unix_count += 1
|
|
|
|
}
|
|
|
|
default:
|
2018-07-16 20:30:15 +00:00
|
|
|
if maxPerType < 1 || http_count < maxPerType {
|
2018-07-12 11:30:17 +00:00
|
|
|
httpAddrs = append(httpAddrs, addr.String())
|
|
|
|
http_count += 1
|
|
|
|
}
|
2018-07-10 16:13:51 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
return
|
|
|
|
}
|
|
|
|
|
2018-07-16 20:30:15 +00:00
|
|
|
func (c *RuntimeConfig) ClientAddress() (unixAddr, httpAddr, httpsAddr string) {
|
|
|
|
unixAddrs, httpAddrs, httpsAddrs := c.apiAddresses(0)
|
|
|
|
|
|
|
|
if len(unixAddrs) > 0 {
|
|
|
|
unixAddr = "unix://" + unixAddrs[0]
|
|
|
|
}
|
|
|
|
|
|
|
|
http_any := ""
|
|
|
|
if len(httpAddrs) > 0 {
|
|
|
|
for _, addr := range httpAddrs {
|
|
|
|
host, port, err := net.SplitHostPort(addr)
|
|
|
|
if err != nil {
|
|
|
|
continue
|
|
|
|
}
|
|
|
|
|
|
|
|
if host == "0.0.0.0" || host == "::" {
|
|
|
|
if http_any == "" {
|
|
|
|
if host == "0.0.0.0" {
|
|
|
|
http_any = net.JoinHostPort("127.0.0.1", port)
|
|
|
|
} else {
|
|
|
|
http_any = net.JoinHostPort("::1", port)
|
|
|
|
}
|
|
|
|
}
|
|
|
|
continue
|
|
|
|
}
|
|
|
|
|
|
|
|
httpAddr = addr
|
|
|
|
break
|
|
|
|
}
|
|
|
|
|
|
|
|
if httpAddr == "" && http_any != "" {
|
|
|
|
httpAddr = http_any
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
https_any := ""
|
|
|
|
if len(httpsAddrs) > 0 {
|
|
|
|
for _, addr := range httpsAddrs {
|
|
|
|
host, port, err := net.SplitHostPort(addr)
|
|
|
|
if err != nil {
|
|
|
|
continue
|
|
|
|
}
|
|
|
|
|
|
|
|
if host == "0.0.0.0" || host == "::" {
|
|
|
|
if https_any == "" {
|
|
|
|
if host == "0.0.0.0" {
|
|
|
|
https_any = net.JoinHostPort("127.0.0.1", port)
|
|
|
|
} else {
|
|
|
|
https_any = net.JoinHostPort("::1", port)
|
|
|
|
}
|
|
|
|
}
|
|
|
|
continue
|
|
|
|
}
|
|
|
|
|
|
|
|
httpsAddr = addr
|
|
|
|
break
|
|
|
|
}
|
|
|
|
|
|
|
|
if httpsAddr == "" && https_any != "" {
|
|
|
|
httpsAddr = https_any
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
return
|
|
|
|
}
|
|
|
|
|
2020-07-23 20:05:28 +00:00
|
|
|
func (c *RuntimeConfig) ConnectCAConfiguration() (*structs.CAConfiguration, error) {
|
|
|
|
ca := &structs.CAConfiguration{
|
|
|
|
Provider: "consul",
|
|
|
|
Config: map[string]interface{}{
|
|
|
|
"LeafCertTTL": structs.DefaultLeafCertTTL,
|
|
|
|
"IntermediateCertTTL": structs.DefaultIntermediateCertTTL,
|
2021-11-02 18:02:10 +00:00
|
|
|
"RootCertTTL": structs.DefaultRootCertTTL,
|
2020-07-23 20:05:28 +00:00
|
|
|
},
|
|
|
|
}
|
|
|
|
|
|
|
|
// Allow config to specify cluster_id provided it's a valid UUID. This is
|
|
|
|
// meant only for tests where a deterministic ID makes fixtures much simpler
|
|
|
|
// to work with but since it's only read on initial cluster bootstrap it's not
|
|
|
|
// that much of a liability in production. The worst a user could do is
|
|
|
|
// configure logically separate clusters with same ID by mistake but we can
|
|
|
|
// avoid documenting this is even an option.
|
|
|
|
if clusterID, ok := c.ConnectCAConfig["cluster_id"]; ok {
|
|
|
|
// If they tried to specify an ID but typoed it then don't ignore as they
|
|
|
|
// will then bootstrap with a new ID and have to throw away the whole cluster
|
|
|
|
// and start again.
|
|
|
|
|
|
|
|
// ensure the cluster_id value in the opaque config is a string
|
|
|
|
cIDStr, ok := clusterID.(string)
|
|
|
|
if !ok {
|
|
|
|
return nil, fmt.Errorf("cluster_id was supplied but was not a string")
|
|
|
|
}
|
|
|
|
|
|
|
|
// ensure that the cluster_id string is a valid UUID
|
|
|
|
_, err := uuid.ParseUUID(cIDStr)
|
|
|
|
if err != nil {
|
|
|
|
return nil, fmt.Errorf("cluster_id was supplied but was not a valid UUID")
|
|
|
|
}
|
|
|
|
|
|
|
|
// now that we know the cluster_id is okay we can set it in the CAConfiguration
|
|
|
|
ca.ClusterID = cIDStr
|
|
|
|
}
|
|
|
|
|
|
|
|
if c.ConnectCAProvider != "" {
|
|
|
|
ca.Provider = c.ConnectCAProvider
|
|
|
|
}
|
|
|
|
|
|
|
|
// Merge connect CA Config regardless of provider (since there are some
|
|
|
|
// common config options valid to all like leaf TTL).
|
|
|
|
for k, v := range c.ConnectCAConfig {
|
|
|
|
ca.Config[k] = v
|
|
|
|
}
|
|
|
|
|
|
|
|
return ca, nil
|
|
|
|
}
|
|
|
|
|
2018-07-10 16:13:51 +00:00
|
|
|
func (c *RuntimeConfig) APIConfig(includeClientCerts bool) (*api.Config, error) {
|
2022-03-18 10:46:58 +00:00
|
|
|
tls := c.TLS.HTTPS
|
|
|
|
|
2018-07-10 16:13:51 +00:00
|
|
|
cfg := &api.Config{
|
|
|
|
Datacenter: c.Datacenter,
|
2022-03-18 10:46:58 +00:00
|
|
|
TLSConfig: api.TLSConfig{InsecureSkipVerify: !tls.VerifyOutgoing},
|
2018-07-10 16:13:51 +00:00
|
|
|
}
|
|
|
|
|
2018-07-16 20:30:15 +00:00
|
|
|
unixAddr, httpAddr, httpsAddr := c.ClientAddress()
|
2018-07-10 16:13:51 +00:00
|
|
|
|
2018-07-16 20:30:15 +00:00
|
|
|
if httpsAddr != "" {
|
|
|
|
cfg.Address = httpsAddr
|
2018-07-10 16:13:51 +00:00
|
|
|
cfg.Scheme = "https"
|
2022-03-18 10:46:58 +00:00
|
|
|
cfg.TLSConfig.CAFile = tls.CAFile
|
|
|
|
cfg.TLSConfig.CAPath = tls.CAPath
|
2018-07-10 16:13:51 +00:00
|
|
|
if includeClientCerts {
|
2022-03-18 10:46:58 +00:00
|
|
|
cfg.TLSConfig.CertFile = tls.CertFile
|
|
|
|
cfg.TLSConfig.KeyFile = tls.KeyFile
|
2018-07-10 16:13:51 +00:00
|
|
|
}
|
2018-07-16 20:30:15 +00:00
|
|
|
} else if httpAddr != "" {
|
|
|
|
cfg.Address = httpAddr
|
2018-07-10 16:13:51 +00:00
|
|
|
cfg.Scheme = "http"
|
2018-07-16 20:30:15 +00:00
|
|
|
} else if unixAddr != "" {
|
|
|
|
cfg.Address = unixAddr
|
2018-07-11 13:22:47 +00:00
|
|
|
// this should be ignored - however we are still talking http over a unix socket
|
|
|
|
// so it makes sense to set it like this
|
2018-07-10 16:13:51 +00:00
|
|
|
cfg.Scheme = "http"
|
|
|
|
} else {
|
|
|
|
return nil, fmt.Errorf("No suitable client address can be found")
|
|
|
|
}
|
|
|
|
|
|
|
|
return cfg, nil
|
|
|
|
}
|
|
|
|
|
2017-09-27 18:47:40 +00:00
|
|
|
// Sanitized returns a JSON/HCL compatible representation of the runtime
|
|
|
|
// configuration where all fields with potential secrets had their
|
|
|
|
// values replaced by 'hidden'. In addition, network addresses and
|
|
|
|
// time.Duration values are formatted to improve readability.
|
|
|
|
func (c *RuntimeConfig) Sanitized() map[string]interface{} {
|
|
|
|
return sanitize("rt", reflect.ValueOf(c)).Interface().(map[string]interface{})
|
|
|
|
}
|
2017-09-25 18:40:42 +00:00
|
|
|
|
2017-09-27 18:47:40 +00:00
|
|
|
// isSecret determines whether a field name represents a field which
|
|
|
|
// may contain a secret.
|
|
|
|
func isSecret(name string) bool {
|
2020-06-16 19:03:22 +00:00
|
|
|
// special cases for AuthMethod locality and intro token file
|
|
|
|
if name == "TokenLocality" || name == "IntroTokenFile" {
|
|
|
|
return false
|
|
|
|
}
|
2017-09-27 18:47:40 +00:00
|
|
|
name = strings.ToLower(name)
|
|
|
|
return strings.Contains(name, "key") || strings.Contains(name, "token") || strings.Contains(name, "secret")
|
|
|
|
}
|
2017-09-25 18:40:42 +00:00
|
|
|
|
2017-09-27 18:47:40 +00:00
|
|
|
// cleanRetryJoin sanitizes the go-discover config strings key=val key=val...
|
|
|
|
// by scrubbing the individual key=val combinations.
|
|
|
|
func cleanRetryJoin(a string) string {
|
|
|
|
var fields []string
|
|
|
|
for _, f := range strings.Fields(a) {
|
|
|
|
if isSecret(f) {
|
|
|
|
kv := strings.SplitN(f, "=", 2)
|
|
|
|
fields = append(fields, kv[0]+"=hidden")
|
2017-09-25 18:40:42 +00:00
|
|
|
} else {
|
2017-09-27 18:47:40 +00:00
|
|
|
fields = append(fields, f)
|
2017-09-25 18:40:42 +00:00
|
|
|
}
|
|
|
|
}
|
2017-09-27 18:47:40 +00:00
|
|
|
return strings.Join(fields, " ")
|
|
|
|
}
|
|
|
|
|
|
|
|
func sanitize(name string, v reflect.Value) reflect.Value {
|
|
|
|
typ := v.Type()
|
|
|
|
switch {
|
|
|
|
// check before isStruct and isPtr
|
|
|
|
case isNetAddr(typ):
|
|
|
|
if v.IsNil() {
|
|
|
|
return reflect.ValueOf("")
|
|
|
|
}
|
|
|
|
switch x := v.Interface().(type) {
|
|
|
|
case *net.TCPAddr:
|
|
|
|
return reflect.ValueOf("tcp://" + x.String())
|
|
|
|
case *net.UDPAddr:
|
|
|
|
return reflect.ValueOf("udp://" + x.String())
|
|
|
|
case *net.UnixAddr:
|
|
|
|
return reflect.ValueOf("unix://" + x.String())
|
|
|
|
case *net.IPAddr:
|
|
|
|
return reflect.ValueOf(x.IP.String())
|
2019-07-23 20:30:16 +00:00
|
|
|
case *net.IPNet:
|
|
|
|
return reflect.ValueOf(x.String())
|
2017-09-27 18:47:40 +00:00
|
|
|
default:
|
|
|
|
return v
|
|
|
|
}
|
|
|
|
|
|
|
|
// check before isNumber
|
|
|
|
case isDuration(typ):
|
|
|
|
x := v.Interface().(time.Duration)
|
|
|
|
return reflect.ValueOf(x.String())
|
|
|
|
|
|
|
|
case isString(typ):
|
|
|
|
if strings.HasPrefix(name, "RetryJoinLAN[") || strings.HasPrefix(name, "RetryJoinWAN[") {
|
|
|
|
x := v.Interface().(string)
|
|
|
|
return reflect.ValueOf(cleanRetryJoin(x))
|
|
|
|
}
|
|
|
|
if isSecret(name) {
|
|
|
|
return reflect.ValueOf("hidden")
|
|
|
|
}
|
|
|
|
return v
|
2017-09-25 18:40:42 +00:00
|
|
|
|
2017-09-27 18:47:40 +00:00
|
|
|
case isNumber(typ) || isBool(typ):
|
|
|
|
return v
|
2017-09-25 18:40:42 +00:00
|
|
|
|
2017-09-27 18:47:40 +00:00
|
|
|
case isPtr(typ):
|
|
|
|
if v.IsNil() {
|
|
|
|
return v
|
|
|
|
}
|
|
|
|
return sanitize(name, v.Elem())
|
|
|
|
|
|
|
|
case isStruct(typ):
|
|
|
|
m := map[string]interface{}{}
|
|
|
|
for i := 0; i < typ.NumField(); i++ {
|
|
|
|
key := typ.Field(i).Name
|
|
|
|
m[key] = sanitize(key, v.Field(i)).Interface()
|
|
|
|
}
|
|
|
|
return reflect.ValueOf(m)
|
|
|
|
|
|
|
|
case isArray(typ) || isSlice(typ):
|
2020-04-01 08:54:51 +00:00
|
|
|
ma := make([]interface{}, 0, v.Len())
|
2020-11-05 19:25:27 +00:00
|
|
|
|
|
|
|
if name == "AddHeaders" {
|
|
|
|
// must be UIConfig.MetricsProxy.AddHeaders
|
|
|
|
for i := 0; i < v.Len(); i++ {
|
|
|
|
addr := v.Index(i).Addr()
|
|
|
|
hdr := addr.Interface().(*UIMetricsProxyAddHeader)
|
|
|
|
hm := map[string]interface{}{
|
|
|
|
"Name": hdr.Name,
|
|
|
|
"Value": "hidden",
|
|
|
|
}
|
|
|
|
ma = append(ma, hm)
|
|
|
|
}
|
|
|
|
return reflect.ValueOf(ma)
|
|
|
|
}
|
|
|
|
|
2020-05-20 09:31:19 +00:00
|
|
|
if strings.HasPrefix(name, "SerfAllowedCIDRs") {
|
|
|
|
for i := 0; i < v.Len(); i++ {
|
|
|
|
addr := v.Index(i).Addr()
|
|
|
|
ip := addr.Interface().(*net.IPNet)
|
|
|
|
ma = append(ma, ip.String())
|
|
|
|
}
|
|
|
|
return reflect.ValueOf(ma)
|
|
|
|
}
|
2017-09-27 18:47:40 +00:00
|
|
|
for i := 0; i < v.Len(); i++ {
|
|
|
|
ma = append(ma, sanitize(fmt.Sprintf("%s[%d]", name, i), v.Index(i)).Interface())
|
|
|
|
}
|
|
|
|
return reflect.ValueOf(ma)
|
|
|
|
|
|
|
|
case isMap(typ):
|
|
|
|
m := map[string]interface{}{}
|
|
|
|
for _, k := range v.MapKeys() {
|
|
|
|
key := k.String()
|
|
|
|
m[key] = sanitize(key, v.MapIndex(k)).Interface()
|
|
|
|
}
|
|
|
|
return reflect.ValueOf(m)
|
|
|
|
|
|
|
|
default:
|
|
|
|
return v
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
func isDuration(t reflect.Type) bool { return t == reflect.TypeOf(time.Second) }
|
|
|
|
func isMap(t reflect.Type) bool { return t.Kind() == reflect.Map }
|
|
|
|
func isNetAddr(t reflect.Type) bool { return t.Implements(reflect.TypeOf((*net.Addr)(nil)).Elem()) }
|
|
|
|
func isPtr(t reflect.Type) bool { return t.Kind() == reflect.Ptr }
|
|
|
|
func isArray(t reflect.Type) bool { return t.Kind() == reflect.Array }
|
|
|
|
func isSlice(t reflect.Type) bool { return t.Kind() == reflect.Slice }
|
|
|
|
func isString(t reflect.Type) bool { return t.Kind() == reflect.String }
|
|
|
|
func isStruct(t reflect.Type) bool { return t.Kind() == reflect.Struct }
|
|
|
|
func isBool(t reflect.Type) bool { return t.Kind() == reflect.Bool }
|
|
|
|
func isNumber(t reflect.Type) bool { return isInt(t) || isUint(t) || isFloat(t) || isComplex(t) }
|
|
|
|
func isInt(t reflect.Type) bool {
|
|
|
|
return t.Kind() == reflect.Int ||
|
|
|
|
t.Kind() == reflect.Int8 ||
|
|
|
|
t.Kind() == reflect.Int16 ||
|
|
|
|
t.Kind() == reflect.Int32 ||
|
|
|
|
t.Kind() == reflect.Int64
|
|
|
|
}
|
|
|
|
func isUint(t reflect.Type) bool {
|
|
|
|
return t.Kind() == reflect.Uint ||
|
|
|
|
t.Kind() == reflect.Uint8 ||
|
|
|
|
t.Kind() == reflect.Uint16 ||
|
|
|
|
t.Kind() == reflect.Uint32 ||
|
|
|
|
t.Kind() == reflect.Uint64
|
|
|
|
}
|
|
|
|
func isFloat(t reflect.Type) bool { return t.Kind() == reflect.Float32 || t.Kind() == reflect.Float64 }
|
|
|
|
func isComplex(t reflect.Type) bool {
|
|
|
|
return t.Kind() == reflect.Complex64 || t.Kind() == reflect.Complex128
|
2017-09-25 18:40:42 +00:00
|
|
|
}
|
2021-07-27 21:55:00 +00:00
|
|
|
|
|
|
|
// ApplyDefaultQueryOptions returns a function which will set default values on
|
|
|
|
// the options based on the configuration. The RuntimeConfig must not be nil.
|
|
|
|
func ApplyDefaultQueryOptions(config *RuntimeConfig) func(options *structs.QueryOptions) {
|
|
|
|
return func(options *structs.QueryOptions) {
|
|
|
|
switch {
|
|
|
|
case options.MaxQueryTime > config.MaxQueryTime:
|
|
|
|
options.MaxQueryTime = config.MaxQueryTime
|
|
|
|
case options.MaxQueryTime == 0:
|
|
|
|
options.MaxQueryTime = config.DefaultQueryTime
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|