-
Notifications
You must be signed in to change notification settings - Fork 680
/
releaseNotes.yml
1659 lines (1499 loc) · 87.2 KB
/
releaseNotes.yml
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
# -*- fill-column: 100 -*-
# This file should be placed in the folder for the version of the
# product that's meant to be documented. A `/release-notes` page will
# be automatically generated and populated at build time.
#
# Note that an entry needs to be added to the `doc-links.yml` file in
# order to surface the release notes in the table of contents.
#
# The YAML in this file should contain:
#
# changelog: An (optional) URL to the CHANGELOG for the product.
# items: An array of releases with the following attributes:
# - version: The (optional) version number of the release, if applicable.
# - date: The date of the release in the format YYYY-MM-DD.
# - notes: An array of noteworthy changes included in the release, each having the following attributes:
# - type: The type of change, one of `bugfix`, `feature`, `security` or `change`.
# - title: A short title of the noteworthy change.
# - body: >-
# Two or three sentences describing the change and why it
# is noteworthy. This is HTML, not plain text or
# markdown. It is handy to use YAML's ">-" feature to
# allow line-wrapping.
# - image: >-
# The URL of an image that visually represents the
# noteworthy change. This path is relative to the
# `release-notes` directory; if this file is
# `FOO/releaseNotes.yml`, then the image paths are
# relative to `FOO/release-notes/`.
# - docs: The path to the documentation page where additional information can be found.
# - href: A path from the root to a resource on the getambassador website, takes precedence over a docs link.
changelog: https://github.com/emissary-ingress/emissary/blob/$branch$/CHANGELOG.md
items:
- version: 3.8.1
prevVersion: 3.8.0
date: '2023-09-18'
notes:
- title: Upgrade to Golang 1.20.7
type: security
body: >-
Upgrading to the latest release of Golang as part of our general dependency upgrade process. This includes
security fixes for CVE-2023-39318, CVE-2023-39319.
- version: 3.8.0
prevVersion: 3.7.2
date: '2023-08-29'
notes:
- title: Account for matchLabels when associating mappings with the same prefix to different Hosts
type: bugfix
body: >-
As of v2.2.2, if two mappings were associated with different Hosts through host
mappingSelector labels but share the same prefix, the labels were not taken into
account which would cause one Mapping to be correctly routed but the other not.
This change fixes this issue so that Mappings sharing the same prefix but associated
with different Hosts will be correctly routed.
github:
- title: "Canary grouping must take labels into account"
link: https://github.com/emissary-ingress/emissary/issues/4170
- title: Duplication of values when using multiple Headers/QueryParameters in Mappings
type: bugfix
body: >-
In previous versions, if multiple Headers/QueryParameters where used in a v3alpha1 mapping,
these values would duplicate and cause all the Headers/QueryParameters to have the same value.
This is no longer the case and the expected values for unique Headers/QueryParameters will apply.
This issue was only present in v3alpha1 Mappings. For users who may have this issue, please
be sure to re-apply any v3alpha1 Mappings in order to update the stored v2 Mapping and resolve the
issue.
- title: Ambassador Agent no longer collects Envoy metrics
type: change
body: >-
When the Ambassador agent is being used, it will no longer attempt to collect and report Envoy metrics.
In previous versions, $productName$ would always create an Envoy stats sink for the agent as long as the AMBASSADOR_GRPC_METRICS_SINK
environmet variable was provided. This environment variable was hardcoded on the release manifests and has now been removed
and an Envoy stats sink for the agent is no longer created.
- version: 3.7.2
prevVersion: 3.7.1
date: '2023-07-25'
notes:
- title: Upgrade to Envoy 1.26.4
type: security
body: >-
This upgrades $productName$ to be built on Envoy v1.26.4 which includes a security fixes for
CVE-2023-35942, CVE-2023-35943, VE-2023-35944.
- version: 3.7.1
prevVersion: 3.7.0
date: '2023-07-13'
notes:
- title: Upgrade to Envoy 1.26.3
type: security
body: >-
This upgrades $productName$ to be built on Envoy v1.26.3 which includes a security fix for CVE-2023-35945.
- version: 3.7.0
prevVersion: 3.6.0
date: '2023-06-20'
notes:
- title: Upgrade to Golang 1.20.4
type: security
body: >-
Upgrading to the latest release of Golang as part of our general dependency upgrade process. This includes
security fixes for CVE-2023-24539, CVE-2023-24540, CVE-2023-29400.
- title: Upgrade to Envoy 1.26.1
type: feature
body: >-
This upgrades $productName$ to be built on Envoy v1.26.1. This provides $productName$ with the latest
security patches, performances enhancments, and features offered by the envoy proxy.
- version: 3.6.0
prevVersion: 3.5.0
date: '2023-04-17'
notes:
- title: Upgrade to Envoy 1.25.4
type: feature
body: >-
This upgrades $productName$ to be built on Envoy v1.25.4. This provides $productName$ with the latest
security patches, performances enhancments, and features offered by the envoy proxy.
- version: 3.5.0
prevVersion: 3.4.0
date: '2023-02-15'
notes:
- title: Update to golang 1.20.1
type: security
body: >-
Upgrading to the latest release of Golang as part of our general dependency upgrade process. This includes
security fixes for CVE-2022-41725, CVE-2022-41723.
- title: TracingService support for native OpenTelemetry driver
type: feature
body: >-
In Envoy 1.24, experimental support for a native OpenTelemetry tracing driver
was introduced that allows exporting spans in the otlp format. Many
Observability platforms accept that format and is the recommend
replacement for the LightStep driver. $productName$ now supports setting the
<code>TracingService.spec.driver=opentelemetry</code> to export spans in
otlp format.<br/><br/>
Thanks to <a href="https://github.com/psalaberria002">Paul</a> for helping us
get this tested and implemented!
- title: Fix envoy config generation when including port in Host.hostname
type: bugfix
body: >-
When wanting to expose traffic to clients on ports other than 80/443, users will set
a port in the Host.hostname (eg.<code>Host.hostname=example.com:8500</code>. The config
generated allowed matching on the :authority header. This worked in v1.Y series due to the
way emissary was generating Envoy configuration under a single wild-card virtual_host and matching
on :authority.
In v2.Y/v3.Y+, the way emissary generates Envoy configuration changed to address memory pressure and improve
route lookup speed in Envoy. However, when including a port in the hostname, an incorrect configuration was
generated with an sni match including the port. This has been fixed and the correct envoy configuration is
being generated.
github:
- title: "fix: hostname port issue"
link: https://github.com/emissary-ingress/emissary/pull/4816
- title: Add support for resolving port names in Ingress resource
type: change
body: >-
Previously, specifying backend ports by name in Ingress was not supported and would result in defaulting
to port 80. This allows emissary-ingress to now resolve port names for backend services. If the port number
cannot be resolved by the name (e.g named port in the Service doesn't exist) then it defaults back
to the original behavior.
(Thanks to <a href="https://github.com/antonu17">Anton Ustyuzhanin</a>!).
github:
- title: "#4809"
link: https://github.com/emissary-ingress/emissary/pull/4809
- title: Add starupProbe to emissary-apiext server
type: change
body: >-
The <code>emissary-apiext</code> server is a Kubernetes Conversion Webhook that converts between the
Emissary-ingress CRD versions. On startup, it ensures that a self-signed cert is available
so that K8s API Server can talk to the conversion webhook (*TLS is required by K8s*). We
have introduced a startupProbe to ensure that emissary-apiext server has enough time to
configure the webhooks before running liveness and readiness probes. This is to ensure
slow startup doesn't cause K8s to needlessly restart the pod.
- version: 3.4.0
prevVersion: 3.3.0
date: '2023-01-03'
notes:
- title: Re-add support for getambassador.io/v1
type: feature
body: >-
Support for the <code>getambassador.io/v1</code> apiVersion has been re-introduced, in
order to facilitate smoother migrations from $productName$ 1.y. Previously, in order to
make migrations possible, an "unserved" <code>v1</code> version was declared to
Kubernetes, but was unsupported by $productName$. That unserved <code>v1</code> could
cause an excess of errors to be logged by the Kubernetes Nodes (regardless of whether the
installation was migrated from 1.y or was a fresh 2.y install); fully supporting
<code>v1</code> again should resolve these errors.
- title: Add support for active health checking configuration.
type: feature
body: >-
It is now possible to configure active healhchecking for upstreams within a <code>Mapping</code>.
If the upstream fails its configured health check then Envoy will mark the upstream as unhealthy and no longer send
traffic to that upstream. Single pods within a group may can be marked as unhealthy. The healthy pods will continue to receive
traffic normally while the unhealthy pods will not receive any traffic until they recover by passing the health check.
- title: Add environment variables to the healthcheck server.
type: feature
body: >-
The healthcheck server's bind address, bind port and IP family can now be configured using environment variables:
- `AMBASSADOR_HEALTHCHECK_BIND_ADDRESS`: The address to bind the healthcheck server to.
- `AMBASSADOR_HEALTHCHECK_BIND_PORT`: The port to bind the healthcheck server to.
- `AMBASSADOR_HEALTHCHECK_IP_FAMILY`: The IP family to use for the healthcheck server.
This allows the healthcheck server to be configured to use IPv6-only k8s environments.
(Thanks to <a href="https://github.com/TimonOmsk">Dmitry Golushko</a>!).
- title: Upgrade to Envoy 1.24.1
type: feature
body: >-
This upgrades $productName$ to be built on Envoy v1.24.1. One notable change is that
the team at LightStep and Envoy Maintainers have decided to no longer support the
native *LightStep* tracing driver in favor of using the Open Telemetry driver. The code
for LightStep driver has been completely removed from Envoy code base so $productName$
will no longer support it either.
The recommended upgrade path is to leverage a supported Tracing driver such as `Zipkin`
and use the [Open Telemetry Collector](https://opentelemetry.io/docs/collector/) to
collect and forward Observabity data to LightStep.
- title: Add option to enable envoy readiness endpoint from worker
type: feature
body: >-
/ready endpoint used by emissary is using the admin port (8001 by default).
This generates a problem during config reloads with large configs as the
admin thread is blocking so the /ready endpoint can be very slow to
answer (in the order of several seconds, even more).
The new feature allows to enable a specific envoy listener that can answer /ready calls
from the workers so the endpoint is always fast and it does not suffers from single threaded
admin thread slowness on config reloads and other slow endpoints handled by the admin thread
Configure the listener port using AMBASSADOR_READY_PORT and enable access log using
AMBASSADOR_READY_LOG environment variables.
docs: https://www.getambassador.io/docs/emissary/latest/topics/running/environment/
- version: 3.3.0
prevVersion: 3.2.0
date: '2022-11-02'
notes:
- title: Update Golang to 1.19.2
type: security
body: >-
Updated Golang to 1.19.2 to address the CVEs: CVE-2022-2879, CVE-2022-2880, CVE-2022-41715.
- title: Fix regression in http to https redirects with AuthService
type: bugfix
body: >-
By default $productName$ adds routes for http to https redirection. When
an AuthService is applied in v2.Y of $productName$, Envoy would skip the
ext_authz call for non-tls http request and would perform the https
redirect. In Envoy 1.20+ the behavior has changed where Envoy will
always call the ext_authz filter and must be disabled on a per route
basis.
This new behavior change introduced a regression in v3.0 of
$productName$ when it was upgraded to Envoy 1.22. The http to https
redirection no longer works when an AuthService was applied. This fix
restores the previous behavior by disabling the ext_authz call on the
https redirect routes.
github:
- title: "#4620"
link: https://github.com/emissary-ingress/emissary/issues/4620
- title: Fix regression in host_redirects with AuthService
type: bugfix
body: >-
When an AuthService is applied in v2.Y of $productName$,
Envoy would skip the ext_authz call for all redirect routes and
would perform the redirect. In Envoy 1.20+ the behavior has changed
where Envoy will always call the ext_authz filter so it must be
disabled on a per route basis.
This new behavior change introduced a regression in v3.0 of
$productName$ when it was upgraded to Envoy 1.22. The host_redirect
would call an AuthService prior to redirect if applied. This fix
restores the previous behavior by disabling the ext_authz call on the
host_redirect routes.
github:
- title: "#4640"
link: https://github.com/emissary-ingress/emissary/issues/4640
- title: Fixed finding ingress resource tls secrets
type: bugfix
body: >-
Previous versions of $productName$ required a workaround using <code>TLSContexts</code> to find tls secrets referenced from
<code>Ingress</code> resources. Now tls secrets referenced are properly detected without requiring an additional <code>TLSContext</code> to
reference them.
(Thanks to <a href="https://github.com/olemarkus">Ole Markus</a>!).
- version: 3.2.0
prevVersion: 3.1.0
date: '2022-09-26'
notes:
- title: Envoy upgraded to 1.23
type: change
body: >-
The envoy version included in $productName$ has been upgraded from 1.22 to the latest patch
release of 1.23. This provides $productName$ with the latest security patches, performances enhancments,
and features offered by the envoy proxy.
docs: https://www.envoyproxy.io/docs/envoy/latest/version_history/v1.23/v1.23.0
- title: Fixed <code>mappingSelector</code> associating <code>Hosts</code> with <code>Mappings</code>
type: change
body: >-
Changes to label matching will change how <code>Hosts</code> are associated with <code>Mappings</code>. There was a bug with label
selectors that was causing <code>Hosts</code> to be incorrectly being associated with more <code>Mappings</code> than intended.
If any single label from the selector was matched then the <code>Host</code> would be associated with the <code>Mapping</code>.
Now it has been updated to correctly only associate a <code>Host</code> with a <code>Mapping</code> if <b>all</b> labels required by
the selector are present. This brings the <code>mappingSelector</code> field in-line with how label selectors are used
in Kubernetes. To avoid unexpected behaviour after the upgrade, add all labels that Hosts have in their
<code>mappingSelector</code> to <code>Mappings</code> you want to associate with the <code>Host</code>. You can opt-out of the new behaviour
by setting the environment variable <code>DISABLE_STRICT_LABEL_SELECTORS</code> to <code>"true"</code> (default: <code>"false"</code>).
(Thanks to <a href="https://github.com/f-herceg">Filip Herceg</a> and <a href="https://github.com/dynajoe">Joe Andaverde</a>!).
- title: Add support for Host resources using secrets from different namespaces
type: feature
body: >-
Previously the <code>Host</code> resource could only use secrets that are in the namespace as the
Host. The <code>tlsSecret</code> field in the Host has a new subfield <code>namespace</code> that will allow
the use of secrets from different namespaces.
- title: Allow bypassing of EDS for manual endpoint insertion
type: change
body: >-
Set `AMBASSADOR_EDS_BYPASS` to `true` to bypass EDS handling of endpoints and have endpoints be
inserted to clusters manually. This can help resolve with `503 UH` caused by certification rotation relating to
a delay between EDS + CDS. The default is `false`.
- title: Correctly manage cluster names when service names are very long
type: bugfix
body: >-
Distinct services with names that are the same in the first forty characters
will no longer be incorrectly mapped to the same cluster.
github:
- title: "#4354"
link: https://github.com/emissary-ingress/emissary/issues/4354
- title: Add failure_mode_deny option to the RateLimitService
type: feature
body: >-
By default, when Envoy is unable to communicate with the configured
RateLimitService then it will allow traffic through. The
<code>RateLimitService</code> resource now exposes the
<a href="https://www.envoyproxy.io/docs/envoy/v1.23.0/configuration/http/http_filters/rate_limit_filter">failure_mode_deny</a>
option. Set <code>failure_mode_deny: true</code>, then Envoy will
deny traffic when it is unable to communicate to the RateLimitService
returning a 500.
docs: https://www.getambassador.io/docs/emissary/latest/topics/running/services/rate-limit-service/
- title: Properly populate alt_state_name for Tracing, Auth and RateLimit Services
type: bugfix
body: >-
Previously, setting the <code>stats_name</code> for the <code>TracingService</code>, <code>RateLimitService</code>
or the <code>AuthService</code> would have no affect because it was not being properly passed to the Envoy cluster
config. This has been fixed and the <code>alt_stats_name</code> field in the cluster config is now set correctly.
(Thanks to <a href="https://github.com/psalaberria002">Paul</a>!)
- title: Add support for config change batch window before reconfiguring Envoy
type: feature
body: >-
The <code>AMBASSADOR_RECONFIG_MAX_DELAY</code> env var can be optionally set to batch changes for the specified
non-negative window period in seconds before doing an Envoy reconfiguration. Default is "1" if not set.
- title: Diagnostics stats properly handles parsing envoy metrics with colons
type: bugfix
body: >-
If a <code>Host</code> or <code>TLSContext</code> contained a hostname with a <code>:</code> when using the
diagnostics endpoints <code>ambassador/v0/diagd</code> then an error would be thrown due to the parsing logic not
being able to handle the extra colon. This has been fixed and $productName$ will not throw an error when parsing
envoy metrics for the diagnostics user interface.
- title: Allow setting custom_tags for traces
type: feature
body: >-
It is now possible to set <code>custom_tags</code> in the
<code>TracingService</code>. Trace tags can be set based on
literal values, environment variables, or request headers.
(Thanks to <a href="https://github.com/psalaberria002">Paul</a>!)
github:
- title: "#4181"
link: https://github.com/emissary-ingress/emissary/pull/4181
- title: TCPMappings use correct SNI configuration
type: bugfix
body: >-
$productName$ 2.0.0 introduced a bug where a <code>TCPMapping</code> that uses SNI,
instead of using the hostname glob in the <code>TCPMapping</code>, uses the hostname glob
in the <code>Host</code> that the TLS termination configuration comes from.
- title: TCPMappings configure TLS termination without a Host resource
type: bugfix
body: >-
$productName$ 2.0.0 introduced a bug where a <code>TCPMapping</code> that terminates TLS
must have a corresponding <code>Host</code> that it can take the TLS configuration from.
This was semi-intentional, but didn't make much sense. You can now use a
<code>TLSContext</code> without a <code>Host</code>as in $productName$ 1.y releases, or a
<code>Host</code> with or without a <code>TLSContext</code> as in prior 2.y releases.
- title: TCPMappings and HTTP Hosts can coexist on Listeners that terminate TLS
type: bugfix
body: >-
Prior releases of $productName$ had the arbitrary limitation that a
<code>TCPMapping</code> cannot be used on the same port that HTTP is served on, even if
TLS+SNI would make this possible. $productName$ now allows <code>TCPMappings</code> to be
used on the same <code>Listener</code> port as HTTP <code>Hosts</code>, as long as that
<code>Listener</code> terminates TLS.
- title: Update Golang to 1.19.1
type: security
body: >-
Updated Golang to 1.19.1 to address the CVEs: CVE-2022-27664, CVE-2022-32190.
- version: 3.1.0
date: '2022-08-01'
notes:
- title: Add support for OpenAPI 2 contracts
type: feature
body: >-
The agent is now able to parse api contracts using swagger 2, and to convert them to OpenAPI 3, making them
available for use in the dev portal.
- title: Add new secrets sync directive to the Agent
type: feature
body: >-
Adds a new command to the agent directive service to manage secrets. This allows
a third party product to manage CRDs that depend upon a secret.
- title: Add additional pprof endpoints
type: feature
body: >-
Add additional pprof endpoints to allow for profiling $productName$:
- CPU profiles (/debug/pprof/profile)
- tracing (/debug/pprof/trace)
- command line running (/debug/pprof/cmdline)
- program counters (/debug/pprof/symbol)
- title: Default YAML enables the diagnostics interface from non-local clients on the admin service port
type: change
body: >-
In the standard published <code>.yaml</code> files, the <code>Module</code> resource enables serving
remote client requests to the <code>:8877/ambassador/v0/diag/</code> endpoint.
The associated Helm chart release also now enables it by default.
- title: fix regression in the agent for the metrics transfer.
type: bugfix
body: >-
A regression was introduced in 2.3.0 causing the agent to miss some of the metrics coming from
emissary ingress before sending them to Ambassador cloud. This issue has been resolved to ensure
that all the nodes composing the emissary ingress cluster are reporting properly.
- title: Update Golang to 1.17.12
type: security
body: >-
Updated Golang to 1.17.12 to address the CVEs: CVE-2022-23806, CVE-2022-28327, CVE-2022-24675,
CVE-2022-24921, CVE-2022-23772.
- title: Update Curl to 7.80.0-r2
type: security
body: >-
Updated Curl to 7.80.0-r2 to address the CVEs: CVE-2022-32207, CVE-2022-27782, CVE-2022-27781,
CVE-2022-27780.
- title: Update openSSL-dev to 1.1.1q-r0
type: security
body: >-
Updated openSSL-dev to 1.1.1q-r0 to address CVE-2022-2097.
- title: Update ncurses to 1.1.1q-r0
type: security
body: >-
Updated ncurses to 1.1.1q-r0 to address CVE-2022-29458
- version: 3.0.0
prevVersion: 2.3.1
date: '2022-06-27'
notes:
- title: Envoy upgraded to 1.22
type: change
body: >-
The envoy version included in $productName$ has been upgraded from 1.17 to the latest patch
release of 1.22. This provides $productName$ with the latest security patches, performances enhancments,
and features offered by the envoy proxy. One notable change that will effect users is the removal
of support for V2 tranport protocol. See below for more information.
docs: https://www.envoyproxy.io/docs/envoy/latest/version_history/v1.22/v1.22.0
- title: Envoy xDS v2 API removal, removal of ECMAScript regexes
type: change
body: >-
$productName$ can no longer be made to configure Envoy using the v2 xDS configuration API;
it now always uses the v3 xDS API to configure Envoy. This change should be mostly
invisible to users, with one notable exception: It removes support for <code>regex_type:
unsafe</code>.
The <code>regex_type</code> field will is removed from the <code>ambassador</code>
<code>Module</code>, meaning that it is not be possible to instruct Envoy to use the <a
href="https://en.cppreference.com/w/cpp/regex/ecmascript">ECMAScript Regex</a> engine
rather than the default <a href="https://github.com/google/re2">RE2</a> engine.
Users who rely on the specific ECMAScript Regex syntax will need to rewrite their regular
expressions with RE2 syntax before upgrading to $productName$ 3.0.0.
As the xDS version is no longer configurable and the range of supported Zipkin protocols
is reduced (see below), the AMBASSADOR_ENVOY_API_VERSION environment variable has been removed.
- title: Support for protocol_version v2 is removed
type: change
body: >-
With the ugprade to Envoy 1.22, $productName$ no longer supports the V2 transport protocol.
The <code>AuthService</code>, <code>LogService</code> and the <code>RateLimitService</code>
will only support the v3 protocol_version. If protocol_version is not specified, the default
value of <code>v2</code> will cause an error to be posted. Therefore, you will need to set it
to <code>protocol_version: "v3"</code>. If upgrading from a previous version you will want
to set it to "v3" and ensure it is working before upgrading to $productName$ 3.Y.
- title: Support for Zipkin HTTP_JSON_V1 protocol is removed
type: change
body: >-
With the upgrade to Envoy 1.22, the <code>zipkin</code> driver for the <code>TraceService</code>
no longer supports setting the <code>collector_endpoint_version: HTTP_JSON_V1</code>. This was removed
in Envoy 1.20 - <a href="https://github.com/envoyproxy/envoy/commit/db74e313b3651588e59c671af45077714ac32cef" />.
The new default will be <code>collector_endpoint_version: HTTP_JSON</code>, regardless of the
<code>AMBASSADOR_ENVOY_API_VERSION</code> environment variable.
- title: Default YAML disables the diagnostics interface
type: change
body: >-
In the standard published <code>.yaml</code> files, now included is a <code>Module</code>
resource that disables the <code>/ambassador/v0/</code> → <code>127.0.0.1:8878</code>
synthetic mapping. We have long recommended to turn this off for production use; it is
now off in the standard YAML. The associated Helm chart release also now disables it by
default. A later apiVersion (<code>getambassador.io/v3alpha2</code> or later) will likely
change the <code>Module</code> CRD so that it is disabled if unspecified; but in the
mean-time, the default install procedure will now specify it to be disabled.
- title: No longer publish obsolete YAML manifest files
type: change
body: >-
This release does not include the publishing of
<code>emissary-emissaryns-agent.yaml</code>, <code>emissary-defaultns-agent.yaml</code>,
<code>emissary-emissaryns-migration.yaml</code>, or
<code>emissary-defaultns-migration.yaml</code> files. All four of these files existed
solely as part of the migration process from 1;y, but since 2.2.0 the
<code>*-migration.yaml</code> files have not been part of the migration instructions, and
while the <code>*-agent.yaml</code> files remained part of the instructions they were
actually unnescessary.
- title: Metric naming change for grpc_stats
type: change
body: >-
The previous version of $productName$ was based on Envoy 1.17 and when using grpc_stats
with <code>all_methods</code> or <code>services</code> set, it would output metrics in
the following format <code>envoy_cluster_grpc_{ServiceName}_{statname}</code>. When
neither of these fields are set it would be aggregated to <code>envoy_cluster_grpc_{statname}</code>.
The new behavior since Envoy 1.18 will produce metrics in the following format
<code>envoy_cluster_grpc_{MethodName}_statsname</code> and <code>envoy_cluster_grpc_statsname</code>.
After further investigation we found that Envoy doesn't properly parse service
names such as <code>cncf.telepresence.Manager/Status</code>. In the future, we will work
upstream Envoy to get this parsing logic fixed to ensure consistent metric naming.
- title: Default behavior for empty grpc_stats changed
type: bugfix
body: >-
Previously setting <code>grpc_stats</code> in the <code>ambassador</code> <code>Module</code>
without setting either <code>grpc_stats.services</code> or <code>grpc_stats.all_methods</code>
would result in crashing. Now it behaves as if <code>grpc_stats.all_methods=false</code>.
- title: Downstream HTTP/3 support
type: feature
body: >-
With the ugprade to Envoy 1.22, $productName$ can now be configured to listen for HTTP/3
connections using QUIC and the UDP network protocol. It currently only supports for connections
between downstream clients and $productName$.
- version: 2.5.0
date: 'TBD'
prevVersion: 2.4.0
notes:
- title: Fixed <code>mappingSelector</code> associating <code>Hosts</code> with <code>Mappings</code>
type: change
body: >-
Changes to label matching will change how <code>Hosts</code> are associated with <code>Mappings</code>. There was a bug with label
selectors that was causing <code>Hosts</code> to be incorrectly being associated with more <code>Mappings</code> than intended.
If any single label from the selector was matched then the <code>Host</code> would be associated with the <code>Mapping</code>.
Now it has been updated to correctly only associate a <code>Host</code> with a <code>Mapping</code> if <b>all</b> labels required by
the selector are present. This brings the <code>mappingSelector</code> field in-line with how label selectors are used
in Kubernetes. To avoid unexpected behaviour after the upgrade, add all labels that Hosts have in their
<code>mappingSelector</code> to <code>Mappings</code> you want to associate with the <code>Host</code>. You can opt-out of the new behaviour
by setting the environment variable <code>DISABLE_STRICT_LABEL_SELECTORS</code> to <code>"true"</code> (default: <code>"false"</code>).
(Thanks to <a href="https://github.com/f-herceg">Filip Herceg</a> and <a href="https://github.com/dynajoe">Joe Andaverde</a>!).
- version: 2.4.0
date: '2022-09-19'
prevVersion: 2.3.2
notes:
- title: Add support for Host resources using secrets from different namespaces
type: feature
body: >-
Previously the <code>Host</code> resource could only use secrets that are in the namespace as the
Host. The <code>tlsSecret</code> field in the Host has a new subfield <code>namespace</code> that will allow
the use of secrets from different namespaces.
- title: Allow bypassing of EDS for manual endpoint insertion
type: change
body: >-
Set `AMBASSADOR_EDS_BYPASS` to `true` to bypass EDS handling of endpoints and have endpoints be
inserted to clusters manually. This can help resolve with `503 UH` caused by certification rotation relating to
a delay between EDS + CDS. The default is `false`.
- title: Properly populate alt_state_name for Tracing, Auth and RateLimit Services
type: bugfix
body: >-
Previously, setting the <code>stats_name</code> for the <code>TracingService</code>, <code>RateLimitService</code>
or the <code>AuthService</code> would have no affect because it was not being properly passed to the Envoy cluster
config. This has been fixed and the <code>alt_stats_name</code> field in the cluster config is now set correctly.
(Thanks to <a href="https://github.com/psalaberria002">Paul</a>!)
- title: Add support for config change batch window before reconfiguring Envoy
type: feature
body: >-
The <code>AMBASSADOR_RECONFIG_MAX_DELAY</code> env var can be optionally set to batch changes for the specified
non-negative window period in seconds before doing an Envoy reconfiguration. Default is "1" if not set.
- title: TCPMappings use correct SNI configuration
type: bugfix
body: >-
$productName$ 2.0.0 introduced a bug where a <code>TCPMapping</code> that uses SNI,
instead of using the hostname glob in the <code>TCPMapping</code>, uses the hostname glob
in the <code>Host</code> that the TLS termination configuration comes from.
- title: TCPMappings configure TLS termination without a Host resource
type: bugfix
body: >-
$productName$ 2.0.0 introduced a bug where a <code>TCPMapping</code> that terminates TLS
must have a corresponding <code>Host</code> that it can take the TLS configuration from.
This was semi-intentional, but didn't make much sense. You can now use a
<code>TLSContext</code> without a <code>Host</code>as in $productName$ 1.y releases, or a
<code>Host</code> with or without a <code>TLSContext</code> as in prior 2.y releases.
- title: TCPMappings and HTTP Hosts can coexist on Listeners that terminate TLS
type: bugfix
body: >-
Prior releases of $productName$ had the arbitrary limitation that a
<code>TCPMapping</code> cannot be used on the same port that HTTP is served on, even if
TLS+SNI would make this possible. $productName$ now allows <code>TCPMappings</code> to be
used on the same <code>Listener</code> port as HTTP <code>Hosts</code>, as long as that
<code>Listener</code> terminates TLS.
- version: 1.14.5
date: 'TBD'
notes:
- title: When using gzip, upstreams will no longer receive encoded data
type: bugfix
body: >-
When using gzip compression, upstream services will no longer receive compressed
data. This bug was introduced in 1.14.0. The fix restores the default behavior of
not sending compressed data to upstream services.
github:
- title: 3818
link: https://github.com/emissary-ingress/emissary/issues/3818
docs: https://github.com/emissary-ingress/emissary/issues/3818
- version: 2.3.2
date: '2022-08-01'
prevVersion: 2.3.1
notes:
- title: Fix regression in the agent for the metrics transfer.
type: bugfix
body: >-
A regression was introduced in 2.3.0 causing the agent to miss some of the metrics coming from
emissary ingress before sending them to Ambassador cloud. This issue has been resolved to ensure
that all the nodes composing the emissary ingress cluster are reporting properly.
- title: Update Golang to 1.17.12
type: security
body: >-
Updated Golang to 1.17.12 to address the CVEs: CVE-2022-23806, CVE-2022-28327, CVE-2022-24675,
CVE-2022-24921, CVE-2022-23772.
- title: Update Curl to 7.80.0-r2
type: security
body: >-
Updated Curl to 7.80.0-r2 to address the CVEs: CVE-2022-32207, CVE-2022-27782, CVE-2022-27781,
CVE-2022-27780.
- title: Update openSSL-dev to 1.1.1q-r0
type: security
body: >-
Updated openSSL-dev to 1.1.1q-r0 to address CVE-2022-2097.
- title: Update ncurses to 1.1.1q-r0
type: security
body: >-
Updated ncurses to 1.1.1q-r0 to address CVE-2022-29458
- version: 1.14.4
date: '2022-06-13'
notes:
- title: Envoy security updates
type: security
body: >-
We have backported patches from the Envoy 1.19.5 security update to $productName$'s
1.17-based Envoy, addressing CVE-2022-29224 and CVE-2022-29225. $productName$ is not
affected by CVE-2022-29226, CVE-2022-29227, or CVE-2022-29228; as it <a
href="https://github.com/emissary-ingress/emissary/issues/2846">does not support internal
redirects</a>, and does not use Envoy's built-in OAuth2 filter.
docs: https://groups.google.com/g/envoy-announce/c/8nP3Kn4jV7k
- version: 2.3.1
date: '2022-06-09'
notes:
- title: fix regression in tracing service config
type: bugfix
body: >-
A regression was introduced in 2.3.0 that leaked zipkin default config fields into the configuration
for the other drivers (lightstep, etc...). This caused $productName$ to crash on startup. This issue has been resolved
to ensure that the defaults are only applied when driver is <code>zipkin</code>
github:
- title: "#4267"
link: https://github.com/emissary-ingress/emissary/issues/4267
- title: Envoy security updates
type: security
body: >-
We have backported patches from the Envoy 1.19.5 security update to $productName$'s
1.17-based Envoy, addressing CVE-2022-29224 and CVE-2022-29225. $productName$ is not
affected by CVE-2022-29226, CVE-2022-29227, or CVE-2022-29228; as it <a
href="https://github.com/emissary-ingress/emissary/issues/2846">does not support internal
redirects</a>, and does not use Envoy's built-in OAuth2 filter.
docs: https://groups.google.com/g/envoy-announce/c/8nP3Kn4jV7k
- version: 2.3.0
date: '2022-06-06'
notes:
- title: Remove unused packages
type: security
body: >-
Completely remove gdbm, pip, smtplib, and sqlite packages, as they are unused.
- title: Allow setting propagation modes for Lightstep tracing
type: feature
body: >-
It is now possible to set <code>propagation_modes</code> in the
<code>TracingService</code> config when using lightstep as the driver.
(Thanks to <a href="https://github.com/psalaberria002">Paul</a>!)
github:
- title: "#4179"
link: https://github.com/emissary-ingress/emissary/pull/4179
- title: Added support for TLS certificate revocation list
type: feature
body: >-
It is now possible to set `crl_secret` in `Host` and `TLSContext` resources
to check peer certificates against a certificate revocation list.
github:
- title: "#1743"
link: https://github.com/emissary-ingress/emissary/issues/1743
- title: Added support for the LogService v3 transport protocol
type: feature
body: >-
Previously, a <code>LogService</code> would always have $productName$ communicate with the
external log service using the <code>envoy.service.accesslog.v2.AccessLogService</code>
API. It is now possible for the <code>LogService</code> to specify
<code>protocol_version: v3</code> to use the newer
<code>envoy.service.accesslog.v3.AccessLogService</code> API instead. This functionality
is not available if you set the <code>AMBASSADOR_ENVOY_API_VERSION=V2</code> environment
variable.
- title: CORS now happens before auth
type: bugfix
body: >-
When CORS is specified (either in a <code>Mapping</code> or in the <code>Ambassador</code>
<code>Module</code>), CORS processing will happen before authentication. This corrects a
problem where XHR to authenticated endpoints would fail.
- title: Correctly handle caching of Mappings with the same name in different namespaces
type: bugfix
body: >-
In 2.x releases of $productName$ when there are multiple <code>Mapping</code>s that have the same
<code>metadata.name</code> across multiple namespaces, their old config would not properly be removed
from the cache when their config was updated. This resulted in an inability to update configuration
for groups of <code>Mapping</code>s that share the same name until the $productName$ pods restarted.
- title: Fix support for Zipkin API-v1 with Envoy xDS-v3
type: bugfix
body: >-
It is now possible for a <code>TracingService</code> to specify
<code>collector_endpoint_version: HTTP_JSON_V1</code> when using xDS v3 to configure Envoy
(which has been the default since $productName$ 1.14.0). The <code>HTTP_JSON_V1</code>
value configures Envoy to speak to Zipkin using Zipkin's old API-v1, while the
<code>HTTP_JSON</code> value configures Envoy to speak to Zipkin using Zipkin's new
API-v2. In previous versions of $productName$ it was only possible to use
<code>HTTP_JSON_V1</code> when explicitly setting the
<code>AMBASSADOR_ENVOY_API_VERSION=V2</code> environment variable to force use of xDS v2
to configure Envoy.
- version: 2.2.2
date: '2022-02-25'
prevVersion: 2.2.1
notes:
- title: TLS Secret validation is now opt-in
type: change
body: >-
You may now choose to enable TLS Secret validation by setting the
<code>AMBASSADOR_FORCE_SECRET_VALIDATION=true</code> environment variable. The default configuration does not
enforce secret validation.
- title: Correctly validate EC (Elliptic Curve) Private Keys
type: bugfix
body: >-
Kubernetes Secrets that should contain an EC (Elliptic Curve) TLS Private Key are now properly validated.
github:
- title: 4134
link: https://github.com/emissary-ingress/emissary/issues/4134
docs: https://github.com/emissary-ingress/emissary/issues/4134
- title: Decrease metric sync frequency
type: change
body: >-
The new delay between two metrics syncs is now 30s.
github:
- title: "#4122"
link: https://github.com/emissary-ingress/emissary/pull/4122
- version: 1.14.3
date: '2022-02-25'
notes:
- title: Envoy security updates
type: security
body: >-
Upgraded Envoy to address security vulnerabilities CVE-2021-43824, CVE-2021-43825, CVE-2021-43826,
CVE-2022-21654, and CVE-2022-21655.
docs: https://groups.google.com/g/envoy-announce/c/bIUgEDKHl4g
- version: 2.2.1
date: '2022-02-22'
notes:
- title: Envoy V2 API deprecation
type: change
body: >-
Support for the Envoy V2 API is deprecated as of $productName$ v2.1, and will be removed in $productName$
v3.0. The <code>AMBASSADOR_ENVOY_API_VERSION</code> environment variable will be removed at the same
time. Only the Envoy V3 API will be supported (this has been the default since $productName$ v1.14.0).
- title: Correctly support canceling rollouts
type: bugfix
body: >-
The Ambassador Agent now correctly supports requests to cancel a rollout.
docs: ../../../argo/latest/howtos/manage-rollouts-using-cloud
- version: 2.2.0
date: '2022-02-10'
notes:
- title: Envoy V2 API deprecation
type: change
body: >-
Support for the Envoy V2 API is deprecated as of $productName$ v2.1, and will be removed in $productName$
v3.0. The <code>AMBASSADOR_ENVOY_API_VERSION</code> environment variable will be removed at the same
time. Only the Envoy V3 API will be supported (this has been the default since $productName$ v1.14.0).
- title: Emissary-ingress will watch for Cloud Connect Tokens
type: change
body: >-
$productName$ will now watch for ConfigMap or Secret resources specified by the
<code>AGENT_CONFIG_RESOURCE_NAME</code> environment variable in order to allow all
components (and not only the Ambassador Agent) to authenticate requests to
Ambassador Cloud.
image: ./v2.2.0-cloud.png
- title: Update Alpine and libraries
type: security
body: >-
$productName$ has updated Alpine to 3.15, and Python and Go dependencies
to their latest compatible versions, to incorporate numerous security patches.
- title: Support a log-level metric
type: feature
body: >-
$productName$ now supports the metric <code>ambassador_log_level{label="debug"}</code>
which will be set to 1 if debug logging is enabled for the running Emissary
instance, or to 0 if not. This can help to be sure that a running production
instance was not actually left doing debugging logging, for example.
(Thanks to <a href="https://github.com/jfrabaute">Fabrice</a>!)
github:
- title: "#3906"
link: https://github.com/emissary-ingress/emissary/issues/3906
docs: topics/running/statistics/8877-metrics/
- title: Envoy configuration % escaping
type: feature
body: >-
$productName$ is now leveraging a new Envoy Proxy patch that allows Envoy to accept escaped
'%' characters in its configuration. This means that error_response_overrides and other
custom user content can now contain '%' symbols escaped as '%%'.
docs: topics/running/custom-error-responses
github:
- title: "DW Envoy: 74"
link: https://github.com/datawire/envoy/pull/74
- title: "Upstream Envoy: 19383"
link: https://github.com/envoyproxy/envoy/pull/19383
image: ./v2.2.0-percent-escape.png
- title: Stream metrics from Envoy to Ambassador Cloud
type: feature
body: >-
Support for streaming Envoy metrics about the clusters to Ambassador Cloud.
github:
- title: "#4053"
link: https://github.com/emissary-ingress/emissary/pull/4053
docs: https://github.com/emissary-ingress/emissary/pull/4053
- title: Support received commands to pause, continue and abort a Rollout via Agent directives
type: feature
body: >-
The Ambassador agent now receives commands to manipulate Rollouts (pause, continue, and
abort are currently supported) via directives and executes them in the cluster. A report
is sent to Ambassador Cloud including the command ID, whether it ran successfully, and
an error message in case there was any.
github:
- title: "#4040"
link: https://github.com/emissary-ingress/emissary/pull/4040
docs: https://github.com/emissary-ingress/emissary/pull/4040
- title: Validate certificates in TLS Secrets
type: bugfix
body: >-
Kubernetes Secrets that should contain TLS certificates are now validated before being
accepted for configuration. A Secret that contains an invalid TLS certificate will be logged
as an invalid resource.
github:
- title: "#3821"
link: https://github.com/emissary-ingress/emissary/issues/3821
docs: ../topics/running/tls
image: ./v2.2.0-tls-cert-validation.png
edgeStackNotes:
- title: Devportal support for using API server definitions from OpenAPI docs
type: feature
body: >-
You can now set <code>preserve_servers</code> in Ambassador Edge Stack's
<code>DevPortal</code> resource to configure the DevPortal to use server definitions from
the OpenAPI document when displaying connection information for services in the DevPortal.
- version: 2.1.2
prevVersion: 2.1.0
date: '2022-01-25'
notes:
- title: Envoy V2 API deprecation
type: change
body: >-
Support for the Envoy V2 API is deprecated as of $productName$ v2.1, and will be removed in $productName$
v3.0. The <code>AMBASSADOR_ENVOY_API_VERSION</code> environment variable will be removed at the same
time. Only the Envoy V3 API will be supported (this has been the default since $productName$ v1.14.0).
- title: Docker BuildKit always used for builds
type: change
body: >-
Docker BuildKit is enabled for all Emissary builds. Additionally, the Go
build cache is fully enabled when building images, speeding up repeated builds.
docs: https://github.com/moby/buildkit/blob/master/frontend/dockerfile/docs/syntax.md
- title: Fix support for for v2 Mappings with CORS
type: bugfix
body: >-
Emissary-ingress 2.1.0 generated invalid Envoy configuration for
<code>getambassador.io/v2</code> <code>Mappings</code> that set
<code>spec.cors.origins</code> to a string rather than a list of strings; this has been
fixed, and these <code>Mappings</code> should once again function correctly.
docs: topics/using/cors/#the-cors-attribute
image: ./v2.1.2-mapping-cors.png
- title: Correctly handle canary Mapping weights when reconfiguring
type: bugfix
body: >-
Changes to the <code>weight</code> of <code>Mapping</code> in a canary group
will now always be correctly managed during reconfiguration; such changes could
have been missed in earlier releases.
docs: topics/using/canary/#the-weight-attribute
- title: Correctly handle solitary Mappings with explicit weights
type: bugfix
body: >-
A <code>Mapping</code> that is not part of a canary group, but that has a
<code>weight</code> less than 100, will be correctly configured to receive all
traffic as if the <code>weight</code> were 100.
docs: topics/using/canary/#the-weight-attribute
image: ./v2.1.2-mapping-less-weighted.png
- title: Correctly handle empty rewrite in a Mapping
type: bugfix
body: >-
Using <code>rewrite: ""</code> in a <code>Mapping</code> is correctly handled
to mean "do not rewrite the path at all".
docs: topics/using/rewrites
image: ./v2.1.2-mapping-no-rewrite.png
- title: Correctly use Mappings with host redirects
type: bugfix
body: >-
Any <code>Mapping</code> that uses the <code>host_redirect</code> field is now properly discovered and used. Thanks
to <a href="https://github.com/gferon">Gabriel Féron</a> for contributing this bugfix!
github:
- title: "#3709"
link: https://github.com/emissary-ingress/emissary/issues/3709
docs: https://github.com/emissary-ingress/emissary/issues/3709
- title: Correctly handle DNS wildcards when associating Hosts and Mappings
type: bugfix
body: >-
<code>Mapping</code>s with DNS wildcard <code>hostname</code> will now be correctly
matched with <code>Host</code>s. Previously, the case where both the <code>Host</code>
and the <code>Mapping</code> use DNS wildcards for their hostnames could sometimes
not correctly match when they should have.
docs: howtos/configure-communications/
image: ./v2.1.2-host-mapping-matching.png
- title: Fix overriding global settings for adding or removing headers
type: bugfix
body: >-
If the <code>ambassador</code> <code>Module</code> sets a global default for
<code>add_request_headers</code>, <code>add_response_headers</code>,
<code>remove_request_headers</code>, or <code>remove_response_headers</code>, it is often
desirable to be able to turn off that setting locally for a specific <code>Mapping</code>.
For several releases this has not been possible for <code>Mappings</code> that are native