Files
sablier/docs/providers/overview.md
Alexis Couvreur fbb6e38d53 docs: add multiversioned documentation (#344)
Documentation is now published on the `gh-pages` branch.

The branch will have a folder `docs` containing the following structure:
- `./docs` the copy from the `main` docs, but only used for the `index.html` page to do the multi-version routing.
- `./docs/main` the copy from the `main` branch docs folder
- `./docs/beta` the copy from the `beta` branch docs folder

Closes #332
2024-10-01 17:30:14 -07:00

26 lines
1.9 KiB
Markdown

# Providers
## What is a Provider?
A Provider is how Sablier can interact with your instances.
A Provider typically have the following capabilities:
- Start an instance
- Stop an instance
- Get the current status of an instance
- Listen for instance lifecycle events (started, stopped)
## Available providers
| Provider | Name | Details |
|------------------------------------------------------------|---------------------------|------------------------------------------------------------------|
| [Docker](docker) | `docker` | Stop and start **containers** on demand |
| [Docker Swarm](docker_swarm) | `docker_swarm` or `swarm` | Scale down to zero and up **services** on demand |
| [Kubernetes](kubernetes) | `kubernetes` | Scale down and up **deployments** and **statefulsets** on demand |
| [Podman](https://github.com/acouvreur/sablier/issues/70) | `podman` | [See #70](https://github.com/acouvreur/sablier/issues/70) |
| [ECS](https://github.com/acouvreur/sablier/issues/116) | `ecs` | [See #116](https://github.com/acouvreur/sablier/issues/116) |
| [Systemd](https://github.com/acouvreur/sablier/issues/148) | `systemd` | [See #148](https://github.com/acouvreur/sablier/issues/148) |
*Your Provider is not on the list? [Open an issue to request the missing provider here!](https://github.com/acouvreur/sablier/issues/new?assignees=&labels=enhancement%2C+provider&projects=&template=instance-provider-request.md&title=Add+%60%5BPROVIDER%5D%60+provider)*
[See the active issues about the providers](https://github.com/acouvreur/sablier/issues?q=is%3Aopen+is%3Aissue+label%3Aprovider)