Reference Key Vault secrets (App Configuration)

Understand Key Vault references

Una Key Vault reference es un par especial clave-valor en App Configuration, donde el valor contiene una URI que apunta a un secreto en Key Vault

El content type es especial application/vnd.microsoft.appconfig.keyvaultref+json;charset=utf-8. El provider resuelve la referencia automáticamente, por lo que la app nunca llega a ver este valor. Solo ve una variable de entorno como cualquier otra.

No hay que escribir código custom, la app nunca ve diferencia o los entresijos por detrás

La App Configuration no almacena nunca el valor actual del secreto. Solo tiene el puntero donde reside en el Key Vault

Create Key Vault references

Podemos crear referencias desde el Azure Portal o con Azure CLI

az appconfig kv set-keyvault \
	--name myAppConfigStore \
	--key "OpenAI:ApiKey" \
	--secret-identifier "https://my-keyvault.vault.azure.net/secrets/openai-api-key" \
	--label "Production"

El --secret-identifier acepta la full URI y podemos incluir una versión https://my-keyvault.vault.azure.net/secrets/open-api-key/custom-version-1. Si omitimos la versión, por defecto se apunta a latest, y es lo recomendado.

También se pueden aplicar labels a las Key Vault references, por lo que podemos tener varias para separar entornos Production de por ej. Development

Configure python provider for Key Vault resolution

La library azure-appconfiguration-provider resuelve Key Vault references de manera automatica cuando le das una credencial a través del param keyvault_credential. Si pasamos un DefaultAzureCredential que autentica a ambos App Configuration y Key Vault usando la misma managed identity.

# Code fragment - focus on resolving Key Vault references through the provider
from azure.appconfiguration.provider import load
from azure.identity import DefaultAzureCredential
import os

endpoint = os.environ.get("AZURE_APPCONFIG_ENDPOINT")
credential = DefaultAzureCredential()

config = load(
    endpoint=endpoint,
    credential=credential,
    keyvault_credential=credential
)

# Regular settings and resolved Key Vault secrets are accessed the same way
model_endpoint = config["OpenAI:Endpoint"]     # Regular value from App Configuration
api_key = config["OpenAI:ApiKey"]               # Resolved from Key Vault
batch_size = config["Pipeline:BatchSize"]       # Regular value from App Configuration

Set up authentication for both services

La app identity tiene que tener permisos para ambos App Configuration y Key Vault para que las Key Vault references se resuelvan correctamente

Cada servicio usa su propio set de Azure RBAC roles y la identidad necesita por lo menos un rol en cada servicio.

IMPORTANTE

Para App Configuration la identidad necesita el rol App Configuration Data Reader, para obtener settings y referencias.

Para Key Vault la identidad necesita el rol Key Vault Secrets User para leer el secret value al que apunta la referencia.

Si tenemos apps que acceden a secretos de multiples Key Vaults, la identidad necesita el rol Key Vault Secrets User en cada vault referenciada en la configuración

/IMPORTANTE

Understand refresh behavior for Key Vault references

El provider soporta refrescar Key Vault secret values de manera independiente a otros configuration settings, a través del param secret_refresh_interval. Mientras que la Key Vault reference URI en App Configuration se mantiene sin cambiar, el secreto por debajo en Key Vault puede rotar. Este param indica cada cuanto hay que refrescar el secreto.

# Code fragment - focus on configuring independent secret refresh
config = load(
    endpoint=endpoint,
    credential=credential,
    keyvault_credential=credential,
    refresh_on=[WatchKey("Sentinel")],
    refresh_interval=60,
    secret_refresh_interval=7200  # Re-resolve Key Vault secrets every 2 hours
)

Esta separación entre refresh y secret_refresh permite comprobar cambios de config normales, de manera frecuente, y re-resolver los secretos en un ciclo más largo que se alinee con tu periodo de rotacion.