Permanent issue - Breaking changes documentations

rikatz commented 1 year ago

This issue is a permanent issue that will document breaking changes between every minor and major release. Maintainers will update it so we can track changes. The community can sign/get notifications of this issue.

v1.12 - To be released

Changing security flags: https://github.com/kubernetes/ingress-nginx/pull/11819

Flags changes

Configmap changes

allow-cross-namespace-resources - should be disabled by default. Annotations below may be impacted:
- auth-secret
- auth-proxy-set-header
- auth-tls-secret
- fastcgi-params-configmap
- proxy-ssl-secret
strict-validate-path-type - should be enabled by default
annotations-risk - should be lowered from Critical to High

Features removed

Third party Lua plugins - https://github.com/kubernetes/ingress-nginx/pull/11821
Lua Global rate limiter - https://github.com/kubernetes/ingress-nginx/pull/11851

v1.10 - Completed

This version now uses NGINX v1.25

Features removed

OpenTracing, Zipkin, Jaeger and Datadog specific collectors - Ingress NGINX will support Opentelemetry only
legacy GeoIP - Users should use GeoIP2
Support for PodSecurityPolicy

v1.9 - Completed

Features removed

AJP support - backend-protocol annotation does not support ajp value anymore - #10158
Configmap changes
allow-snippet-annotations - should be disabled by default - #10393
Annotation changes
whitelist-source-range was renamed to allowlist-source-range. The former annotation still works but may be removed on a future release
All the annotations now have validation in place. This may represent breaking changes and should be monitored
custom-http-errors now supports only HTTP errors between 400 and 599
disable-annotation-validation - should default to false

Unplanned releases

Uncategorized breaking changes

Remove old SSL protocol and cipher support

Planned Features removed for v2.0.0

Modsecurity - should be replaced by Coraza
strict path validation to true
Move to the Control Plane/data plane architecture
removing Jaeger etc for Otel

Annotation changes

Remove whitelist-source-range annotation

rikatz commented 11 months ago

Added GeoIP deprecation to the list

rikatz commented 11 months ago

Added https://github.com/kubernetes/ingress-nginx/issues/10498 for dropping support of architectures on v1.10

rikatz commented 3 weeks ago

Considering adding global throttle to the deprecations on v1.12

rikatz commented 3 weeks ago

Removing global-rate-limit feature for v1.12

kubernetes / ingress-nginx