Prebuilt Image

Deploy from an existing OCI/Docker image instead of building from source.

What this demonstrates

  • The `image` field deploys a pre-built OCI/Docker image
  • No `runtime` or `build` needed when using an image
  • `start_period` gives slow-starting apps time before health checks kick in

When to use this: Deploying existing Docker images without building from source.

Top-Level Fields Health
prebuilt-image.yaml View on GitHub
# yaml-language-server: $schema=../schema/launchfile.schema.json
version: launch/v1
name: hedgedoc-backend
image: ghcr.io/hedgedoc/hedgedoc/backend:develop
platform: linux/amd64
provides:
  - protocol: http
    port: 3000
    bind: "0.0.0.0"
requires:
  - type: postgres
    set_env:
      HD_DATABASE_URL: $url
health:
  path: /api/private/config
  start_period: 60s

Key lines explained

image:
Uses a pre-built image instead of runtime + build. Most catalog apps use this.
start_period: 60s
Grace period before health checks start — useful for apps with slow initialization.
esc
Type to search the docs