[doc] New Ports Documentation (#5442)

* Adding a ports table.

* Updating layout based on feedback.
This commit is contained in:
kaitlincarter-hc 2019-03-08 13:10:35 -06:00 committed by GitHub
parent 25c9f0e4aa
commit f4c7b84500
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 34 additions and 0 deletions

View File

@ -0,0 +1,29 @@
---
layout: "docs"
page_title: "Required Ports"
sidebar_current: "docs-install-ports"
description: |-
Before starting Consul it is important to have the necessary bind ports accessible.
---
# Required Ports
Before running Consul, you should ensure the following bind ports are accessible.
| Use | Default Ports |
| --------------------------------- | ---------------- |
| DNS: The DNS server | 8600 |
| HTTP: The HTTP API | 8500 |
| HTTPS: The HTTPs API | disabled (8501)* |
| gRPC: The gRPC API | disabled (8502)* |
| LAN Serf: The Serf LAN port. | 8301 |
| Wan Serf: The Serf WAN port | 8302 |
| server: Server RPC address | 8300 |
| Sidecar Proxy Min: Inclusive min port number to use for automatically assigned sidecar service registrations. | 21000 |
| Sidecar Proxy Max: Inclusive max port number to use for automatically assigned sidecar service registrations. | 21255 |
*For `HTTPS` and `gRPC` the ports specified in the table
are recommendations.
Note, the default ports can be changed in the [agent configuration](/docs/agent/options.html#ports).

View File

@ -3,6 +3,11 @@
<ul class="nav docs-sidenav"> <ul class="nav docs-sidenav">
<li<%= sidebar_current('docs-install-install') %>> <li<%= sidebar_current('docs-install-install') %>>
<a href="/docs/install/index.html">Installing Consul</a> <a href="/docs/install/index.html">Installing Consul</a>
<ul class="nav">
<li<%= sidebar_current("docs-install-ports") %>>
<a href="/docs/install/ports.html">Required Ports</a>
</li>
</ul>
</li> </li>
<li<%= sidebar_current("docs-upgrading") %>> <li<%= sidebar_current("docs-upgrading") %>>