From 27c12a6e70f2bae2ea126ca302ba93437a6d1fa9 Mon Sep 17 00:00:00 2001 From: Charlie Voiselle <464492+angrycub@users.noreply.github.com> Date: Tue, 19 May 2020 09:14:17 -0400 Subject: [PATCH] Interlinking API, FAQ, and Config Creating a FAQ question to provide a home for additional context around bootstrapping. Linking from API page to `default_server_config` attribute. Added sample API response to to discuss "Updated: false" --- website/pages/api-docs/operator.mdx | 49 +++++++++++++++++---- website/pages/docs/configuration/server.mdx | 2 +- 2 files changed, 42 insertions(+), 9 deletions(-) diff --git a/website/pages/api-docs/operator.mdx b/website/pages/api-docs/operator.mdx index 6ae229d68..ff26ff5f3 100644 --- a/website/pages/api-docs/operator.mdx +++ b/website/pages/api-docs/operator.mdx @@ -406,6 +406,12 @@ The table below shows this endpoint's support for | ---------------- | ---------------- | | `NO` | `operator:write` | +### Bootstrap Configuration Element + +The [`default_scheduler_config`][] attribute of the server stanza will provide a +starting value for this configuration. Once bootstrapped, the value in the +server state is authoritative. + ### Parameters - `cas` `(int: 0)` - Specifies to use a Check-And-Set operation. The update will @@ -425,11 +431,38 @@ The table below shows this endpoint's support for } ``` -- `SchedulerAlgorithm` `(string: "binpack")` - Specifies whether scheduler binpacks or spreads allocations on available nodes. Possible values are `"binpack"` and `"spread"` -- `PreemptionConfig` `(PreemptionConfig)` - Options to enable preemption for various schedulers. -- `SystemSchedulerEnabled` `(bool: true)` - Specifies whether preemption for system jobs is enabled. Note that - if this is set to true, then system jobs can preempt any other jobs. -- `BatchSchedulerEnabled` `(bool: false)` (Enterprise Only) - Specifies whether preemption for batch jobs is enabled. Note that - if this is set to true, then batch jobs can preempt any other jobs. -- `ServiceSchedulerEnabled` `(bool: false)` (Enterprise Only) - Specifies whether preemption for service jobs is enabled. Note that - if this is set to true, then service jobs can preempt any other jobs. +- `SchedulerAlgorithm` `(string: "binpack")` - Specifies whether scheduler + binpacks or spreads allocations on available nodes. Possible values are + `"binpack"` and `"spread"` + +- `PreemptionConfig` `(PreemptionConfig)` - Options to enable preemption for + various schedulers. + + - `SystemSchedulerEnabled` `(bool: true)` - Specifies whether preemption for + system jobs is enabled. Note that if this is set to true, then system jobs + can preempt any other jobs. + + - `BatchSchedulerEnabled` `(bool: false)` (Enterprise Only) - Specifies + whether preemption for batch jobs is enabled. Note that if this is set to + true, then batch jobs can preempt any other jobs. + + - `ServiceSchedulerEnabled` `(bool: false)` (Enterprise Only) - Specifies + whether preemption for service jobs is enabled. Note that if this is set to + true, then service jobs can preempt any other jobs. + +### Sample Response + +```json +{ + "Updated": false, + "Index": 15 +} +``` + +- `Updated` - Indicates that the configuration was updated when a `cas` value is + provided. For non-CAS requests, this field will be false even though the + update is applied. + +- `Index` - Current Raft index when the request was received. + +[`default_scheduler_config`]: /docs/configuration/server#default_scheduler_config \ No newline at end of file diff --git a/website/pages/docs/configuration/server.mdx b/website/pages/docs/configuration/server.mdx index f30d49ef2..300910962 100644 --- a/website/pages/docs/configuration/server.mdx +++ b/website/pages/docs/configuration/server.mdx @@ -239,7 +239,7 @@ server { } ``` -### Bootstrapping with a Custom Scheduler Config +### Bootstrapping with a Custom Scheduler Config ((#configuring-scheduler-config)) While [bootstrapping a cluster], you can use the `default_scheduler_config` stanza to prime the cluster with a [`SchedulerConfig`][update-scheduler-config]. The