From 002e49b5c252346eaa1f4de3d2bcd2b19be1cb73 Mon Sep 17 00:00:00 2001 From: Melisa Griffin Date: Fri, 25 Aug 2023 09:58:30 -0400 Subject: [PATCH] more updates --- .../config-entries/ingress-gateway.mdx | 114 +++++++++++------- .../config-entries/service-defaults.mdx | 2 +- 2 files changed, 72 insertions(+), 44 deletions(-) diff --git a/website/content/docs/connect/config-entries/ingress-gateway.mdx b/website/content/docs/connect/config-entries/ingress-gateway.mdx index e4dac5beb0a8a..a8c2e2d397359 100644 --- a/website/content/docs/connect/config-entries/ingress-gateway.mdx +++ b/website/content/docs/connect/config-entries/ingress-gateway.mdx @@ -42,9 +42,11 @@ The following list describes the configuration hierarchy, language-specific data - [`MaxPendingRequests`](#defaults-maxpendingrequests): number - [`MaxConcurrentRequests`](#defaults-maxconcurrentrequests): number - [`PassiveHealthCheck`](#defaults-passivehealthcheck): map - - [`interval`](#defaults-passivehealthcheck): number - - [`max_failures`](#defaults-passivehealthcheck): number - - [`enforcing_consecutive_5xx`](#defaults-passivehealthcheck): number + - [`Interval`](#defaults-passivehealthcheck): number + - [`MaxFailures`](#defaults-passivehealthcheck): number + - [`EnforcingConsecutive5xx`](#upstreamconfig-overrides-passivehealthcheck): number + - [`MaxEjectionPercent`](#upstreamconfig-overrides-passivehealthcheck): number + - [`BaseEjectionTime`](#upstreamconfig-overrides-passivehealthcheck): string - [`Listeners`](#listeners): list of maps - [`Port`](#listeners-port): number | `0` - [`Protocol`](#listeners-protocol): number | `tcp` @@ -69,9 +71,11 @@ The following list describes the configuration hierarchy, language-specific data - [`MaxPendingRequests`](#listeners-services-maxconnections): number | `0` - [`MaxConcurrentRequests`](#listeners-services-maxconnections): number | `0` - [`PassiveHealthCheck`](#listeners-services-passivehealthcheck): map - - [`interval`](#listeners-services-passivehealthcheck): number - - [`max_failures`](#listeners-services-passivehealthcheck): number - - [`enforcing_consecutive_5xx`](#listeners-services-passivehealthcheck): number + - [`Interval`](#defaults-passivehealthcheck): number + - [`MaxFailures`](#defaults-passivehealthcheck): number + - [`EnforcingConsecutive5xx`](#upstreamconfig-overrides-passivehealthcheck): number + - [`MaxEjectionPercent`](#upstreamconfig-overrides-passivehealthcheck): number + - [`BaseEjectionTime`](#upstreamconfig-overrides-passivehealthcheck): string - [`TLS`](#listeners-tls): map - [`Enabled`](#listeners-tls-enabled): boolean | `false` - [`TLSMinVersion`](#listeners-tls-tlsminversion): string | `TLSv1_2` @@ -104,9 +108,11 @@ The following list describes the configuration hierarchy, language-specific data - [`maxPendingRequests`](#spec-defaults-maxpendingrequests): number - [`maxConcurrentRequests`](#spec-defaults-maxconcurrentrequests): number - [`passiveHealthCheck`](#spec-defaults-passivehealthcheck): map - - [`interval`](#spec-defaults-passivehealthcheck): number | no proxy's default value - - [`max_failures`](#spec-defaults-passivehealthcheck): number | no proxy's default value - - [`enforcing_consecutive_5xx`](#spec-defaults-passivehealthcheck): number | proxy's default value + - [`interval`](#spec-defaults-passivehealthcheck): string + - [`maxFailures`](#spec-defaults-passivehealthcheck): integer + - [`enforcingConsecutive5xx`](#spec-defaults-passivehealthcheck): integer + - [`maxEjectionPercent`](#spec-defaults-passivehealthcheck): integer + - [`baseEjectionTime`](#spec-defaults-passivehealthcheck): string - [`listeners`](#spec-listeners): list of maps - [`port`](#spec-listeners-port): number | `0` - [`protocol`](#spec-listeners-protocol): number | `tcp` @@ -131,9 +137,11 @@ The following list describes the configuration hierarchy, language-specific data - [`maxPendingRequests`](#spec-listeners-services-maxconnections): number | `0` - [`maxConcurrentRequests`](#spec-listeners-services-maxconnections): number | `0` - [`passiveHealthCheck`](#spec-listeners-services-passivehealthcheck): map - - [`interval`](#spec-listeners-services-passivehealthcheck): number - - [`max_failures`](#spec-listeners-services-passivehealthcheck): number - - [`enforcing_consecutive_5xx`](#spec-listeners-services-passivehealthcheck): number + - [`interval`](#spec-listeners-services-passivehealthcheck): string + - [`maxFailures`](#spec-listeners-services-passivehealthcheck): integer + - [`enforcingConsecutive5xx`](#spec-listeners-services-passivehealthcheck): integer + - [`maxEjectionPercent`](#spec-listeners-services-passivehealthcheck): integer + - [`baseEjectionTime`](#spec-listeners-services-passivehealthcheck): string - [`tls`](#spec-listeners-tls): map - [`enabled`](#spec-listeners-tls-enabled): boolean | `false` - [`tlsMinVersion`](#spec-listeners-tls-tlsminversion): string | `TLSv1_2` @@ -180,9 +188,11 @@ Defaults = { MaxPendingRequests = 0 MaxConcurrentRequests = 0 PassiveHealthCheck = { - interval = 10 - max_failures = 5 - enforcing_consecutive_5xx = 100 + Interval = "5s" + MaxFailures = 5 + EnforcingConsecutive5xx = 99 + MaxEjectionPercent = 10 + BaseEjectionTime = "30s" } } Listeners = [ @@ -229,9 +239,11 @@ Listeners = [ MaxPendingRequests = MaxConcurrentRequests = PassiveHealthCheck = { - interval = 10 - max_failures = 5 - enforcing_consecutive_5xx = 100 + Interval = "1s" + MaxFailures = 1 + EnforcingConsecutive5xx = 89 + MaxEjectionPercent = 10 + BaseEjectionTime = "30s" } }] TLS = { @@ -275,9 +287,11 @@ spec: maxPendingRequests: 0 maxConcurrentRequests: 0 passiveHealthCheck: - interval: 10 - max_failures: 5 - enforcing_consecutive_5xx: 100 + interval: "10s" + maxFailures: 0 + enforcingConsecutive5xx: 100 + maxEjectionPercent: 10 + baseEjectionTime: "30s" listeners: - port: 0 protocol: tcp @@ -292,7 +306,7 @@ spec: requestHeaderName: set: requestHeaderName: - remove: + remove: - responseHeaders: add: @@ -309,9 +323,11 @@ spec: maxPendingRequests: maxConcurrentRequests: passiveHealthCheck: - interval: 10 - max_failures: 5 - enforcing_consecutive_5xx: 100 + interval: "0s" + maxFailures: 0 + enforcingConsecutive5xx: 100 + maxEjectionPercent: 10 + baseEjectionTime: "30s" tls: enabled: false tlsMinVersion: TLSv1_2 @@ -353,9 +369,11 @@ spec: "MaxPendingRequests" : 0, "MaxConcurrentRequests": 0, "PassiveHealthCheck" : { - "interval" : 10, - "max_failures" : 5, - "enforcing_consecutive_5xx" : 100 + "interval": "0s", + "maxFailures": 0, + "enforcingConsecutive5xx": 100, + "maxEjectionPercent": 10, + "baseEjectionTime": "30s", } }, "Listeners" : [ @@ -402,9 +420,11 @@ spec: "MaxPendingRequests" : , "MaxConcurrentRequests" : , "PassiveHealthCheck" : { - "interval" : 10, - "max_failures" : 5, - "enforcing_consecutive_5xx" : 100 + "interval": "0s", + "maxFailures": 0, + "enforcingConsecutive5xx": 100, + "maxEjectionPercent": 10, + "baseEjectionTime": "30s", } } ], @@ -632,9 +652,11 @@ The following table describes the configurations for passive health checks: | Parameter | Description | Data type | Default | | --- | --- | --- | --- | -| `interval` | Specifies the time in nanoseconds between checks. | Integer | Proxy's default configuration, which is `10` for Envoy | -| `max_failures` | Specifies the number of consecutive failures that cause a host to be removed from the upstream cluster. | Integer | Proxy's default configuration, which is `5` for Envoy | -| `enforcing_consecutive_5xx` | Specifies a percentage that indicates how many times out of 100 that Consul ejects the host when it detects an outlier status. The outlier status is determined by consecutive errors in the 500-599 response range. | Integer | Proxy's default configuration, which is `100` for Envoy | + | `Interval` | Specifies the time between checks. | string | `0s` | + | `MaxFailures` | Specifies the number of consecutive failures allowed per check interval. If exceeded, Consul removes the host from the load balancer. | integer | `0` | + | `EnforcingConsecutive5xx` | Specifies a percentage that indicates how many times out of 100 that Consul ejects the host when it detects an outlier status. The outlier status is determined by consecutive errors in the 500-599 response range. | integer | `100` | + | `MaxEjectionPercent` | The maximum % of an upstream cluster that can be ejected due to outlier detection. Defaults to 10% but will eject at least one host regardless of the value. | integer | `10` | + | `BaseEjectionTime` | The base time that a host is ejected for. The real time is equal to the base time multiplied by the number of times the host has been ejected and is capped by max_ejection_time (Default 300s). Defaults to 30000ms or 30s. | string | `30s` | ### `Listeners[]` @@ -867,9 +889,11 @@ The following table describes the configurations for passive health checks: | Parameter | Description | Data type | Default | | --- | --- | --- | --- | -| `interval` | Specifies the time in nanoseconds between checks. | Integer | Proxy's default configuration, which is `10` for Envoy | -| `max_failures` | Specifies the number of consecutive failures that cause a host to be removed from the upstream cluster. | Integer | Proxy's default configuration, which is `5` for Envoy | -| `enforcing_consecutive_5xx` | Specifies a percentage that indicates how many times out of 100 that Consul ejects the host when it detects an outlier status. The outlier status is determined by consecutive errors in the 500-599 response range. | Integer | Proxy's default configuration, which is `100` for Envoy | + | `Interval` | Specifies the time between checks. | string | `0s` | + | `MaxFailures` | Specifies the number of consecutive failures allowed per check interval. If exceeded, Consul removes the host from the load balancer. | integer | `0` | + | `EnforcingConsecutive5xx` | Specifies a percentage that indicates how many times out of 100 that Consul ejects the host when it detects an outlier status. The outlier status is determined by consecutive errors in the 500-599 response range. | integer | `100` | + | `MaxEjectionPercent` | The maximum % of an upstream cluster that can be ejected due to outlier detection. Defaults to 10% but will eject at least one host regardless of the value. | integer | `10` | + | `BaseEjectionTime` | The base time that a host is ejected for. The real time is equal to the base time multiplied by the number of times the host has been ejected and is capped by max_ejection_time (Default 300s). Defaults to 30000ms or 30s. | string | `30s` | ### `Listeners[].TLS` @@ -1163,9 +1187,11 @@ The following table describes the configurations for passive health checks: | Parameter | Description | Data type | Default | | --- | --- | --- | --- | -| `interval` | Specifies the time in nanoseconds between checks. | Integer | Proxy's default configuration, which is `10` for Envoy | -| `max_failures` | Specifies the number of consecutive failures that cause a host to be removed from the upstream cluster. | Integer | Proxy's default configuration, which is `5` for Envoy | -| `enforcing_consecutive_5xx` | Specifies a percentage that indicates how many times out of 100 that Consul ejects the host when it detects an outlier status. The outlier status is determined by consecutive errors in the 500-599 response range. | Integer | Proxy's default configuration, which is `100` for Envoy | + | `Interval` | Specifies the time between checks. | string | `0s` | + | `MaxFailures` | Specifies the number of consecutive failures allowed per check interval. If exceeded, Consul removes the host from the load balancer. | integer | `0` | + | `EnforcingConsecutive5xx` | Specifies a percentage that indicates how many times out of 100 that Consul ejects the host when it detects an outlier status. The outlier status is determined by consecutive errors in the 500-599 response range. | integer | `100` | + | `MaxEjectionPercent` | The maximum % of an upstream cluster that can be ejected due to outlier detection. Defaults to 10% but will eject at least one host regardless of the value. | integer | `10` | + | `BaseEjectionTime` | The base time that a host is ejected for. The real time is equal to the base time multiplied by the number of times the host has been ejected and is capped by max_ejection_time (Default 300s). Defaults to 30000ms or 30s. | string | `30s` | ### `spec.listeners[]` @@ -1399,9 +1425,11 @@ The following table describes the configurations for passive health checks: | Parameter | Description | Data type | Default | | --- | --- | --- | --- | -| `interval` | Specifies the time in nanoseconds between checks. | Integer | Proxy's default configuration, which is `10` for Envoy | -| `max_failures` | Specifies the number of consecutive failures that cause a host to be removed from the upstream cluster. | Integer | Proxy's default configuration, which is `5` for Envoy | -| `enforcing_consecutive_5xx` | Specifies a percentage that indicates how many times out of 100 that Consul ejects the host when it detects an outlier status. The outlier status is determined by consecutive errors in the 500-599 response range. | Integer | Proxy's default configuration, which is `100` for Envoy | + | `Interval` | Specifies the time between checks. | string | `0s` | + | `MaxFailures` | Specifies the number of consecutive failures allowed per check interval. If exceeded, Consul removes the host from the load balancer. | integer | `0` | + | `EnforcingConsecutive5xx` | Specifies a percentage that indicates how many times out of 100 that Consul ejects the host when it detects an outlier status. The outlier status is determined by consecutive errors in the 500-599 response range. | integer | `100` | + | `MaxEjectionPercent` | The maximum % of an upstream cluster that can be ejected due to outlier detection. Defaults to 10% but will eject at least one host regardless of the value. | integer | `10` | + | `BaseEjectionTime` | The base time that a host is ejected for. The real time is equal to the base time multiplied by the number of times the host has been ejected and is capped by max_ejection_time (Default 300s). Defaults to 30000ms or 30s. | string | `30s` | ### `spec.listeners[].tls` diff --git a/website/content/docs/connect/config-entries/service-defaults.mdx b/website/content/docs/connect/config-entries/service-defaults.mdx index c725f6462fd46..6943291bf166d 100644 --- a/website/content/docs/connect/config-entries/service-defaults.mdx +++ b/website/content/docs/connect/config-entries/service-defaults.mdx @@ -40,7 +40,7 @@ The following outline shows how to format the service defaults configuration ent - [`PassiveHealthCheck`](#upstreamconfig-overrides-passivehealthcheck): map | optional - [`Interval`](#upstreamconfig-overrides-passivehealthcheck): string | `0s` - [`MaxFailures`](#upstreamconfig-overrides-passivehealthcheck): integer | `0` - - [`EnforcingConsecutive5xx`](#upstreamconfig-overrides-passivehealthcheck): integer | `100` + - [`EnforcingConsecutive5xx`](#upstreamconfig-overrides-passivehealthcheck): integer | `0` - [`MaxEjectionPercent`](#upstreamconfig-overrides-passivehealthcheck): integer | `0` - [`BaseEjectionTime`](#upstreamconfig-overrides-passivehealthcheck): string | `30s` - [`Defaults`](#upstreamconfig-defaults): map | no default