Skip to content

Commit b00c642

Browse files
authored
Merge pull request #232180 from AbhishekMallick01/Mar-27-2023-AKS
AKS backup updates
2 parents 1503a66 + b5383c2 commit b00c642

5 files changed

+68
-65
lines changed

articles/backup/azure-kubernetes-service-cluster-backup-concept.md

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Azure Kubernetes Service (AKS) backup using Azure Backup prerequisites
33
description: This article explains the prerequisites for Azure Kubernetes Service (AKS) backup.
44
ms.topic: conceptual
55
ms.service: backup
6-
ms.date: 03/20/2023
6+
ms.date: 03/27/2023
77
author: jyothisuri
88
ms.author: jsuri
99
---
@@ -24,11 +24,11 @@ Azure Backup now allows you to back up AKS clusters (cluster resources and persi
2424

2525
- You need to install Backup Extension on both the source cluster to be backed up and the target cluster where the restore will happen.
2626

27-
- Backup Extension can be installed in the cluster from the *AKS portal* blade on the **Backup** tab under **Settings**. You can also use the Azure CLI commands to [manage the installation and other operations on the Backup Extension](azure-kubernetes-service-cluster-manage-backups.md#manage-operations).
27+
- Backup Extension can be installed in the cluster from the *AKS portal* blade on the **Backup** tab under **Settings**. You can also use the Azure CLI commands to [manage the installation and other operations on the Backup Extension](azure-kubernetes-service-cluster-manage-backups.md#backup-extension-related-operations).
2828

29-
- Before you install an extension in an AKS cluster, you must register the `Microsoft.KubernetesConfiguration` resource provider at the subscription level. Learn how to [register the resource provider](azure-kubernetes-service-cluster-manage-backups.md#register-the-resource-provider).
29+
- Before you install an extension in an AKS cluster, you must register the `Microsoft.KubernetesConfiguration` resource provider at the subscription level. Learn how to [register the resource provider](azure-kubernetes-service-cluster-manage-backups.md#resource-provider-registrations).
3030

31-
Learn [how to manage the operation to install Backup Extension using Azure CLI](azure-kubernetes-service-cluster-manage-backups.md#manage-operations).
31+
Learn [how to manage the operation to install Backup Extension using Azure CLI](azure-kubernetes-service-cluster-manage-backups.md#backup-extension-related-operations).
3232

3333
## Trusted Access
3434

@@ -38,9 +38,14 @@ Your Azure resources access AKS clusters through the AKS regional gateway using
3838

3939
For AKS backup, the Backup vault accesses your AKS clusters via Trusted Access to configure backups and restores. The Backup vault is assigned a pre-defined role **Microsoft.DataProtection/backupVaults/backup-operator** in the AKS cluster, allowing it to only perform specific backup operations.
4040

41-
Before you enable Trusted Access between a Backup vault and an AKS cluster, [enable a *feature flag* on the cluster's subscription](azure-kubernetes-service-cluster-manage-backups.md#enable-the-feature-flag).
41+
To enable Trusted Access between a Backup vault and an AKS cluster, you must register the `TrustedAccessPreview` feature flag on `Microsoft.ContainerService` at the subscription level. Learn more [to register the resource provider](azure-kubernetes-service-cluster-manage-backups.md#enable-the-feature-flag).
42+
43+
Learn [how to enable Trusted Access](azure-kubernetes-service-cluster-manage-backups.md#register-the-trusted-access).
44+
45+
>[!Note]
46+
>- You can install the Backup Extension on your AKS cluster directly from the Azure portal under the *Backup* section in AKS portal.
47+
>- You can also enable Trusted Access between Backup vault and AKS cluster during the backup or restore operations in the Azure portal.
4248
43-
Learn [how to enable Trusted Access](azure-kubernetes-service-cluster-manage-backups.md#enable-trusted-access).
4449

4550
## AKS Cluster
4651

articles/backup/azure-kubernetes-service-cluster-backup-support-matrix.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: Azure Kubernetes Service (AKS) backup support matrix
33
description: This article provides a summary of support settings and limitations of Azure Kubernetes Service (AKS) backup.
44
ms.topic: conceptual
5-
ms.date: 03/20/2023
5+
ms.date: 03/27/2023
66
ms.custom: references_regions
77
ms.service: backup
88
author: jyothisuri
@@ -41,6 +41,8 @@ AKS backup is available in all the Azure public cloud regions, East US, North Eu
4141

4242
- Currently, the modification of backup policy and the modification of snapshot resource group (assigned to a backup instance during configuration of the AKS cluster backup) aren't supported.
4343

44+
- AKS cluster and Backup Extension pods should be in running state for any backup and restore operations to be performed. This includes deletion of expired recovery points.
45+
4446
- For successful backup and restore operations, role assignments are required by the Backup vault's managed identity. If you don't have the required permissions, you may see permission issues during backup configuration or restore operations soon after assigning roles because the role assignments take a few minutes to take effect. Learn about the [role definitions](azure-kubernetes-service-cluster-backup-concept.md#required-roles-and-permissions).
4547

4648
- AKS backup limits are:

articles/backup/azure-kubernetes-service-cluster-backup.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Back up Azure Kubernetes Service (AKS) using Azure Backup
33
description: This article explains how to back up Azure Kubernetes Service (AKS) using Azure Backup.
44
ms.topic: how-to
55
ms.service: backup
6-
ms.date: 03/20/2023
6+
ms.date: 03/27/2023
77
author: jyothisuri
88
ms.author: jsuri
99
---
@@ -24,7 +24,7 @@ Azure Backup now allows you to back up AKS clusters (cluster resources and persi
2424

2525
- You must [install the Backup Extension](azure-kubernetes-service-cluster-manage-backups.md#install-backup-extension) to configure backup and restore operations on an AKS cluster. Learn more [about Backup Extension](azure-kubernetes-service-cluster-backup-concept.md#backup-extension).
2626

27-
- Ensure that the `Microsoft.KubernetesConfiguration` and `Microsoft.DataProtection` providers are registered for your subscription before initiating backup configuration and restore operations.
27+
- Ensure that `Microsoft.KubernetesConfiguration`, `Microsoft.DataProtection`, and the `TrustedAccessPreview` feature flag on `Microsoft.ContainerService` are registered for your subscription before initiating the backup configuration and restore operations.
2828

2929
- Ensure to perform [all the prerequisites](azure-kubernetes-service-cluster-backup-concept.md) before initiating backup or restore operation for AKS backup.
3030

articles/backup/azure-kubernetes-service-cluster-manage-backups.md

Lines changed: 50 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -3,129 +3,125 @@ title: Manage Azure Kubernetes Service (AKS) backups using Azure Backup
33
description: This article explains how to manage Azure Kubernetes Service (AKS) backups using Azure Backup.
44
ms.topic: how-to
55
ms.service: backup
6-
ms.date: 03/20/2023
6+
ms.date: 03/27/2023
77
author: jyothisuri
88
ms.author: jsuri
99
---
1010

1111
# Manage Azure Kubernetes Service backups using Azure Backup (preview)
1212

13-
This article describes how to manage Azure Kubernetes Service (AKS) backups using Azure CLI commands.
13+
This article describes how to register resource providers on your subscriptions for using Backup Extension and Trusted Access. Also, it provides you with the Azure CLI commands to manage them.
1414

15-
Azure Backup now allows you to back up AKS clusters (cluster resources and persistent volumes attached to the cluster) using a backup extension, which must be installed in the cluster. Backup vault communicates with the cluster via this Backup Extension to perform backup and restore operations.
15+
Azure Backup now allows you to back up AKS clusters (cluster resources and persistent volumes attached to the cluster) using a backup extension, which must be installed in the cluster. AKS cluster requires Trusted Access enabled with Backup vault, so that the vault can communicate with the Backup Extension to perform backup and restore operations.
1616

17-
## Manage operations
17+
## Resource provider registrations
1818

19-
This section provides the set of Azure CLI commands to create, update, delete operations on the backup extension. You can use the *update* command to change the blob container where backups are stored along with compute limits for the underlying Backup Extension Pods.
19+
- You must register these resource providers on the subscription before initiating any backup and restore operation.
20+
- Once the registration is complete, you can perform backup and restore operations on all the cluster under the subscription.
2021

21-
## Register the resource provider
22+
### Register the Backup Extension
2223

23-
To register the resource provider, run the following command:
24+
To install Backup Extension, you need to register `Microsoft.KubernetesConfiguration` resource provider on the subscription. To perform the registration, run the following command:
2425

2526
```azurecli-interactive
2627
az provider register --namespace Microsoft.KubernetesConfiguration
2728
```
2829

29-
>[!Note]
30-
>Don't initiate extension installation before registering resource provider.
31-
32-
### Monitor the registration process
33-
3430
The registration may take up to *10 minutes*. To monitor the registration process, run the following command:
3531

3632
```azurecli-interactive
3733
az provider show -n Microsoft.KubernetesConfiguration -o table
3834
```
3935

40-
### Install Backup Extension
36+
### Register the Trusted Access
4137

42-
To install the Backup Extension, use the following command:
38+
To enable Trusted Access between the Backup vault and AKS cluster, you must register *TrustedAccessPreview* feature flag on *Microsoft.ContainerService* over the subscription. To perform the registration, run the following commands:
4339

44-
```azurecli-interactive
45-
az k8s-extension create --name azure-aks-backup --extension-type Microsoft.DataProtection.Kubernetes --scope cluster --cluster-type managedClusters --cluster-name aksclustername --resource-group aksclusterrg --release-train stable --configuration-settings blobContainer=containername storageAccount=storageaccountname storageAccountResourceGroup=storageaccountrg storageAccountSubscriptionId=subscriptionid
46-
```
40+
## Enable the feature flag
4741

48-
### Update resources in Backup Extension
42+
To enable the feature flag follow these steps:
4943

50-
To update blob container, CPU, and memory in the Backup Extension, use the following command:
44+
1. Install the *aks-preview* extension:
5145

5246
```azurecli-interactive
53-
az k8s-extension update --name azure-aks-backup --cluster-type managedClusters --cluster-name aksclustername --resource-group aksclusterrg --release-train stable --configuration-settings [blobContainer=containername storageAccount=storageaccountname storageAccountResourceGroup=storageaccountrg storageAccountSubscriptionId=subscriptionid] [cpuLimit=1] [memoryLimit=1Gi]
54-
55-
[]: denotes the 3 different sub-groups of updates possible (discard the brackets while using the command)
56-
47+
az extension add --name aks-preview
5748
```
5849

59-
### Delete Backup Extension installation operation
60-
61-
To stop the Backup Extension install operation, use the following command:
50+
1. Update to the latest version of the extension released:
6251

6352
```azurecli-interactive
64-
az k8s-extension delete --name azure-aks-backup --cluster-type managedClusters --cluster-name aksclustername --resource-group aksclusterrg
53+
az extension update --name aks-preview
6554
```
6655

67-
### Grant permission on storage account
68-
69-
To provide *Storage Account Contributor Permission* to the Extension Identity on storage account, run the following command:
56+
1. Register the *TrustedAccessPreview* feature flag:
7057

7158
```azurecli-interactive
72-
az role assignment create --assignee-object-id $(az k8s-extension show --name azure-aks-backup --cluster-name aksclustername --resource-group aksclusterresourcegroup --cluster-type managedClusters --query aksAssignedIdentity.principalId --output tsv) --role 'Storage Account Contributor' --scope /subscriptions/subscriptionid/resourceGroups/storageaccountresourcegroup/providers/Microsoft.Storage/storageAccounts/storageaccountname
59+
az feature register --namespace "Microsoft.ContainerService" --name "TrustedAccessPreview"
7360
```
61+
62+
It takes a few minutes for the status to show *Registered*.
7463

75-
### View Backup Extension installation status
64+
1. Verify the registration status:
7665

77-
To view the progress of Backup Extension installation, use the following command:
66+
```azurecli-interactive
67+
az feature show --namespace "Microsoft.ContainerService" --name "TrustedAccessPreview"
68+
```
69+
70+
1. When the status shows *Registered*, refresh the `Microsoft.ContainerService` resource provider registration:
7871

7972
```azurecli-interactive
80-
az k8s-extension show --name azure-aks-backup --cluster-type managedClusters --cluster-name aksclustername --resource-group aksclusterrg
73+
az provider register --namespace Microsoft.ContainerService
8174
```
8275

83-
## Enable the feature flag
76+
## Backup Extension related operations
8477

85-
To enable the feature flag follow these steps:
78+
This section provides the set of Azure CLI commands to perform create, update, or delete operations on the Backup Extension. You can use the update command to change compute limits for the underlying Backup Extension Pods.
79+
80+
### Install Backup Extension
8681

87-
1. To install the *aks-preview* extension, run the following command:
82+
To install the Backup Extension, run the following command:
8883

8984
```azurecli-interactive
90-
az extension add --name aks-preview
85+
az k8s-extension create --name azure-aks-backup --extension-type Microsoft.DataProtection.Kubernetes --scope cluster --cluster-type managedClusters --cluster-name aksclustername --resource-group aksclusterrg --release-train stable --configuration-settings blobContainer=containername storageAccount=storageaccountname storageAccountResourceGroup=storageaccountrg storageAccountSubscriptionId=subscriptionid
9186
```
9287

93-
1. To update to the latest version of the extension released, run the following command:
88+
### View Backup Extension installation status
89+
90+
To view the progress of Backup Extension installation, use the following command:
9491

9592
```azurecli-interactive
96-
az extension update --name aks-preview
93+
az k8s-extension show --name azure-aks-backup --cluster-type managedClusters --cluster-name aksclustername --resource-group aksclusterrg
9794
```
9895

99-
1. To register the *TrustedAccessPreview* feature flag, run the `az feature register` command.
96+
### Update resources in Backup Extension
10097

101-
**Example**
98+
To update blob container, CPU, and memory in the Backup Extension, use the following command:
10299

103100
```azurecli-interactive
104-
az feature register --namespace "Microsoft.ContainerService" --name "TrustedAccessPreview"
105-
```
101+
az k8s-extension update --name azure-aks-backup --cluster-type managedClusters --cluster-name aksclustername --resource-group aksclusterrg --release-train stable --configuration-settings [blobContainer=containername storageAccount=storageaccountname storageAccountResourceGroup=storageaccountrg storageAccountSubscriptionId=subscriptionid] [cpuLimit=1] [memoryLimit=1Gi]
106102
107-
It takes a few minutes for the status to show Registered.
103+
[]: denotes the 3 different sub-groups of updates possible (discard the brackets while using the command)
108104
109-
1. To verify the registration status, run the `az feature show` command.
105+
```
110106

111-
**Example**
107+
### Delete Backup Extension installation operation
108+
109+
To stop the Backup Extension install operation, use the following command:
112110

113111
```azurecli-interactive
114-
az feature show --namespace "Microsoft.ContainerService" --name "TrustedAccessPreview"
112+
az k8s-extension delete --name azure-aks-backup --cluster-type managedClusters --cluster-name aksclustername --resource-group aksclusterrg
115113
```
116114

117-
1. When the status shows as **Registered**, run the `az provider register` command to refresh the `Microsoft.ContainerService` resource provider registration.
115+
### Grant permission on storage account
118116

119-
**Example**
117+
To provide *Storage Account Contributor Permission* to the Extension Identity on storage account, run the following command:
120118

121119
```azurecli-interactive
122-
az provider register --namespace Microsoft.ContainerService
120+
az role assignment create --assignee-object-id $(az k8s-extension show --name azure-aks-backup --cluster-name aksclustername --resource-group aksclusterresourcegroup --cluster-type managedClusters --query aksAssignedIdentity.principalId --output tsv) --role 'Storage Account Contributor' --scope /subscriptions/subscriptionid/resourceGroups/storageaccountresourcegroup/providers/Microsoft.Storage/storageAccounts/storageaccountname
123121
```
124122

125-
>[!Note]
126-
>Don't initiate backup configuration before enabling the feature flag.
127123

128-
## Enable Trusted Access
124+
## Trusted Access related operations
129125

130126
To enable Trusted Access between Backup vault and AKS cluster, use the following Azure CLI command:
131127

articles/backup/azure-kubernetes-service-cluster-restore.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Restore Azure Kubernetes Service (AKS) using Azure Backup
33
description: This article explains how to restore backed-up Azure Kubernetes Service (AKS) using Azure Backup.
44
ms.topic: how-to
55
ms.service: backup
6-
ms.date: 03/03/2023
6+
ms.date: 03/27/2023
77
author: jyothisuri
88
ms.author: jsuri
99
---
@@ -18,7 +18,7 @@ Azure Backup now allows you to back up AKS clusters (cluster resources and persi
1818

1919
- AKS backup allows you to restore to original AKS cluster (that was backed up) and to an alternate AKS cluster. AKS backup allows you to perform a full restore and item-level restore. You can utilize [restore configurations](#restore-configurations) to define parameters based on the cluster resources that will be picked up during the restore.
2020

21-
- You must [install the Backup Extension](azure-kubernetes-service-cluster-manage-backups.md#install-backup-extension) in the target AKS cluster. Also, you must [enable Trusted Access](azure-kubernetes-service-cluster-manage-backups.md#enable-trusted-access) between the Backup vault and the AKS cluster.
21+
- You must [install the Backup Extension](azure-kubernetes-service-cluster-manage-backups.md#install-backup-extension) in the target AKS cluster. Also, you must [enable Trusted Access](azure-kubernetes-service-cluster-manage-backups.md#register-the-trusted-access) between the Backup vault and the AKS cluster.
2222

2323
For more information on the limitations and supported scenarios, see the [support matrix](azure-kubernetes-service-cluster-backup-support-matrix.md).
2424

0 commit comments

Comments
 (0)