From 627dc49147c549ae38ca57b0d8614bcbe98a6e11 Mon Sep 17 00:00:00 2001 From: hc-github-team-nomad-core <82989552+hc-github-team-nomad-core@users.noreply.github.com> Date: Mon, 27 Nov 2023 16:58:54 -0600 Subject: [PATCH] backport of commit 772ddd3638d4130b0e3590c5d0279e5757823250 (#19193) Co-authored-by: Luiz Aoqui --- website/content/api-docs/client.mdx | 24 ++++++++++++++---------- website/content/api-docs/nodes.mdx | 4 ++++ 2 files changed, 18 insertions(+), 10 deletions(-) diff --git a/website/content/api-docs/client.mdx b/website/content/api-docs/client.mdx index 7a2c490ba..52993fb4d 100644 --- a/website/content/api-docs/client.mdx +++ b/website/content/api-docs/client.mdx @@ -2,25 +2,29 @@ layout: api page_title: Client - HTTP API description: |- - The /client endpoints are used to access client information and inspect - allocations running on a particular client. + The /client endpoints are used to access client information, read and write + dynamic node metadata, and inspect allocations running on a particular + client. --- # Client HTTP API -The `/v1/client` endpoints are used to interact with the Nomad clients. +The `/client` endpoints are used to interact with the Nomad clients. -Since Nomad 0.8.0, both a client and server can handle client endpoints. This is -particularly useful for when a direct connection to a client is not possible due -to the network configuration. For high volume access to the client endpoints, -particularly endpoints streaming file contents, direct access to the node should -be preferred as it avoids adding additional load to the servers. +Both clients and servers can handle client endpoints. This is particularly +useful for when a direct connection to a client is not possible due to the +network configuration. For high volume access to the client endpoints, +particularly endpoints streaming file contents, direct access to the node +should be preferred as it avoids adding additional load to the servers. When accessing the endpoints via the server, if the desired node is ambiguous based on the URL, an additional `?node_id` query parameter must be provided to disambiguate. -## Read Node Metadata +The [`/node`](/nomad/api-docs/nodes) endpoints provide node information that +are retried from Nomad servers. + +## Read Dynamic Node Metadata This endpoint queries Node metadata on a specific Client agent and responds with the following fields: @@ -97,7 +101,7 @@ Formatted by appending `?pretty` above. ### Sample Request -## Update Node Metadata +## Update Dynamic Node Metadata This endpoint updates dynamic Node metadata on a specific Client agent. Since dynamic Node metadata is only periodically synchronized to Nomad Servers, the diff --git a/website/content/api-docs/nodes.mdx b/website/content/api-docs/nodes.mdx index 5688040c0..113b2ee24 100644 --- a/website/content/api-docs/nodes.mdx +++ b/website/content/api-docs/nodes.mdx @@ -8,6 +8,10 @@ description: The /node endpoints are used to query for and interact with client The `/node` endpoints are used to query for and interact with client nodes. +Requests to these endpoints are always forwarded to and answered by Nomad +servers. The [`/client`](/nomad/api-docs/client) endpoints provide node +information that are answered directly by the Nomad client. + ## List Nodes This endpoint lists all nodes registered with Nomad.