Terminal
Terminal/Skill
Writes and validates render.yaml Blueprints that define Render services, databases, and environments as code, for multi-service apps.
By Render
Works with
npx skills add render-oss/skills --skill render-blueprintsBlueprints define Render infrastructure as YAML (commonly render.yaml at the repo root). This skill focuses on authoring, wiring, projects/environments, previews, validation, and immutable fields. Heavy detail lives under references/.
Before creating or modifying a Blueprint, read references/blueprints.md for the current specification-fetch, validation, repository-sync, and safety workflow.
For current compute-plan terminology, Plan IDs, and availability, use references/compute-plans.md instead of relying on plan catalogs embedded in examples.
Before adding or changing a service-attached disk, read references/persistent-disks.md for current architectural constraints and configuration workflow.
Before wiring private-network addresses, ports, or discovery hostnames, read references/private-networking.md.
Before choosing a service type or translating its Dashboard name to Blueprint structure, read references/service-types.md.
Apply this skill when the user:
render.yaml / BlueprintFor end-to-end deploy flows and MCP/CLI operations, see render-deploy. For env var strategy outside Blueprint syntax, see render-env-vars. For Docker-specific Blueprint fields, see render-docker.
| Key | Purpose |
|---|---|
services | Web, worker, cron, private service, Key Value, static (via web + runtime: static) |
databases | Managed PostgreSQL instances |
envVarGroups | Reusable env var sets attached to services |
projects | Optional grouping; contains environments and service lists |
previews | Defaults for PR preview environments |
A Blueprint may also use patterns like ungrouped resources vs environment-scoped lists, depending on whether you adopt the projects model. See references/common-mistakes.md for duplication and naming pitfalls.
databases:
- name: mydb
plan: basic-256mb
region: oregon
services:
- type: web
name: api
runtime: node
region: oregon
plan: starter
buildCommand: npm ci && npm run build
startCommand: npm start
envVars:
- key: DATABASE_URL
fromDatabase:
name: mydb
property: connectionString
type | Role |
|---|---|
web | Public HTTP service (use runtime: static for static sites) |
pserv | Private service (internal HTTP/TCP; not public) |
worker | Long-running background process |
cron | Scheduled job (schedule required) |
keyvalue | Managed Key Value (Redis-compatible); alias redis accepted in Blueprints |
Common runtime values: node, python, go, ruby, rust, elixir, docker, image, static.
docker: Build from Dockerfile (see dockerfilePath, dockerContext, dockerCommand).image: Run a prebuilt container image with image.url and optional image.creds.fromRegistryCreds.static: Static site; requires staticPublishPath and build output paths (see references).Before configuring variables, secrets, secret files, or environment groups, read references/environment-variables.md.
Service env vars under envVars can pull values from other resources instead of hardcoding secrets. Environment-group variables cannot reference services, databases, or other environment groups.
fromDatabaseReference a database in databases: by name. Properties include:
connectionString, connectionPoolString, host, port, user, password, databasefromServiceReference a service by name. Typical properties:
host, port, hostport, connectionString, envVarKeyWhich properties are valid depends on target service type (e.g. Key Value vs pserv). See references/wiring-patterns.md.
fromGroupAttach shared vars from envVarGroups (by group name).
Full patterns and combinations: references/wiring-patterns.md.
For multi-service apps, use the projects/environments pattern instead of flat top-level services/databases. This groups all related resources into a single Render project, supports multiple environments (production, staging), and enables environment-scoped configuration.
projects:
- name: my-app
environments:
- name: production
services:
- type: web
name: api
runtime: node
plan: standard
buildCommand: npm ci && npm run build
startCommand: npm start
envVars:
- key: DATABASE_URL
fromDatabase:
name: db
property: connectionString
- key: REDIS_URL
fromService:
type: keyvalue
name: cache
property: connectionString
- key: API_SECRET
sync: false
- type: worker
name: jobs
runtime: node
plan: starter
buildCommand: npm ci
startCommand: node worker.js
envVars:
- key: DATABASE_URL
fromDatabase:
name: db
property: connectionString
- key: REDIS_URL
fromService:
type: keyvalue
name: cache
property: connectionString
- type: keyvalue
name: cache
plan: starter
maxmemoryPolicy: noeviction
ipAllowList: [] # Internal access only
databases:
- name: db
plan: basic-256mb
Key rules:
services and databases lists.envVarGroups can be scoped to a project environment or shared across the workspace.For single-service apps, flat top-level services/databases is fine. Reach for the projects pattern when you have multiple services, need staging/production separation, or want environment-scoped env groups.
When a preview request is underspecified, first establish the desired generation mode, retention period, preview compute plans, and whether the user expects to exclude any resources.
Top-level previews controls Blueprint preview environments:
previews.generation: off (default), manual, or automaticpreviews.expireAfterDays: Auto-delete preview stacks after N daysDo not confuse preview environments with service previews:
previews.generation: automatic creates the Blueprint's preview environment, including the resources declared by that Blueprint.previews.generation controls that service's independent service previews. It does not override the Blueprint preview environment or exclude that service from it. It accepts only manual or automatic; omit it to disable independent service previews.previews.plan and previews.numInstances on compute services to size their preview-environment instances. Key Value and Postgres use previewPlan instead.If a user needs a worker or another resource omitted entirely from Blueprint preview environments, explain that service-level preview generation is not an exclusion mechanism; the Blueprint or application architecture must account for that requirement. Other limitations include autoscaling behavior, sync: false variables, and database plan compatibility—see references/preview-environments.md.
CRITICAL: Some fields cannot change after the resource is created. Edits may be rejected or require replacement resources.
type: Cannot change (e.g. web → worker).runtime: Cannot change (e.g. node → docker).Cannot change after creation:
name (logical Blueprint/database identifier in this context)databaseNameuserregionpostgresMajorVersionPlan other fields (disk, HA, replicas) carefully up front; consult Render docs for fields that can scale vs require recreation.
| Area | Fields |
|---|---|
| Plans | plan; compute-service previews.plan; Key Value/Postgres previewPlan |
| Build/run | buildCommand, startCommand, preDeployCommand, rootDir |
| Deploy | autoDeployTrigger: commit, checksPass, or off |
| Lifecycle | maxShutdownDelaySeconds: 1–300, default 30 |
| HTTP | healthCheckPath, domains |
| Storage | disk (name, mountPath, sizeGB) |
| Scale | scaling / numInstances (see references) |
| Monorepo | buildFilter (paths, ignoredPaths) |
| Docker | dockerfilePath, dockerContext, dockerCommand, registryCredential; prebuilt image.url / image.creds |
Deprecated names to avoid: env (use runtime), redis (use keyvalue), autoDeploy (use autoDeployTrigger), previewsEnabled, and pullRequestPreviewsEnabled. Use the appropriate top-level or service-level previews.generation replacement described in references/common-mistakes.md.
| Document | Contents |
|---|---|
references/blueprints.md | Current Blueprint specification, schema, validation, repository-sync, and safety workflow |
references/compute-plans.md | Current compute-plan terminology, Plan ID discovery, availability, and change behavior |
references/environment-variables.md | Current environment-variable documentation, secrets, groups, platform variables, and mutation safety |
references/persistent-disks.md | Service-attached disk constraints, current documentation, sizing, snapshots, and Blueprint workflow |
references/private-networking.md | Private-network scope, addresses, Blueprint references, discovery, ports, and isolation |
references/service-types.md | Service-type selection, execution models, and Blueprint naming |
references/field-reference.md | YAML fields by service type, database, groups, projects, previews, scaling, disk, static, Key Value |
references/wiring-patterns.md | fromDatabase / fromService / fromGroup examples and combined wiring patterns |
references/common-mistakes.md | Branch + previews, buildFilter, replicas, duplicates, preview plans, wiring mistakes |
references/preview-environments.md | previews.generation, expiry, previews.plan, previewPlan, disks, PR workflow |
Whenever this skill directs you to consult current Render documentation:
curl. Do not substitute web-search summaries for the document.When a task requires multiple references, apply this workflow to each one and distinguish the documents you verified from those that remain unavailable.