docs/root/configuration/upstream/cluster_manager/cluster_runtime.rst
.. _config_cluster_manager_cluster_runtime:
Upstream clusters support the following runtime settings:
health_check.min_interval
Min value for the health checking :ref:interval <envoy_v3_api_field_config.core.v3.HealthCheck.interval>.
Default value is 1 ms. The effective health check interval will be no less than 1ms. The health
checking interval will be between min_interval and max_interval.
health_check.max_interval
Max value for the health checking :ref:interval <envoy_v3_api_field_config.core.v3.HealthCheck.interval>.
Default value is MAX_INT. The effective health check interval will be no less than 1ms. The health
checking interval will be between min_interval and max_interval.
health_check.verify_cluster
What % of health check requests will be verified against the :ref:expected upstream service <envoy_v3_api_field_config.core.v3.HealthCheck.HttpHealthCheck.service_name_matcher> as the :ref:health check filter <arch_overview_health_checking_filter> will write the remote service cluster into the response.
.. _config_cluster_manager_cluster_runtime_outlier_detection:
See the outlier detection :ref:architecture overview <arch_overview_outlier_detection> for more
information on outlier detection. The runtime parameters supported by outlier detection are the
same as the :ref:static configuration parameters <envoy_v3_api_msg_config.cluster.v3.OutlierDetection>, namely:
outlier_detection.consecutive_5xx
:ref:consecutive_5XX <envoy_v3_api_field_config.cluster.v3.OutlierDetection.consecutive_5xx>
setting in outlier detection
outlier_detection.consecutive_gateway_failure
:ref:consecutive_gateway_failure <envoy_v3_api_field_config.cluster.v3.OutlierDetection.consecutive_gateway_failure>
setting in outlier detection
outlier_detection.consecutive_local_origin_failure
:ref:consecutive_local_origin_failure <envoy_v3_api_field_config.cluster.v3.OutlierDetection.consecutive_local_origin_failure>
setting in outlier detection
outlier_detection.interval_ms
:ref:interval <envoy_v3_api_field_config.cluster.v3.OutlierDetection.interval>
setting in outlier detection
outlier_detection.base_ejection_time_ms
:ref:base_ejection_time <envoy_v3_api_field_config.cluster.v3.OutlierDetection.base_ejection_time>
setting in outlier detection
outlier_detection.max_ejection_percent
:ref:max_ejection_percent <envoy_v3_api_field_config.cluster.v3.OutlierDetection.max_ejection_percent>
setting in outlier detection
outlier_detection.enforcing_consecutive_5xx
:ref:enforcing_consecutive_5xx <envoy_v3_api_field_config.cluster.v3.OutlierDetection.enforcing_consecutive_5xx>
setting in outlier detection
outlier_detection.enforcing_consecutive_gateway_failure
:ref:enforcing_consecutive_gateway_failure <envoy_v3_api_field_config.cluster.v3.OutlierDetection.enforcing_consecutive_gateway_failure>
setting in outlier detection
outlier_detection.enforcing_consecutive_local_origin_failure
:ref:enforcing_consecutive_local_origin_failure <envoy_v3_api_field_config.cluster.v3.OutlierDetection.enforcing_consecutive_local_origin_failure>
setting in outlier detection
outlier_detection.enforcing_success_rate
:ref:enforcing_success_rate <envoy_v3_api_field_config.cluster.v3.OutlierDetection.enforcing_success_rate>
setting in outlier detection
outlier_detection.enforcing_local_origin_success_rate
:ref:enforcing_local_origin_success_rate <envoy_v3_api_field_config.cluster.v3.OutlierDetection.enforcing_local_origin_success_rate>
setting in outlier detection
outlier_detection.success_rate_minimum_hosts
:ref:success_rate_minimum_hosts <envoy_v3_api_field_config.cluster.v3.OutlierDetection.success_rate_minimum_hosts>
setting in outlier detection
outlier_detection.success_rate_request_volume
:ref:success_rate_request_volume <envoy_v3_api_field_config.cluster.v3.OutlierDetection.success_rate_request_volume>
setting in outlier detection
outlier_detection.success_rate_stdev_factor
:ref:success_rate_stdev_factor <envoy_v3_api_field_config.cluster.v3.OutlierDetection.success_rate_stdev_factor>
setting in outlier detection
outlier_detection.enforcing_failure_percentage
:ref:enforcing_failure_percentage <envoy_v3_api_field_config.cluster.v3.OutlierDetection.enforcing_failure_percentage>
setting in outlier detection
outlier_detection.enforcing_failure_percentage_local_origin
:ref:enforcing_failure_percentage_local_origin <envoy_v3_api_field_config.cluster.v3.OutlierDetection.enforcing_failure_percentage_local_origin>
setting in outlier detection
outlier_detection.failure_percentage_request_volume
:ref:failure_percentage_request_volume <envoy_v3_api_field_config.cluster.v3.OutlierDetection.failure_percentage_request_volume>
setting in outlier detection
outlier_detection.failure_percentage_minimum_hosts
:ref:failure_percentage_minimum_hosts <envoy_v3_api_field_config.cluster.v3.OutlierDetection.failure_percentage_minimum_hosts>
setting in outlier detection
outlier_detection.failure_percentage_threshold
:ref:failure_percentage_threshold <envoy_v3_api_field_config.cluster.v3.OutlierDetection.failure_percentage_threshold>
setting in outlier detection
outlier_detection.max_ejection_time_ms
:ref:max_ejection_time <envoy_v3_api_field_config.cluster.v3.OutlierDetection.max_ejection_time>
setting in outlier detection
outlier_detection.max_ejection_time_jitter_ms
:ref:base_ejection_time <envoy_v3_api_field_config.cluster.v3.OutlierDetection.max_ejection_time_jitter>
setting in outlier detection
upstream.healthy_panic_threshold
Sets the :ref:panic threshold <arch_overview_load_balancing_panic_threshold> percentage.
Defaults to 50%.
upstream.use_http2
Whether the cluster uses HTTP/2 if configured in :ref:HttpProtocolOptions <envoy_v3_api_msg_extensions.upstreams.http.v3.HttpProtocolOptions>.
Set to 0 to disable HTTP/2 even if the feature is configured. Defaults to enabled.
upstream.use_http3
Whether the cluster uses HTTP/3 if configured in :ref:HttpProtocolOptions <envoy_v3_api_msg_extensions.upstreams.http.v3.HttpProtocolOptions>.
Set to 0 to disable HTTP/3 even if the feature is configured. Defaults to enabled.
.. _config_cluster_manager_cluster_runtime_zone_routing:
upstream.zone_routing.enabled % of requests that will be routed to the same upstream zone. Defaults to 100% of requests.
upstream.zone_routing.min_cluster_size Minimal size of the upstream cluster for which zone aware routing can be attempted. Default value is 6. If the upstream cluster size is smaller than min_cluster_size zone aware routing will not be performed.
upstream.zone_routing.force_local_zone.min_size Enables force_local_zone and configures the minimum number of the upstream hosts in the local zone for force_local_zone to be respected. If the upstream zone size is smaller than force_local_zone_min_size routing logic falls back to default zone aware routing behavior.
circuit_breakers.<cluster_name>.<priority>.max_connections
:ref:Max connections circuit breaker setting <envoy_v3_api_field_config.cluster.v3.CircuitBreakers.Thresholds.max_connections>
circuit_breakers.<cluster_name>.<priority>.max_pending_requests
:ref:Max pending requests circuit breaker setting <envoy_v3_api_field_config.cluster.v3.CircuitBreakers.Thresholds.max_pending_requests>
circuit_breakers.<cluster_name>.<priority>.max_requests
:ref:Max requests circuit breaker setting <envoy_v3_api_field_config.cluster.v3.CircuitBreakers.Thresholds.max_requests>
circuit_breakers.<cluster_name>.<priority>.max_retries
:ref:Max retries circuit breaker setting <envoy_v3_api_field_config.cluster.v3.CircuitBreakers.Thresholds.max_retries>
circuit_breakers.<cluster_name>.<priority>.retry_budget.budget_percent
:ref:Max retries circuit breaker setting <envoy_v3_api_field_config.cluster.v3.CircuitBreakers.Thresholds.RetryBudget.budget_percent>
circuit_breakers.<cluster_name>.<priority>.retry_budget.min_retry_concurrency
:ref:Max retries circuit breaker setting <envoy_v3_api_field_config.cluster.v3.CircuitBreakers.Thresholds.RetryBudget.min_retry_concurrency>