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

Update segment docs

This commit is contained in:
Kyle Havlovitz 2017-08-31 17:39:57 -07:00
parent 5cc4b32a5d
commit 5605d735a1
No known key found for this signature in database
GPG Key ID: 8A5E6B173056AD6C
4 changed files with 10 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
website/source/api/operator/segment.html.md
View File

@ -12,7 +12,7 @@ description: |-
The `/operator/segment` endpoints provide tools to manage network segments via The `/operator/segment` endpoints provide tools to manage network segments via
Consul's HTTP API. Consul's HTTP API.
~> **Enterprise Only!** This API endpoint and functionality only exists in ~> **Enterprise-only!** This API endpoint and functionality only exists in
Consul Enterprise. This is not present in the open source version of Consul. Consul Enterprise. This is not present in the open source version of Consul.
The network area functionality described here is available only in The network area functionality described here is available only in

2
website/source/api/query.html.md
View File

@ -87,7 +87,7 @@ populate the query before it is executed. All of the string fields inside the
doesn't match, or an invalid index is given, then `${match(N)}` will return an doesn't match, or an invalid index is given, then `${match(N)}` will return an
empty string. empty string.
- `${agent.segment}` has the network segment (Enterprise only) of the agent that - `${agent.segment}` has the network segment (Enterprise-only) of the agent that
initiated the query. This can be used with the `NodeMeta` field to limit the results initiated the query. This can be used with the `NodeMeta` field to limit the results
of a query to service instances within its own network segment: of a query to service instances within its own network segment:

1
website/source/docs/enterprise/index.html.md
View File

@ -18,6 +18,7 @@ increases both scalability and resilience. Features include:
- [Redundancy Zones](/docs/enterprise/redundancy/index.html) - [Redundancy Zones](/docs/enterprise/redundancy/index.html)
- [Advanced Federation for Complex Network - [Advanced Federation for Complex Network
Topologies](/docs/enterprise/federation/index.html) Topologies](/docs/enterprise/federation/index.html)
- [Network Segments](/docs/guides/segments.html)
These features are part of [Consul These features are part of [Consul
Enterprise](https://www.hashicorp.com/consul.html). Enterprise](https://www.hashicorp.com/consul.html).

12
website/source/docs/guides/segments.html.markdown.erb
View File

@ -13,8 +13,8 @@ description: |-
# Partial LAN Connectivity # Partial LAN Connectivity
## Configuring Network Segments ## Configuring Network Segments
[//]: # ( ~> The network area functionality described here is available only in ) [//]: # ( ~> The network segment functionality described here is available only in )
[//]: # ( [Consul Enterprise](https://www.hashicorp.com/products/consul/) version 0.8.0 and later. ) [//]: # ( [Consul Enterprise](https://www.hashicorp.com/products/consul/) version 0.9.3 and later. )
<%= enterprise_alert :consul %> <%= enterprise_alert :consul %>
@ -53,7 +53,9 @@ another segment, or the listening port of another segment on a server, they will
Once the servers have been configured with the correct segment info, the clients only need to specify Once the servers have been configured with the correct segment info, the clients only need to specify
their own segment in the [Agent Config](/docs/agent/options.html) and join by connecting to another their own segment in the [Agent Config](/docs/agent/options.html) and join by connecting to another
agent within the same segment. agent within the same segment. If joining to a Consul server, client will need to provide the server's
port for their segment along with the address of the server when performing the join (for example,
`consul agent -retry-join "consul.domain.internal:1234"`).
## Getting Started ## Getting Started
@ -140,8 +142,8 @@ Node ID Address DC
client1 4c29819c 192.168.0.5 dc1 client1 4c29819c 192.168.0.5 dc1
``` ```
With this metadata key, we can construct a prepared query that can be used for DNS to return With this metadata key, we can construct a [Prepared Query](/api/query.html) that can be used
only services within the same network segment as the local agent. for DNS to return only services within the same network segment as the local agent.
First, register a service on each of the client nodes: First, register a service on each of the client nodes: