[docs] Server Performance (#5627)

* Moving server performance guide to docs.

* fixing broken links

* updating broken link

* fixing broken links
This commit is contained in:
kaitlincarter-hc 2019-04-17 13:17:12 -05:00 committed by GitHub
parent bd69480fe1
commit 7859d8c409
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
11 changed files with 18 additions and 20 deletions

View file

@ -26,7 +26,7 @@ const (
DefaultWANSerfPort = 8302
// DefaultRaftMultiplier is used as a baseline Raft configuration that
// will be reliable on a very basic server. See docs/guides/performance.html
// will be reliable on a very basic server. See docs/install/performance.html
// for information on how this value was obtained.
DefaultRaftMultiplier uint = 5

View file

@ -1295,7 +1295,7 @@ default will automatically work with some tooling.
* <a name="performance"></a><a href="#performance">`performance`</a> 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/guides/performance.html) guide for more details. The
Consul. See the [Server Performance](/docs/install/performance.html) guide for more details. The
following parameters are available:
* <a name="leave_drain_time"></a><a href="#leave_drain_time">`leave_drain_time`</a> - A duration
@ -1313,12 +1313,12 @@ default will automatically work with some tooling.
performance.
By default, Consul will use a lower-performance timing that's suitable
for [minimal Consul servers](/docs/guides/performance.html#minimum), currently equivalent
for [minimal Consul servers](/docs/install/performance.html#minimum), currently equivalent
to setting this to a value of 5 (this default may be changed in future versions of Consul,
depending if the target minimum server profile changes). Setting this to a value of 1 will
configure Raft to its highest-performance mode, equivalent to the default timing of Consul
prior to 0.7, and is recommended for [production Consul servers](/docs/guides/performance.html#production).
See the note on [last contact](/docs/guides/performance.html#last-contact) timing for more
prior to 0.7, and is recommended for [production Consul servers](/docs/install/performance.html#production).
See the note on [last contact](/docs/install/performance.html#last-contact) timing for more
details on tuning this parameter. The maximum allowed value is 10.
* <a name="rpc_hold_timeout"></a><a href="#rpc_hold_timeout">`rpc_hold_timeout`</a> - A duration

View file

@ -562,7 +562,7 @@ These metrics are used to monitor the health of the Consul servers.
</tr>
<tr>
<td><a name="last-contact"></a>`consul.raft.leader.lastContact`</td>
<td>This will only be emitted by the Raft leader and measures the time since the leader was last able to contact the follower nodes when checking its leader lease. It can be used as a measure for how stable the Raft timing is and how close the leader is to timing out its lease.<br><br>The lease timeout is 500 ms times the [`raft_multiplier` configuration](/docs/agent/options.html#raft_multiplier), so this telemetry value should not be getting close to that configured value, otherwise the Raft timing is marginal and might need to be tuned, or more powerful servers might be needed. See the [Server Performance](/docs/guides/performance.html) guide for more details.</td>
<td>This will only be emitted by the Raft leader and measures the time since the leader was last able to contact the follower nodes when checking its leader lease. It can be used as a measure for how stable the Raft timing is and how close the leader is to timing out its lease.<br><br>The lease timeout is 500 ms times the [`raft_multiplier` configuration](/docs/agent/options.html#raft_multiplier), so this telemetry value should not be getting close to that configured value, otherwise the Raft timing is marginal and might need to be tuned, or more powerful servers might be needed. See the [Server Performance](/docs/install/performance.html) guide for more details.</td>
<td>ms</td>
<td>timer</td>
</tr>

View file

@ -93,7 +93,7 @@ The limit on a key's value size is 512KB. This is strictly enforced and an
HTTP 413 status will be returned to any client that attempts to store more
than that limit in a value. It should be noted that the Consul key/value store
is not designed to be used as a general purpose database. See
[Server Performance](/docs/guides/performance.html) for more details.
[Server Performance](/docs/install/performance.html) for more details.
## Q: What data is replicated between Consul datacenters?

View file

@ -24,7 +24,7 @@ Finally, you will configure your services to use Connect.
with an appropriate number of servers and
clients deployed according to the other reference material including the
[deployment](/docs/guides/deployment.html) and
[performance](/docs/guides/performance.html) guides.
[performance](/docs/install/performance.html) guides.
The steps we need to get to a secure Connect cluster are:

View file

@ -189,7 +189,7 @@ performance {
- [`raft_multiplier`](/docs/agent/options.html#raft_multiplier) - An integer multiplier used by Consul servers to scale key Raft timing parameters. Setting this to a value of 1 will configure Raft to its highest-performance mode, equivalent to the default timing of Consul prior to 0.7, and is recommended for production Consul servers.
For more information on Raft tuning and the `raft_multiplier` setting, see the [server performance](/docs/guides/performance.html) documentation.
For more information on Raft tuning and the `raft_multiplier` setting, see the [server performance](/docs/install/performance.html) documentation.
### Telemetry stanza
@ -275,5 +275,5 @@ This spreads the load across nodes at the possible expense of losing full consis
for recovery from a Consul outage due to a majority of server nodes in a
datacenter being lost.
- Read [Server Performance](/docs/guides/performance.html) to learn about
- Read [Server Performance](/docs/install/performance.html) to learn about
additional configuration that benefits production deployments.

View file

@ -43,7 +43,7 @@ or "Burstable CPU".
~> **NOTE** For large workloads, ensure that the disks support a high number of IOPS to keep up with the rapid Raft log update rate.
For more information on server requirements, review the [server performance](/docs/guides/performance.html) documentation.
For more information on server requirements, review the [server performance](/docs/install/performance.html) documentation.
## Infrastructure Diagram
@ -118,5 +118,5 @@ By default agents will only listen for HTTP and DNS traffic on the local interfa
- Read [Deployment Guide](/docs/guides/deployment-guide.html) to learn
the steps required to install and configure a single HashiCorp Consul cluster.
- Read [Server Performance](/docs/guides/performance.html) to learn about
- Read [Server Performance](/docs/install/performance.html) to learn about
additional configuration that benefits production deployments.

View file

@ -62,6 +62,4 @@ The following guides are available:
* [Semaphore](/docs/guides/semaphore.html) - This guide covers using the KV store to implement a semaphore.
* [Server Performance](/docs/guides/performance.html) - This guide covers minimum requirements for Consul servers as well as guidelines for running Consul servers in production.
* [Windows Service](/docs/guides/windows-guide.html) - This guide covers how to run Consul as a service on Windows.

View file

@ -1,7 +1,7 @@
---
layout: "docs"
page_title: "Server Performance"
sidebar_current: "docs-guides-performance"
sidebar_current: "docs-install-performance"
description: |-
Consul requires different amounts of compute resources, depending on cluster size and expected workload. This guide provides guidance on choosing compute resources.
---

View file

@ -439,7 +439,7 @@ configuration:
Consul also 0.7 introduced support for tuning Raft performance using a new
[performance configuration block](/docs/agent/options.html#performance). Also,
the default Raft timing is set to a lower-performance mode suitable for
[minimal Consul servers](/docs/guides/performance.html#minimum).
[minimal Consul servers](/docs/install/performance.html#minimum).
To continue to use the high-performance settings that were the default prior to
Consul 0.7 (recommended for production servers), add the following configuration
@ -453,7 +453,7 @@ to all Consul servers when upgrading:
}
```
See the [Server Performance](/docs/guides/performance.html) guide for more details.
See the [Server Performance](/docs/install/performance.html) guide for more details.
#### Leave-Related Configuration Defaults

View file

@ -10,6 +10,9 @@
<li<%= sidebar_current("docs-install-bootstrapping") %>>
<a href="/docs/install/bootstrapping.html">Bootstrapping a Datacenter</a>
</li>
<li<%= sidebar_current("docs-install-performance") %>>
<a href="/docs/install/performance.html">Server Performance</a>
</li>
</ul>
</li>
@ -495,9 +498,6 @@
<li<%= sidebar_current("docs-guides-semaphore") %>>
<a href="/docs/guides/semaphore.html">Semaphore</a>
</li>
<li<%= sidebar_current("docs-guides-performance") %>>
<a href="/docs/guides/performance.html">Server Performance</a>
</li>
<li<%= sidebar_current("docs-guides-windows-service") %>>
<a href="/docs/guides/windows-guide.html">Windows (Service)</a>
</li>