From 6c199bffb56140cd11ddb59d29c855cebe2225a5 Mon Sep 17 00:00:00 2001 From: Brian Pane Date: Sun, 21 Jan 2018 18:18:49 +0000 Subject: [PATCH 1/2] docs: add new percentage-based response option to health check filter *Description*: Update the documentation to match envoy PR [2387](https://github.com/envoyproxy/envoy/pull/2387) Associated envoyproxy/envoy issue: [2362](https://github.com/envoyproxy/envoy/issues/2362) Signed-off-by: Brian Pane --- api/filter/http/health_check.proto | 1 - docs/root/intro/arch_overview/health_checking.rst | 4 ++++ 2 files changed, 4 insertions(+), 1 deletion(-) diff --git a/api/filter/http/health_check.proto b/api/filter/http/health_check.proto index fa8530cb8..797d4d784 100644 --- a/api/filter/http/health_check.proto +++ b/api/filter/http/health_check.proto @@ -23,7 +23,6 @@ message HealthCheck { // that the filter should cache the upstream response. google.protobuf.Duration cache_time = 3; - // [#not-implemented-hide:] // If operating in non-pass-through mode, specifies a set of upstream cluster // names and the minimum percentage of servers in each of those clusters that // must be healthy in order for the filter to return a 200. diff --git a/docs/root/intro/arch_overview/health_checking.rst b/docs/root/intro/arch_overview/health_checking.rst index 9527903fa..230b20042 100644 --- a/docs/root/intro/arch_overview/health_checking.rst +++ b/docs/root/intro/arch_overview/health_checking.rst @@ -44,6 +44,10 @@ operation: * **No pass through**: In this mode, the health check request is never passed to the local service. Envoy will respond with a 200 or a 503 depending on the current draining state of the server. +* **No pass through, computed from upstream cluster health**: In this mode, the health checking + filter will return a 200 or a 503 depending on whether at least a specified percentage of the + servers are healthy in one or more upstream clusters. (If the Envoy server is in a draining + state, though, it will respond with a 503 regardless of the upstream cluster health.) * **Pass through**: In this mode, Envoy will pass every health check request to the local service. The service is expected to return a 200 or a 503 depending on its health state. * **Pass through with caching**: In this mode, Envoy will pass health check requests to the local From 279d56a9badc0107d0be0623997141e2fb8822f9 Mon Sep 17 00:00:00 2001 From: Brian Pane Date: Mon, 22 Jan 2018 19:31:07 +0000 Subject: [PATCH 2/2] Fix doc build error due to extraneous space, and add deep link to new config field Signed-off-by: Brian Pane --- api/filter/http/health_check.proto | 2 +- docs/root/intro/arch_overview/health_checking.rst | 3 ++- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/api/filter/http/health_check.proto b/api/filter/http/health_check.proto index 797d4d784..c1266955b 100644 --- a/api/filter/http/health_check.proto +++ b/api/filter/http/health_check.proto @@ -25,6 +25,6 @@ message HealthCheck { // If operating in non-pass-through mode, specifies a set of upstream cluster // names and the minimum percentage of servers in each of those clusters that - // must be healthy in order for the filter to return a 200. + // must be healthy in order for the filter to return a 200. map cluster_min_healthy_percentages = 4; } diff --git a/docs/root/intro/arch_overview/health_checking.rst b/docs/root/intro/arch_overview/health_checking.rst index 230b20042..da90edc4f 100644 --- a/docs/root/intro/arch_overview/health_checking.rst +++ b/docs/root/intro/arch_overview/health_checking.rst @@ -45,7 +45,8 @@ operation: * **No pass through**: In this mode, the health check request is never passed to the local service. Envoy will respond with a 200 or a 503 depending on the current draining state of the server. * **No pass through, computed from upstream cluster health**: In this mode, the health checking - filter will return a 200 or a 503 depending on whether at least a specified percentage of the + filter will return a 200 or a 503 depending on whether at least a :ref:`specified percentage + ` of the servers are healthy in one or more upstream clusters. (If the Envoy server is in a draining state, though, it will respond with a 503 regardless of the upstream cluster health.) * **Pass through**: In this mode, Envoy will pass every health check request to the local service.