Skip to content

Commit a94c0d2

Browse files
Merge pull request #252924 from schaffererin/daprmigrationfreshness
Freshness pass: Migrate from Dapr OSS to the Dapr extension for AKS
2 parents 31e96c4 + 80503eb commit a94c0d2

File tree

1 file changed

+44
-50
lines changed

1 file changed

+44
-50
lines changed

articles/aks/dapr-migration.md

Lines changed: 44 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -1,85 +1,79 @@
11
---
22
title: Migrate from Dapr OSS to the Dapr extension for Azure Kubernetes Service (AKS)
3-
description: Learn how to migrate your managed clusters from Dapr OSS to the Dapr extension for AKS
3+
description: Learn how to migrate your managed clusters from Dapr OSS to the Dapr extension for Azure Kubernetes Service (AKS).
44
author: hhunter-ms
55
ms.author: hannahhunter
66
ms.reviewer: nigreenf
77
ms.topic: article
8-
ms.date: 11/21/2022
8+
ms.date: 09/26/2023
99
ms.custom: devx-track-azurecli
1010
---
1111

1212
# Migrate from Dapr OSS to the Dapr extension for Azure Kubernetes Service (AKS)
1313

14-
You've installed and configured Dapr OSS (using Dapr CLI or Helm) on your Kubernetes cluster, and want to start using the Dapr extension on AKS. In this guide, you'll learn how the Dapr extension for AKS can use the Kubernetes resources created by Dapr OSS and start managing them, by either:
14+
This article shows you how to migrate from Dapr OSS to the Dapr extension for AKS.
1515

16-
- Checking for an existing Dapr installation via Azure CLI prompts (default method), or
17-
- Using the release name and namespace from `--configuration-settings` to explicitly point to an existing Dapr installation.
16+
You can configure the Dapr extension to use and manage the Kubernetes resources created by Dapr OSS by [checking for an existing Dapr installation using the Azure CLI](#check-for-an-existing-dapr-installation) (*default method*) or [configuring the existing Dapr installation using `--configuration-settings`](#configure-the-existing-dapr-installation-using---configuration-settings).
17+
18+
For more information, see [Dapr extension for AKS][dapr-extension-aks].
1819

1920
## Check for an existing Dapr installation
2021

21-
The Dapr extension, by default, checks for existing Dapr installations when you run the `az k8s-extension create` command. To list the details of your current Dapr installation, run the following command and save the Dapr release name and namespace:
22+
When you [create the Dapr extension](./dapr.md), the extension checks for an existing Dapr installation on your cluster. If Dapr exists, the extension uses and manages the Kubernetes resources created by Dapr OSS.
2223

23-
```bash
24-
helm list -A
25-
```
24+
1. List the details of your current Dapr installation using the `helm list -A` command and save the Dapr release name and namespace from the output.
2625

27-
When [installing the extension][dapr-create], you'll receive a prompt asking if Dapr is already installed:
26+
```azurecli-interactive
27+
helm list -A
28+
```
2829
29-
```bash
30-
Is Dapr already installed in the cluster? (y/N): y
31-
```
30+
2. Enter the Helm release name and namespace (from `helm list -A`) when prompted with the following questions:
3231
33-
If Dapr is already installed, please enter the Helm release name and namespace (from `helm list -A`) when prompted the following:
32+
```azurecli-interactive
33+
Enter the Helm release name for Dapr, or press Enter to use the default name [dapr]:
34+
Enter the namespace where Dapr is installed, or press Enter to use the default namespace [dapr-system]:
35+
```
3436
35-
```bash
36-
Enter the Helm release name for Dapr, or press Enter to use the default name [dapr]:
37-
Enter the namespace where Dapr is installed, or press Enter to use the default namespace [dapr-system]:
38-
```
37+
## Configure the existing Dapr installation using `--configuration-settings`
3938
40-
## Configuring the existing Dapr installation using `--configuration-settings`
39+
When you [create the Dapr extension](./dapr.md), you can configure the extension to use and manage the Kubernetes resources created by Dapr OSS using the `--configuration-settings` flag.
4140
42-
Alternatively, when creating the Dapr extension, you can configure the above settings via `--configuration-settings`. This method is useful when you are automating the installation via bash scripts, CI pipelines, etc.
41+
1. List the details of your current Dapr installation using the `helm list -A` command and save the Dapr release name and namespace from the output.
4342
44-
If you don't have an existing Dapr installation on your cluster, set `skipExistingDaprCheck` to `true`:
43+
```azurecli-interactive
44+
helm list -A
45+
```
4546
46-
```azurecli-interactive
47-
az k8s-extension create --cluster-type managedClusters \
48-
--cluster-name myAKScluster \
49-
--resource-group myResourceGroup \
50-
--name dapr \
51-
--extension-type Microsoft.Dapr \
52-
--configuration-settings "skipExistingDaprCheck=true"
53-
```
47+
2. Create the Dapr extension using the [`az k8s-extension create`][az-k8s-extension-create] and use the `--configuration-settings` flags to set the Dapr release name and namespace.
5448
55-
If Dapr exists on your cluster, set the Helm release name and namespace (from `helm list -A`) via `--configuration-settings`:
56-
57-
```azurecli-interactive
58-
az k8s-extension create --cluster-type managedClusters \
59-
--cluster-name myAKScluster \
60-
--resource-group myResourceGroup \
61-
--name dapr \
62-
--extension-type Microsoft.Dapr \
63-
--configuration-settings "existingDaprReleaseName=dapr" \
64-
--configuration-settings "existingDaprReleaseNamespace=dapr-system"
65-
```
49+
```azurecli-interactive
50+
az k8s-extension create --cluster-type managedClusters \
51+
--cluster-name myAKSCluster \
52+
--resource-group myResourceGroup \
53+
--name dapr \
54+
--extension-type Microsoft.Dapr \
55+
--configuration-settings "existingDaprReleaseName=dapr" \
56+
--configuration-settings "existingDaprReleaseNamespace=dapr-system"
57+
```
6658
6759
## Update HA mode or placement service settings
6860
69-
When you install the Dapr extension on top of an existing Dapr installation, you'll see the following prompt:
61+
When installing the Dapr extension on top of an existing Dapr installation, you receive the following message:
7062
71-
> ```The extension will be installed on your existing Dapr installation. Note, if you have updated the default values for global.ha.* or dapr_placement.* in your existing Dapr installation, you must provide them in the configuration settings. Failing to do so will result in an error, since Helm upgrade will try to modify the StatefulSet. See <link> for more information.```
63+
```output
64+
The extension will be installed on your existing Dapr installation. Note, if you have updated the default values for global.ha.* or dapr_placement.* in your existing Dapr installation, you must provide them in the configuration settings. Failing to do so will result in an error, since Helm upgrade will try to modify the StatefulSet. See <link> for more information.
65+
```
7266

73-
Kubernetes only allows for limited fields in StatefulSets to be patched, subsequently failing upgrade of the placement service if any of the mentioned settings are configured. You can follow the steps below to update those settings:
67+
Kubernetes only allows patching for limited fields in StatefulSets. If any of the HA mode or placement service settings are configured, the upgrade fails. To update the HA mode or placement service settings, you must delete the stateful set and then update the HA mode.
7468

75-
1. Delete the stateful set.
69+
1. Delete the stateful set using the `kubectl delete` command.
7670

7771
```azurecli-interactive
7872
kubectl delete statefulset.apps/dapr-placement-server -n dapr-system
7973
```
8074

81-
1. Update the HA mode:
82-
75+
2. Update the HA mode using the [`az k8s-extension update`][az-k8s-extension-update] command.
76+
8377
```azurecli-interactive
8478
az k8s-extension update --cluster-type managedClusters \
8579
--cluster-name myAKSCluster \
@@ -90,18 +84,18 @@ Kubernetes only allows for limited fields in StatefulSets to be patched, subsequ
9084
--configuration-settings "global.ha.enabled=true" \
9185
```
9286

93-
For more information, see [Dapr Production Guidelines][dapr-prod-guidelines].
94-
87+
For more information, see the [Dapr production guidelines][dapr-prod-guidelines].
9588

9689
## Next steps
9790

9891
Learn more about [Dapr][dapr-overview] and [how to use it][dapr-howto].
9992

100-
10193
<!-- LINKS INTERNAL -->
10294
[dapr-overview]: ./dapr-overview.md
10395
[dapr-howto]: ./dapr.md
104-
[dapr-create]: ./dapr.md#create-the-extension-and-install-dapr-on-your-aks-or-arc-enabled-kubernetes-cluster
96+
[dapr-extension-aks]: ./dapr-overview.md
97+
[az-k8s-extension-create]: /cli/azure/k8s-extension#az-k8s-extension-create
98+
[az-k8s-extension-update]: /cli/azure/k8s-extension#az-k8s-extension-update
10599

106100
<!-- LINKS EXTERNAL -->
107101
[dapr-prod-guidelines]: https://docs.dapr.io/operations/hosting/kubernetes/kubernetes-production/#enabling-high-availability-in-an-existing-dapr-deployment

0 commit comments

Comments
 (0)