docs: add an entry to FAQs about circuit breakers (#4641)

Currently, there isn't a way to turn circuit breaking off completely; however, as a workaround, users can set thresholds very high, which effectively produces similar behavior to that of a system without circuit breakers. This commit adds an entry to the FAQs section about the same. Signed-off-by: Venil Noronha <veniln@vmware.com>
envoyproxy · Oct 8, 2018 · d003be8 · d003be8
1 parent 00299a5
commit d003be8
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 0 deletions.
diff --git a/docs/root/faq/disable_circuit_breaking.rst b/docs/root/faq/disable_circuit_breaking.rst
@@ -0,0 +1,20 @@
+Is there a way to disable circuit breaking?
+===========================================
+
+Envoy comes with :ref:`certain defaults <envoy_api_msg_cluster.CircuitBreakers.Thresholds>`
+for each kind of circuit breaking. Currently, there isn't a switch to turn
+circuit breaking off completely; however, you could achieve a similar behavior
+by setting these thresholds very high, for example, to `std::numeric_limits<uint32_t>::max()`.
+
+Following is a sample configuration that tries to effectively disable all kinds
+of circuit breaking by setting the thresholds to a value of `1000000000`.
+
+.. code-block:: yaml
+
+  circuit_breakers:
+    thresholds:
+      priority: HIGH
+      max_connections: 1000000000
+      max_pending_requests: 1000000000
+      max_requests: 1000000000
+      max_retries: 1000000000
diff --git a/docs/root/faq/overview.rst b/docs/root/faq/overview.rst
@@ -13,3 +13,4 @@ FAQ
   zipkin_tracing
   lb_panic_threshold
   concurrency_lb
+  disable_circuit_breaking