Releases: Azure/api-management-self-hosted-gateway
Container Image - v2.0.0
We are excited to announce the GA version of our self-hosted gateway v2 🎉
This new gateway version introduces fewer infrastructure requirements, a new Configuration API, and OpenTelemetry support (preview)!
Getting started
You can easily install the self-hosted gateway with Docker:
docker run -d -p 8080:8080 -p 8081:8081 --name <gateway-name> --envconfig.service.endpoint=<instance-name>.configuration.azure-api.net
config.service.auth=<auth-token> mcr.microsoft.com/azure-api-management/gateway:2.0.0
The following tags have been made available - latest
, v2
& 2.0.0
.
Learn how you can install it on other container platforms:
- Deploy self-hosted gateway on Kubernetes with Helm
- Deploy self-hosted gateway on Kubernetes with Azure Arc (Preview)
- Deploy self-hosted gateway on Kubernetes with YAML
What is new?
Features
- Introduction of new Configuration API v2 with fewer infrastructure requirements (docs)
- Support for pushing metrics to OpenTelemetry Collector (Preview | docs)
- Image tagging strategy was introduced for better understanding of what tags to use (docs)
- Production guidance for running on Kubernetes was extended with high-availability, security, autoscaling and more (docs)
Fixes / Changes
None.
Breaking Changes
- Configuration API v2 (
<name>.configuration.azure-api.net
) should be used in favor of the existing Configuration API v1 (https://<name>.management.azure-api.net/subscriptions/...
).
Learn more in our migration guide.
Removal
None.
Known Limitations
- Configuration API v2 doesn't support custom domain names
For an up-to-date overview, learn more in our documentation.
Helm Chart v1.2.0
Chart: v1.2.0 | App: v2.1.0
What is new?
Features
- Support Ingress
networking.k8s.io/v1
(#103) - Support for managing log configuration in Helm chart (#73)
- Use self-hosted gateway v2.1
Fixes / Changes
None.
Breaking Changes
None.
Removal
None.
New Contributors
None.
Full Changelog: v1.1.0...v1.2.0
Helm Chart v1.1.0
Chart: v1.1.0 | App: v2.0.3
What is new?
Features
- Provide capability to use an existing Kubernetes secret for the
gateway.auth.key
(#84) - Provide capability to add security context configuration (#85)
- Provide capability to use serviceAccountName (#86)
Fixes / Changes
Breaking Changes
None.
Removal
None.
New Contributors
Full Changelog: v1.0.0...v1.1.0
Helm Chart v1.0.0
Chart: v1.0.0 | App: v2.0.0
GA of self-hosted gateway v2 with new configuration API that has less infrastructure requirements.
What is new?
Features
- Use new configuration API with less infrastructure requirements (docs)
- Provide capability to emit metrics to OpenTelemetry Collector (public preview)
- Provide capability to emit metrics to Azure Monitor (#53)
- Use Pod Disruption Budget to ensure gateway remains up (#35)
- Spread instances across zones in Kubernetes cluster for high availability (#36)
- Use readiness probe to detect when gateway is ready to serve traffic (#69)
- Use liveness probes to ensure gateway is still able to serve traffic (#68)
Fixes / Changes
- Allow support for deploying on Kubernetes clusters running pre-release versions (#61 - Contributed by @trenslow)
- Automatically deploy chart on Kubernetes v1.23 (#63)
- Become verified publisher on Artifact Hub to improve discovery (#58)
- Automatically deploy chart on multiple Kubernetes versions (#38)
- Annotate Helm chart with supported Kubernetes versions (#49)
Breaking Changes
The self-hosted gateway now relies on a new Configuration API that is available on {tenant}.configuration.azure-api.net instead of management URL.
Our existing configuration file has been refactored which includes some breaking changes.
service.targetPort
has been removed from our chart README since it was never being usedservice.port
(default: 88) has been removed in favor ofservice.ports.http
(default: 8080) &service.ports.https
(default: 8081).gateway.endpoint
was renamed togateway.configuration.uri
gateway.authKey
was renamed togateway.auth.key
dapr.appId
was renamed todapr.app.id
Removal
The following configuration options have been removed:
service.port
(default: 88) has been removed in favor ofservice.ports.http
(default: 8080) &service.ports.https
(default: 8081).service.targetPort
has been removed from our chart README since it was never being used
New Contributors
None.
Full Changelog: v0.3.0...v1.0.0
Helm Chart v1.0.0-rc.3
Chart: v1.0.0-rc.3 | App: v2.0.0-preview-6
This is the public preview of Azure API Management's self-hosted gateway v2.
This is an incremental release of https://github.com/Azure/api-management-self-hosted-gateway/releases/tag/v1.0.0-rc.2.
What is new?
Features
- Provide capability to emit metrics to OpenTelemetry Collector (public preview)
- Provide capability to emit metrics to Azure Monitor (#53)
- Use Pod Disruption Budget to ensure gateway remains up (#35)
- Spread instances across zones in Kubernetes cluster for high availability (#36)
- Use readiness probe to detect when gateway is ready to serve traffic (#69)
- Use liveness probes to ensure gateway is still able to serve traffic (#68)
Fixes / Changes
- Allow support for deploying on Kubernetes clusters running pre-release versions (#61 - Contributed by @trenslow)
- Automatically deploy chart on Kubernetes v1.23 (#63)
- Become verified publisher on Artifact Hub to improve discovery (#58)
- Automatically deploy chart on multiple Kubernetes versions (#38)
- Annotate Helm chart with supported Kubernetes versions (#49)
Breaking Changes
The self-hosted gateway now relies on a new Configuration API that is available on {tenant}.configuration.azure-api.net instead of management URL.
Our existing configuration file has been refactored which includes some breaking changes.
service.targetPort
has been removed from our chart README since it was never being usedservice.port
(default: 88) has been removed in favor ofservice.ports.http
(default: 8080) &service.ports.https
(default: 8081).gateway.endpoint
was renamed togateway.configuration.uri
gateway.authKey
was renamed togateway.auth.key
dapr.appId
was renamed todapr.app.id
Removal
The following configuration options have been removed:
service.port
(default: 88) has been removed in favor ofservice.ports.http
(default: 8080) &service.ports.https
(default: 8081).service.targetPort
has been removed from our chart README since it was never being used
New Contributors
None.
Full Changelog: v0.3.0...v1.0.0-rc.3
v1.0.0-rc.2
Chart: v1.0.0-rc.2 | App: v1.2.5
This is an incremental release of https://github.com/Azure/api-management-self-hosted-gateway/releases/tag/v1.0.0-rc.
What is new?
Features
See https://github.com/Azure/api-management-self-hosted-gateway/releases/tag/v1.0.0-rc.
Fixes / Changes
- Allow support for deploying on Kubernetes clusters running pre-release versions (#61 - Contributed by @trenslow)
- Automatically deploy chart on Kubernetes v1.23 (#63)
- See https://github.com/Azure/api-management-self-hosted-gateway/releases/tag/v1.0.0-rc.
Breaking Changes
See https://github.com/Azure/api-management-self-hosted-gateway/releases/tag/v1.0.0-rc.
Removal
See https://github.com/Azure/api-management-self-hosted-gateway/releases/tag/v1.0.0-rc.
New Contributors
Full Changelog: v0.3.0...v1.0.0-rc.2
v1.0.0-rc
Chart: v1.0.0-rc | App: v1.2.5
What is new?
Features
- Provide capability to control emitting metrics to Azure Monitor (#53)
- Use Pod Disruption Budget to ensure gateway remains up (#35)
- Spread instances across zones in Kubernetes cluster for high availability (#36)
Fixes / Changes
- Become verified publisher on Artifact Hub to improve discovery (#58)
- Automatically deploy chart on multiple Kubernetes versions (#38)
- Annotate Helm chart with supported Kubernetes versions (#49)
Breaking Changes
Our existing configuration file has been refactored which includes some breaking changes.
service.targetPort
has been removed from our chart README since it was never being usedservice.port
(default: 88) has been removed in favor ofservice.ports.http
(default: 8080) &service.ports.https
(default: 8081).gateway.endpoint
was renamed togateway.configuration.uri
gateway.authKey
was renamed togateway.auth.key
dapr.appId
was renamed todapr.app.id
Removal
The following configuration options have been removed:
service.port
(default: 88) has been removed in favor ofservice.ports.http
(default: 8080) &service.ports.https
(default: 8081).service.targetPort
has been removed from our chart README since it was never being used
Full Changelog: v0.3.0...v1.0.0-rc
v0.3.0
Chart: v0.3.0 | App: v1.1.2
What is new?
Features
- Provide capability to specify annotations to the service (#22)
- Add nodeSelector to test pod (#18)
- Provide capability to use image pull secrets (#23)
Fixes / Changes
- Change ingress apiVersion for kubernetes versions 1.14 and higher (#12)
- Enforce users to specify gateway configuration (#26)
Breaking Changes
None.
Removal
None.