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

Container Image - v2.1.7

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.7

The following tags have been made available - latest, v2 & 2.1.7.

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 a bug where rate limiting was not properly synchronizing across nodes after starting
• Fix a bug where container logs used date time entries which were not according to ISO standard
• 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)
• Fix for CVE-2022-43551 vulnerability in our base image (High Severity | details)
• Fix for CVE-2022-42898 vulnerability in our base image (High Severity | details)
• Fix for CVE-2022-43552 vulnerability in our base image (Medium Severity | details)

Breaking Changes

None.

Removal

None.

Full Changelog: Container-v2.1.6...Container-v2.1.7

Helm Chart - v1.5.3

Chart: v1.5.3 | App: v2.1.6

What is new?

Features

• Provide support for configuring hostAliases in case of using Configuration API v2 with custom domains or VNETs (#184 - Contributed by @RomanDvorsky🎉)
• Provide support for specifying custom annotations on deployment (#185 - Contributed by @TimMnz09 🎉)
• Provide support for using HTTPS backend for ingress (#183 - Contributed by @TimMnz09 🎉)

Fixes / Changes

None.

Breaking Changes

None.

Removal

None.

New Contributors

• @RomanDvorsky made their first contribution in #184

Full Changelog: v1.5.2...v1.5.3

Helm Chart - v1.5.2

Chart: v1.5.2 | App: v2.1.6

What is new?

Features

None.

Fixes / Changes

• Provide capability to specify additional configuration (#172)
• Provide support for ingressClassName in ingress (#177)

Breaking Changes

None.

Removal

• Remove ingress with networking.k8s.io/v1beta1/Ingress as it is no longer offered by a supported Kubernetes version (v1.23 and above)

New Contributors

• @TimMnz09 made their first contribution in #179

Full Changelog: v1.5.1...v1.5.2

Helm Chart - v1.5.1

Chart: v1.5.1 | App: v2.1.6

What is new?

Features

None.

Fixes / Changes

• Use Container v2.1.6 release
• Use 3 replicas by default

Breaking Changes

None.

Removal

None.

New Contributors

None.

Full Changelog: v1.5.0...v1.5.1

Container Image - v2.1.6

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.6

The following tags have been made available - latest, v2 & 2.1.6.

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 a bug where rate-limit-by-key policy is no longer working due to configuration parsing failure (#165)

Breaking Changes

None.

Removal

None.

Full Changelog: Container-v2.1.5...Container-v2.1.6

Helm Chart - v1.5.0

Chart: v1.5.0 | App: v2.1.5

What is new?

Features

• Provide batteries-included approach for service discovery and related features (#151)
• Provide capability to define the upgrade strategy for gateway (#145 - Contributed by @ErikMogensen)
• Provide support for the terminationGracePeriodSeconds field in Deployment (#147 - Contributed by @ErikMogensen)

Fixes / Changes

• Use Container v2.1.5 release which contains various (vulnerability) fixes

Breaking Changes

None.

Removal

None.

New Contributors

None.

New Contributors

• @ErikMogensen made their first contribution in #146

Full Changelog: v1.4.1...v1.5.0

Container Image - v2.1.5

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.5

The following tags have been made available - latest, v2 & 2.1.5.

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 a bug where gateway does not start up when DNS resolving fails for neighbor discovery
• Fix a bug where multiple gateway instances are not synchronizing rate-limiting information unless an endpoint with rate limiting was called earlier.
• Fix a bug where HTTP(S) proxy does not provide logs in console output nor API inspector
• Fix a bug where data-plane requests randomly stop working due to policy parsing cancellation
• Fix for CVE-2022-35252 vulnerability in our base image (Low Severity | details)

Breaking Changes

None.

Removal

None.