Exploración de las opciones de implementación de Data API Builder

Completados

El traslado de Data API Builder de desarrollo local a entornos de producción de Azure requiere elegir la plataforma de hospedaje adecuada y configurar la automatización de la implementación. Azure ofrece varias opciones para ejecutar DAB, cada una con características diferentes para la escalabilidad, la sobrecarga de administración y la integración con otros servicios de Azure.

La estrategia de implementación afecta no solo a dónde se ejecuta DAB, sino también a cómo administrar la configuración, controlar los secretos y escalar para satisfacer la demanda. Comprender estas opciones de implementación le ayuda a seleccionar el enfoque que mejor se adapte a los requisitos operativos y la arquitectura de la aplicación.

Implementación en Azure Container Apps

Azure Container Apps proporciona una plataforma de contenedor sin servidor que controla la administración de infraestructura automáticamente. Es adecuado para Data API Builder, ya que puede escalar desde cero cuando está inactivo y escalar verticalmente automáticamente en función del volumen de solicitudes.

Para implementar DAB en Container Apps, cree primero una imagen de contenedor con la configuración:

FROM mcr.microsoft.com/azure-databases/data-api-builder:latest

COPY dab-config.json /App/dab-config.json

ENV DATABASE_CONNECTION_STRING=""
ENV ASPNETCORE_URLS="http://+:5000"

EXPOSE 5000

Este Dockerfile comienza desde la imagen DAB oficial y agrega el archivo de configuración. Las variables de entorno controlan la configuración de puerto y la cadena de conexión.

Implementación mediante la CLI de Azure:

az containerapp create \
  --name dab-api \
  --resource-group myResourceGroup \
  --environment myContainerAppEnv \
  --image myregistry.azurecr.io/dab-api:v1 \
  --target-port 5000 \
  --ingress external \
  --secrets database-conn="<connection-string>" \
  --env-vars DATABASE_CONNECTION_STRING=secretref:database-conn

Container Apps se integra con Azure Key Vault para la administración de secretos. Haga referencia a secretos en las variables de entorno en lugar de almacenar credenciales en archivos de configuración o imágenes de contenedor.

Sugerencia

Habilite la identidad administrada de Azure Container Apps y conceda acceso a Azure SQL Database. Este enfoque elimina las credenciales almacenadas por completo mediante la autenticación de Microsoft Entra.

Implementación en Azure App Service

Azure App Service ofrece una plataforma madura con ranuras de implementación integradas, dominios personalizados y supervisión completa. Para los equipos que ya usan App Service, agregar DAB sigue patrones conocidos.

Configure App Service para que ejecute el contenedor DAB.

az webapp create \
  --name dab-api \
  --resource-group myResourceGroup \
  --plan myAppServicePlan \
  --deployment-container-image-name mcr.microsoft.com/azure-databases/data-api-builder:latest

Establecimiento de variables de entorno mediante la configuración de App Service:

az webapp config appsettings set \
  --name dab-api \
  --resource-group myResourceGroup \
  --settings DATABASE_CONNECTION_STRING="@Microsoft.KeyVault(SecretUri=https://myvault.vault.azure.net/secrets/db-connection)"

La sintaxis de referencia de Key Vault permite que App Service extraiga secretos en tiempo de ejecución sin exponerlos en la configuración. Habilite la identidad administrada asignada por el sistema en App Service y conceda acceso a Key Vault.

Implementar en Azure Static Web Apps

Azure Static Web Apps incluye Data API Builder como una característica integrada denominada conexiones de base de datos. Esta integración proporciona la experiencia de implementación más sencilla cuando la API complementa un front-end estático.

Vincule la base de datos a través de Azure Portal o la CLI:

az staticwebapp dbconnection create \
  --name myStaticWebApp \
  --resource-group myResourceGroup \
  --db-type mssql \
  --db-resource-id /subscriptions/.../servers/myserver/databases/mydb

El staticwebapps.database.config.json archivo del repositorio define configuraciones de entidad con la misma estructura que DAB independiente:

{
  "data-source": {
    "database-type": "mssql"
  },
  "entities": {
    "Product": {
      "source": "dbo.Products",
      "permissions": [
        { "role": "anonymous", "actions": ["read"] }
      ]
    }
  }
}

Static Web Apps controla automáticamente la integración de la autenticación con sus proveedores de autenticación integrados. Las rutas de la API aparecen en las ubicaciones /.auth/ y /data-api/ por defecto.

Nota:

Las conexiones de base de datos en Static Web Apps tienen algunas limitaciones en comparación con DAB independiente, incluida la compatibilidad con procedimientos almacenados restringidos. Revise la documentación sobre la disponibilidad de las características actuales.

Implementación de canalizaciones de implementación de CI/CD

Las canalizaciones de implementación automatizadas garantizan una configuración coherente entre entornos y permiten una iteración rápida. Acciones de GitHub proporciona un enfoque sencillo para las implementaciones de DAB.

Cree un archivo de flujo de trabajo en .github/workflows/deploy-dab.yml:

name: Deploy Data API Builder

on:
  push:
    branches: [main]
    paths:
      - 'dab-config*.json'
      - 'Dockerfile'

jobs:
  build-and-deploy:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      
      - name: Login to Azure Container Registry
        uses: azure/docker-login@v1
        with:
          login-server: ${{ secrets.ACR_LOGIN_SERVER }}
          username: ${{ secrets.ACR_USERNAME }}
          password: ${{ secrets.ACR_PASSWORD }}
      
      - name: Build and push container
        run: |
          docker build -t ${{ secrets.ACR_LOGIN_SERVER }}/dab-api:${{ github.sha }} .
          docker push ${{ secrets.ACR_LOGIN_SERVER }}/dab-api:${{ github.sha }}
      
      - name: Deploy to Container Apps
        uses: azure/container-apps-deploy-action@v1
        with:
          resourceGroup: myResourceGroup
          containerAppName: dab-api
          imageToDeploy: ${{ secrets.ACR_LOGIN_SERVER }}/dab-api:${{ github.sha }}

Este flujo de trabajo se desencadena ante cambios en los archivos de configuración o el Dockerfile. Compila una nueva imagen de contenedor, la inserta en Azure Container Registry y actualiza la aplicación contenedora.

Configuración de implementaciones específicas del entorno

Las implementaciones de producción requieren una separación cuidadosa entre entornos. Use archivos de configuración específicos del entorno combinados con variables de implementación.

Estructurar el repositorio con varios archivos de configuración:

/
├── dab-config.json           # Base configuration (shared settings)
├── dab-config.development.json
├── dab-config.staging.json
├── dab-config.production.json
└── Dockerfile

Modifique el Dockerfile para aceptar un argumento de compilación:

FROM mcr.microsoft.com/azure-databases/data-api-builder:latest

ARG ENVIRONMENT=production
COPY dab-config.json /App/dab-config.json
COPY dab-config.${ENVIRONMENT}.json /App/dab-config.${ENVIRONMENT}.json

ENV DAB_ENVIRONMENT=${ENVIRONMENT}

Crear imágenes específicas del entorno:

docker build --build-arg ENVIRONMENT=production -t dab-api:production .

Importante

Nunca incluya cadenas de conexión o secretos reales en los archivos de configuración comprometidos en el control de código fuente. Use referencias de variables de entorno (@env()) y administre secretos mediante Azure Key Vault o en la administración de secretos de su canalización de implementación.

Supervisión de la salud de la implementación

Después de la implementación, configure las comprobaciones de estado para comprobar que DAB funciona correctamente. Container Apps y App Service admiten sondeos de estado:

{
  "probes": [
    {
      "type": "liveness",
      "httpGet": {
        "path": "/",
        "port": 5000
      },
      "periodSeconds": 30
    },
    {
      "type": "readiness",
      "httpGet": {
        "path": "/api/Product?$first=1",
        "port": 5000
      },
      "periodSeconds": 10
    }
  ]
}

El sondeo de ejecución verifica que DAB está respondiendo. El sondeo de preparación comprueba la conectividad de la base de datos mediante la realización de una solicitud de API real. Configura la plataforma de orquestación para reiniciar automáticamente las instancias con problemas.