Skip to content
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Commit 87231ec

Browse files
committedFeb 26, 2021
added migration doc
1 parent da56052 commit 87231ec

File tree

3 files changed

+47
-23
lines changed

3 files changed

+47
-23
lines changed
 
Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
---
2+
title: How to migrate from AGIC Helm to AGIC add-on
3+
description: This article provides instructions on how to migrate from AGIC deployed through Helm to AGIC deployed as an AKS add-on
4+
services: application-gateway
5+
author: caya
6+
ms.service: application-gateway
7+
ms.topic: article
8+
ms.date: 03/02/2021
9+
ms.author: caya
10+
---
11+
12+
# Migrate from AGIC Helm to AGIC add-on
13+
14+
If you already have AGIC deployed through Helm but want to migrate to AGIC deployed as an AKS add-on, the following steps will help guide you through the migration process.
15+
16+
## Prerequisites
17+
Before you start the migration process, there are a few things to check.
18+
- Are you using any features with AGIC Helm that are [currently not supported with AGIC add-on](ingress-controller-overview.md#difference-between-helm-deployment-and-aks-add-on)?
19+
- Are you using more than one AGIC Helm deployment per AKS cluster?
20+
- Are you using multiple AGIC Helm deployments to target one Application Gateway?
21+
22+
If you answered yes to any of the questions above, AGIC add-on won't support your use case yet so it will be best to continue using AGIC Helm in the meantime. Otherwise, continue with the migration process below during off-business hours.
23+
24+
## Find the Application Gateway resource ID that AGIC Helm is currently targeting
25+
Navigate to the Application Gateway that your AGIC Helm deployment is targeting. Copy and save the resource ID of that Application Gateway. You will need the resource ID in a later step. The resource ID can be found in Portal, under the Properties tab of your Application Gateway or through Azure CLI. The following example saves the Application Gateway resource ID to *appgwId* for a gateway named *myApplicationGateway* in the resource group *myResourceGroup*.
26+
27+
```azurecli-interactive
28+
appgwId=$(az network application-gateway show -n myApplicationGateway -g myResourceGroup -o tsv --query "id")
29+
```
30+
31+
## Delete AGIC Helm from your AKS cluster
32+
Through Azure CLI, delete your AGIC Helm deployment from your cluster. You'll need to delete the AGIC Helm deployment first before you can enable the AGIC AKS add-on. Please note that any changes that occur within your AKS cluster between the time of deleting your AGIC Helm deployment and the time you enable the AGIC add-on won't be reflected on your Application Gateway, and therefore this migration process should be done outside of business hours to minimize impact. Application Gateway will continue to have the last configuration applied by AGIC so existing routing rules will not be affected.
33+
34+
## Enable AGIC add-on using your existing Application Gateway
35+
You can now enable the AGIC add-on in your AKS cluster to target your existing Application Gateway through Azure CLI or Portal. Run the following Azure CLI command to enable the AGIC add-on in your AKS cluster. The example enables the add-on in a cluster called *myCluster*, in a resource group called *myResourceGroup*, using the Application Gateway resource ID *appgwId* we saved above in the earlier step.
36+
37+
38+
```azurecli-interactive
39+
az aks enable-addons -n myCluster -g myResourceGroup -a ingress-appgw --appgw-id $appgwId
40+
```
41+
42+
Alternatively, you can navigate to your AKS cluster in Portal using this [link](https://portal.azure.com/?feature.aksagic=true) and enable the AGIC add-on in the Networking tab of your cluster. Select your existing Application Gateway from the dropdown menu when you choose which Application Gateway the add-on should target.
43+
44+
<INSERT SCREENSHOT PICTURE HERE>

‎articles/application-gateway/ingress-controller-overview.md

Lines changed: 2 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ AGIC is configured via the Kubernetes [Ingress resource](https://kubernetes.io/d
3232
- Integrated web application firewall
3333

3434
## Difference between Helm deployment and AKS Add-On
35-
There are two ways to deploy AGIC for your AKS cluster. The first way is through Helm; the second is through AKS as an add-on. The primary benefit of deploying AGIC as an AKS add-on is that it's much simpler than deploying through Helm. For a new setup, you can deploy a new Application Gateway and a new AKS cluster with AGIC enabled as an add-on in one line in Azure CLI. The add-on is also a fully managed service, which provides added benefits such as automatic updates and increased support. Both ways of deploying AGIC (Helm and AKS add-on) are fully supported by Microsoft. Additionally, the add-on will allows for better integration with AKS as a first class add-on.
35+
There are two ways to deploy AGIC for your AKS cluster. The first way is through Helm; the second is through AKS as an add-on. The primary benefit of deploying AGIC as an AKS add-on is that it's much simpler than deploying through Helm. For a new setup, you can deploy a new Application Gateway and a new AKS cluster with AGIC enabled as an add-on in one line in Azure CLI. The add-on is also a fully managed service, which provides added benefits such as automatic updates and increased support. Both ways of deploying AGIC (Helm and AKS add-on) are fully supported by Microsoft. Additionally, the add-on allows for better integration with AKS as a first class add-on.
3636

3737
The AGIC add-on is still deployed as a pod in the customer's AKS cluster, however, there are a few differences between the Helm deployment version and the add-on version of AGIC. Below is a list of differences between the two versions:
3838
- Helm deployment values cannot be modified on the AKS add-on:
@@ -45,27 +45,7 @@ The AGIC add-on is still deployed as a pod in the customer's AKS cluster, howeve
4545
- Since AGIC add-on is a managed service, customers will automatically be updated to the latest version of AGIC add-on, unlike AGIC deployed through Helm where the customer must manually update AGIC.
4646

4747
> [!NOTE]
48-
> The AGIC AKS add-on method of deployment is currently in preview. We don't recommend running production workloads on features still in preview, so if you're curious to try it out, we'd recommend setting up a new cluster to test it out with.
49-
50-
The following tables sort which scenarios are currently supported with the Helm deployment version and the AKS add-on version of AGIC.
51-
52-
### AKS add-on AGIC (single AKS cluster)
53-
| |1 Application Gateway |2+ Application Gateways |
54-
|------------------|---------|--------|
55-
|**1 AGIC**|Yes, this is supported |No, this is in our backlog |
56-
|**2+ AGICs**|No, only 1 AGIC supported/cluster |No, only 1 AGIC supported/cluster |
57-
58-
### Helm deployed AGIC (single AKS cluster)
59-
| |1 Application Gateway |2+ Application Gateways |
60-
|------------------|---------|--------|
61-
|**1 AGIC**|Yes, this is supported |No, this is in our backlog |
62-
|**2+ AGICs**|Must use shared ProhibitedTarget functionality and watch separate namespaces |Yes, this is supported |
63-
64-
### Helm deployed AGIC (2+ AKS clusters)
65-
| |1 Application Gateway |2+ Application Gateways |
66-
|------------------|---------|--------|
67-
|**1 AGIC**|N/A |N/A |
68-
|**2+ AGICs**|Must use shared ProhibitedTarget functionality |N/A |
48+
> Customers can only deploy one AGIC add-on per AKS cluster, and each AGIC add-on currently can only target one Application Gateway. For deployments that require more than one AGIC per cluster or multiple AGICs targeting one Application Gateway, please continue to use AGIC deployed through Helm.
6949
7050
## Next steps
7151
- [**AKS Add-On Greenfield Deployment**](tutorial-ingress-controller-add-on-new.md): Instructions on installing AGIC add-on, AKS, and Application Gateway on blank-slate infrastructure.

‎articles/application-gateway/tutorial-ingress-controller-add-on-existing.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ az aks enable-addons -n myCluster -g myResourceGroup -a ingress-appgw --appgw-id
7777

7878
If you'd like to use Azure Portal to enable AGIC add-on, please go to [(https://aka.ms/azure/portal/aks/agic)](https://aka.ms/azure/portal/aks/agic) and navigate to your AKS cluster through the Portal link. From there, go to the Networking tab within your AKS cluster. You'll see an Application Gateway ingress controller section, which allows you to enable/disable the ingress controller add-on using the Portal UI. Check the box next to "Enable ingress controller", and select the Application Gateway you created, *myApplicationGateway* from the dropdown menu.
7979

80-
<INSERT PICTURE>
80+
<INSERT SCREENSHOT PICTURE>
8181

8282
## Peer the two virtual networks together
8383

0 commit comments

Comments
 (0)
Please sign in to comment.