docs: move shared section for circuit breakers (#297)

Signed-off-by: Jose Nino <jnino@lyft.com>
pull/295/head
Jose Ulises Nino Rivera 7 years ago committed by Matt Klein
parent ec38af2de5
commit 30e4830489
  1. 2
      docs/root/api-v1/cluster_manager/cluster.rst
  2. 11
      docs/root/api-v1/cluster_manager/cluster_circuit_breakers.rst
  3. 17
      docs/root/configuration/cluster_manager/cluster_circuit_breakers.rst
  4. 1
      docs/root/configuration/cluster_manager/cluster_manager.rst

@ -121,7 +121,7 @@ max_requests_per_connection
parameter is respected by both the HTTP/1.1 and HTTP/2 connection pool implementations. If not parameter is respected by both the HTTP/1.1 and HTTP/2 connection pool implementations. If not
specified, there is no limit. Setting this parameter to 1 will effectively disable keep alive. specified, there is no limit. Setting this parameter to 1 will effectively disable keep alive.
:ref:`circuit_breakers <config_cluster_manager_cluster_circuit_breakers>` :ref:`circuit_breakers <config_cluster_manager_cluster_circuit_breakers_v1>`
*(optional, object)* Optional :ref:`circuit breaking <arch_overview_circuit_break>` settings *(optional, object)* Optional :ref:`circuit breaking <arch_overview_circuit_break>` settings
for the cluster. for the cluster.

@ -1,4 +1,4 @@
.. _config_cluster_manager_cluster_circuit_breakers: .. _config_cluster_manager_cluster_circuit_breakers_v1:
Circuit breakers Circuit breakers
================ ================
@ -62,12 +62,3 @@ max_retries
*(optional, integer)* The maximum number of parallel retries that Envoy will allow to the upstream *(optional, integer)* The maximum number of parallel retries that Envoy will allow to the upstream
cluster. If not specified, the default is 3. See the :ref:`circuit breaking overview cluster. If not specified, the default is 3. See the :ref:`circuit breaking overview
<arch_overview_circuit_break>` for more information. <arch_overview_circuit_break>` for more information.
Runtime
-------
All four circuit breaking settings are runtime configurable for all defined priorities based on cluster
name. They follow the following naming scheme ``circuit_breakers.<cluster_name>.<priority>.<setting>``.
``cluster_name`` is the name field in each cluster's configuration, which is set in the envoy
:ref:`config file <config_cluster_manager_cluster_name>`. Available runtime settings will override
settings set in the envoy config file.

@ -0,0 +1,17 @@
.. _config_cluster_manager_cluster_circuit_breakers:
Circuit breaking
================
* Circuit Breaking :ref:`architecture overview <arch_overview_circuit_break>`.
* :ref:`v1 API documentation <config_cluster_manager_cluster_circuit_breakers_v1>`.
* :ref:`v2 API documentation <envoy_api_msg_CircuitBreakers>`.
Runtime
-------
All circuit breaking settings are runtime configurable for all defined priorities based on cluster
name. They follow the following naming scheme ``circuit_breakers.<cluster_name>.<priority>.<setting>``.
``cluster_name`` is the name field in each cluster's configuration, which is set in the envoy
:ref:`config file <config_cluster_manager_cluster_name>`. Available runtime settings will override
settings set in the envoy config file.

@ -10,6 +10,7 @@ Cluster manager
cluster_runtime cluster_runtime
cds cds
cluster_hc cluster_hc
cluster_circuit_breakers
* Cluster manager :ref:`architecture overview <arch_overview_cluster_manager>` * Cluster manager :ref:`architecture overview <arch_overview_cluster_manager>`
* :ref:`v1 API reference <config_cluster_manager_v1>` * :ref:`v1 API reference <config_cluster_manager_v1>`

Loading…
Cancel
Save