Skip to main content

​
Check the sources in order

Peak reads your setup from the default branch. It uses the first source that works. Expect Peak to always use a version 2 .peak/preview.yml. Fix its errors. Peak does not fall back to another source. Expect Peak to skip any other source it can’t use and try the next one. Peak reads Blueprints named render.yaml, render.yml, or render.NAME.yaml, at the root or up to two folders deep. Peak reads Compose files with these names.
Open your repository in Previews. Under Setup, check the source, the public service, and every warning. Merge setup changes to the default branch to use them. Each pull request builds its own code and Dockerfiles.

​
Render Blueprints

Peak runs the Blueprint the way Render runs a preview environment. Peak treats previews as on when previews.generation is automatic or manual. With manual, Peak starts the repository in Labeled. Expect each service’s variables to also reach docker build as build arguments, as on Render. Expect PORT=10000 on a service that doesn’t set PORT. Peak serves the first web service with a health check. It prefers web services that turn on previews themselves. With no web service, it serves the first private service. Check Setup for these warnings. Peak sets the variables Render sets in a preview environment. Expect each service to answer on its own name and on its name with -pr-NUMBER.

​
Docker Compose

Peak runs each service as written, databases included. Peak serves the first service that matches, in this order.
  1. A reverse proxy that publishes a port.
  2. A service named web, frontend, app, or similar that publishes a port.
  3. The first service that publishes a port.
  4. A reverse proxy.
  5. The first service with a port.
Expect Peak never to serve a data store or a job.

​
Dockerfile

Peak builds the root Dockerfile as one service named app. Peak picks the port from the first of these.
  1. EXPOSE in the final stage.
  2. ENV PORT in the final stage.
  3. A port in the package.json start script, or 3000 for Next.js.
  4. 3000, with a warning.
Expect Peak to set PORT to that port and wait for it to accept connections.

​
Databases

Peak creates the databases that render.yaml or .peak/preview.yml names. Set a version to pin another one. Expect every database and volume to start empty in each deployment. Load test data in your migration command.

​
Migrations

Expect the command to run once per deployment, in the service’s image and environment, before the service starts. Expect a failed migration to fail the deployment. Expect the current preview to keep serving.

​
Health checks

Expect Peak to serve a new deployment only after every check passes.