Skip to main content

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.

Apps base domain — The platform-managed parent zone every preview is served under by default. URLs look like <prefix>-<dep-id>.<apps-base>. To use your own zone instead, see Custom domains. Build — Producing a container image from a service’s build: block. Builds run as BuildKit Jobs in the slipway-system namespace. Images are content-addressed, so unchanged inputs short-circuit to a cache hit. Cutover — The moment a public service’s Ingress is applied with the deployment’s hostname. For PR previews, cutover swaps the stable PR hostname (web-pr-42.<apps>) from the previous tenant namespace to the new one. Default branch — The repo’s default branch on GitHub (typically main). Pushes to it trigger deployments. Manual deploys are scoped to it. Deployment — One attempt to bring a commit alive. Carries a status, an event log, a public-URL map, and (optionally) a TTL. Ephemeral — A deployment with a TTL. The TTL clock starts when status flips to healthy. Default ephemeral TTL is 5 minutes. Event — An append-only structured record on a deployment. Examples: queued, build_start, cutover, failed. See Event kinds. GitHub installation — One install of the slipway GitHub App on a GitHub user or org. One slipway organization corresponds to exactly one installation. Healthy — A deployment status meaning every public service is Ready and addressable. For ephemeral runs, this is when the TTL clock starts. Ingress — A Kubernetes object that maps a public hostname to a Service. slipway creates one Ingress per public port, with cert-manager auto-issued TLS. Manual deploy — A deploy triggered from the slipway UI rather than a GitHub event. Scoped to the default branch. Org / Organization — slipway’s tenancy boundary. 1:1 with a GitHub installation. URLs use a slug derived from the GitHub account login. Phase — Roughly a status range. The phase ladder on the deployment detail page tracks queued → building → deploying → healthy. Preview — Informal name for a deployment. “PR preview”, “preview environment”, etc. Preview auth — Optional gating on public Ingresses: shared token, GitHub org membership, or per-deployment token. Configured per repo. Probe — A startup / readiness / liveness check in healthcheck:. One of http, tcp, exec, or grpc. Repository — A GitHub repo ingested through an installation. Carries slipway_enabled and comment_on_prs flags. Resolution — At deploy time, slipway expands every ${secret.*} and ${var.*} reference in env and build.args to its concrete value. Missing references fail the deploy. Secret — Encrypted key/value pair. AES-256-GCM at rest. Values are write-only after creation. Service — One container in slipway.yaml. Produces a Kubernetes Deployment + optional Service + optional Ingress. Spec — A parsed slipway.yaml. Frozen into spec_snapshot on the deployment row at deploy time. Subdomain — The <prefix>-<id> portion of a preview URL. PR previews use <prefix>-pr-<n> (stable across commits); manual / push deploys use <prefix>-<short-id>-<rand>. Supersession — When a newer healthy deployment for the same branch takes over from an older one. Older deployments flip to superseded. Tenant namespace — sl-<dep-id>. Holds the deployment’s pods, services, ingresses, and resolved secret materializations. Default-deny NetworkPolicy, ResourceQuota, gVisor sandbox. TTL — Time to live, in seconds, for an ephemeral deployment. Set at enqueue; clock starts on healthy. Variable — Plaintext key/value pair. Visible to viewers and above. Counterpart of a secret for non-sensitive config.