Skip to content

Commit 1140d5c

Browse files
committed
docs: Provide overview of tagging strategy for API Management's self-hosted gateway
Signed-off-by: Tom Kerkhove <[email protected]>
1 parent 9e67704 commit 1140d5c

File tree

1 file changed

+31
-7
lines changed

1 file changed

+31
-7
lines changed

articles/api-management/how-to-self-hosted-gateway-on-kubernetes-in-production.md

Lines changed: 31 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -48,16 +48,40 @@ It's impossible to reliably predict and recommend the amount of per-container CP
4848
We recommend setting resource requests to two cores and 2 GiB as a starting point. Perform a load test and scale up/out or down/in based on the results.
4949

5050
## Container image tag
51-
The YAML file provided in the Azure portal uses the **latest** tag. This tag always references the most recent version of the self-hosted gateway container image.
5251

53-
Consider using a specific version tag in production to avoid unintentional upgrade to a newer version.
52+
We provide a variety of container images for self-hosted gateways to meet your needs:
53+
- `2.0.0` - The most specific tag for a container image.
54+
- *Use this image if you always want to run the same container image.*
55+
- `v2` - The latest stable version of the v2 container image. (Moving tag)
56+
- *Use this image if you always want to run our v2 container image with every new feature and patch.*
57+
- `v2-preview` - The latest preview version of the container image. (Moving tag)
58+
- *Use this image if you always want to run our latest preview container image, but not recommended for production.*
59+
- `latest` - The latest stable version of the container image. (Moving tag)
60+
- *Use this image to evaluate the self-hosted gateway, but not recommended for production.*
5461

55-
You can [download a full list of available tags](https://mcr.microsoft.com/v2/azure-api-management/gateway/tags/list).
62+
You can find a full list of available tags [here](https://mcr.microsoft.com/v2/azure-api-management/gateway/tags/list).
5663

57-
> [!TIP]
58-
> When installing with Helm, 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`.
59-
>
60-
> 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).
64+
### Use of tags in our official deployment options
65+
66+
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.
67+
68+
> [!NOTE]
69+
> We provide the command and YAML snippets as reference, feel free to use a more specific tag if you wish to.
70+
71+
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`.
72+
73+
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).
74+
75+
### Risk of using moving tags
76+
77+
Moving 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.
78+
79+
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.
80+
81+
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.
82+
83+
> [!IMPORTANT]
84+
> Consider using a specific version tag in production to avoid unintentional upgrade to a newer version.
6185
6286
## DNS policy
6387
DNS name resolution plays a critical role in a self-hosted gateway's ability to connect to dependencies in Azure and dispatch API calls to backend services.

0 commit comments

Comments
 (0)