api-management-self-hosted-gateway

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

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

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 requests where sent to the backend with a wrong port when using HTTPS_PROXY
• Fix for CVE-2022-37434 vulnerability in our base image (Critical Severity | details)
• Fix for CVE-2022-30065 vulnerability in our base image (High Severity | details)
• Fix for CVE-2022-30065 vulnerability in our base image (High Severity | details)

Breaking Changes

None.

Removal

None.

Chart: v1.4.0 | App: v2.1.3

What is new?

Features

• Provide configuration backup with Persistent Volume (https://github.com/Azure/api-management-self-hosted-gateway/issues/81 - Contributed by @LDL-GH)

Fixes / Changes

• Use Container v2.1.3 release which contains various vulnerability fixes

Breaking Changes

None.

Removal

None.

New Contributors

None.

Full Changelog: https://github.com/Azure/api-management-self-hosted-gateway/compare/v1.3.1...v1.4.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.1.3

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

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

None.

Fixes / Changes

• Fix a bug where StatsD metrics are no longer being pushed after a given amount of time because of invalid formatting
• Fix for CVE-2022-32207 vulnerability (Critical Severity | details)
• Fix for CVE-2022-27781 vulnerability (High Severity | details)
• Fix for CVE-2022-27782 vulnerability (High Severity | details)
• Fix for CVE-2022-32205 vulnerability (Medium Severity | details)
• Fix for CVE-2022-32206 vulnerability (Medium Severity | details)
• Fix for CVE-2022-32208 vulnerability (Medium Severity | details)
• Fix for CVE-2022-2097 vulnerability (Low Severity | details)

Breaking Changes

None.

Removal

None.

Chart: v1.3.1 | App: v2.1.2

What is new?

Features

None.

Fixes / Changes

• Use Container v2.1.2 release which contains various vulnerability fixes

Breaking Changes

None.

Removal

None.

New Contributors

None.

Full Changelog: https://github.com/Azure/api-management-self-hosted-gateway/compare/v1.3.0...v1.3.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.1.2

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

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

None.

Fixes / Changes

• Fix for CVE-2022-28391 vulnerability (Critical Severity | details)
• Fix for CVE-2022-28391 vulnerability (Critical Severity | details)
• Fix for CVE-2018-25032 vulnerability (High Severity | details)
• Fix for CVE-2022-0778 vulnerability (High Severity | details)
• Fix for CVE-2021-37750 vulnerability (Medium Severity | details)

Breaking Changes

None.

Removal

None.

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

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

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

None.

Fixes / Changes

• Fixes a bug where TLS cipher suites are not properly used for gateway-to-backend communication

Breaking Changes

None.

Removal

None.

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

The following tags have been made available - latest, v2 & 2.1.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

• Support for HTTP/2 for gateway-to-backend communication (preview)
• Support for managing TLS cipher suites used for client-to-gateway and gateway-to-backend communication (#31 | docs)
• System.Net.IpAddress & System.Enum in policy expressions
• Support for using System.Net.IpAddress & System.Enum in policy expressions
• Support for disabling colored STDOUT/STDERR logs (#78)

Fixes / Changes

• Improve gateway startup experience to better indicate wrongly configured authentication tokens
• Fixes a bug where hostname:port convention is not supported for local log endpoints (#94)
• Fixes a bug where local JSON logs are not encoded correctly (#95)

Breaking Changes

None.

Removal

None.

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

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

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

None.

Fixes / Changes

• Fixed a bug where self-hosted gateway v2 was not using the same TLS cipher suites as self-hosted gateway v1

Breaking Changes

None.

Removal

None.

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

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

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

None.

Fixes / Changes

• Allow gateway to start up without root permissions (#82 | docs)

Breaking Changes

None.

Removal

None.

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

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

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

None.

Fixes / Changes

• Fixes a bug in the internal scheduling of the gateway

Breaking Changes

None.

Removal

None.

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

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

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

None.

Fixes / Changes

• Fixes a timezone bug in the integration with the Configuration API to pull configuration from

Breaking Changes

None.

Removal

None.

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)!

• Migration Guide
• v2 requirements
• Azure Updates

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.

Chart: v1.3.0 | App: v2.1.1

What is new?

Features

• Support for managing used TLS cipher suites (#31)
• Support for managing local metrics (#108)
• Support for disabling output log colors (#78)
• Use self-hosted gateway v2.1.1

Fixes / Changes

• Enforce specifying Configuration API URL (#110)
• Fixed bug in local logs where hostname:port convention is not excepted (#94)
• Fixed encoding bug in local JSON logs (#95)

Breaking Changes

None.

Removal

None.

New Contributors

None.

Full Changelog: https://github.com/Azure/api-management-self-hosted-gateway/compare/v1.2.0...v1.3.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: https://github.com/Azure/api-management-self-hosted-gateway/compare/v1.1.0...v1.2.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

• Allow gateway to run as non-root (#82 - Docs)

Breaking Changes

None.

Removal

None.

New Contributors

• @LDL-GH made their first contribution in https://github.com/Azure/api-management-self-hosted-gateway/pull/92

Full Changelog: https://github.com/Azure/api-management-self-hosted-gateway/compare/v1.0.0...v1.1.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 used
• service.port (default: 88) has been removed in favor of service.ports.http (default: 8080) & service.ports.https (default: 8081).
• gateway.endpoint was renamed to gateway.configuration.uri
• gateway.authKey was renamed to gateway.auth.key
• dapr.appId was renamed to dapr.app.id

Removal

The following configuration options have been removed:

• service.port (default: 88) has been removed in favor of service.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: https://github.com/Azure/api-management-self-hosted-gateway/compare/v0.3.0...v1.0.0

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 used
• service.port (default: 88) has been removed in favor of service.ports.http (default: 8080) & service.ports.https (default: 8081).
• gateway.endpoint was renamed to gateway.configuration.uri
• gateway.authKey was renamed to gateway.auth.key
• dapr.appId was renamed to dapr.app.id

Removal

The following configuration options have been removed:

• service.port (default: 88) has been removed in favor of service.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: https://github.com/Azure/api-management-self-hosted-gateway/compare/v0.3.0...v1.0.0-rc.3

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

• @trenslow made their first contribution in https://github.com/Azure/api-management-self-hosted-gateway/pull/61

Full Changelog: https://github.com/Azure/api-management-self-hosted-gateway/compare/v0.3.0...v1.0.0-rc.2

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 used
• service.port (default: 88) has been removed in favor of service.ports.http (default: 8080) & service.ports.https (default: 8081).
• gateway.endpoint was renamed to gateway.configuration.uri
• gateway.authKey was renamed to gateway.auth.key
• dapr.appId was renamed to dapr.app.id

Removal

The following configuration options have been removed:

• service.port (default: 88) has been removed in favor of service.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: https://github.com/Azure/api-management-self-hosted-gateway/compare/v0.3.0...v1.0.0-rc

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.