open-nomad/website/content/api-docs
Seth Hoenig 9467bc9eb3 api: enable selecting subset of services using rendezvous hashing
This PR adds the 'choose' query parameter to the '/v1/service/<service>' endpoint.

The value of 'choose' is in the form '<number>|<key>', number is the number
of desired services and key is a value unique but consistent to the requester
(e.g. allocID).

Folks aren't really expected to use this API directly, but rather through consul-template
which will soon be getting a new helper function making use of this query parameter.

Example,

curl 'localhost:4646/v1/service/redis?choose=2|abc123'

Note: consul-templte v0.29.1 includes the necessary nomadServices functionality.
2022-06-25 10:37:37 -05:00
..
operator api-docs: add SysBatchSchedulerEnabled docs (#11973) 2022-02-02 16:54:47 -05:00
acl-policies.mdx feat(website): migrates to new nav data format (#10264) 2021-03-31 08:43:17 -05:00
acl-tokens.mdx Allow Operator Generated bootstrap token (#12520) 2022-06-03 07:37:24 -04:00
agent.mdx Fixed scheduler config examples (#12049) 2022-02-23 12:58:29 -05:00
allocations.mdx Fix spelling error (#13397) 2022-06-16 12:41:49 -04:00
client.mdx feat(website): migrates to new nav data format (#10264) 2021-03-31 08:43:17 -05:00
deployments.mdx docs: initial docs for the new API features (#12094) 2022-03-14 10:58:42 -04:00
evaluations.mdx cli: update default redis and use nomad service discovery 2022-05-17 10:24:19 -05:00
events.mdx website: add initial website docs for Nomad service discovery. (#12456) 2022-04-06 18:51:14 +02:00
index.mdx parse ACL token from authorization header (#12534) 2022-06-06 15:51:02 -04:00
jobs.mdx docs: add allocation and job services API endpoint docs. (#13174) 2022-05-30 16:15:09 +02:00
json-jobs.mdx cli: update default redis and use nomad service discovery 2022-05-17 10:24:19 -05:00
libraries-and-sdks.mdx Update libraries-and-sdks.mdx 2021-04-27 16:34:55 -04:00
metrics.mdx feat(website): migrates to new nav data format (#10264) 2021-03-31 08:43:17 -05:00
namespaces.mdx docs: add meta to namespace docs 2022-03-04 14:18:57 -08:00
nodes.mdx api: Add support for filtering and pagination to the node list endpoint (#12727) 2022-04-21 17:04:33 +02:00
plugins.mdx feat(website): migrates to new nav data format (#10264) 2021-03-31 08:43:17 -05:00
quotas.mdx feat(website): migrates to new nav data format (#10264) 2021-03-31 08:43:17 -05:00
recommendations.mdx feat(website): migrates to new nav data format (#10264) 2021-03-31 08:43:17 -05:00
regions.mdx docs: fixup regions API documentation path to include version. 2021-07-21 12:14:19 +02:00
scaling-policies.mdx feat(website): migrates to new nav data format (#10264) 2021-03-31 08:43:17 -05:00
search.mdx docs: Fix minor fuzzy search things (#10423) 2021-04-21 14:55:17 -05:00
sentinel-policies.mdx feat(website): migrates to new nav data format (#10264) 2021-03-31 08:43:17 -05:00
services.mdx api: enable selecting subset of services using rendezvous hashing 2022-06-25 10:37:37 -05:00
status.mdx feat(website): migrates to new nav data format (#10264) 2021-03-31 08:43:17 -05:00
system.mdx feat(website): migrates to new nav data format (#10264) 2021-03-31 08:43:17 -05:00
ui.mdx feat(website): extract /plugins /tools docs (#11584) 2021-12-09 14:25:18 -05:00
validate.mdx feat(website): migrates to new nav data format (#10264) 2021-03-31 08:43:17 -05:00
volumes.mdx cli: update default redis and use nomad service discovery 2022-05-17 10:24:19 -05:00