From ba8eb6f2e510b3be4f34229d6b35370b5c6c4df3 Mon Sep 17 00:00:00 2001 From: Jose Diaz-Gonzalez Date: Tue, 14 Apr 2020 19:17:59 -0400 Subject: [PATCH] docs: add minor documentation for the kubernetes and nomad schedulers --- .../schedulers/alternate-schedulers.md | 10 ++++++++++ docs/advanced-usage/schedulers/docker-local.md | 13 ++++++++----- docs/template.html | 1 + 3 files changed, 19 insertions(+), 5 deletions(-) create mode 100644 docs/advanced-usage/schedulers/alternate-schedulers.md diff --git a/docs/advanced-usage/schedulers/alternate-schedulers.md b/docs/advanced-usage/schedulers/alternate-schedulers.md new file mode 100644 index 000000000..d0f743d7c --- /dev/null +++ b/docs/advanced-usage/schedulers/alternate-schedulers.md @@ -0,0 +1,10 @@ +# Alternative Schedulers + +Aside from the built-in [docker-local scheduler](/docs/advanced-usage/schedulers/docker-local.md), Dokku also supports two beta scheduler plugins: + +- [Kubernetes](https://github.com/dokku/dokku-scheduler-kubernetes) +- [Nomad](https://github.com/dokku/dokku-scheduler-nomad) + +These scheduler implementations may not be complete, though provide enough functionality for a user to get an app deployed via the underlying scheduler. + +For users that require additional functionality, please refer to the [Sponsoring Documentation](https://github.com/dokku/.github/blob/master/SPONSORING.md). diff --git a/docs/advanced-usage/schedulers/docker-local.md b/docs/advanced-usage/schedulers/docker-local.md index 73dd41061..7f572846a 100644 --- a/docs/advanced-usage/schedulers/docker-local.md +++ b/docs/advanced-usage/schedulers/docker-local.md @@ -44,15 +44,18 @@ This plugin implements various functionality through `plugn` triggers to integra - `check-deploy` - `core-post-deploy` - `post-app-clone-setup` +- `post-app-rename-setup` - `post-create` - `post-delete` - `pre-deploy` - `pre-restore` +- `scheduler-app-status` - `scheduler-deploy` - `scheduler-docker-cleanup` - `scheduler-inspect` -- `scheduler-logs-failed` +- `scheduler-is-deployed` - `scheduler-logs` +- `scheduler-logs-failed` - `scheduler-retire` - `scheduler-run` - `scheduler-stop` @@ -65,14 +68,14 @@ The `docker-local` scheduler supports a minimal list of resource _limits_ and _r ### Resource Limits -- cpu: (docker option: `--cpus`), and is specified in number of CPUs a process can access. +- cpu: (docker option: `--cpus`), is specified in number of CPUs a process can access. - See the ["CPU" section](https://docs.docker.com/config/containers/resource_constraints/#cpu) of the Docker Runtime Options documentation for more information. -- memory: (docker option: `--memory`) and should be specified with a suffix of `b` (bytes), `k` (kilobytes), `m` (megabytes), `g` (gigabytes). +- memory: (docker option: `--memory`) should be specified with a suffix of `b` (bytes), `k` (kilobytes), `m` (megabytes), `g` (gigabytes). - See the ["Memory" section](https://docs.docker.com/config/containers/resource_constraints/#memory) of the Docker Runtime Options documentation for more information. -- memory-swap: (docker option: `--memory-swap`) and should be specified with a suffix of `b` (bytes), `k` (kilobytes), `m` (megabytes), `g` (gigabytes) +- memory-swap: (docker option: `--memory-swap`) should be specified with a suffix of `b` (bytes), `k` (kilobytes), `m` (megabytes), `g` (gigabytes) - See the ["Memory" section](https://docs.docker.com/config/containers/resource_constraints/#memory) of the Docker Runtime Options documentation for more information. ### Resource Reservations -- memory: (docker option: `--memory-reservation`) and should be specified with a suffix of `b` (bytes), `k` (kilobytes), `m` (megabytes), `g` (gigabytes) +- memory: (docker option: `--memory-reservation`) should be specified with a suffix of `b` (bytes), `k` (kilobytes), `m` (megabytes), `g` (gigabytes) - See the ["Memory" section](https://docs.docker.com/config/containers/resource_constraints/#memory) of the Docker Runtime Options documentation for more information. diff --git a/docs/template.html b/docs/template.html index 1896d9676..fdaba8f94 100644 --- a/docs/template.html +++ b/docs/template.html @@ -162,6 +162,7 @@ Schedulers Docker Local + Alternate Schedulers Development