Releases: Azure/api-management-self-hosted-gateway
Container Image - v2.3.0
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.3.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
Here are other relevant resources:
- Authenticate self-hosted gateway with Azure AD
- Self-hosted gateway on Microsoft Artifact Registry
- Migrate to self-hosted gateway v2
- Our image tagging strategy
What is new?
Features
- Support for using Azure AD authentication for Configuration API v2 (docs)
- Support for using Configuration API v2 with custom hostname (docs)
- Support for exposing system metrics in OpenTelemetry Collector (configuration reference)
Fixes / Changes
- Provide automated fallback for regional Azure AD based on DNS failures (see MSAL discussion)
- Improve logging around local log sink creation/connection outcome
- Fix for CVE-2023-29491 vulnerability in our base image (High Severity | details)
- Fixed a bug where CPU spikes are caused due to excessive logging due to
ScheduledActionMissedDeadline
- Fixed a bug where logs are polluted with
System.Diagnostics.Tracing.EventPayload
entries - Fixed a bug where localsyslog telemetry was no longer sent correctly due to connection issues while streaming
- Fixed a bug where request fails with exception
Stack empty
Breaking Changes
None.
Removal
None.
Container Image - v2.3.0-preview-2
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.3.0-preview-2
⚠️ This is a preview release for which we do not provide support and should only be used for evaluation/experimentation.
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
Here are other relevant resources:
- Authenticate self-hosted gateway with Azure AD
- Self-hosted gateway on Microsoft Artifact Registry
- Migrate to self-hosted gateway v2
- Our image tagging strategy
What is new?
Features
- Support for using Azure AD authentication for Configuration API v2 (docs)
- Support for using Configuration API v2 with custom hostname (docs)
- Support for exposing system metrics in OpenTelemetry Collector (configuration reference)
Fixes / Changes
- Provide automated fallback for regional Azure AD based on DNS failures (see MSAL discussion)
- Improve logging around local log sink creation/connection outcome
- Fix for CVE-2023-29491 vulnerability in our base image (High Severity | details)
- Fixed a bug where CPU spikes are caused due to excessive logging due to
ScheduledActionMissedDeadline
- Fixed a bug where logs are polluted with
System.Diagnostics.Tracing.EventPayload
entries - Fixed a bug where localsyslog telemetry was no longer sent correctly due to connection issues while streaming
- Fixed a bug where request fails with exception
Stack empty
Breaking Changes
None.
Removal
None.
Helm Chart - v1.7.0-preview-1
Chart: v1.7.0-preview-1 | App: v2.3.0-preview-1
What is new?
Features
- Support for Azure AD authentication for Configuration API v2 (#213)
- Support for configuring HTTP(S) proxy (#153)
- Use container image v2.3.0-preview-1 (release notes)
Fixes / Changes
None.
Breaking Changes
None.
Removal
None.
New Contributors
None.
Full Changelog: v1.6.0...v1.7.0-preview-1
Container Image - v2.3.0-preview-1
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.3.0-preview-1
⚠️ This is a preview release for which we do not provide support and should only be used for evaluation/experimentation.
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
Here are other relevant resources:
- Authenticate self-hosted gateway with Azure AD
- Self-hosted gateway on Microsoft Artifact Registry
- Migrate to self-hosted gateway v2
- Our image tagging strategy
What is new?
Features
- Support for using Azure AD authentication for Configuration API v2 (docs)
- Support for using Configuration API v2 with custom hostname (docs)
Fixes / Changes
- Provide automated fallback for regional Azure AD based on DNS failures (see MSAL discussion)
- Improve logging around local log sink creation/connection outcome
- Fixed a bug where CPU spikes are caused due to excessive logging due to
ScheduledActionMissedDeadline
- Fixed a bug where logs are polluted with
System.Diagnostics.Tracing.EventPayload
entries - Fixed a bug where localsyslog telemetry was no longer sent correctly due to connection issues while streaming
- Fixed a bug where request fails with exception
Stack empty
Breaking Changes
None.
Removal
None.
Helm Chart - v1.6.0
Chart: v1.6.0 | App: v2.2.0
What is new?
Features
- Use container image v2.2.0 (release notes)
Fixes / Changes
None.
Breaking Changes
None.
Removal
None.
New Contributors
None.
Full Changelog: v1.5.5...v1.6.0
Helm Chart - v1.5.5
Chart: v1.5.5 | App: v2.1.8
What is new?
Features
- Provide support for configuring a pre-provisioned IP for load balancer (#198 - Contributed by @khenri🎉)
- Use container image v2.1.8 (release notes)
Fixes / Changes
None.
Breaking Changes
None.
Removal
None.
New Contributors
Full Changelog: v1.5.4...v1.5.5
Container Image - v2.2.0
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.2.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
Here are other relevant resources:
- Self-hosted gateway on Microsoft Artifact Registry
- Migrate to self-hosted gateway v2
- Our image tagging strategy
What is new?
Features
- Support for WebSocket APIs
- Support for HTTP/2
- Support for
validate-azure-ad-token
policy - Support for
limit-concurrency
policy - Support for policy fragments
- Support for
context.Deployment.Gateway.*
context properties (docs) - Provide a warning when gateway authentication tokens are about to expire ('GatewayTokenAboutToExpire' event)
- Provide additional insights on instance discovery for synchronization
- Provide startup validation to fail fast when misconfigured with better guidance
- Provide overview of supported policies on startup
Fixes / Changes
- Fixed a bug where self-hosted gateway was not respecting API revisions properly
- Fixed a bug where send-one-way-request policy does not gracefully sending a response due to an empty stack
- Fixed a bug where self-hosted gateway could log exceptions up to 6MB in size
- Fixed a bug where local logging was causing a memory leak
- Fixed various vulnerabilities in our base image
Breaking Changes
None.
Removal
None.
Container Image - v2.2.0-preview-1
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.2.0-preview-1
⚠️ This is a preview release for which we do not provide support and should only be used for evaluation/experimentation.
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
Here are other relevant resources:
- Self-hosted gateway on Microsoft Artifact Registry
- Migrate to self-hosted gateway v2
- Our image tagging strategy
What is new?
Features
-
Support for WebSocket APIs
-
Support for
validate-azure-ad-token
policy -
Support for
limit-concurrency
policy -
Support for policy fragments
-
Support for
context.Deployment.Gateway.*
context properties (docs) -
Provide a warning when gateway authentication tokens are about to expire ('GatewayTokenAboutToExpire' event)
-
Provide additional insights on instance discovery for synchronization
-
Provide startup validation to fail fast when misconfigured with better guidance
-
Provide overview of supported policies on startup
Fixes / Changes
- Fixed a bug where self-hosted gateway was not respecting API revisions properly
- Fixed a bug where send-one-way-request policy does not gracefully sending a response due to an empty stack
- Fixed a bug where self-hosted gateway could log exceptions up to 6MB in size
- Fixed a bug where local logging was causing a memory leak
- Fixed various vulnerabilities in our base image
Breaking Changes
None.
Removal
None.
Container Image - v2.1.8
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.1.8
The following tags have been made available - latest
, v2
& 2.1.8
.
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
Here are other relevant resources:
- Self-hosted gateway on Microsoft Artifact Registry
- Migrate to self-hosted gateway v2
- Our image tagging strategy
What is new?
Features
None.
Fixes / Changes
- Fix for CVE-2022-32221 vulnerability in our base image (Critical Severity | details)
- Fix for CVE-2022-42915 vulnerability in our base image (Critical Severity | details)
- Fix for CVE-2022-42916 vulnerability in our base image (High Severity | details)
Breaking Changes
None.
Removal
None.
Full Changelog: Container-v2.1.7...Container-v2.1.8
Helm Chart - v1.5.4
Chart: v1.5.4 | App: v2.1.7
What is new?
Features
- Use container image v2.1.7 (release notes)
Fixes / Changes
None.
Breaking Changes
None.
Removal
None.
New Contributors
None.
Full Changelog: v1.5.3...v1.5.4