Files
sablier/docs/providers/docker.md
semantic-release-bot 2515771ce1
Some checks failed
Build / Build (push) Has been cancelled
Docker / Build Sablier Docker image (linux/amd64) (push) Has been cancelled
Docker / Build Sablier Docker image (linux/arm/v7) (push) Has been cancelled
Docker / Build Sablier Docker image (linux/arm64) (push) Has been cancelled
Build Sablier plugins / Build Sablier docker image once and share it to E2E jobs (push) Has been cancelled
Build Sablier plugins / Build Traefik Sablier Plugin (push) Has been cancelled
Build Sablier plugins / Build Caddy Sablier Plugin (push) Has been cancelled
Build Sablier plugins / Build Caddy docker image once and share it to Caddy E2E jobs (push) Has been cancelled
Build Sablier plugins / Build ProxyWasm Plugin once and share it to ProxyWasm E2E jobs (push) Has been cancelled
Release / Release (push) Has been cancelled
Docker / Merge and Publish multiarch (push) Has been cancelled
Build Sablier plugins / Run Sablier E2E tests for Traefik middleware (docker) (push) Has been cancelled
Build Sablier plugins / Run Sablier E2E tests for Traefik middleware (docker_swarm) (push) Has been cancelled
Build Sablier plugins / Run Sablier E2E tests for Traefik middleware (kubernetes) (push) Has been cancelled
Build Sablier plugins / Run Sablier E2E tests for Nginx NJS module with Sablier (docker) (push) Has been cancelled
Build Sablier plugins / Run Sablier E2E tests for Nginx NJS module with Sablier (docker_swarm) (push) Has been cancelled
Build Sablier plugins / Run Sablier E2E tests for Caddy middleware (docker) (push) Has been cancelled
Build Sablier plugins / Run Sablier E2E tests for Caddy middleware (docker_swarm) (push) Has been cancelled
Build Sablier plugins / Run Sablier E2E tests for Proxywasm middleware on Apache APISIX (docker) (push) Has been cancelled
Build Sablier plugins / Run Sablier E2E tests for Proxywasm middleware on Envoy (docker) (push) Has been cancelled
Build Sablier plugins / Run Sablier E2E tests for Proxywasm middleware on Nginx (docker) (push) Has been cancelled
Close stale issues and PRs / stale (push) Has been cancelled
docs(release): update doc version from 1.8.1 to 1.8.2
2025-01-14 22:09:16 +00:00

1.3 KiB

Docker

The Docker provider communicates with the docker.sock socket to start and stop containers on demand.

Use the Docker provider

In order to use the docker provider you can configure the provider.name property.

File (YAML)

provider:
  name: docker

CLI

sablier start --provider.name=docker

Environment Variable

PROVIDER_NAME=docker

!> Ensure that Sablier has access to the docker socket!

services:
  sablier:
    image: sablierapp/sablier:1.8.2
    command:
      - start
      - --provider.name=docker
    volumes:
      - '/var/run/docker.sock:/var/run/docker.sock'

Register containers

For Sablier to work, it needs to know which docker container to start and stop.

You have to register your containers by opting-in with labels.

services:
  whoami:
    image: acouvreur/whoami:v1.10.2
    labels:
      - sablier.enable=true
      - sablier.group=mygroup

How does Sablier knows when a container is ready?

If the container defines a Healthcheck, then it will check for healthiness before stating the ready status.

If the containers do not define a Healthcheck, then as soon as the container has the status started