From 09a1c40444e451a188ddbbd5fd85ebc6c2da4ed1 Mon Sep 17 00:00:00 2001 From: Armon Dadgar Date: Tue, 5 Aug 2014 10:46:52 -0700 Subject: [PATCH] website: More port use docs --- .../source/docs/agent/options.html.markdown | 31 ++++++++++--------- 1 file changed, 16 insertions(+), 15 deletions(-) diff --git a/website/source/docs/agent/options.html.markdown b/website/source/docs/agent/options.html.markdown index 85c8ac3063..b436c90f0e 100644 --- a/website/source/docs/agent/options.html.markdown +++ b/website/source/docs/agent/options.html.markdown @@ -286,23 +286,24 @@ definitions support being updated during a reload. ## Ports Used -* `TCP:8300` Server RPC port. Used to bootstrap agents and replicate data. - Should be open between agents. +Consul requires up to 5 different ports to work properly, some requiring +TCP, UDP, or both protocols. Below we document the requirements for each +port. -* `TCP+UDP:8301` Serf LAN port. Used by the gossip protocol. Should be opened - to all other agents on the same LAN. +* Server RPC (Default 8300). This is used by servers to handle incoming + requests from other agents. TCP only. -* `TCP+UDP:8302` Serf WAN port. Used by the gossip protocol. Should be opened - to all other agents on the same WAN. +* Serf LAN (Default 8301). This is used to handle gossip in the LAN. + Required by all agents, TCP and UDP. -* `TCP:8400` Used by the RPC endpoint, which is also used by the CLI. Should be - opened to localhost only to serve your local CLI. Also needs to be opened to - any client doing RPC requests against this agent. +* Serf WAN( Default 8302). This is used by servers to gossip over the + WAN to other servers. TCP and UDP. -* `TCP:8500` Used by the HTTP api. Should be opened to localhost only to - serve your local requests. Also needs to be opened to any client doing api - requests against this agent. +* CLI RPC (Default 8400). This is used by all agents to handle RPC + from the CLI. TCP only. + +* HTTP API (Default 8500). This is used by clients to talk to the HTTP + API. TCP only. + +* DNS Interface (Default 8600). Used to resolve DNS queries. TCP and UDP. -* `TCP+UDP:8600` Used by the DNS server. Should be opened to localhost only to - serve your local requests. Also needs to be opened to any client doing DNS - queries against this agent.