Skip to content

Commit e8e4794

Browse files
authored
Merge pull request #210591 from hhunter-ms/hh-1983877
[Dapr/AKS] Troubleshooting guide for Dapr extension
2 parents 83583ef + 0ae4ae6 commit e8e4794

File tree

3 files changed

+102
-19
lines changed

3 files changed

+102
-19
lines changed

articles/aks/TOC.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -471,6 +471,8 @@
471471
href: dapr.md
472472
- name: Migrate from Dapr OSS
473473
href: dapr-migration.md
474+
- name: Troubleshoot the Dapr extension
475+
href: dapr-troubleshooting.md
474476
- name: Use GitOps
475477
href: ../azure-arc/kubernetes/tutorial-use-gitops-flux2.md
476478
maintainContext: true

articles/aks/dapr-troubleshooting.md

Lines changed: 99 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,99 @@
1+
---
2+
title: Troubleshoot Dapr extension installation errors
3+
description: Troubleshoot errors you may encounter while installing the Dapr extension for AKS or Arc for Kubernetes
4+
author: hhunter-ms
5+
ms.author: hannahhunter
6+
ms.reviewer: nigreenf
7+
ms.service: container-service
8+
ms.topic: article
9+
ms.date: 09/15/2022
10+
ms.custom: devx-track-azurecli
11+
---
12+
13+
# Troubleshoot Dapr extension installation errors
14+
15+
This article details some common error messages you may encounter while installing the Dapr extension for Azure Kubernetes Service (AKS) or Arc for Kubernetes.
16+
17+
## Installation failure without an error message
18+
19+
If the extension fails to create or update without an error message, you can inspect where the creation of the extension failed by running the `az k8s-extension list` command. For example, if a wrong key is used in the configuration-settings, such as `global.ha=false` instead of `global.ha.enabled=false`:
20+
21+
```azure-cli-interactive
22+
az k8s-extension list --cluster-type managedClusters --cluster-name myCluster --resource-group myResourceGroup
23+
```
24+
25+
The below JSON is returned, and the error message is captured in the `message` property.
26+
27+
```json
28+
"statuses": [
29+
{
30+
"code": "InstallationFailed",
31+
"displayStatus": null,
32+
"level": null,
33+
"message": "Error: {failed to install chart from path [] for release [dapr-1]: err [template: dapr/charts/dapr_sidecar_injector/templates/dapr_sidecar_injector_poddisruptionbudget.yaml:1:17: executing \"dapr/charts/dapr_sidecar_injector/templates/dapr_sidecar_injector_poddisruptionbudget.yaml\" at <.Values.global.ha.enabled>: can't evaluate field enabled in type interface {}]} occurred while doing the operation : {Installing the extension} on the config",
34+
"time": null
35+
}
36+
],
37+
```
38+
39+
Another example:
40+
41+
```azurecli
42+
az k8s-extension list --cluster-type managedClusters --cluster-name myCluster --resource-group myResourceGroup
43+
```
44+
45+
```json
46+
"statuses": [
47+
{
48+
"code": "InstallationFailed",
49+
"displayStatus": null,
50+
"level": null,
51+
"message": "The extension operation failed with the following error: unable to add the configuration with configId {extension:microsoft-dapr} due to error: {error while adding the CRD configuration: error {failed to get the immutable configMap from the elevated namespace with err: configmaps 'extension-immutable-values' not found }}. (Code: ExtensionOperationFailed)",
52+
"time": null
53+
}
54+
]
55+
```
56+
57+
For these cases, possible remediation actions are to:
58+
59+
- [Restart your AKS or Arc for Kubernetes cluster](./start-stop-cluster.md).
60+
- Make sure you've [registered the `KubernetesConfiguration` service provider](./dapr.md#register-the-kubernetesconfiguration-service-provider).
61+
- Force delete and [reinstall the Dapr extension](./dapr.md).
62+
63+
See below for examples of error messages you may encounter during Dapr extension install or update.
64+
65+
## Error: Dapr version doesn't exist
66+
67+
You're installing the Dapr extension and [targeting a specific version](./dapr.md#targeting-a-specific-dapr-version), but run into an error message saying the Dapr version doesn't exist.
68+
69+
```
70+
(ExtensionOperationFailed) The extension operation failed with the following error: Failed to resolve the extension version from the given values.
71+
Code: ExtensionOperationFailed
72+
Message: The extension operation failed with the following error: Failed to resolve the extension version from the given values.
73+
```
74+
75+
Try installing again, making sure to use a [supported version of Dapr](./dapr.md#dapr-versions).
76+
77+
## Error: Dapr version exists, but not in the mentioned region
78+
79+
Some versions of Dapr aren't available in all regions. If you receive an error message like the following, try installing in an [available region](./dapr.md#cloudsregions) where your Dapr version is supported.
80+
81+
```
82+
(ExtensionTypeRegistrationGetFailed) Extension type microsoft.dapr is not registered in region <regionname>.
83+
Code: ExtensionTypeRegistrationGetFailed
84+
Message: Extension type microsoft.dapr is not registered in region <regionname>
85+
```
86+
87+
## Error: `dapr-system` already exists
88+
89+
You're installing the Dapr extension for AKS or Arc for Kubernetes, but receive an error message indicating that Dapr already exists. This error message may look like:
90+
91+
```
92+
(ExtensionOperationFailed) The extension operation failed with the following error: Error: {failed to install chart from path [] for release [dapr-ext]: err [rendered manifests contain a resource that already exists. Unable to continue with install: ServiceAccount "dapr-operator" in namespace "dapr-system" exists and cannot be imported into the current release: invalid ownership metadata; annotation validation error: key "meta.helm.sh/release-name" must equal "dapr-ext": current value is "dapr"]} occurred while doing the operation : {Installing the extension} on the config
93+
```
94+
95+
You need to uninstall Dapr OSS before installing the Dapr extension. For more information, read [Migrate from Dapr OSS](./dapr-migration.md).
96+
97+
## Next steps
98+
99+
If you're still running into issues, explore the [AKS troubleshooting guide](./troubleshooting.md) and the [Dapr OSS troubleshooting guide](https://docs.dapr.io/operations/troubleshooting/common_issues/).

articles/aks/dapr.md

Lines changed: 1 addition & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -308,25 +308,7 @@ The Dapr extension for AKS and Arc for Kubernetes requires outbound URLs on `htt
308308

309309
## Troubleshooting extension errors
310310

311-
If the extension fails to create or update, you can inspect where the creation of the extension failed by running the `az k8s-extension list` command. For example, if a wrong key is used in the configuration-settings, such as `global.ha=false` instead of `global.ha.enabled=false`:
312-
313-
```azure-cli-interactive
314-
az k8s-extension list --cluster-type managedClusters --cluster-name myAKSCluster --resource-group myResourceGroup
315-
```
316-
317-
The below JSON is returned, and the error message is captured in the `message` property.
318-
319-
```json
320-
"statuses": [
321-
{
322-
"code": "InstallationFailed",
323-
"displayStatus": null,
324-
"level": null,
325-
"message": "Error: {failed to install chart from path [] for release [dapr-1]: err [template: dapr/charts/dapr_sidecar_injector/templates/dapr_sidecar_injector_poddisruptionbudget.yaml:1:17: executing \"dapr/charts/dapr_sidecar_injector/templates/dapr_sidecar_injector_poddisruptionbudget.yaml\" at <.Values.global.ha.enabled>: can't evaluate field enabled in type interface {}]} occurred while doing the operation : {Installing the extension} on the config",
326-
"time": null
327-
}
328-
],
329-
```
311+
If the extension fails to create or update, try suggestions and solutions in the [Dapr extension troubleshooting guide](./dapr-troubleshooting.md).
330312

331313
### Troubleshooting Dapr
332314

0 commit comments

Comments
 (0)