Documentation Index
Fetch the complete documentation index at: https://docs.slipway.sh/llms.txt
Use this file to discover all available pages before exploring further.
Quick-scan table of every field slipway parses today. For the rationale and examples, see the slipway.yaml overview and adjacent pages.
Top level
| Path | Type | Required | Notes |
|---|
version | int | yes | Currently 1. |
services | map | yes | Keys: ^[a-z][a-z0-9-]{0,30}$. |
services.<name>
| Path | Type | Required | Notes |
|---|
build | object | one of build/image | Build from repo. |
image | string | one of build/image | Use prebuilt image. |
ports | list | no | Empty / omitted → worker service. |
env | map | no | ${secret.*}, ${var.*} substitution. |
resources.cpu | string | yes | Kubernetes CPU quantity. |
resources.memory | string | yes | Kubernetes memory quantity. |
resources.disk | string | no | Ephemeral storage hint. |
healthcheck.startup | probe | no | See “Probes” below. |
healthcheck.readiness | probe | no | Gates cutover for public services. |
healthcheck.liveness | probe | no | Restarts unhealthy pods. |
services.<name>.build
| Path | Type | Required | Notes |
|---|
context | string | yes | Relative to repo root. |
dockerfile | string | no | Defaults to Dockerfile. |
args | map | no | Build args. Values support ${secret.*} / ${var.*} substitution. |
services.<name>.ports[]
| Path | Type | Required | Notes |
|---|
port | int | yes | 1–65535. |
public | bool | no | Exposes via Ingress. |
prefix | string | no | Public hostname prefix. Defaults to service name. ^[a-z][a-z0-9-]{0,30}$. |
domain | string | no | Verified custom parent zone. Must be claimed under Settings → Domains. |
Probes
A probe is { <handler>: {...}, <timing-fields...> }. Exactly one handler.
| Handler | Fields |
|---|
http | { path, port } |
tcp | { port } |
exec | { command: [...] } |
grpc | { port, service? } |
initialDelaySeconds, periodSeconds, timeoutSeconds, failureThreshold, successThreshold.
Substitution syntax
| Form | Resolves to |
|---|
${secret.NAME} | Secret. Repo store first, org store fallback. |
${secret.repo.NAME} | Secret. Repo store only — strict. |
${secret.org.NAME} | Secret. Org store only — strict. |
${var.NAME} | Variable. Repo store first, org store fallback. |
${var.repo.NAME} | Variable. Repo store only — strict. |
${var.org.NAME} | Variable. Org store only — strict. |
${NAME} | Deprecated. Alias for ${secret.NAME}. Warns at deploy time. |
^[A-Z][A-Z0-9_]*$.
