Skip to content

Commit 6012e14

Browse files
authored
Merge pull request #190441 from tomkerkhove/image-tagging
docs: Provide overview of tagging strategy for API Management's self-hosted gateway
2 parents daf24fa + 34eb010 commit 6012e14

File tree

1 file changed

+35
-0
lines changed

1 file changed

+35
-0
lines changed

articles/api-management/self-hosted-gateway-overview.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,41 @@ The following functionality found in the managed gateways is **not available** i
4949
- Client certificate renegotiation. This means that for [client certificate authentication](api-management-howto-mutual-certificates-for-clients.md) to work, API consumers must present their certificates as part of the initial TLS handshake. To ensure this behavior, enable the Negotiate Client Certificate setting when configuring a self-hosted gateway custom hostname.
5050
- Built-in cache. Learn about using an [external Redis-compatible cache](api-management-howto-cache-external.md) in self-hosted gateways.
5151

52+
### Container images
53+
54+
We provide a variety of container images for self-hosted gateways to meet your needs:
55+
56+
| Tag convention | Recommendation | Example | Rolling tag | Recommended for production |
57+
| ------------- | -------- | ------- | ------- | ------- |
58+
| `{major}.{minor}.{patch}` | Use this tag to always to run the same version of the gateway |`2.0.0` || ✔️ |
59+
| `v{major}` | Use this tag to always run a major version of the gateway with every new feature and patch. |`v2` | ✔️ ||
60+
| `v{major}-preview` | Use this tag if you always want to run our latest preview container image. | `v2-preview` | ✔️ ||
61+
| `latest` | Use this tag if you want to evaluate the self-hosted gateway. | `latest` | ✔️ ||
62+
63+
You can find a full list of available tags [here](https://mcr.microsoft.com/v2/azure-api-management/gateway/tags/list).
64+
65+
#### Use of tags in our official deployment options
66+
67+
Our deployment options in the Azure portal use the `v2` tag which allows customers to use the most recent version of the self-hosted gateway v2 container image with all feature updates and patches.
68+
69+
> [!NOTE]
70+
> We provide the command and YAML snippets as reference, feel free to use a more specific tag if you wish to.
71+
72+
When installing with our Helm chart, image tagging is optimized for you. The Helm chart's application version pins the gateway to a given version and does not rely on `latest`.
73+
74+
Learn more on how to [install an API Management self-hosted gateway on Kubernetes with Helm](how-to-deploy-self-hosted-gateway-kubernetes-helm.md).
75+
76+
#### Risk of using rolling tags
77+
78+
Rolling tags are tags that are potentially updated when a new version of the container image is released. This allows container users to receive updates to the container image without having to update their deployments.
79+
80+
This means that you can potentially run different versions in parallel without noticing it, for example when you perform scaling actions once `v2` tag was updated.
81+
82+
Example - `v2` tag was released with `2.0.0` container image, but when `2.1.0` will be released, the `v2` tag will be linked to the `2.1.0` image.
83+
84+
> [!IMPORTANT]
85+
> Consider using a specific version tag in production to avoid unintentional upgrade to a newer version.
86+
5287
## Connectivity to Azure
5388

5489
Self-hosted gateways require outbound TCP/IP connectivity to Azure on port 443. Each self-hosted gateway must be associated with a single API Management service and is configured via its management plane. A self-hosted gateway uses connectivity to Azure for:

0 commit comments

Comments
 (0)