Skip to content

Commit 94137e0

Browse files
author
AbhishekMallick01
committed
AKS post-release updates
1 parent 138d87e commit 94137e0

4 files changed

+105
-43
lines changed

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

Lines changed: 19 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Azure Kubernetes Service backup - Overview
33
description: This article gives you an understanding about Azure Kubernetes Service (AKS) backup, the cloud-native process to back up and restore the containerized applications and data running in AKS clusters.
44
ms.topic: conceptual
55
ms.service: backup
6-
ms.date: 03/14/2023
6+
ms.date: 03/17/2023
77
author: jyothisuri
88
ms.author: jsuri
99
---
@@ -12,30 +12,38 @@ ms.author: jsuri
1212

1313
[Azure Kubernetes Service (AKS)](../aks/intro-kubernetes.md) backup is a simple, cloud-native process to back up and restore the containerized applications and data running in AKS clusters. You can configure scheduled backup for cluster state and application data (persistent volumes - CSI driver-based Azure Disks). The solution provides granular control to choose a specific namespace or an entire cluster to back up or restore by storing backups locally in a blob container and as disk snapshots. With AKS backup, you can unlock end-to-end scenarios - operational recovery, cloning developer/test environments, or cluster upgrade scenarios.
1414

15-
AKS backup integrates with Backup center (with other backup management capabilities) to provide a single pane of glass that helps you govern, monitor, operate, and analyze backups at scale.
15+
AKS backup integrates with Backup center, providing a single pane of glass that can help you govern, monitor, operate, and analyze backups at scale. Your backups are also available in the *AKS portal* under the **Settings** section.
1616

1717
## How does AKS backup work?
1818

19-
AKS backup enables you to back up your Kubernetes workloads and persistent volumes deployed in AKS clusters. The solution requires a [**Backup Extension**](../azure-arc/kubernetes/conceptual-extensions.md) to be installed in the AKS cluster. Backup vault communicates to the Backup Extension to perform backup and restore related operations. You can configure scheduled backups for your clusters as per your backup policy and can restore the backups to the original or an alternate cluster within the same subscription and region. The extension also allows you to enable granular controls to choose a specific namespace or an entire cluster as a backup/restore configuration while performing the specific operation.
19+
AKS Backup enables you to back up your Kubernetes workloads and Persistent Volumes deployed in AKS clusters. The solution requires a [**Backup Extension**](/azure/azure-arc/kubernetes/conceptual-extensions) to be installed inside the AKS cluster and Backup Vault communicates to the Extension to perform backup and restore related operations. **Backup Extension** is mandatory to be installed inside AKS cluster to enable backup and restore. As part of installation, a storage account and a blob container is to be provided in input where backups will be stored.
20+
21+
Along with Backup Extension, a *User Identity* is created in the AKS cluster's Managed Resource Group (called Extension Identity). This extension identity gets the *Storage Account Contributor* role assigned to it on the storage account where backups are stored in a blob container.
22+
23+
To support Public, Private, and Authorized IP based clusters, AKS backup requires *Trusted Access* to be enabled between *Backup vault* and *AKS cluster*. Trusted Access allows Backup vault to access the AKS clusters as specific permissions assigned to it related to the *Backup operations*. For more information on AKS Trusted Access, see [Enable Azure resources to access Azure Kubernetes Service (AKS) clusters using Trusted Access](../aks/trusted-access-feature.md).
2024

2125
>[!Note]
22-
>- You must install Backup Extension in the AKS cluster to enable backups and restores. With the extension installation, a User Identity is created in the AKS cluster's managed resource group (Extension Identity), which gets assigned a set of permissions to access the storage account with the backups stored in the blob container.
23-
>
24-
>- An AKS cluster can have only one Backup Extension installed at a time.
25-
>
26-
>- Currently, AKS backup allows storing backups in Operational Tier. Operational Tier is a local data store and backups aren't moved to a vault but are stored in your own tenant. However, the Backup vault still serves as the unit for managing backups.
26+
>AKS backup currently allows storing backups in *Operational Tier*. Operational Tier is a local data store and backups aren't moved to a vault, but are stored in your own tenant. However, the Backup vault still serves as the unit of managing backups.
2727
28-
The backup solution enables backups for your Kubernetes workloads deployed in the cluster and the data stored in the persistent volume. Currently, the solution only supports persistent volumes of CSI driver-based Azure Disks. During backups, other *PV* types (such as File Share and Blobs) are skipped by the solution. The Kubernetes workloads are stored in a blob container and the Disk-based persistent volumes are backed up as Disk snapshots.
28+
Once *Backup Extension* is installed and *Trusted Access* is enabled, you can configure scheduled backups for the clusters as per your backup policy, and can restore the backups to the original or an alternate cluster in the same subscription and region. AKS backup allows you to enable granular controls to choose a specific *namespace* or an *entire cluster* as a backup/restore configuration while performing the specific operation.
29+
30+
The *backup solution* enables backup operation for your Kubernetes workloads deployed in the cluster and the data stored in the *Persistent Volume*. The Kubernetes workloads are stored in a blob container and the *Disk-based Persistent Volumes* are backed up as *Disk Snapshots* in a Snapshot Resource Group
31+
32+
>[!Note]
33+
>Currently, the solution only supports Persistent Volumes of CSI Driver-based Azure Disks. During backups, other Persistent Volume types (File Share, Blobs) are skipped by the solution.
2934
3035
## Backup
3136

3237
To configure backup for AKS cluster, first you need to create a *Backup vault*. The vault gives you a consolidated view of the backups configured across different workloads. AKS backup supports only Operational Tier backup.
33-
Note: Copying backups to the Vault Tier is currently not supported. So, the Backup vault storage redundancy setting (LRS/GRS) doesn't apply to the backups stored in Operational Tier.
38+
39+
>[!Note]
40+
>- The Backup vault and the AKS cluster to be backed up or restored should be in the same region and subscription.
41+
>- Copying backups to the *Vault Tier* is currently not supported. So, the *Backup vault storage redundancy* setting (LRS/GRS) doesn't apply to the backups stored in Operational Tier.
3442
3543
AKS backup automatically triggers scheduled backup job that copies the cluster resources to a blob container and creates an incremental snapshot of the disk-based persistent volumes as per the backup frequency. Older backups are deleted as per the retention duration specified by the backup policy.
3644

3745
>[!Note]
38-
>AKS backup allows creating multiple backup instances for a single AKS cluster. You can create multiple backup Instances with different backup configurations, as required. However, each backup instance of an AKS cluster should be created with a different backup policy, either in the same or in a different Backup vault.
46+
>AKS backup allows creating multiple backup instances for a single AKS cluster with different backup configurations, as required. However, each backup instance of an AKS cluster should be created either in a different Backup vault or with a different backup policy in the same Backup vault.
3947
4048
## Backup management
4149

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

Lines changed: 13 additions & 2 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/14/2023
6+
ms.date: 03/17/2023
77
author: jyothisuri
88
ms.author: jsuri
99
---
@@ -24,6 +24,10 @@ 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).
28+
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).
30+
2731
Learn [how to manage the operation to install Backup Extension using Azure CLI](azure-kubernetes-service-cluster-manage-backups.md#manage-operations).
2832

2933
## Trusted Access
@@ -34,6 +38,8 @@ Your Azure resources access AKS clusters through the AKS regional gateway using
3438

3539
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.
3640

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).
42+
3743
Learn [how to enable Trusted Access](azure-kubernetes-service-cluster-manage-backups.md#enable-trusted-access).
3844

3945
## AKS Cluster
@@ -55,6 +61,11 @@ To enable backup for an AKS cluster, see the following prerequisites: .
5561
5662
- The Backup Extension during installation fetches Container Images stored in Microsoft Container Registry (MCR). If you enable a firewall on the AKS cluster, the extension installation process might fail due to access issues on the Registry. Learn [how to allow MCR access from the firewall](../container-registry/container-registry-firewall-access-rules.md#configure-client-firewall-rules-for-mcr).
5763

64+
- Install Backup Extension on the AKS clusters following the [required FQDN/application rules](../aks/limit-egress-traffic.md#required-fqdn--application-rules-6).
65+
66+
- If you've any previous installation of *Velero* in the AKS cluster, you need to delete it before installing Backup Extension.
67+
68+
5869
## Required roles and permissions
5970

6071
To perform AKS backup and restore operations as a user, you need to have specific roles on the AKS cluster, Backup vault, Storage account, and Snapshot resource group.
@@ -75,7 +86,7 @@ Also, as part of the backup and restore operations, the following roles are assi
7586
| --- | --- | --- | --- |
7687
| Reader | Backup vault | AKS cluster | Allows the Backup vault to perform *List* and *Read* operations on AKS cluster. |
7788
| Reader | Backup vault | Snapshot resource group | Allows the Backup vault to perform *List* and *Read* operations on snapshot resource group. |
78-
| Disk Snapshot Contributor | AKS cluster | Snapshot resource group | Allows AKS cluster to store persistent volume snapshots in the resource group. |
89+
| Contributor | AKS cluster | Snapshot resource group | Allows AKS cluster to store persistent volume snapshots in the resource group. |
7990
| Storage Account Contributor | Extension Identity | Storage account | Allows Backup Extension to store cluster resource backups in the blob container. |
8091

8192
>[!Note]

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

Lines changed: 8 additions & 29 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/15/2023
6+
ms.date: 03/17/2023
77
author: jyothisuri
88
ms.author: jsuri
99
---
@@ -91,46 +91,25 @@ To configure backups for AKS cluster, follow these steps:
9191

9292
6. In the *context* pane, provide the *storage account* and *blob container* where you need to store the backup, and then select **Generate Command**.
9393

94-
>[!Note]
95-
>Before you install the AKS Backup Extension via *Azure CLI*, you must enable the `Microsoft.KubernetesConfiguration` resource provider on the subscription.
96-
>
97-
>To register the resource provider before the extension installation (don't initiate extension installation before registering resource provider), run the following commands:
98-
>
99-
>1. Register the resource provider.
100-
> `az provider register --namespace Microsoft.KubernetesConfiguration`
101-
>2. Monitor the registration process. The registration may take up to *10 minutes*.
102-
> `az provider show -n Microsoft.KubernetesConfiguration -o table`
103-
104-
7. Open the PowerShell console, and then upgrade the CLI to version *2.24.0* or later using the command `az upgrade`.
105-
106-
Sign in to the Azure portal (using the command `az login`), and then copy and run the generated commands.
107-
108-
The commands install the *Backup Extension* and *Assign Extension* managed identity permissions on the storage account.
109-
110-
Once done, select **Revalidate**.
111-
112-
>[!Note]
113-
>We're using the Extension managed identity attached to the underlying compute of the AKS cluster. After running the `az role assignment` command, it may take some time (up to *1 hour*) to propagate permission to the AKS cluster (due to caching issue). If revalidation fails, try again after some time.
114-
115-
8. To enable *Trusted Access* and *other role permissions*, select **Grant Permission** > **Next**.
94+
7. To enable *Trusted Access* and *other role permissions*, select **Grant Permission** > **Next**.
11695

117-
9. Select the backup policy that defines the schedule and retention policy for AKS backup, and then select **Next**.
96+
8. Select the backup policy that defines the schedule and retention policy for AKS backup, and then select **Next**.
11897

11998
10. Select **Add/Edit** to define the *backup instance configuration*.
12099

121-
11. In the *context* pane, enter the *cluster resources* that you want to back up.
100+
9. In the *context* pane, enter the *cluster resources* that you want to back up.
122101

123102
Learn about the [backup configurations](#backup-configurations).
124103

125-
12. Select the *snapshot resource group* where *persistent volume (Azure Disk) snapshots* need to be stored, and then select **Validate**.
104+
10. Select the *snapshot resource group* where *persistent volume (Azure Disk) snapshots* need to be stored, and then select **Validate**.
126105

127106
After validation, if the appropriate roles aren't assigned to the vault over snapshot resource group, the error **Role assignment not done** appears.
128107

129-
14. To resolve the error, select the *checkbox* corresponding to the *Datasource*, and then select **Assign Missing Role**.
108+
11. To resolve the error, select the *checkbox* corresponding to the *Datasource*, and then select **Assign Missing Role**.
130109

131-
15. Once the *role assignment* is successful, select **Next**.
110+
12. Once the *role assignment* is successful, select **Next**.
132111

133-
16. Select **Configure Backup**.
112+
13. Select **Configure Backup**.
134113

135114
Once the configuration is complete, the **Backup Instance** gets created.
136115

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

Lines changed: 65 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ 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/15/2023
6+
ms.date: 03/17/2023
77
author: jyothisuri
88
ms.author: jsuri
99
---
@@ -18,6 +18,25 @@ Azure Backup now allows you to back up AKS clusters (cluster resources and persi
1818

1919
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.
2020

21+
## Register the resource provider
22+
23+
To register the resource provider, run the following command:
24+
25+
```azurecli-interactive
26+
az provider register --namespace Microsoft.KubernetesConfiguration
27+
```
28+
29+
>[!Note]
30+
>Don't initiate extension installation before registering resource provider.
31+
32+
### Monitor the registration process
33+
34+
The registration may take up to *10 minutes*. To monitor the registration process, run the following command:
35+
36+
```azurecli-interactive
37+
az provider show -n Microsoft.KubernetesConfiguration -o table
38+
```
39+
2140
### Install Backup Extension
2241

2342
To install the Backup Extension, use the following command:
@@ -53,6 +72,51 @@ To view the progress of Backup Extension installation, use the following command
5372
az k8s-extension show --name azure-aks-backup --cluster-type managedClusters --cluster-name aksclustername --resource-group aksclusterrg
5473
```
5574

75+
## Enable the feature flag
76+
77+
To enable the feature flag follow these steps:
78+
79+
1. To install the *aks-preview* extension, run the following command:
80+
81+
```azurecli-interactive
82+
az extension add --name aks-preview
83+
```
84+
85+
1. To update to the latest version of the extension released, run the following command:
86+
87+
```azurecli-interactive
88+
az extension update --name aks-preview
89+
```
90+
91+
1. To register the *TrustedAccessPreview* feature flag, run the `az feature register` command.
92+
93+
**Eexample**
94+
95+
```azurecli-interactive
96+
az feature register --namespace "Microsoft.ContainerService" --name "TrustedAccessPreview"
97+
```
98+
99+
It takes a few minutes for the status to show Registered.
100+
101+
1. To verify the registration status, run the `az feature show` command.
102+
103+
**Eexample**
104+
105+
```azurecli-interactive
106+
az feature show --namespace "Microsoft.ContainerService" --name "TrustedAccessPreview"
107+
```
108+
109+
1. When the status shows as **Registered**, run the `az provider register` command to refresh the `Microsoft.ContainerService` resource provider registration.
110+
111+
**Example**
112+
113+
```azurecli-interactive
114+
az provider register --namespace Microsoft.ContainerService
115+
```
116+
117+
>[!Note]
118+
>Don't initiate backup configuration before enabling the feature flag.
119+
56120
## Enable Trusted Access
57121

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

0 commit comments

Comments
 (0)