Releases: api7/adc
v0.21.1
What's Changed
- feat(apisix-standalone): support upstream healthcheck and service discovery by @bzp2010 in #333
- fix(apisix-standalone): duplicate upstreams when use service multiple upstreams by @bzp2010 in #334
- fix(backend-api7): duplicate removal of upstream and credentials by @bzp2010 in #343
- fix(apisix-standalone): conflict between upstream nodes and service discovery by @bzp2010 in #344
- feat: bump to 0.21.1 by @bzp2010 in #345
Full Changelog: v0.21.0...v0.21.1
v0.21.0
Notice
-
Support for API7
3.3.x
and3.4.x
in ADC has been discontinued. API73.5.x
to3.8.x
are now supported.
If you have questions about this, please contact the API7 Support. -
The OpenAPI converter has introduced a breaking change. This is not expected to impact your actual use case. #321
We've now introduced a slight break change where your server's URL will no longer emit aservice.path_prefix
regardless of whether it contains a path suffix or not, and every path will be inlined as a prefix in the uri of every route.The value of path_prefix is still resolved from the first server's URL as before.
The reason for this change is that APISIX does not support path_prefix and strip_path_prefix, and we had to choose a more widely compatible way to achieve a similar effect.
Highlight
New OpenAPI Converter Implementation
We have switched to a new OAS parser library implementation that offers improved code quality and new features.
ADC now also supports Swagger (OpenAPI 2.0), which will be transparently upgraded to OpenAPI 3.1 behind the scenes before being converted into ADC configurations.
Performance improvements
We have introduced performance modifications across multiple domains within ADC, including:
- YAML parser: Achieves speed advantages on larger YAML files
- APISIX Standalone backend
What's Changed
- docs(readme): remove hardcoded download link by @bzp2010 in #294
- feat(apisix-standalone): optional sync put request by @bzp2010 in #298
- feat(core): faster YAML and JSON parser by @bzp2010 in #299
- perf(apisix-standalone): remove immerjs by @bzp2010 in #300
- chore: replace typescript alias with pnpm workspace by @bzp2010 in #301
- chore: update tsconfig reference by @bzp2010 in #303
- feat(core): move linter to zod4 by @bzp2010 in #304
- feat(core): add ingress server mode by @bzp2010 in #305
- feat(core): configurable ingress server listen by @bzp2010 in #306
- feat(core): ingress server listen on https and UDS http by @bzp2010 in #307
- feat(ci): build dev image for commit on main branch by @bzp2010 in #309
- chore(core): remove ingress server etag header by @bzp2010 in #311
- fix(core): ingress server listen no TLS endpoint by @bzp2010 in #310
- feat(core): ingress server status endpoint by @bzp2010 in #312
- chore: add code owners for review approval by @bzp2010 in #313
- feat(core): ingress server local configuration filter by @bzp2010 in #314
- feat(core): move to separate differ module by @bzp2010 in #316
- chore: move jest to vitest by @bzp2010 in #317
- chore: move eslintrc to eslint flat config by @bzp2010 in #318
- feat(converter-openapi): move to new openapi parser by @bzp2010 in #321
- refactor(apisix-standalone) by @bzp2010 in #320
- fix(core): ingress server sync API server option accept multiple endpoints by @bzp2010 in #322
- feat(apisix-standalone): separate inline upstream by @bzp2010 in #319
- docs(converter-openapi): fix typo by @juzhiyuan in #315
- feat(apisix-standalone): use millisecond timestamp as conf version by @bzp2010 in #323
- feat(core): add debug log to ingress server by @bzp2010 in #324
- fix(apisix-standalone): handle inline upstream update and delete by @bzp2010 in #326
- test(apisix-standalone): add inline upstream update 2 times case by @bzp2010 in #327
- fix(apisix-standalone): ensure PUT sent when no diff events by @bzp2010 in #328
- feat(apisix-standalone): add server field to sync result by @bzp2010 in #329
- feat(apisix-standalone): use one of servers when no XLM header by @bzp2010 in #330
- feat: bump to 0.21.0 by @bzp2010 in #331
Full Changelog: v0.20.0...v0.21.0
v0.20.0
Highlight
New APISIX standalone backend
Benefiting from the API-driven standalone mode (enhancements sponsored by API7) released in APISIX 3.13, ADC has introduced a new backend for Ingress Controller support.
The new apisix-standalone
backend, which is isomorphic to any other backend, ensures that users do not need to provide different configuration inputs for different scenarios, but rather use a single unified configuration for multiple different gateway products.
Input configurations will be converted on a best-effort basis to the configuration/API calls required by the specified backend.
With this new ADC backend, APISIX in Kubernetes will have the opportunity to become a truly stateless API gateway with no etcd and no persistence.
ADC is already used as a core by the API7 Ingress Controller and will further enhance the capabilities of the APISIX Ingress Controller. ADC has become an important part of the API7 portfolio, bringing value to a wider range of products and users..
What's Changed
- feat(apisix-standalone): add new experimental backend by @bzp2010 in #269
- fix(apisix-standalone): incorrect desc field in service inlined upstream by @bzp2010 in #276
- fix(apisix-standalone): remove path_prefix and strip_path_prefix by @bzp2010 in #277
- fix(apisix-standalone): remove zod-based transformer by @bzp2010 in #280
- fix(apisix-standalone): consumer sync exception by @bzp2010 in #282
- fix(apisix-standalone): credential modifiedIndex is not updated by @bzp2010 in #288
- fix(apisix): transform upstream nodes to array by @bzp2010 in #290
- chore(apisix): remove experimental log by @bzp2010 in #292
- feat: bump to 0.20.0 by @bzp2010 in #293
Full Changelog: v0.19.1...v0.20.0
v0.19.1
This is a patch release for bug fixes. But it also contains a few new features for addressing potential bugs in specific scenarios, such as now syncing requests concurrently by user control and ensuring that dump output is organized.
What's Changed
- feat(core): add sync request concurrent option by @bzp2010 in #258
- feat(core): sort the configuration by readable name during dump by @bzp2010 in #260
- feat(core): allow keep var syntax in yaml via escaping chars by @bzp2010 in #262
- fix: modify frozen immutable objects by @bzp2010 in #265
- fix(backend): failed to report operation error by @bzp2010 in #266
- feat: bump to 0.19.1 by @bzp2010 in #267
Full Changelog: v0.19.0...v0.19.1
0.19.0
Highlight
Multi-upstream support in services
ADC now supports the inclusion of multiple upstreams in a single service in such a structure:
services:
- name: demo
upstream:
<default upstream>
upstreams:
- name: non-default-upstream-1
<upstream config 1>
- name: non-default-upstream-2
<upstream config 2>
routes: []
That is, it lets users create multiple new upstreams with service.upstreams
. Where service.upstream
is the default upstream, it will be used as the default upstream for all requests, or users can use the traffic-split
plugin if users want to route some traffic to other upstreams proportionally or conditionally.
The service.upstreams
supports setting a name or ID for the upstream, which is inferred and generated using sha1(service_name.upstream_name)
if users don't specify the ID manually, and which can be used in the weighted_upstreams.upstream_id
in the traffic-split
plugin, allowing users to get rid of the requirement to inline upstream resources in the traffic-split
plugin and enjoy the full functionality of the upstream health check.
Please note that when using custom IDs, users must ensure the uniqueness of the IDs, as conflicts can result in unintended coverage of resources.
In API7, upstream is natively associated with the service, which is a built-in capability, so support is native.
Whereas in APISIX upstreams are unable to proactively record associations with services, so we record the services that the upstream belongs to in labels, even though this is simulated, it works out of the box, please be careful not to manage and manually modify the records in labels by means other than ADC.
What's Changed
- feat(api7): support multiple upstream of service by @bzp2010 in #252
- fix(apisix): log scope typo by @bzp2010 in #253
- feat(apisix): support multiple upstream of service by @bzp2010 in #254
- fix(apisix): tolerate instance without stream proxy enabled by @bzp2010 in #255
- feat: bump to 0.19.0 by @bzp2010 in #256
Full Changelog: v0.18.0...v0.19.0
0.18.0
Notice
Since this version, the API7 backend no longer uses the force publish mode (i.e. publish-free API) and it no longer uses service templates.
As it does not use the publish mechanism, atomicity in effect is now no longer supported and all changes take effect immediately. If an error occurs, the ADC will report the error and exit with the exit code.
Highlight
ADC efficiency improvements
It greatly improves the time taken by the ADC to perform export and synchronization, and it may achieve a 100% speedup when enjoying the full optimization.
It encompasses multiple aspects:
- TCP connection reuse on the backend
- Mechanisms for parallel sync tasks
- Extensive refactoring
You can enjoy these optimizations as soon as you update, check the compatibility list for your use case.
OpenAPI converter support multi-file input
In 0.17.0 we supported multi-file input support for diff
and sync
, and now it has been introduced to the OAS converter as well.
Refactoring
In addition to the above, we have done a lot of refactoring, for example:
- Backend API definations
- API7 and APISIX backend implementations
- ADC logging infrastructure
- Differ v3 logging output
What's Changed
- fix(core): sync command example typo by @bzp2010 in #227
- chore: upgrade nx toolchain by @bzp2010 in #226
- feat(core): add remote state file as experimental feature by @bzp2010 in #229
- feat(core): support multiple file input for OAS converter by @bzp2010 in #228
- feat(api7): add parallel backend request as experimental feature by @bzp2010 in #230
- feat(api7): move to publish-free api by @bzp2010 in #234
- feat(backend): enable keepalive for backend api call by @bzp2010 in #235
- chore(core): move tasks to separate folder by @bzp2010 in #236
- chore(core): decouple logger by @bzp2010 in #237
- feat(api7): allow dev version and admin key mode by @bzp2010 in #238
- fix(api7): unexpectedly pass the empty string gateway group id by @bzp2010 in #239
- refactor: api7 backend by @bzp2010 in #240
- feat(core): add ingress entrypoint by @bzp2010 in #241
- feat(core): all in one ingress mode by @bzp2010 in #244
- fix(core): incorrect empty remote in ingress mode by @bzp2010 in #246
- feat(apisix): rewrite apisix backend by @bzp2010 in #245
- feat: imporve backend error handling by @bzp2010 in #247
- feat: bump to 0.18.0 by @bzp2010 in #248
- fix(core): lint does not allow string input on numeric fields by @bzp2010 in #249
- docs(api7): update compatibility matrix by @bzp2010 in #250
Full Changelog: v0.17.0...v0.18.0
0.17.0
Highlight
Support for multi-file input using glob
This has been implemented on the diff
and sync
commands. It is not implemented on OpenAPI Converter because it doesn't support multi-file input yet, which will be improved later.
It now supports such syntax:
adc sync -f 'spec/*.yaml'
adc sync -f 'spec/**/*.yaml'
Note that the glob expressions need to be quote-wrapped because we don't want the glob implementation in the shell to intervene for a uniform user experience.
More guides: https://github.com/isaacs/node-glob?tab=readme-ov-file#glob-primer
APISIX support down to 3.2.x
APISIX support has been extended to 3.2, which was an LTS but is now considered retired, which helps users to migrate.
For Known Issues/Limitations, please refer to: https://github.com/api7/adc/blob/main/libs/backend-apisix/README.md
What's Changed
- feat(core): support glob file path by @bzp2010 in #212
- feat(apisix): support apisix lower than 3.8 by @bzp2010 in #213
- feat(core): dump sorted yaml by @bzp2010 in #217
- feat(api7): support route vars expr by @bzp2010 in #219
- fix(apisix): service missing hosts by @bzp2010 in #220
- feat: bump to 0.17.0 by @bzp2010 in #221
- fix(apisix): upstream nodes should be allowed to be null by @bzp2010 in #222
- docs(api7): add 3.3.x support by @bzp2010 in #223
Full Changelog: v0.16.2...v0.17.0
0.16.2
0.16.1
0.16.0
Highlight
Support for custom resource ID
The resource ID can now be customized by the user instead of letting ADC generate it automatically.
Just write the id
field in the resource to make it work, but there are a few resources that are not supported yet, such as upstream (which is inlined by the service and doesn't support references) and consumer (whose username is the ID and doesn't want to be specified additionally).
It has been implemented on API7 and APISIX. #203 #204
What's Changed
- fix(api7): mismatched fields in upstream mtls by @bzp2010 in #202
- feat: support custom resource id by @bzp2010 in #203
- feat(core): update custom id schema by @bzp2010 in #204
- feat: bump to 0.16.0 by @bzp2010 in #205
Full Changelog: v0.15.0...v0.16.0