-
Notifications
You must be signed in to change notification settings - Fork 47
/
listener.pb.go
1585 lines (1453 loc) · 80.1 KB
/
listener.pb.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// Code generated by protoc-gen-go. DO NOT EDIT.
// versions:
// protoc-gen-go v1.23.0
// protoc v4.23.4
// source: envoy/config/listener/v3/listener.proto
package listenerv3
import (
_ "github.com/cilium/proxy/go/envoy/annotations"
v33 "github.com/cilium/proxy/go/envoy/config/accesslog/v3"
v3 "github.com/cilium/proxy/go/envoy/config/core/v3"
_ "github.com/cncf/xds/go/udpa/annotations"
_ "github.com/cncf/xds/go/xds/annotations/v3"
v31 "github.com/cncf/xds/go/xds/core/v3"
v32 "github.com/cncf/xds/go/xds/type/matcher/v3"
_ "github.com/envoyproxy/protoc-gen-validate/validate"
proto "github.com/golang/protobuf/proto"
protoreflect "google.golang.org/protobuf/reflect/protoreflect"
protoimpl "google.golang.org/protobuf/runtime/protoimpl"
durationpb "google.golang.org/protobuf/types/known/durationpb"
wrapperspb "google.golang.org/protobuf/types/known/wrapperspb"
reflect "reflect"
sync "sync"
)
const (
// Verify that this generated code is sufficiently up-to-date.
_ = protoimpl.EnforceVersion(20 - protoimpl.MinVersion)
// Verify that runtime/protoimpl is sufficiently up-to-date.
_ = protoimpl.EnforceVersion(protoimpl.MaxVersion - 20)
)
// This is a compile-time assertion that a sufficiently up-to-date version
// of the legacy proto package is being used.
const _ = proto.ProtoPackageIsVersion4
type Listener_DrainType int32
const (
// Drain in response to calling /healthcheck/fail admin endpoint (along with the health check
// filter), listener removal/modification, and hot restart.
Listener_DEFAULT Listener_DrainType = 0
// Drain in response to listener removal/modification and hot restart. This setting does not
// include /healthcheck/fail. This setting may be desirable if Envoy is hosting both ingress
// and egress listeners.
Listener_MODIFY_ONLY Listener_DrainType = 1
)
// Enum value maps for Listener_DrainType.
var (
Listener_DrainType_name = map[int32]string{
0: "DEFAULT",
1: "MODIFY_ONLY",
}
Listener_DrainType_value = map[string]int32{
"DEFAULT": 0,
"MODIFY_ONLY": 1,
}
)
func (x Listener_DrainType) Enum() *Listener_DrainType {
p := new(Listener_DrainType)
*p = x
return p
}
func (x Listener_DrainType) String() string {
return protoimpl.X.EnumStringOf(x.Descriptor(), protoreflect.EnumNumber(x))
}
func (Listener_DrainType) Descriptor() protoreflect.EnumDescriptor {
return file_envoy_config_listener_v3_listener_proto_enumTypes[0].Descriptor()
}
func (Listener_DrainType) Type() protoreflect.EnumType {
return &file_envoy_config_listener_v3_listener_proto_enumTypes[0]
}
func (x Listener_DrainType) Number() protoreflect.EnumNumber {
return protoreflect.EnumNumber(x)
}
// Deprecated: Use Listener_DrainType.Descriptor instead.
func (Listener_DrainType) EnumDescriptor() ([]byte, []int) {
return file_envoy_config_listener_v3_listener_proto_rawDescGZIP(), []int{2, 0}
}
// The additional address the listener is listening on.
type AdditionalAddress struct {
state protoimpl.MessageState
sizeCache protoimpl.SizeCache
unknownFields protoimpl.UnknownFields
Address *v3.Address `protobuf:"bytes,1,opt,name=address,proto3" json:"address,omitempty"`
// Additional socket options that may not be present in Envoy source code or
// precompiled binaries. If specified, this will override the
// :ref:`socket_options <envoy_v3_api_field_config.listener.v3.Listener.socket_options>`
// in the listener. If specified with no
// :ref:`socket_options <envoy_v3_api_field_config.core.v3.SocketOptionsOverride.socket_options>`
// or an empty list of :ref:`socket_options <envoy_v3_api_field_config.core.v3.SocketOptionsOverride.socket_options>`,
// it means no socket option will apply.
SocketOptions *v3.SocketOptionsOverride `protobuf:"bytes,2,opt,name=socket_options,json=socketOptions,proto3" json:"socket_options,omitempty"`
}
func (x *AdditionalAddress) Reset() {
*x = AdditionalAddress{}
if protoimpl.UnsafeEnabled {
mi := &file_envoy_config_listener_v3_listener_proto_msgTypes[0]
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
ms.StoreMessageInfo(mi)
}
}
func (x *AdditionalAddress) String() string {
return protoimpl.X.MessageStringOf(x)
}
func (*AdditionalAddress) ProtoMessage() {}
func (x *AdditionalAddress) ProtoReflect() protoreflect.Message {
mi := &file_envoy_config_listener_v3_listener_proto_msgTypes[0]
if protoimpl.UnsafeEnabled && x != nil {
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
if ms.LoadMessageInfo() == nil {
ms.StoreMessageInfo(mi)
}
return ms
}
return mi.MessageOf(x)
}
// Deprecated: Use AdditionalAddress.ProtoReflect.Descriptor instead.
func (*AdditionalAddress) Descriptor() ([]byte, []int) {
return file_envoy_config_listener_v3_listener_proto_rawDescGZIP(), []int{0}
}
func (x *AdditionalAddress) GetAddress() *v3.Address {
if x != nil {
return x.Address
}
return nil
}
func (x *AdditionalAddress) GetSocketOptions() *v3.SocketOptionsOverride {
if x != nil {
return x.SocketOptions
}
return nil
}
// Listener list collections. Entries are “Listener“ resources or references.
// [#not-implemented-hide:]
type ListenerCollection struct {
state protoimpl.MessageState
sizeCache protoimpl.SizeCache
unknownFields protoimpl.UnknownFields
Entries []*v31.CollectionEntry `protobuf:"bytes,1,rep,name=entries,proto3" json:"entries,omitempty"`
}
func (x *ListenerCollection) Reset() {
*x = ListenerCollection{}
if protoimpl.UnsafeEnabled {
mi := &file_envoy_config_listener_v3_listener_proto_msgTypes[1]
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
ms.StoreMessageInfo(mi)
}
}
func (x *ListenerCollection) String() string {
return protoimpl.X.MessageStringOf(x)
}
func (*ListenerCollection) ProtoMessage() {}
func (x *ListenerCollection) ProtoReflect() protoreflect.Message {
mi := &file_envoy_config_listener_v3_listener_proto_msgTypes[1]
if protoimpl.UnsafeEnabled && x != nil {
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
if ms.LoadMessageInfo() == nil {
ms.StoreMessageInfo(mi)
}
return ms
}
return mi.MessageOf(x)
}
// Deprecated: Use ListenerCollection.ProtoReflect.Descriptor instead.
func (*ListenerCollection) Descriptor() ([]byte, []int) {
return file_envoy_config_listener_v3_listener_proto_rawDescGZIP(), []int{1}
}
func (x *ListenerCollection) GetEntries() []*v31.CollectionEntry {
if x != nil {
return x.Entries
}
return nil
}
// [#next-free-field: 35]
type Listener struct {
state protoimpl.MessageState
sizeCache protoimpl.SizeCache
unknownFields protoimpl.UnknownFields
// The unique name by which this listener is known. If no name is provided,
// Envoy will allocate an internal UUID for the listener. If the listener is to be dynamically
// updated or removed via :ref:`LDS <config_listeners_lds>` a unique name must be provided.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// The address that the listener should listen on. In general, the address must be unique, though
// that is governed by the bind rules of the OS. E.g., multiple listeners can listen on port 0 on
// Linux as the actual port will be allocated by the OS.
// Required unless “api_listener“ or “listener_specifier“ is populated.
Address *v3.Address `protobuf:"bytes,2,opt,name=address,proto3" json:"address,omitempty"`
// The additional addresses the listener should listen on. The addresses must be unique across all
// listeners. Multiple addresses with port 0 can be supplied. When using multiple addresses in a single listener,
// all addresses use the same protocol, and multiple internal addresses are not supported.
AdditionalAddresses []*AdditionalAddress `protobuf:"bytes,33,rep,name=additional_addresses,json=additionalAddresses,proto3" json:"additional_addresses,omitempty"`
// Optional prefix to use on listener stats. If empty, the stats will be rooted at
// “listener.<address as string>.“. If non-empty, stats will be rooted at
// “listener.<stat_prefix>.“.
StatPrefix string `protobuf:"bytes,28,opt,name=stat_prefix,json=statPrefix,proto3" json:"stat_prefix,omitempty"`
// A list of filter chains to consider for this listener. The
// :ref:`FilterChain <envoy_v3_api_msg_config.listener.v3.FilterChain>` with the most specific
// :ref:`FilterChainMatch <envoy_v3_api_msg_config.listener.v3.FilterChainMatch>` criteria is used on a
// connection.
//
// Example using SNI for filter chain selection can be found in the
// :ref:`FAQ entry <faq_how_to_setup_sni>`.
FilterChains []*FilterChain `protobuf:"bytes,3,rep,name=filter_chains,json=filterChains,proto3" json:"filter_chains,omitempty"`
// :ref:`Matcher API <arch_overview_matching_listener>` resolving the filter chain name from the
// network properties. This matcher is used as a replacement for the filter chain match condition
// :ref:`filter_chain_match
// <envoy_v3_api_field_config.listener.v3.FilterChain.filter_chain_match>`. If specified, all
// :ref:`filter_chains <envoy_v3_api_field_config.listener.v3.Listener.filter_chains>` must have a
// non-empty and unique :ref:`name <envoy_v3_api_field_config.listener.v3.FilterChain.name>` field
// and not specify :ref:`filter_chain_match
// <envoy_v3_api_field_config.listener.v3.FilterChain.filter_chain_match>` field.
//
// .. note::
//
// Once matched, each connection is permanently bound to its filter chain.
// If the matcher changes but the filter chain remains the same, the
// connections bound to the filter chain are not drained. If, however, the
// filter chain is removed or structurally modified, then the drain for its
// connections is initiated.
FilterChainMatcher *v32.Matcher `protobuf:"bytes,32,opt,name=filter_chain_matcher,json=filterChainMatcher,proto3" json:"filter_chain_matcher,omitempty"`
// If a connection is redirected using “iptables“, the port on which the proxy
// receives it might be different from the original destination address. When this flag is set to
// true, the listener hands off redirected connections to the listener associated with the
// original destination address. If there is no listener associated with the original destination
// address, the connection is handled by the listener that receives it. Defaults to false.
UseOriginalDst *wrapperspb.BoolValue `protobuf:"bytes,4,opt,name=use_original_dst,json=useOriginalDst,proto3" json:"use_original_dst,omitempty"`
// The default filter chain if none of the filter chain matches. If no default filter chain is supplied,
// the connection will be closed. The filter chain match is ignored in this field.
DefaultFilterChain *FilterChain `protobuf:"bytes,25,opt,name=default_filter_chain,json=defaultFilterChain,proto3" json:"default_filter_chain,omitempty"`
// Soft limit on size of the listener’s new connection read and write buffers.
// If unspecified, an implementation defined default is applied (1MiB).
PerConnectionBufferLimitBytes *wrapperspb.UInt32Value `protobuf:"bytes,5,opt,name=per_connection_buffer_limit_bytes,json=perConnectionBufferLimitBytes,proto3" json:"per_connection_buffer_limit_bytes,omitempty"`
// Listener metadata.
Metadata *v3.Metadata `protobuf:"bytes,6,opt,name=metadata,proto3" json:"metadata,omitempty"`
// [#not-implemented-hide:]
//
// Deprecated: Do not use.
DeprecatedV1 *Listener_DeprecatedV1 `protobuf:"bytes,7,opt,name=deprecated_v1,json=deprecatedV1,proto3" json:"deprecated_v1,omitempty"`
// The type of draining to perform at a listener-wide level.
DrainType Listener_DrainType `protobuf:"varint,8,opt,name=drain_type,json=drainType,proto3,enum=envoy.config.listener.v3.Listener_DrainType" json:"drain_type,omitempty"`
// Listener filters have the opportunity to manipulate and augment the connection metadata that
// is used in connection filter chain matching, for example. These filters are run before any in
// :ref:`filter_chains <envoy_v3_api_field_config.listener.v3.Listener.filter_chains>`. Order matters as the
// filters are processed sequentially right after a socket has been accepted by the listener, and
// before a connection is created.
// UDP Listener filters can be specified when the protocol in the listener socket address in
// :ref:`protocol <envoy_v3_api_field_config.core.v3.SocketAddress.protocol>` is :ref:`UDP
// <envoy_v3_api_enum_value_config.core.v3.SocketAddress.Protocol.UDP>` and no
// :ref:`quic_options <envoy_v3_api_field_config.listener.v3.UdpListenerConfig.quic_options>` is specified in :ref:`udp_listener_config <envoy_v3_api_field_config.listener.v3.Listener.udp_listener_config>`.
// QUIC listener filters can be specified when :ref:`quic_options
// <envoy_v3_api_field_config.listener.v3.UdpListenerConfig.quic_options>` is
// specified in :ref:`udp_listener_config <envoy_v3_api_field_config.listener.v3.Listener.udp_listener_config>`.
// They are processed sequentially right before connection creation. And like TCP Listener filters, they can be used to manipulate the connection metadata and socket. But the difference is that they can't be used to pause connection creation.
ListenerFilters []*ListenerFilter `protobuf:"bytes,9,rep,name=listener_filters,json=listenerFilters,proto3" json:"listener_filters,omitempty"`
// The timeout to wait for all listener filters to complete operation. If the timeout is reached,
// the accepted socket is closed without a connection being created unless
// “continue_on_listener_filters_timeout“ is set to true. Specify 0 to disable the
// timeout. If not specified, a default timeout of 15s is used.
ListenerFiltersTimeout *durationpb.Duration `protobuf:"bytes,15,opt,name=listener_filters_timeout,json=listenerFiltersTimeout,proto3" json:"listener_filters_timeout,omitempty"`
// Whether a connection should be created when listener filters timeout. Default is false.
//
// .. attention::
//
// Some listener filters, such as :ref:`Proxy Protocol filter
// <config_listener_filters_proxy_protocol>`, should not be used with this option. It will cause
// unexpected behavior when a connection is created.
ContinueOnListenerFiltersTimeout bool `protobuf:"varint,17,opt,name=continue_on_listener_filters_timeout,json=continueOnListenerFiltersTimeout,proto3" json:"continue_on_listener_filters_timeout,omitempty"`
// Whether the listener should be set as a transparent socket.
// When this flag is set to true, connections can be redirected to the listener using an
// “iptables“ “TPROXY“ target, in which case the original source and destination addresses and
// ports are preserved on accepted connections. This flag should be used in combination with
// :ref:`an original_dst <config_listener_filters_original_dst>` :ref:`listener filter
// <envoy_v3_api_field_config.listener.v3.Listener.listener_filters>` to mark the connections' local addresses as
// "restored." This can be used to hand off each redirected connection to another listener
// associated with the connection's destination address. Direct connections to the socket without
// using “TPROXY“ cannot be distinguished from connections redirected using “TPROXY“ and are
// therefore treated as if they were redirected.
// When this flag is set to false, the listener's socket is explicitly reset as non-transparent.
// Setting this flag requires Envoy to run with the “CAP_NET_ADMIN“ capability.
// When this flag is not set (default), the socket is not modified, i.e. the transparent option
// is neither set nor reset.
Transparent *wrapperspb.BoolValue `protobuf:"bytes,10,opt,name=transparent,proto3" json:"transparent,omitempty"`
// Whether the listener should set the “IP_FREEBIND“ socket option. When this
// flag is set to true, listeners can be bound to an IP address that is not
// configured on the system running Envoy. When this flag is set to false, the
// option “IP_FREEBIND“ is disabled on the socket. When this flag is not set
// (default), the socket is not modified, i.e. the option is neither enabled
// nor disabled.
Freebind *wrapperspb.BoolValue `protobuf:"bytes,11,opt,name=freebind,proto3" json:"freebind,omitempty"`
// Additional socket options that may not be present in Envoy source code or
// precompiled binaries. The socket options can be updated for a listener when
// :ref:`enable_reuse_port <envoy_v3_api_field_config.listener.v3.Listener.enable_reuse_port>`
// is “true“. Otherwise, if socket options change during a listener update the update will be rejected
// to make it clear that the options were not updated.
SocketOptions []*v3.SocketOption `protobuf:"bytes,13,rep,name=socket_options,json=socketOptions,proto3" json:"socket_options,omitempty"`
// Whether the listener should accept TCP Fast Open (TFO) connections.
// When this flag is set to a value greater than 0, the option TCP_FASTOPEN is enabled on
// the socket, with a queue length of the specified size
// (see `details in RFC7413 <https://tools.ietf.org/html/rfc7413#section-5.1>`_).
// When this flag is set to 0, the option TCP_FASTOPEN is disabled on the socket.
// When this flag is not set (default), the socket is not modified,
// i.e. the option is neither enabled nor disabled.
//
// On Linux, the net.ipv4.tcp_fastopen kernel parameter must include flag 0x2 to enable
// TCP_FASTOPEN.
// See `ip-sysctl.txt <https://www.kernel.org/doc/Documentation/networking/ip-sysctl.txt>`_.
//
// On macOS, only values of 0, 1, and unset are valid; other values may result in an error.
// To set the queue length on macOS, set the net.inet.tcp.fastopen_backlog kernel parameter.
TcpFastOpenQueueLength *wrapperspb.UInt32Value `protobuf:"bytes,12,opt,name=tcp_fast_open_queue_length,json=tcpFastOpenQueueLength,proto3" json:"tcp_fast_open_queue_length,omitempty"`
// Specifies the intended direction of the traffic relative to the local Envoy.
// This property is required on Windows for listeners using the original destination filter,
// see :ref:`Original Destination <config_listener_filters_original_dst>`.
TrafficDirection v3.TrafficDirection `protobuf:"varint,16,opt,name=traffic_direction,json=trafficDirection,proto3,enum=envoy.config.core.v3.TrafficDirection" json:"traffic_direction,omitempty"`
// If the protocol in the listener socket address in :ref:`protocol
// <envoy_v3_api_field_config.core.v3.SocketAddress.protocol>` is :ref:`UDP
// <envoy_v3_api_enum_value_config.core.v3.SocketAddress.Protocol.UDP>`, this field specifies UDP
// listener specific configuration.
UdpListenerConfig *UdpListenerConfig `protobuf:"bytes,18,opt,name=udp_listener_config,json=udpListenerConfig,proto3" json:"udp_listener_config,omitempty"`
// Used to represent an API listener, which is used in non-proxy clients. The type of API
// exposed to the non-proxy application depends on the type of API listener.
// When this field is set, no other field except for :ref:`name<envoy_v3_api_field_config.listener.v3.Listener.name>`
// should be set.
//
// .. note::
//
// Currently only one ApiListener can be installed; and it can only be done via bootstrap config,
// not LDS.
//
// [#next-major-version: In the v3 API, instead of this messy approach where the socket
// listener fields are directly in the top-level Listener message and the API listener types
// are in the ApiListener message, the socket listener messages should be in their own message,
// and the top-level Listener should essentially be a oneof that selects between the
// socket listener and the various types of API listener. That way, a given Listener message
// can structurally only contain the fields of the relevant type.]
ApiListener *ApiListener `protobuf:"bytes,19,opt,name=api_listener,json=apiListener,proto3" json:"api_listener,omitempty"`
// The listener's connection balancer configuration, currently only applicable to TCP listeners.
// If no configuration is specified, Envoy will not attempt to balance active connections between
// worker threads.
//
// In the scenario that the listener X redirects all the connections to the listeners Y1 and Y2
// by setting :ref:`use_original_dst <envoy_v3_api_field_config.listener.v3.Listener.use_original_dst>` in X
// and :ref:`bind_to_port <envoy_v3_api_field_config.listener.v3.Listener.bind_to_port>` to false in Y1 and Y2,
// it is recommended to disable the balance config in listener X to avoid the cost of balancing, and
// enable the balance config in Y1 and Y2 to balance the connections among the workers.
ConnectionBalanceConfig *Listener_ConnectionBalanceConfig `protobuf:"bytes,20,opt,name=connection_balance_config,json=connectionBalanceConfig,proto3" json:"connection_balance_config,omitempty"`
// Deprecated. Use “enable_reuse_port“ instead.
//
// Deprecated: Do not use.
ReusePort bool `protobuf:"varint,21,opt,name=reuse_port,json=reusePort,proto3" json:"reuse_port,omitempty"`
// When this flag is set to true, listeners set the “SO_REUSEPORT“ socket option and
// create one socket for each worker thread. This makes inbound connections
// distribute among worker threads roughly evenly in cases where there are a high number
// of connections. When this flag is set to false, all worker threads share one socket. This field
// defaults to true. The change of field will be rejected during an listener update when the
// runtime flag “envoy.reloadable_features.enable_update_listener_socket_options“ is enabled.
// Otherwise, the update of this field will be ignored quietly.
//
// .. attention::
//
// Although this field defaults to true, it has different behavior on different platforms. See
// the following text for more information.
//
// - On Linux, reuse_port is respected for both TCP and UDP listeners. It also works correctly
// with hot restart.
// - On macOS, reuse_port for TCP does not do what it does on Linux. Instead of load balancing,
// the last socket wins and receives all connections/packets. For TCP, reuse_port is force
// disabled and the user is warned. For UDP, it is enabled, but only one worker will receive
// packets. For QUIC/H3, SW routing will send packets to other workers. For "raw" UDP, only
// a single worker will currently receive packets.
// - On Windows, reuse_port for TCP has undefined behavior. It is force disabled and the user
// is warned similar to macOS. It is left enabled for UDP with undefined behavior currently.
EnableReusePort *wrapperspb.BoolValue `protobuf:"bytes,29,opt,name=enable_reuse_port,json=enableReusePort,proto3" json:"enable_reuse_port,omitempty"`
// Configuration for :ref:`access logs <arch_overview_access_logs>`
// emitted by this listener.
AccessLog []*v33.AccessLog `protobuf:"bytes,22,rep,name=access_log,json=accessLog,proto3" json:"access_log,omitempty"`
// The maximum length a tcp listener's pending connections queue can grow to. If no value is
// provided net.core.somaxconn will be used on Linux and 128 otherwise.
TcpBacklogSize *wrapperspb.UInt32Value `protobuf:"bytes,24,opt,name=tcp_backlog_size,json=tcpBacklogSize,proto3" json:"tcp_backlog_size,omitempty"`
// The maximum number of connections to accept from the kernel per socket
// event. Envoy may decide to close these connections after accepting them
// from the kernel e.g. due to load shedding, or other policies.
// If there are more than max_connections_to_accept_per_socket_event
// connections pending accept, connections over this threshold will be
// accepted in later event loop iterations.
// If no value is provided Envoy will accept all connections pending accept
// from the kernel.
MaxConnectionsToAcceptPerSocketEvent *wrapperspb.UInt32Value `protobuf:"bytes,34,opt,name=max_connections_to_accept_per_socket_event,json=maxConnectionsToAcceptPerSocketEvent,proto3" json:"max_connections_to_accept_per_socket_event,omitempty"`
// Whether the listener should bind to the port. A listener that doesn't
// bind can only receive connections redirected from other listeners that set
// :ref:`use_original_dst <envoy_v3_api_field_config.listener.v3.Listener.use_original_dst>`
// to true. Default is true.
BindToPort *wrapperspb.BoolValue `protobuf:"bytes,26,opt,name=bind_to_port,json=bindToPort,proto3" json:"bind_to_port,omitempty"`
// The exclusive listener type and the corresponding config.
//
// Types that are assignable to ListenerSpecifier:
//
// *Listener_InternalListener
ListenerSpecifier isListener_ListenerSpecifier `protobuf_oneof:"listener_specifier"`
// Enable MPTCP (multi-path TCP) on this listener. Clients will be allowed to establish
// MPTCP connections. Non-MPTCP clients will fall back to regular TCP.
EnableMptcp bool `protobuf:"varint,30,opt,name=enable_mptcp,json=enableMptcp,proto3" json:"enable_mptcp,omitempty"`
// Whether the listener should limit connections based upon the value of
// :ref:`global_downstream_max_connections <config_overload_manager_limiting_connections>`.
IgnoreGlobalConnLimit bool `protobuf:"varint,31,opt,name=ignore_global_conn_limit,json=ignoreGlobalConnLimit,proto3" json:"ignore_global_conn_limit,omitempty"`
}
func (x *Listener) Reset() {
*x = Listener{}
if protoimpl.UnsafeEnabled {
mi := &file_envoy_config_listener_v3_listener_proto_msgTypes[2]
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
ms.StoreMessageInfo(mi)
}
}
func (x *Listener) String() string {
return protoimpl.X.MessageStringOf(x)
}
func (*Listener) ProtoMessage() {}
func (x *Listener) ProtoReflect() protoreflect.Message {
mi := &file_envoy_config_listener_v3_listener_proto_msgTypes[2]
if protoimpl.UnsafeEnabled && x != nil {
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
if ms.LoadMessageInfo() == nil {
ms.StoreMessageInfo(mi)
}
return ms
}
return mi.MessageOf(x)
}
// Deprecated: Use Listener.ProtoReflect.Descriptor instead.
func (*Listener) Descriptor() ([]byte, []int) {
return file_envoy_config_listener_v3_listener_proto_rawDescGZIP(), []int{2}
}
func (x *Listener) GetName() string {
if x != nil {
return x.Name
}
return ""
}
func (x *Listener) GetAddress() *v3.Address {
if x != nil {
return x.Address
}
return nil
}
func (x *Listener) GetAdditionalAddresses() []*AdditionalAddress {
if x != nil {
return x.AdditionalAddresses
}
return nil
}
func (x *Listener) GetStatPrefix() string {
if x != nil {
return x.StatPrefix
}
return ""
}
func (x *Listener) GetFilterChains() []*FilterChain {
if x != nil {
return x.FilterChains
}
return nil
}
func (x *Listener) GetFilterChainMatcher() *v32.Matcher {
if x != nil {
return x.FilterChainMatcher
}
return nil
}
func (x *Listener) GetUseOriginalDst() *wrapperspb.BoolValue {
if x != nil {
return x.UseOriginalDst
}
return nil
}
func (x *Listener) GetDefaultFilterChain() *FilterChain {
if x != nil {
return x.DefaultFilterChain
}
return nil
}
func (x *Listener) GetPerConnectionBufferLimitBytes() *wrapperspb.UInt32Value {
if x != nil {
return x.PerConnectionBufferLimitBytes
}
return nil
}
func (x *Listener) GetMetadata() *v3.Metadata {
if x != nil {
return x.Metadata
}
return nil
}
// Deprecated: Do not use.
func (x *Listener) GetDeprecatedV1() *Listener_DeprecatedV1 {
if x != nil {
return x.DeprecatedV1
}
return nil
}
func (x *Listener) GetDrainType() Listener_DrainType {
if x != nil {
return x.DrainType
}
return Listener_DEFAULT
}
func (x *Listener) GetListenerFilters() []*ListenerFilter {
if x != nil {
return x.ListenerFilters
}
return nil
}
func (x *Listener) GetListenerFiltersTimeout() *durationpb.Duration {
if x != nil {
return x.ListenerFiltersTimeout
}
return nil
}
func (x *Listener) GetContinueOnListenerFiltersTimeout() bool {
if x != nil {
return x.ContinueOnListenerFiltersTimeout
}
return false
}
func (x *Listener) GetTransparent() *wrapperspb.BoolValue {
if x != nil {
return x.Transparent
}
return nil
}
func (x *Listener) GetFreebind() *wrapperspb.BoolValue {
if x != nil {
return x.Freebind
}
return nil
}
func (x *Listener) GetSocketOptions() []*v3.SocketOption {
if x != nil {
return x.SocketOptions
}
return nil
}
func (x *Listener) GetTcpFastOpenQueueLength() *wrapperspb.UInt32Value {
if x != nil {
return x.TcpFastOpenQueueLength
}
return nil
}
func (x *Listener) GetTrafficDirection() v3.TrafficDirection {
if x != nil {
return x.TrafficDirection
}
return v3.TrafficDirection_UNSPECIFIED
}
func (x *Listener) GetUdpListenerConfig() *UdpListenerConfig {
if x != nil {
return x.UdpListenerConfig
}
return nil
}
func (x *Listener) GetApiListener() *ApiListener {
if x != nil {
return x.ApiListener
}
return nil
}
func (x *Listener) GetConnectionBalanceConfig() *Listener_ConnectionBalanceConfig {
if x != nil {
return x.ConnectionBalanceConfig
}
return nil
}
// Deprecated: Do not use.
func (x *Listener) GetReusePort() bool {
if x != nil {
return x.ReusePort
}
return false
}
func (x *Listener) GetEnableReusePort() *wrapperspb.BoolValue {
if x != nil {
return x.EnableReusePort
}
return nil
}
func (x *Listener) GetAccessLog() []*v33.AccessLog {
if x != nil {
return x.AccessLog
}
return nil
}
func (x *Listener) GetTcpBacklogSize() *wrapperspb.UInt32Value {
if x != nil {
return x.TcpBacklogSize
}
return nil
}
func (x *Listener) GetMaxConnectionsToAcceptPerSocketEvent() *wrapperspb.UInt32Value {
if x != nil {
return x.MaxConnectionsToAcceptPerSocketEvent
}
return nil
}
func (x *Listener) GetBindToPort() *wrapperspb.BoolValue {
if x != nil {
return x.BindToPort
}
return nil
}
func (m *Listener) GetListenerSpecifier() isListener_ListenerSpecifier {
if m != nil {
return m.ListenerSpecifier
}
return nil
}
func (x *Listener) GetInternalListener() *Listener_InternalListenerConfig {
if x, ok := x.GetListenerSpecifier().(*Listener_InternalListener); ok {
return x.InternalListener
}
return nil
}
func (x *Listener) GetEnableMptcp() bool {
if x != nil {
return x.EnableMptcp
}
return false
}
func (x *Listener) GetIgnoreGlobalConnLimit() bool {
if x != nil {
return x.IgnoreGlobalConnLimit
}
return false
}
type isListener_ListenerSpecifier interface {
isListener_ListenerSpecifier()
}
type Listener_InternalListener struct {
// Used to represent an internal listener which does not listen on OSI L4 address but can be used by the
// :ref:`envoy cluster <envoy_v3_api_msg_config.cluster.v3.Cluster>` to create a user space connection to.
// The internal listener acts as a TCP listener. It supports listener filters and network filter chains.
// Upstream clusters refer to the internal listeners by their :ref:`name
// <envoy_v3_api_field_config.listener.v3.Listener.name>`. :ref:`Address
// <envoy_v3_api_field_config.listener.v3.Listener.address>` must not be set on the internal listeners.
//
// There are some limitations that are derived from the implementation. The known limitations include:
//
// - :ref:`ConnectionBalanceConfig <envoy_v3_api_msg_config.listener.v3.Listener.ConnectionBalanceConfig>` is not
// allowed because both the cluster connection and the listener connection must be owned by the same dispatcher.
// - :ref:`tcp_backlog_size <envoy_v3_api_field_config.listener.v3.Listener.tcp_backlog_size>`
// - :ref:`freebind <envoy_v3_api_field_config.listener.v3.Listener.freebind>`
// - :ref:`transparent <envoy_v3_api_field_config.listener.v3.Listener.transparent>`
InternalListener *Listener_InternalListenerConfig `protobuf:"bytes,27,opt,name=internal_listener,json=internalListener,proto3,oneof"`
}
func (*Listener_InternalListener) isListener_ListenerSpecifier() {}
// A placeholder proto so that users can explicitly configure the standard
// Listener Manager via the bootstrap's :ref:`listener_manager <envoy_v3_api_field_config.bootstrap.v3.Bootstrap.listener_manager>`.
// [#not-implemented-hide:]
type ListenerManager struct {
state protoimpl.MessageState
sizeCache protoimpl.SizeCache
unknownFields protoimpl.UnknownFields
}
func (x *ListenerManager) Reset() {
*x = ListenerManager{}
if protoimpl.UnsafeEnabled {
mi := &file_envoy_config_listener_v3_listener_proto_msgTypes[3]
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
ms.StoreMessageInfo(mi)
}
}
func (x *ListenerManager) String() string {
return protoimpl.X.MessageStringOf(x)
}
func (*ListenerManager) ProtoMessage() {}
func (x *ListenerManager) ProtoReflect() protoreflect.Message {
mi := &file_envoy_config_listener_v3_listener_proto_msgTypes[3]
if protoimpl.UnsafeEnabled && x != nil {
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
if ms.LoadMessageInfo() == nil {
ms.StoreMessageInfo(mi)
}
return ms
}
return mi.MessageOf(x)
}
// Deprecated: Use ListenerManager.ProtoReflect.Descriptor instead.
func (*ListenerManager) Descriptor() ([]byte, []int) {
return file_envoy_config_listener_v3_listener_proto_rawDescGZIP(), []int{3}
}
// A placeholder proto so that users can explicitly configure the standard
// Validation Listener Manager via the bootstrap's :ref:`listener_manager <envoy_v3_api_field_config.bootstrap.v3.Bootstrap.listener_manager>`.
// [#not-implemented-hide:]
type ValidationListenerManager struct {
state protoimpl.MessageState
sizeCache protoimpl.SizeCache
unknownFields protoimpl.UnknownFields
}
func (x *ValidationListenerManager) Reset() {
*x = ValidationListenerManager{}
if protoimpl.UnsafeEnabled {
mi := &file_envoy_config_listener_v3_listener_proto_msgTypes[4]
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
ms.StoreMessageInfo(mi)
}
}
func (x *ValidationListenerManager) String() string {
return protoimpl.X.MessageStringOf(x)
}
func (*ValidationListenerManager) ProtoMessage() {}
func (x *ValidationListenerManager) ProtoReflect() protoreflect.Message {
mi := &file_envoy_config_listener_v3_listener_proto_msgTypes[4]
if protoimpl.UnsafeEnabled && x != nil {
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
if ms.LoadMessageInfo() == nil {
ms.StoreMessageInfo(mi)
}
return ms
}
return mi.MessageOf(x)
}
// Deprecated: Use ValidationListenerManager.ProtoReflect.Descriptor instead.
func (*ValidationListenerManager) Descriptor() ([]byte, []int) {
return file_envoy_config_listener_v3_listener_proto_rawDescGZIP(), []int{4}
}
// A placeholder proto so that users can explicitly configure the API
// Listener Manager via the bootstrap's :ref:`listener_manager <envoy_v3_api_field_config.bootstrap.v3.Bootstrap.listener_manager>`.
// [#not-implemented-hide:]
type ApiListenerManager struct {
state protoimpl.MessageState
sizeCache protoimpl.SizeCache
unknownFields protoimpl.UnknownFields
}
func (x *ApiListenerManager) Reset() {
*x = ApiListenerManager{}
if protoimpl.UnsafeEnabled {
mi := &file_envoy_config_listener_v3_listener_proto_msgTypes[5]
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
ms.StoreMessageInfo(mi)
}
}
func (x *ApiListenerManager) String() string {
return protoimpl.X.MessageStringOf(x)
}
func (*ApiListenerManager) ProtoMessage() {}
func (x *ApiListenerManager) ProtoReflect() protoreflect.Message {
mi := &file_envoy_config_listener_v3_listener_proto_msgTypes[5]
if protoimpl.UnsafeEnabled && x != nil {
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
if ms.LoadMessageInfo() == nil {
ms.StoreMessageInfo(mi)
}
return ms
}
return mi.MessageOf(x)
}
// Deprecated: Use ApiListenerManager.ProtoReflect.Descriptor instead.
func (*ApiListenerManager) Descriptor() ([]byte, []int) {
return file_envoy_config_listener_v3_listener_proto_rawDescGZIP(), []int{5}
}
// [#not-implemented-hide:]
type Listener_DeprecatedV1 struct {
state protoimpl.MessageState
sizeCache protoimpl.SizeCache
unknownFields protoimpl.UnknownFields
// Whether the listener should bind to the port. A listener that doesn't
// bind can only receive connections redirected from other listeners that
// set use_original_dst parameter to true. Default is true.
//
// This is deprecated. Use :ref:`Listener.bind_to_port
// <envoy_v3_api_field_config.listener.v3.Listener.bind_to_port>`
BindToPort *wrapperspb.BoolValue `protobuf:"bytes,1,opt,name=bind_to_port,json=bindToPort,proto3" json:"bind_to_port,omitempty"`
}
func (x *Listener_DeprecatedV1) Reset() {
*x = Listener_DeprecatedV1{}
if protoimpl.UnsafeEnabled {
mi := &file_envoy_config_listener_v3_listener_proto_msgTypes[6]
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
ms.StoreMessageInfo(mi)
}
}
func (x *Listener_DeprecatedV1) String() string {
return protoimpl.X.MessageStringOf(x)
}
func (*Listener_DeprecatedV1) ProtoMessage() {}
func (x *Listener_DeprecatedV1) ProtoReflect() protoreflect.Message {
mi := &file_envoy_config_listener_v3_listener_proto_msgTypes[6]
if protoimpl.UnsafeEnabled && x != nil {
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
if ms.LoadMessageInfo() == nil {
ms.StoreMessageInfo(mi)
}
return ms
}
return mi.MessageOf(x)
}
// Deprecated: Use Listener_DeprecatedV1.ProtoReflect.Descriptor instead.
func (*Listener_DeprecatedV1) Descriptor() ([]byte, []int) {
return file_envoy_config_listener_v3_listener_proto_rawDescGZIP(), []int{2, 0}
}
func (x *Listener_DeprecatedV1) GetBindToPort() *wrapperspb.BoolValue {
if x != nil {
return x.BindToPort
}
return nil
}
// Configuration for listener connection balancing.
type Listener_ConnectionBalanceConfig struct {
state protoimpl.MessageState
sizeCache protoimpl.SizeCache
unknownFields protoimpl.UnknownFields
// Types that are assignable to BalanceType:
//
// *Listener_ConnectionBalanceConfig_ExactBalance_
// *Listener_ConnectionBalanceConfig_ExtendBalance
BalanceType isListener_ConnectionBalanceConfig_BalanceType `protobuf_oneof:"balance_type"`
}
func (x *Listener_ConnectionBalanceConfig) Reset() {
*x = Listener_ConnectionBalanceConfig{}
if protoimpl.UnsafeEnabled {
mi := &file_envoy_config_listener_v3_listener_proto_msgTypes[7]
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
ms.StoreMessageInfo(mi)
}
}
func (x *Listener_ConnectionBalanceConfig) String() string {
return protoimpl.X.MessageStringOf(x)
}
func (*Listener_ConnectionBalanceConfig) ProtoMessage() {}
func (x *Listener_ConnectionBalanceConfig) ProtoReflect() protoreflect.Message {
mi := &file_envoy_config_listener_v3_listener_proto_msgTypes[7]
if protoimpl.UnsafeEnabled && x != nil {
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
if ms.LoadMessageInfo() == nil {
ms.StoreMessageInfo(mi)
}
return ms
}
return mi.MessageOf(x)
}
// Deprecated: Use Listener_ConnectionBalanceConfig.ProtoReflect.Descriptor instead.
func (*Listener_ConnectionBalanceConfig) Descriptor() ([]byte, []int) {
return file_envoy_config_listener_v3_listener_proto_rawDescGZIP(), []int{2, 1}
}
func (m *Listener_ConnectionBalanceConfig) GetBalanceType() isListener_ConnectionBalanceConfig_BalanceType {
if m != nil {
return m.BalanceType
}
return nil
}
func (x *Listener_ConnectionBalanceConfig) GetExactBalance() *Listener_ConnectionBalanceConfig_ExactBalance {
if x, ok := x.GetBalanceType().(*Listener_ConnectionBalanceConfig_ExactBalance_); ok {
return x.ExactBalance
}
return nil
}
func (x *Listener_ConnectionBalanceConfig) GetExtendBalance() *v3.TypedExtensionConfig {
if x, ok := x.GetBalanceType().(*Listener_ConnectionBalanceConfig_ExtendBalance); ok {
return x.ExtendBalance
}
return nil
}
type isListener_ConnectionBalanceConfig_BalanceType interface {
isListener_ConnectionBalanceConfig_BalanceType()
}
type Listener_ConnectionBalanceConfig_ExactBalance_ struct {
// If specified, the listener will use the exact connection balancer.
ExactBalance *Listener_ConnectionBalanceConfig_ExactBalance `protobuf:"bytes,1,opt,name=exact_balance,json=exactBalance,proto3,oneof"`
}
type Listener_ConnectionBalanceConfig_ExtendBalance struct {
// The listener will use the connection balancer according to “type_url“. If “type_url“ is invalid,
// Envoy will not attempt to balance active connections between worker threads.
// [#extension-category: envoy.network.connection_balance]
ExtendBalance *v3.TypedExtensionConfig `protobuf:"bytes,2,opt,name=extend_balance,json=extendBalance,proto3,oneof"`
}
func (*Listener_ConnectionBalanceConfig_ExactBalance_) isListener_ConnectionBalanceConfig_BalanceType() {
}
func (*Listener_ConnectionBalanceConfig_ExtendBalance) isListener_ConnectionBalanceConfig_BalanceType() {
}
// Configuration for envoy internal listener. All the future internal listener features should be added here.
type Listener_InternalListenerConfig struct {
state protoimpl.MessageState
sizeCache protoimpl.SizeCache
unknownFields protoimpl.UnknownFields
}
func (x *Listener_InternalListenerConfig) Reset() {
*x = Listener_InternalListenerConfig{}
if protoimpl.UnsafeEnabled {
mi := &file_envoy_config_listener_v3_listener_proto_msgTypes[8]