sidecar

envoy object - See Below

envoy

accessLog array of objects - See Below

clusters array of objects - See Below

excludedExternalAuth array of objects - See Below

excludedRateLimit array of objects - See Below

network object

volumes array of objects - See Below

accessLog

priority number

name string

Possible enum values:

  • envoy.http_grpc_access_log

typed_config object - See Below

typed_config

@type object

common_config object - See Below

additional_request_headers_to_log array of strings

additional_response_headers_to_log array of strings

additional_response_trailers_to_log array of strings

common_config

log_name string

grpc_service object - See Below

transport_api_version string

Possible enum values:

  • AUTO

  • V2

  • V3

buffer_flush_interval object - See Below

buffer_size_bytes integer

filter_state_objects_to_log array of strings

grpc_stream_retry_policy object - See Below

grpc_service

envoy_grpc object - See Below

google_grpc object - See Below

timeout object - See Below

initial_metadata array of objects - See Below

envoy_grpc

cluster_name string

authority string

Default: [object Object]

retry_policy object - See Below

retry_policy

retry_back_off object - See Below

num_retries number

retry_back_off

base_interval object - See Below

max_interval object - See Below

base_interval

seconds integer

nanos integer

max_interval

seconds integer

nanos integer

google_grpc

target_uri string

channel_credentials object - See Below

call_credentials array of objects - See Below

stat_prefix string

credentials_factory_name string

config object

channel_credentials

ssl_credentials object - See Below

ssl_credentials

root_certs object - See Below

private_key object - See Below

cert_chain object - See Below

root_certs

filename string

inline_string string

environment_variable string

private_key

filename string

inline_string string

environment_variable string

cert_chain

filename string

inline_string string

environment_variable string

call_credentials

access_token string

google_refresh_token string

service_account_jwt_access object - See Below

google_iam object - See Below

from_plugin object - See Below

sts_service object - See Below

service_account_jwt_access

json_key string

token_lifetime_seconds integer

google_iam

authorization_token string

authority_selector string

from_plugin

name string

typed_config object

sts_service

token_exchange_service_uri string

resource string

audience string

scope string

requested_token_type string

subject_token_path string

subject_token_type string

actor_token_path string

actor_token_type string

timeout

seconds integer

nanos integer

initial_metadata

key string

value string

buffer_flush_interval

seconds integer

nanos integer

grpc_stream_retry_policy

retry_back_off object - See Below

num_retries number

clusters

name string

transport_socket_matches array of objects - See Below

alt_stat_name string

type string

Possible enum values:

  • STATIC

  • STRICT_DNS

  • LOGICAL_DNS

  • EDS

  • ORIGINAL_DST

cluster_type object - See Below

eds_cluster_config object - See Below

connect_timeout object - See Below

per_connection_buffer_limit_bytes integer

lb_policy string

Possible enum values:

  • ROUND_ROBIN

  • LEAST_REQUEST

  • RING_HASH

  • RANDOM

  • MAGLEV

  • CLUSTER_PROVIDED

  • LOAD_BALANCING_POLICY_CONFIG

load_assignment object - See Below

health_checks array of objects - See Below

max_requests_per_connection integer

circuit_breakers object - See Below

upstream_http_protocol_options object - See Below

common_http_protocol_options object - See Below

http_protocol_options object - See Below

http2_protocol_options object - See Below

typed_extension_protocol_options object

dns_refresh_rate object - See Below

dns_failure_refresh_rate object - See Below

respect_dns_ttl boolean

dns_lookup_family string

Possible enum values:

  • AUTO

  • V4_ONLY

  • V6_ONLY

  • V4_PREFERRED

  • ALL

dns_resolvers array of objects - See Below

use_tcp_for_dns_lookups boolean

dns_resolution_config object - See Below

typed_dns_resolver_config object - See Below

wait_for_warm_on_init boolean

outlier_detection object - See Below

cleanup_interval object - See Below

upstream_bind_config object - See Below

lb_subset_config object - See Below

ring_hash_lb_config object - See Below

maglev_lb_config object - See Below

least_request_lb_config object - See Below

common_lb_config object - See Below

transport_socket object - See Below

metadata object - See Below

protocol_selection string

Possible enum values:

  • USE_CONFIGURED_PROTOCOL

  • USE_DOWNSTREAM_PROTOCOL

upstream_connection_options object - See Below

close_connections_on_host_health_failure boolean

ignore_health_on_host_removal boolean

filters array of objects - See Below

load_balancing_policy object - See Below

track_timeout_budgets boolean

upstream_config object - See Below

track_cluster_stats object - See Below

preconnect_policy object - See Below

connection_pool_per_downstream_connection boolean

transport_socket_matches

name string

match object

transport_socket object - See Below

transport_socket

name string

typed_config object

cluster_type

name string

typed_config object

eds_cluster_config

eds_config object - See Below

service_name string

eds_config

path string

path_config_source object - See Below

api_config_source object - See Below

initial_fetch_timeout object - See Below

resource_api_version string

Possible enum values:

  • AUTO

  • V2

  • V3

path_config_source

path string

watched_directory object - See Below

watched_directory

path string

api_config_source

api_type string

Possible enum values:

  • DEPRECATED_AND_UNAVAILABLE_DO_NOT_USE

  • REST

  • GRPC

  • DELTA_GRPC

transport_api_version string

Possible enum values:

  • AUTO

  • V2

  • V3

cluster_names array of strings

grpc_services array of objects - See Below

refresh_delay object - See Below

request_timeout object - See Below

rate_limit_settings object - See Below

set_node_on_first_message_only boolean

config_validators array of objects - See Below

grpc_services

envoy_grpc object - See Below

google_grpc object - See Below

timeout object - See Below

initial_metadata array of objects - See Below

refresh_delay

seconds integer

nanos integer

request_timeout

seconds integer

nanos integer

rate_limit_settings

max_tokens integer

fill_rate number

config_validators

name string

typed_config object

initial_fetch_timeout

seconds integer

nanos integer

connect_timeout

seconds integer

nanos integer

load_assignment

cluster_name string

endpoints array of objects - See Below

policy object - See Below

endpoints

locality object - See Below

lb_endpoints array of objects - See Below

load_balancing_weight integer

priority integer

locality

region string

zone string

sub_zone string

lb_endpoints

endpoint object - See Below

health_status string

Possible enum values:

  • UNKNOWN

  • HEALTHY

  • UNHEALTHY

  • DRAINING

  • TIMEOUT

  • DEGRADED

metadata object - See Below

load_balancing_weight integer

endpoint

address object - See Below

health_check_config object - See Below

hostname string

additional_addresses array of objects - See Below

address

socket_address object - See Below

pipe object - See Below

envoy_internal_address object - See Below

socket_address

protocol string

Possible enum values:

  • TCP

  • UDP

address string

port_value integer

named_port string

resolver_name object

ipv4_compat boolean

pipe

path string

mode integer

envoy_internal_address

server_listener_name string

endpoint_id string

health_check_config

port_value integer

hostname string

address object - See Below

disable_active_health_check boolean

additional_addresses

address object - See Below

metadata

filter_metadata object

typed_filter_metadata object

policy

drop_overloads array of objects - See Below

overprovisioning_factor integer

endpoint_stale_after object - See Below

weighted_priority_health boolean

drop_overloads

category string

drop_percentage object - See Below

drop_percentage

numerator integer

denominator integer

endpoint_stale_after

seconds integer

nanos integer

health_checks

timeout object - See Below

interval object - See Below

initial_jitter object - See Below

interval_jitter object - See Below

interval_jitter_percent integer

unhealthy_threshold integer

healthy_threshold integer

reuse_connection boolean

http_health_check object - See Below

tcp_health_check object - See Below

grpc_health_check object - See Below

custom_health_check object - See Below

no_traffic_interval object - See Below

no_traffic_healthy_interval object - See Below

unhealthy_interval object - See Below

healthy_edge_interval object - See Below

event_log_path string

event_logger array of objects - See Below

always_log_health_check_failures boolean

tls_options object - See Below

transport_socket_match_criteria object

interval

seconds integer

nanos integer

initial_jitter

seconds integer

nanos integer

interval_jitter

seconds integer

nanos integer

http_health_check

host string

path string

receive array of objects - See Below

response_buffer_size integer

request_headers_to_add array of objects - See Below

request_headers_to_remove array of strings

expected_statuses array of objects - See Below

retriable_statuses array of objects - See Below

codec_client_type string

Possible enum values:

  • HTTP1

  • HTTP2

service_name_matcher object - See Below

method string

Possible enum values:

  • METHOD_UNSPECIFIED

  • GET

  • HEAD

  • POST

  • PUT

  • DELETE

  • CONNECT

  • OPTIONS

  • TRACE

  • PATCH

receive

text string

request_headers_to_add

header object - See Below

append boolean

append_action string

Possible enum values:

  • APPEND_IF_EXISTS_OR_ADD

  • ADD_IF_ABSENT

  • OVERWRITE_IF_EXISTS_OR_ADD

  • OVERWRITE_IF_EXISTS

keep_empty_value boolean

header

key string

value string

expected_statuses

start integer

end integer

retriable_statuses

start integer

end integer

service_name_matcher

exact string

prefix string

suffix string

safe_regex object - See Below

contains string

ignore_case boolean

safe_regex

google_re2 object - See Below

regex string

google_re2

max_program_size integer

tcp_health_check

send object - See Below

receive array of objects - See Below

send

text string

grpc_health_check

service_name string

authority string

initial_metadata array of objects - See Below

initial_metadata

header object - See Below

append boolean

append_action string

Possible enum values:

  • APPEND_IF_EXISTS_OR_ADD

  • ADD_IF_ABSENT

  • OVERWRITE_IF_EXISTS_OR_ADD

  • OVERWRITE_IF_EXISTS

keep_empty_value boolean

custom_health_check

name string

typed_config object

no_traffic_interval

seconds integer

nanos integer

no_traffic_healthy_interval

seconds integer

nanos integer

unhealthy_interval

seconds integer

nanos integer

healthy_edge_interval

seconds integer

nanos integer

event_logger

name string

typed_config object

tls_options

alpn_protocols array of strings

circuit_breakers

thresholds array of objects - See Below

per_host_thresholds array of objects - See Below

thresholds

priority string

Possible enum values:

  • DEFAULT

  • HIGH

max_connections integer

max_pending_requests integer

max_requests integer

retry_budget object - See Below

track_remaining boolean

max_connection_pools integer

retry_budget

budget_percent integer

min_retry_concurrency integer

per_host_thresholds

priority string

Possible enum values:

  • DEFAULT

  • HIGH

max_connections integer

max_pending_requests integer

max_requests integer

retry_budget object - See Below

track_remaining boolean

max_connection_pools integer

upstream_http_protocol_options

auto_sni boolean

auto_san_validation boolean

override_auto_sni_header string

common_http_protocol_options

idle_timeout object - See Below

max_connection_duration object - See Below

max_headers_count integer

max_stream_duration object - See Below

headers_with_underscores_action string

Possible enum values:

  • ALLOW

  • REJECT_REQUEST

  • DROP_HEADER

idle_timeout

seconds integer

nanos integer

max_connection_duration

seconds integer

nanos integer

max_stream_duration

seconds integer

nanos integer

http_protocol_options

allow_absolute_url boolean

accept_http_10 boolean

default_host_for_http_10 string

header_key_format object - See Below

enable_trailers boolean

allow_chunked_length boolean

override_stream_error_on_invalid_http_message boolean

send_fully_qualified_url boolean

header_key_format

proper_case_words object - See Below

stateful_formatter object - See Below

proper_case_words

interval object - See Below

timeout object - See Below

interval_jitter integer

connection_idle_interval object - See Below

connection_idle_interval

seconds integer

nanos integer

stateful_formatter

name string

typed_config object

http2_protocol_options

hpack_table_size integer

max_concurrent_streams integer

initial_stream_window_size integer

initial_connection_window_size integer

allow_connect boolean

max_outbound_frames integer

max_outbound_control_frames integer

max_consecutive_inbound_frames_with_empty_payload integer

max_inbound_priority_frames_per_stream integer

max_inbound_window_update_frames_per_data_frame_sent integer

stream_error_on_invalid_http_messaging boolean

override_stream_error_on_invalid_http_message boolean

connection_keepalive object - See Below

connection_keepalive

interval object - See Below

timeout object - See Below

interval_jitter integer

connection_idle_interval object - See Below

dns_refresh_rate

seconds integer

nanos integer

dns_failure_refresh_rate

base_interval object - See Below

max_interval object - See Below

dns_resolvers

socket_address object - See Below

pipe object - See Below

envoy_internal_address object - See Below

dns_resolution_config

resolvers array of objects - See Below

dns_resolver_options object - See Below

resolvers

socket_address object - See Below

pipe object - See Below

envoy_internal_address object - See Below

dns_resolver_options

use_tcp_for_dns_lookups boolean

no_default_search_domain boolean

typed_dns_resolver_config

name string

typed_config object

outlier_detection

consecutive_5xx integer

interval object - See Below

base_ejection_time object - See Below

max_ejection_percent integer

enforcing_consecutive5xx integer

enforcing_success_rate integer

success_rate_minimum_hosts integer

success_rate_request_volume integer

success_rate_stdev_factor integer

consecutive_gateway_failure integer

enforcing_consecutive_gateway_failure integer

split_external_local_origin_errors boolean

consecutive_local_origin_failure integer

enforcing_consecutive_local_origin_failure integer

enforcing_local_origin_success_rate integer

failure_percentage_threshold integer

enforcing_failure_percentage integer

enforcing_failure_percentage_local_origin integer

failure_percentage_minimum_hosts integer

failure_percentage_request_volume integer

max_ejection_time object - See Below

max_ejection_time_jitter object - See Below

successful_active_health_check_uneject_host boolean

base_ejection_time

seconds integer

nanos integer

max_ejection_time

seconds integer

nanos integer

max_ejection_time_jitter

seconds integer

nanos integer

cleanup_interval

seconds integer

nanos integer

upstream_bind_config

source_address object - See Below

freebind boolean

socket_options array of objects - See Below

extra_source_addresses array of objects - See Below

additional_source_addresses array of objects - See Below

local_address_selector object - See Below

source_address

protocol string

Possible enum values:

  • TCP

  • UDP

address string

port_value integer

named_port string

resolver_name object

ipv4_compat boolean

socket_options

description string

level integer

name integer

int_value integer

state string

Possible enum values:

  • STATE_PREBIND

  • STATE_BOUND

  • STATE_LISTENING

extra_source_addresses

address object - See Below

socket_options object - See Below

socket_options

socket_options array of objects - See Below

additional_source_addresses

protocol string

Possible enum values:

  • TCP

  • UDP

address string

port_value integer

named_port string

resolver_name object

ipv4_compat boolean

local_address_selector

name string

typed_config object

lb_subset_config

fallback_policy string

Possible enum values:

  • NO_FALLBACK

  • ANY_ENDPOINT

  • DEFAULT_SUBSET

default_subset object

locality_weight_aware boolean

scale_locality_weight boolean

panic_mode_any boolean

list_as_any boolean

metadata_fallback_policy string

Possible enum values:

  • METADATA_NO_FALLBACK

  • FALLBACK_LIST

ring_hash_lb_config

minimum_ring_size integer

hash_function string

Possible enum values:

  • XX_HASH

  • MURMUR_HASH_2

maximum_ring_size integer

maglev_lb_config

table_size integer

least_request_lb_config

choice_count integer

active_request_bias object - See Below

slow_start_config object - See Below

active_request_bias

default_value number

runtime_key string

slow_start_config

slow_start_window object - See Below

aggression object - See Below

min_weight_percent integer

slow_start_window

seconds integer

nanos integer

aggression

default_value number

runtime_key string

common_lb_config

healthy_panic_threshold integer

zone_aware_lb_config object - See Below

update_merge_window object - See Below

ignore_new_hosts_until_first_hc boolean

close_connections_on_host_set_change boolean

consistent_hashing_lb_config object - See Below

override_host_status object - See Below

zone_aware_lb_config

routing_enabled integer

min_cluster_size integer

fail_traffic_on_panic boolean

update_merge_window

seconds integer

nanos integer

consistent_hashing_lb_config

use_hostname_for_hashing boolean

hash_balance_factor integer

override_host_status

statuses array of strings

Possible enum values:

  • UNKNOWN

  • HEALTHY

  • UNHEALTHY

  • DRAINING

  • TIMEOUT

  • DEGRADED

upstream_connection_options

tcp_keepalive object - See Below

set_local_interface_name_on_upstream_connections boolean

tcp_keepalive

keepalive_probes integer

keepalive_time integer

keepalive_interval integer

filters

name string

typed_config object

config_discovery object - See Below

config_discovery

config_source object - See Below

default_config object

apply_default_config_without_warming boolean

type_urls array of strings

config_source

path string

path_config_source object - See Below

api_config_source object - See Below

initial_fetch_timeout object - See Below

resource_api_version string

Possible enum values:

  • AUTO

  • V2

  • V3

load_balancing_policy

policies array of objects - See Below

policies

typed_extension_config object - See Below

typed_extension_config

name string

typed_config object

upstream_config

name string

typed_config object

track_cluster_stats

timeout_budgets boolean

request_response_sizes boolean

per_endpoint_stats boolean

preconnect_policy

per_upstream_preconnect_ratio number

predictive_preconnect_ratio number

excludedExternalAuth

match object - See Below

port integer

svcPort integer

match

prefix string

path string

safe_regex object - See Below

path_separated_prefix string

path_match_policy object - See Below

case_sensitive boolean

runtime_fraction object - See Below

headers array of objects - See Below

query_parameters array of objects - See Below

grpc object - See Below

tls_context object - See Below

dynamic_metadata array of objects - See Below

path_match_policy

name string

typed_config object

runtime_fraction

default_value object - See Below

runtime_key string

default_value

numerator integer

denominator integer

headers

name string

safe_regex_match object - See Below

range_match object - See Below

present_match boolean

string_match object - See Below

invert_match boolean

treat_missing_header_as_empty boolean

safe_regex_match

google_re2 object - See Below

regex string

range_match

start integer

end integer

string_match

exact string

prefix string

suffix string

safe_regex object - See Below

contains string

ignore_case boolean

query_parameters

name string

string_match object - See Below

present_match boolean

grpc

presented boolean

validated boolean

tls_context

presented boolean

validated boolean

dynamic_metadata

filter string

path array of objects - See Below

value object - See Below

invert boolean

path

key string

value

null_match object

double_match object - See Below

string_match object - See Below

bool_match boolean

present_match boolean

double_match

range object - See Below

exact number

range

start number

end number

excludedRateLimit

match object - See Below

port integer

svcPort integer

volumes

uri string

recoveryPolicy string

Only applicable to persistent volumes, this determines what Control Plane will do when creating a new workload replica if a corresponding volume exists.

Default: retain

Possible enum values:

  • retain

  • recycle

path string

Copyright © 2024 Control Plane Corporation. All rights reserved. Revision ba5c0f81
Contents