Especificación de Blueprint

Descripción General

Un Blueprint de Deployado es un archivo YAML (típicamente llamado deployado.yaml ) que define la infraestructura de tu aplicación. Colócalo en la raíz de tu repositorio para habilitar despliegues con un solo clic.

Ejemplo de Blueprint

Aquí hay un ejemplo completo mostrando una aplicación web típica con base de datos:

# Project configuration
name: my-saas-app
repository: https://github.com/myuser/my-app
branch: main

# Databases
databases:
  - name: postgres-main
    version: "16"
    maxConnections: 100

# Reusable environment variable groups
envGroups:
  - name: common
    envVars:
      - key: NODE_ENV
        value: production

# Services/Applications
services:
  - name: api
    type: web
    runtime: repo
    port: 3000
    healthCheck:
      path: /health
    preDeployCommand: npm run migrate
    envGroups:
      - common
    envVars:
      - key: DATABASE_URL
        fromDatabase:
          name: postgres-main
          property: connectionString
      - key: JWT_SECRET
        generateSecret: true
      - key: ADMIN_EMAIL
        prompt: true
        description: Admin email address

  - name: frontend
    type: web
    runtime: repo
    port: 80
    links:
      - service: api
        envVar: REACT_APP_API_URL

Campos Raíz

Estos campos se definen en el nivel superior de tu archivo blueprint.

Servicios

Los servicios son las aplicaciones que componen tu proyecto. Cada servicio se despliega como un contenedor.

Campos de Servicio

Campos de Build

Campos de Health Check

Links

Los enlaces permiten que los servicios se descubran entre sí. Cuando enlazas el servicio A al servicio B, el servicio A obtiene una variable de entorno con la URL del servicio B.

Bases de Datos

Define bases de datos PostgreSQL que serán aprovisionadas automáticamente. Los servicios pueden referenciar estas bases de datos en sus variables de entorno.

Variables de Entorno

Las variables de entorno pueden definirse de múltiples formas: valores estáticos, secretos generados, referencias a bases de datos, referencias a otros servicios, o prompts al usuario.

Ejemplos

envVars:
  - key: NODE_ENV
    value: production

envVars:
  - key: JWT_SECRET
    generateSecret: true

envVars:
  - key: SENDGRID_API_KEY
    prompt: true
    description: Your SendGrid API key for email delivery

Grupos de Variables

Los grupos de variables de entorno te permiten definir conjuntos reutilizables de variables que pueden compartirse entre múltiples servicios.

# Define the group at root level
envGroups:
  - name: common-settings
    envVars:
      - key: LOG_LEVEL
        value: info
      - key: TZ
        value: UTC

# Reference it in services
services:
  - name: api
    envGroups:
      - common-settings  # Inherits LOG_LEVEL and TZ
    envVars:
      - key: API_PORT
        value: "3000"

  - name: worker
    envGroups:
      - common-settings  # Same env vars as api

Referencias Cruzadas

Los blueprints soportan referencias a bases de datos y servicios para configurar automáticamente cadenas de conexión y URLs.

Referencias de Base de Datos

Usa fromDatabase para obtener información de conexión de una base de datos definida en el blueprint.

Propiedades de base de datos disponibles:

envVars:
  - key: DATABASE_URL
    fromDatabase:
      name: postgres-main
      property: connectionString

Referencias de Servicio

Usa fromService para obtener información de URL/host de otro servicio.

envVars:
  - key: API_ENDPOINT
    fromService:
      name: api
      property: url  # Results in: https://api.myproject.deployado.com

Reglas de Validación

Los blueprints son validados antes del despliegue. Estas son las reglas:

• Debe definirse al menos un servicio
• Los nombres de servicios deben ser únicos dentro del blueprint
• Los nombres de bases de datos deben ser únicos dentro del blueprint
• Todas las referencias fromDatabase.name deben coincidir con una base de datos existente
• Todas las referencias fromService.name deben coincidir con un servicio existente
• Todas las referencias links.service deben coincidir con un servicio existente
• Las claves de variables de entorno deben ser válidas (alfanuméricos y guiones bajos)