Azure Key Vault secret store

Detailed information on the Azure Key Vault secret store component

Component format

To setup Azure Key Vault secret store create a component of type secretstores.azure.keyvault. See this guide on how to create and apply a secretstore configuration. See this guide on referencing secrets to retrieve and use the secret with Dapr components.

See also configure the component guide in this page.

  1. apiVersion: dapr.io/v1alpha1
  2. kind: Component
  3. metadata:
  4.   name: azurekeyvault
  5.   namespace: default
  6. spec:
  7.   type: secretstores.azure.keyvault
  8.   version: v1
  9.   metadata:
  10.   - name: vaultName # Required
  11.     value: [your_keyvault_name]
  12.   - name: azureEnvironment # Optional, defaults to AZUREPUBLICCLOUD
  13.     value: "AZUREPUBLICCLOUD"
  14.   # See authentication section below for all options
  15.   - name: azureTenantId
  16.     value: "[your_service_principal_tenant_id]"
  17.   - name: azureClientId
  18.     value: "[your_service_principal_app_id]"
  19.   - name: azureCertificateFile
  20.     value : "[pfx_certificate_file_fully_qualified_local_path]"

Authenticating with Azure AD

The Azure Key Vault secret store component supports authentication with Azure AD only. Before you enable this component, make sure you’ve read the Authenticating to Azure document and created an Azure AD application (also called Service Principal). Alternatively, make sure you have created a managed identity for your application platform.

Spec metadata fields

FieldRequiredDetailsExample
vaultNameYThe name of the Azure Key Vault“mykeyvault”
azureEnvironmentNOptional name for the Azure environment if using a different Azure cloud“AZUREPUBLICCLOUD” (default value), “AZURECHINACLOUD”, “AZUREUSGOVERNMENTCLOUD”, “AZUREGERMANCLOUD”
Auth metadataSee Authenticating to Azure for more information

Additionally, you must provide the authentication fields as explained in the Authenticating to Azure document.

Example: Create an Azure Key Vault and authorize a Service Principal

Prerequisites

Make sure you have followed the steps in the Authenticating to Azure document to create an Azure AD application (also called Service Principal). You will need the following values:

  • SERVICE_PRINCIPAL_ID: the ID of the Service Principal that you created for a given application

Steps

  1. Set a variable with the Service Principal that you created:
  1. SERVICE_PRINCIPAL_ID="[your_service_principal_object_id]"
  1. Set a variable with the location where to create all resources:
  1. LOCATION="[your_location]"

(You can get the full list of options with: az account list-locations --output tsv)

  1. Create a Resource Group, giving it any name you’d like:
  1. RG_NAME="[resource_group_name]"
  2. RG_ID=$(az group create \
  3.   --name "${RG_NAME}" \
  4.   --location "${LOCATION}" \
  5.   | jq -r .id)
  1. Create an Azure Key Vault (that uses Azure RBAC for authorization):
  1. KEYVAULT_NAME="[key_vault_name]"
  2. az keyvault create \
  3.   --name "${KEYVAULT_NAME}" \
  4.   --enable-rbac-authorization true \
  5.   --resource-group "${RG_NAME}" \
  6.   --location "${LOCATION}"
  1. Using RBAC, assign a role to the Azure AD application so it can access the Key Vault.
    In this case, assign the “Key Vault Secrets User” role, which has the “Get secrets” permission over Azure Key Vault.
  1. az role assignment create \
  2.   --assignee "${SERVICE_PRINCIPAL_ID}" \
  3.   --role "Key Vault Secrets User" \
  4.   --scope "${RG_ID}/providers/Microsoft.KeyVault/vaults/${KEYVAULT_NAME}"

Other less restrictive roles like “Key Vault Secrets Officer” and “Key Vault Administrator” can be used as well, depending on your application. For more information about Azure built-in roles for Key Vault see the Microsoft docs.

Configure the component

To use a client secret, create a file called azurekeyvault.yaml in the components directory, filling in with the Azure AD application that you created following the Authenticating to Azure document:

  1. apiVersion: dapr.io/v1alpha1
  2. kind: Component
  3. metadata:
  4.   name: azurekeyvault
  5.   namespace: default
  6. spec:
  7.   type: secretstores.azure.keyvault
  8.   version: v1
  9.   metadata:
  10.   - name: vaultName
  11.     value: "[your_keyvault_name]"
  12.   - name: azureTenantId
  13.     value: "[your_tenant_id]"
  14.   - name: azureClientId
  15.     value: "[your_client_id]"
  16.   - name: azureClientSecret
  17.     value : "[your_client_secret]"

If you want to use a certificate saved on the local disk, instead, use this template, filling in with details of the Azure AD application that you created following the Authenticating to Azure document:

  1. apiVersion: dapr.io/v1alpha1
  2. kind: Component
  3. metadata:
  4.   name: azurekeyvault
  5.   namespace: default
  6. spec:
  7.   type: secretstores.azure.keyvault
  8.   version: v1
  9.   metadata:
  10.   - name: vaultName
  11.     value: "[your_keyvault_name]"
  12.   - name: azureTenantId
  13.     value: "[your_tenant_id]"
  14.   - name: azureClientId
  15.     value: "[your_client_id]"
  16.   - name: azureCertificateFile
  17.     value : "[pfx_certificate_file_fully_qualified_local_path]"

In Kubernetes, you store the client secret or the certificate into the Kubernetes Secret Store and then refer to those in the YAML file. You will need the details of the Azure AD application that was created following the Authenticating to Azure document.

To use a client secret:

  1. Create a Kubernetes secret using the following command:

    1. kubectl create secret generic [your_k8s_secret_name] --from-literal=[your_k8s_secret_key]=[your_client_secret]
    • [your_client_secret] is the application’s client secret as generated above
    • [your_k8s_secret_name] is secret name in the Kubernetes secret store
    • [your_k8s_secret_key] is secret key in the Kubernetes secret store

  2. Create an azurekeyvault.yaml component file.

    The component yaml refers to the Kubernetes secretstore using auth property and secretKeyRef refers to the client secret stored in the Kubernetes secret store.

    1. apiVersion: dapr.io/v1alpha1
    2. kind: Component
    3. metadata:
    4.   name: azurekeyvault
    5.   namespace: default
    6. spec:
    7.   type: secretstores.azure.keyvault
    8.   version: v1
    9.   metadata:
    10.   - name: vaultName
    11.     value: "[your_keyvault_name]"
    12.   - name: azureTenantId
    13.     value: "[your_tenant_id]"
    14.   - name: azureClientId
    15.     value: "[your_client_id]"
    16.   - name: azureClientSecret
    17.     secretKeyRef:
    18.       name: "[your_k8s_secret_name]"
    19.       key: "[your_k8s_secret_key]"
    20. auth:
    21.   secretStore: kubernetes

  3. Apply the azurekeyvault.yaml component:

    1. kubectl apply -f azurekeyvault.yaml

To use a certificate:

  1. Create a Kubernetes secret using the following command:

    1. kubectl create secret generic [your_k8s_secret_name] --from-file=[your_k8s_secret_key]=[pfx_certificate_file_fully_qualified_local_path]
    • [pfx_certificate_file_fully_qualified_local_path] is the path of PFX file you obtained earlier
    • [your_k8s_secret_name] is secret name in the Kubernetes secret store
    • [your_k8s_secret_key] is secret key in the Kubernetes secret store

  2. Create an azurekeyvault.yaml component file.

    The component yaml refers to the Kubernetes secretstore using auth property and secretKeyRef refers to the certificate stored in the Kubernetes secret store.

    1. apiVersion: dapr.io/v1alpha1
    2. kind: Component
    3. metadata:
    4.   name: azurekeyvault
    5.   namespace: default
    6. spec:
    7.   type: secretstores.azure.keyvault
    8.   version: v1
    9.   metadata:
    10.   - name: vaultName
    11.     value: "[your_keyvault_name]"
    12.   - name: azureTenantId
    13.     value: "[your_tenant_id]"
    14.   - name: azureClientId
    15.     value: "[your_client_id]"
    16.   - name: azureCertificate
    17.     secretKeyRef:
    18.       name: "[your_k8s_secret_name]"
    19.       key: "[your_k8s_secret_key]"
    20. auth:
    21.   secretStore: kubernetes

  3. Apply the azurekeyvault.yaml component:

    1. kubectl apply -f azurekeyvault.yaml

To use Azure managed identity:

  1. Ensure your AKS cluster has managed identity enabled and follow the guide for using managed identities.

  2. Create an azurekeyvault.yaml component file.

    The component yaml refers to a particular KeyVault name. The managed identity you will use in a later step must be given read access to this particular KeyVault instance.

    1. apiVersion: dapr.io/v1alpha1
    2. kind: Component
    3. metadata:
    4.   name: azurekeyvault
    5.   namespace: default
    6. spec:
    7.   type: secretstores.azure.keyvault
    8.   version: v1
    9.   metadata:
    10.   - name: vaultName
    11.     value: "[your_keyvault_name]"

  3. Apply the azurekeyvault.yaml component:

    1. kubectl apply -f azurekeyvault.yaml

  4. Create and use a managed identity / pod identity by following this guide. After creating an AKS pod identity, give this identity read permissions on your desired KeyVault instance, and finally in your application deployment inject the pod identity via a label annotation:

    1. apiVersion: v1
    2. kind: Pod
    3. metadata:
    4.   name: mydaprdemoapp
    5.   labels:
    6.     aadpodidbinding: $POD_IDENTITY_NAME

References

Last modified June 23, 2022: Merge pull request #2550 from ItalyPaleAle/cosmosdb-harcoded-dapr-version (cf03237)