You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/aks/dapr-overview.md
+10-1Lines changed: 10 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,7 +3,7 @@ title: Dapr extension for Azure Kubernetes Service (AKS) overview
3
3
description: Learn more about using Dapr on your Azure Kubernetes Service (AKS) cluster to develop applications.
4
4
ms.author: nickoman
5
5
ms.topic: article
6
-
ms.date: 07/07/2023
6
+
ms.date: 03/28/2024
7
7
---
8
8
9
9
# Dapr
@@ -21,6 +21,14 @@ Dapr is incrementally adoptable. You can use any of the API building blocks as n
21
21
22
22
## Capabilities and features
23
23
24
+
[Using the Dapr extension to provision Dapr on your AKS or Arc-enabled Kubernetes cluster](../azure-arc/kubernetes/conceptual-extensions.md) eliminates the overhead of:
25
+
- Downloading Dapr tooling
26
+
- Manually installing and managing the Dapr runtime on your AKS cluster
27
+
28
+
[You can install, deploy, and configure the Dapr extension on your cluster using either the Azure CLI or a Bicep template.](./dapr.md)
29
+
30
+
Additionally, the extension offers support for all [native Dapr configuration capabilities][dapr-configuration-options] through simple command-line arguments.
31
+
24
32
Dapr provides the following set of capabilities to help with your microservice development on AKS:
25
33
26
34
- Easy provisioning of Dapr on AKS through [cluster extensions][cluster-extensions].
@@ -98,6 +106,7 @@ After learning about Dapr and some of the challenges it solves, try [Deploying a
# Configure the Dapr extension for your Azure Kubernetes Service (AKS) and Arc-enabled Kubernetes project
@@ -17,7 +17,13 @@ Once you've [created the Dapr extension](./dapr.md), you can configure the [Dapr
17
17
- Setting automatic CRD updates
18
18
- Configuring the Dapr release namespace
19
19
20
-
The extension enables you to set Dapr configuration options by using the `--configuration-settings` parameter. For example, to provision Dapr with high availability (HA) enabled, set the `global.ha.enabled` parameter to `true`:
20
+
The extension enables you to set Dapr configuration options by using the `--configuration-settings` parameter in the Azure CLI or `configurationSettings` property in a Bicep template.
21
+
22
+
## Provision Dapr with high availability (HA) enabled
23
+
24
+
Provision Dapr with high availability (HA) enabled by setting the `global.ha.enabled` parameter to `true`.
25
+
26
+
# [Azure CLI](#tab/cli)
21
27
22
28
```azurecli
23
29
az k8s-extension create --cluster-type managedClusters \
@@ -31,7 +37,22 @@ az k8s-extension create --cluster-type managedClusters \
31
37
```
32
38
33
39
> [!NOTE]
34
-
> If configuration settings are sensitive and need to be protected, for example cert related information, pass the `--configuration-protected-settings` parameter and the value will be protected from being read.
40
+
> If configuration settings are sensitive and need to be protected (for example, cert-related information), pass the `--configuration-protected-settings` parameter and the value will be protected from being read.
41
+
42
+
# [Bicep](#tab/bicep)
43
+
44
+
```bicep
45
+
properties: {
46
+
configurationSettings: {
47
+
'global.ha.enabled': true
48
+
}
49
+
}
50
+
```
51
+
52
+
> [!NOTE]
53
+
> If configuration settings are sensitive and need to be protected (for example, cert-related information), use the `configurationProtectedSettings` property and the value will be protected from being read.
54
+
55
+
---
35
56
36
57
If no configuration-settings are passed, the Dapr configuration defaults to:
37
58
@@ -55,7 +76,9 @@ For a list of available options, see [Dapr configuration][dapr-configuration-opt
55
76
56
77
## Limit the extension to certain nodes
57
78
58
-
In some configurations, you may only want to run Dapr on certain nodes. You can limit the extension by passing a `nodeSelector` in the extension configuration. If the desired `nodeSelector` contains `.`, you must escape them from the shell and the extension. For example, the following configuration will install Dapr to only nodes with `topology.kubernetes.io/zone: "us-east-1c"`:
79
+
In some configurations, you may only want to run Dapr on certain nodes. You can limit the extension by passing a `nodeSelector` in the extension configuration. If the desired `nodeSelector` contains `.`, you must escape them from the shell and the extension. For example, the following configuration installs Dapr only to nodes with `topology.kubernetes.io/zone: "us-east-1c"`:
80
+
81
+
# [Azure CLI](#tab/cli)
59
82
60
83
```azurecli
61
84
az k8s-extension create --cluster-type managedClusters \
@@ -84,9 +107,37 @@ az k8s-extension create --cluster-type managedClusters \
For managing OS and architecture, use the [supported versions](https://github.com/dapr/dapr/blob/b8ae13bf3f0a84c25051fcdacbfd8ac8e32695df/docker/docker.mk#L50) of the `global.daprControlPlaneOs` and `global.daprControlPlaneArch` configuration:
124
+
125
+
```bicep
126
+
properties: {
127
+
configurationSettings: {
128
+
'global.clusterType': 'managedclusters'
129
+
'global.ha.enabled': true
130
+
'global.daprControlPlaneOs': 'linux'
131
+
'global.daprControlPlaneArch': 'amd64'
132
+
}
133
+
}
134
+
```
135
+
136
+
---
137
+
87
138
## Install Dapr in multiple availability zones while in HA mode
88
139
89
-
By default, the placement service uses a storage class of type `standard_LRS`. It is recommended to create a `zone redundant storage class` while installing Dapr in HA mode across multiple availability zones. For example, to create a `zrs` type storage class:
140
+
By default, the placement service uses a storage class of type `standard_LRS`. It is recommended to create a **zone redundant storage class** while installing Dapr in HA mode across multiple availability zones. For example, to create a `zrs` type storage class, add the `storageaccounttype` parameter:
90
141
91
142
```yaml
92
143
kind: StorageClass
@@ -101,7 +152,9 @@ parameters:
101
152
storageaccounttype: Premium_ZRS
102
153
```
103
154
104
-
When installing Dapr, use the above storage class:
155
+
When installing Dapr, use the storage class you used in the YAML file:
156
+
157
+
# [Azure CLI](#tab/cli)
105
158
106
159
```azurecli
107
160
az k8s-extension create --cluster-type managedClusters
@@ -114,9 +167,26 @@ az k8s-extension create --cluster-type managedClusters
You can configure the release namespace. The Dapr extension gets installed in the `dapr-system` namespace by default. To override it, use `--release-namespace`. Include the cluster `--scope` to redefine the namespace.
185
+
You can configure the release namespace.
186
+
187
+
# [Azure CLI](#tab/cli)
188
+
189
+
The Dapr extension gets installed in the `dapr-system` namespace by default. To override it, use `--release-namespace`. Include the cluster `--scope` to redefine the namespace.
120
190
121
191
```azurecli
122
192
az k8s-extension create \
@@ -132,6 +202,22 @@ az k8s-extension create \
132
202
--release-namespace dapr-custom
133
203
```
134
204
205
+
# [Bicep](#tab/bicep)
206
+
207
+
The Dapr extension gets installed in the `dapr-system` namespace by default. To override it, use `releaseNamespace` in the cluster `scope` to redefine the namespace.
208
+
209
+
```bicep
210
+
properties: {
211
+
scope: {
212
+
cluster: {
213
+
releaseNamespace: 'dapr-custom'
214
+
}
215
+
}
216
+
}
217
+
```
218
+
219
+
---
220
+
135
221
[Learn how to configure the Dapr release namespace if you already have Dapr installed](./dapr-migration.md).
136
222
137
223
## Show current configuration settings
@@ -192,6 +278,8 @@ If you want to use an outbound proxy with the Dapr extension for AKS, you can do
192
278
193
279
## Updating your Dapr installation version
194
280
281
+
# [Azure CLI](#tab/cli)
282
+
195
283
If you are on a specific Dapr version and you don't have `--auto-upgrade-minor-version` available, you can use the following command to upgrade or downgrade Dapr:
196
284
197
285
```azurecli
@@ -202,6 +290,18 @@ az k8s-extension update --cluster-type managedClusters \
202
290
--version 1.12.0 # Version to upgrade or downgrade to
203
291
```
204
292
293
+
# [Bicep](#tab/bicep)
294
+
295
+
If you are on a specific Dapr version and you don't have `autoUpgradeMinorVersion` available, you can use the following Bicep property to upgrade or downgrade Dapr:
296
+
297
+
```bicep
298
+
properties: {
299
+
version: '1.12.0'
300
+
}
301
+
```
302
+
303
+
---
304
+
205
305
The preceding command updates the Dapr control plane *only.* To update the Dapr sidecars, restart your application deployments:
From Dapr version 1.8.0, you can use Azure Linux images with the Dapr extension. To use them, set the`global.tag` flag:
313
+
From Dapr version 1.8.0, you can use Azure Linux images with the Dapr extension. To use them, set the `global.tag` flag:
314
+
315
+
# [Azure CLI](#tab/cli)
214
316
215
317
```azurecli
216
318
az k8s-extension update --cluster-type managedClusters \
@@ -220,13 +322,25 @@ az k8s-extension update --cluster-type managedClusters \
220
322
--set global.tag=1.10.0-mariner
221
323
```
222
324
325
+
# [Bicep](#tab/bicep)
326
+
327
+
```bicep
328
+
properties: {
329
+
global.tag: '1.10.0-mariner'
330
+
}
331
+
```
332
+
333
+
---
334
+
223
335
- [Learn more about using Mariner-based images with Dapr][dapr-mariner].
224
-
- [Learn more about deploying AzureLinux on AKS][aks-azurelinux].
336
+
- [Learn more about deploying Azure Linux on AKS][aks-azurelinux].
225
337
226
338
227
339
## Disable automatic CRD updates
228
340
229
-
With Dapr version 1.9.2, CRDs are automatically upgraded when the extension upgrades. To disable this setting, you can set `hooks.applyCrds` to `false`.
341
+
From Dapr version 1.9.2, CRDs are automatically upgraded when the extension upgrades. To disable this setting, you can set `hooks.applyCrds` to `false`.
342
+
343
+
# [Azure CLI](#tab/cli)
230
344
231
345
```azurecli
232
346
az k8s-extension update --cluster-type managedClusters \
@@ -236,6 +350,18 @@ az k8s-extension update --cluster-type managedClusters \
236
350
--configuration-settings "hooks.applyCrds=false"
237
351
```
238
352
353
+
# [Bicep](#tab/bicep)
354
+
355
+
```bicep
356
+
properties: {
357
+
configurationSettings: {
358
+
'hooks.applyCrds': false
359
+
}
360
+
}
361
+
```
362
+
363
+
---
364
+
239
365
> [!NOTE]
240
366
> CRDs are only applied in case of upgrades and are skipped during downgrades.
0 commit comments