diff --git a/website/content/docs/agent/options.mdx b/website/content/docs/agent/options.mdx index 4cf58f7e54..5925c35ee8 100644 --- a/website/content/docs/agent/options.mdx +++ b/website/content/docs/agent/options.mdx @@ -465,6 +465,8 @@ The options below are all specified on the command-line. for more details. By default, this is an empty string, which is the `` network segment. + ~> **Warning:** The `segment` flag cannot be used with the [`partition`](#partition-1) option. + - `-serf-lan-allowed-cidrs` ((#\_serf_lan_allowed_cidrs)) - The Serf LAN allowed CIDRs allow to accept incoming connections for Serf only from several networks (multiple values are supported). Those networks are specified with CIDR notation (eg: 192.168.1.0/24). @@ -1688,6 +1690,16 @@ bind_addr = "{{ GetPrivateInterfaces | include \"network\" \"10.0.0.0/8\" | attr } ``` +- `partition` - This flag is used to set + the name of the admin partition the agent belongs to. An agent can only join + and communicate with other agents within its admin partition. Review the + [Admin Partitions documentation](/docs/enterprise/admin-partitions) for more + details. By default, this is an empty string, which is the `default` admin + partition. This cannot be set on a server agent. + + ~> **Warning:** The `partition` option cannot be used either the + [`segment`](#segment-2) option or [`-segment`](#_segment) flag. + - `performance` Available in Consul 0.7 and later, this is a nested object that allows tuning the performance of different subsystems in Consul. See the [Server Performance](/docs/install/performance) documentation for more details. The following parameters are available: - `leave_drain_time` - A duration that a server will dwell during a graceful leave in order to allow requests to be retried against other Consul servers. Under normal circumstances, this can prevent clients from experiencing "no leader" errors when performing a rolling update of the Consul servers. This was added in Consul 1.0. Must be a duration value such as 10s. Defaults to 5s. @@ -1880,6 +1892,8 @@ bind_addr = "{{ GetPrivateInterfaces | include \"network\" \"10.0.0.0/8\" | attr - `segment` - Equivalent to the [`-segment` command-line flag](#_segment). + ~> **Warning:** The `segment` option cannot be used with the [`partition`](#partition-1) option. + - `segments` - (Server agents only) This is a list of nested objects that specifies user-defined network segments, not including the `` segment, which is created automatically. Review the [Network Segments documentation](/docs/enterprise/network-segments)