From 837912a8f10c77ae189043ac14da7599b3dd9b0f Mon Sep 17 00:00:00 2001 From: Charlie Voiselle <464492+angrycub@users.noreply.github.com> Date: Fri, 20 Mar 2020 18:24:56 -0400 Subject: [PATCH] fixing links (cherry picked from commit 575f22e970e2429b8f9871f11b8c3e0924c82dc2) --- website/pages/api-docs/acl-policies.mdx | 16 ++--- website/pages/api-docs/acl-tokens.mdx | 28 ++++---- website/pages/api-docs/agent.mdx | 36 +++++----- website/pages/api-docs/allocations.mdx | 20 +++--- website/pages/api-docs/client.mdx | 40 +++++------ website/pages/api-docs/deployments.mdx | 28 ++++---- website/pages/api-docs/evaluations.mdx | 12 ++-- website/pages/api-docs/jobs.mdx | 72 +++++++++---------- website/pages/api-docs/json-jobs.mdx | 2 +- website/pages/api-docs/metrics.mdx | 4 +- website/pages/api-docs/namespaces.mdx | 16 ++--- website/pages/api-docs/nodes.mdx | 28 ++++---- website/pages/api-docs/operator.mdx | 28 ++++---- website/pages/api-docs/quotas.mdx | 24 +++---- website/pages/api-docs/regions.mdx | 4 +- website/pages/api-docs/search.mdx | 4 +- website/pages/api-docs/sentinel-policies.mdx | 16 ++--- website/pages/api-docs/status.mdx | 8 +-- website/pages/api-docs/system.mdx | 8 +-- website/pages/api-docs/validate.mdx | 4 +- website/pages/docs/commands/job/inspect.mdx | 2 +- .../docs/commands/job/periodic-force.mdx | 2 +- .../pages/docs/commands/operator/index.mdx | 2 +- .../commands/operator/raft-list-peers.mdx | 2 +- .../commands/operator/raft-remove-peer.mdx | 2 +- website/pages/docs/configuration/index.mdx | 2 +- website/pages/docs/configuration/server.mdx | 2 +- website/pages/docs/drivers/index.mdx | 2 +- .../docs/internals/scheduling/preemption.mdx | 4 +- .../pages/docs/job-specification/device.mdx | 4 +- .../pages/docs/job-specification/update.mdx | 2 +- website/pages/docs/telemetry/index.mdx | 2 +- website/pages/docs/telemetry/metrics.mdx | 2 +- .../pages/docs/upgrade/upgrade-specific.mdx | 4 +- .../pages/intro/getting-started/running.mdx | 2 +- 35 files changed, 217 insertions(+), 217 deletions(-) diff --git a/website/pages/api-docs/acl-policies.mdx b/website/pages/api-docs/acl-policies.mdx index 46d435e6e1..817cf64a80 100644 --- a/website/pages/api-docs/acl-policies.mdx +++ b/website/pages/api-docs/acl-policies.mdx @@ -20,8 +20,8 @@ to the region, and may lag behind the authoritative region. | `GET` | `/acl/policies` | `application/json` | The table below shows this endpoint's support for -[blocking queries](/api#blocking-queries), [consistency modes](/api#consistency-modes) and -[required ACLs](/api#acls). +[blocking queries](/api-docs#blocking-queries), [consistency modes](/api-docs#consistency-modes) and +[required ACLs](/api-docs#acls). | Blocking Queries | Consistency Modes | ACL Required | | ---------------- | ----------------- | -------------------------------------------------------------------------------------------------------------------------------- | @@ -67,8 +67,8 @@ authoritative region. | `POST` | `/acl/policy/:policy_name` | `(empty body)` | The table below shows this endpoint's support for -[blocking queries](/api#blocking-queries) and -[required ACLs](/api#acls). +[blocking queries](/api-docs#blocking-queries) and +[required ACLs](/api-docs#acls). | Blocking Queries | ACL Required | | ---------------- | ------------ | @@ -112,8 +112,8 @@ replicated to the region, and may lag behind the authoritative region. | `GET` | `/acl/policy/:policy_name` | `application/json` | The table below shows this endpoint's support for -[blocking queries](/api#blocking-queries), [consistency modes](/api#consistency-modes) and -[required ACLs](/api#acls). +[blocking queries](/api-docs#blocking-queries), [consistency modes](/api-docs#consistency-modes) and +[required ACLs](/api-docs#acls). | Blocking Queries | Consistency Modes | ACL Required | | ---------------- | ----------------- | ------------------------------------------- | @@ -148,8 +148,8 @@ authoritative region. | `DELETE` | `/acl/policy/:policy_name` | `(empty body)` | The table below shows this endpoint's support for -[blocking queries](/api#blocking-queries) and -[required ACLs](/api#acls). +[blocking queries](/api-docs#blocking-queries) and +[required ACLs](/api-docs#acls). | Blocking Queries | ACL Required | | ---------------- | ------------ | diff --git a/website/pages/api-docs/acl-tokens.mdx b/website/pages/api-docs/acl-tokens.mdx index 9e4abdcb8c..338559d05d 100644 --- a/website/pages/api-docs/acl-tokens.mdx +++ b/website/pages/api-docs/acl-tokens.mdx @@ -21,8 +21,8 @@ until a [bootstrap reset](https://learn.hashicorp.com/nomad?track=acls#acls) is | `POST` | `/acl/bootstrap` | `application/json` | The table below shows this endpoint's support for -[blocking queries](/api#blocking-queries) and -[required ACLs](/api#acls). +[blocking queries](/api-docs#blocking-queries) and +[required ACLs](/api-docs#acls). | Blocking Queries | ACL Required | | ---------------- | ------------ | @@ -62,8 +62,8 @@ tokens which have been replicated to the region, and may lag behind the authorit | `GET` | `/acl/tokens` | `application/json` | The table below shows this endpoint's support for -[blocking queries](/api#blocking-queries), [consistency modes](/api#consistency-modes) and -[required ACLs](/api#acls). +[blocking queries](/api-docs#blocking-queries), [consistency modes](/api-docs#consistency-modes) and +[required ACLs](/api-docs#acls). | Blocking Queries | Consistency Modes | ACL Required | | ---------------- | ----------------- | ------------ | @@ -116,8 +116,8 @@ is forwarded to the authoritative region. | `POST` | `/acl/token` | `application/json` | The table below shows this endpoint's support for -[blocking queries](/api#blocking-queries) and -[required ACLs](/api#acls). +[blocking queries](/api-docs#blocking-queries) and +[required ACLs](/api-docs#acls). | Blocking Queries | ACL Required | | ---------------- | ------------ | @@ -180,8 +180,8 @@ to local or visa versa. | `POST` | `/acl/token/:accessor_id` | `application/json` | The table below shows this endpoint's support for -[blocking queries](/api#blocking-queries) and -[required ACLs](/api#acls). +[blocking queries](/api-docs#blocking-queries) and +[required ACLs](/api-docs#acls). | Blocking Queries | ACL Required | | ---------------- | ------------ | @@ -243,8 +243,8 @@ which has been replicated to the region it may lag behind the authoritative regi | `GET` | `/acl/token/:accessor_id` | `application/json` | The table below shows this endpoint's support for -[blocking queries](/api#blocking-queries), [consistency modes](/api#consistency-modes) and -[required ACLs](/api#acls). +[blocking queries](/api-docs#blocking-queries), [consistency modes](/api-docs#consistency-modes) and +[required ACLs](/api-docs#acls). | Blocking Queries | Consistency Modes | ACL Required | | ---------------- | ----------------- | -------------------------------------------------- | @@ -283,8 +283,8 @@ which has been replicated to the region it may lag behind the authoritative regi | `GET` | `/acl/token/self` | `application/json` | The table below shows this endpoint's support for -[blocking queries](/api#blocking-queries), [consistency modes](/api#consistency-modes) and -[required ACLs](/api#acls). +[blocking queries](/api-docs#blocking-queries), [consistency modes](/api-docs#consistency-modes) and +[required ACLs](/api-docs#acls). | Blocking Queries | Consistency Modes | ACL Required | | ---------------- | ----------------- | ------------------- | @@ -324,8 +324,8 @@ authoritative region for global tokens. | `DELETE` | `/acl/token/:accessor_id` | `(empty body)` | The table below shows this endpoint's support for -[blocking queries](/api#blocking-queries) and -[required ACLs](/api#acls). +[blocking queries](/api-docs#blocking-queries) and +[required ACLs](/api-docs#acls). | Blocking Queries | ACL Required | | ---------------- | ------------ | diff --git a/website/pages/api-docs/agent.mdx b/website/pages/api-docs/agent.mdx index 9c6f417f63..266af1d4d3 100644 --- a/website/pages/api-docs/agent.mdx +++ b/website/pages/api-docs/agent.mdx @@ -22,8 +22,8 @@ eventually consistent. | `GET` | `/agent/members` | `application/json` | The table below shows this endpoint's support for -[blocking queries](/api#blocking-queries) and -[required ACLs](/api#acls). +[blocking queries](/api-docs#blocking-queries) and +[required ACLs](/api-docs#acls). | Blocking Queries | ACL Required | | ---------------- | ------------ | @@ -83,8 +83,8 @@ are changes in the cluster. | `GET` | `/agent/servers` | `application/json` | The table below shows this endpoint's support for -[blocking queries](/api#blocking-queries) and -[required ACLs](/api#acls). +[blocking queries](/api-docs#blocking-queries) and +[required ACLs](/api-docs#acls). | Blocking Queries | ACL Required | | ---------------- | ------------ | @@ -113,8 +113,8 @@ This endpoint updates the list of known servers to the provided list. This | `POST` | `/agent/servers` | `(empty body)` | The table below shows this endpoint's support for -[blocking queries](/api#blocking-queries) and -[required ACLs](/api#acls). +[blocking queries](/api-docs#blocking-queries) and +[required ACLs](/api-docs#acls). | Blocking Queries | ACL Required | | ---------------- | ------------- | @@ -142,8 +142,8 @@ This endpoint queries the state of the target agent (self). | `GET` | `/agent/self` | `application/json` | The table below shows this endpoint's support for -[blocking queries](/api#blocking-queries) and -[required ACLs](/api#acls). +[blocking queries](/api-docs#blocking-queries) and +[required ACLs](/api-docs#acls). | Blocking Queries | ACL Required | | ---------------- | ------------ | @@ -395,8 +395,8 @@ eligible for servers. | `POST` | `/agent/join` | `application/json` | The table below shows this endpoint's support for -[blocking queries](/api#blocking-queries) and -[required ACLs](/api#acls). +[blocking queries](/api-docs#blocking-queries) and +[required ACLs](/api-docs#acls). | Blocking Queries | ACL Required | | ---------------- | ------------ | @@ -436,8 +436,8 @@ stop attempting replication. This is only applicable for servers. | `POST` | `/agent/force-leave` | `application/json` | The table below shows this endpoint's support for -[blocking queries](/api#blocking-queries) and -[required ACLs](/api#acls). +[blocking queries](/api-docs#blocking-queries) and +[required ACLs](/api-docs#acls). | Blocking Queries | ACL Required | | ---------------- | ------------- | @@ -468,8 +468,8 @@ containing an error message. | `GET` | `/agent/health` | `application/json` | The table below shows this endpoint's support for -[blocking queries](/api#blocking-queries) and -[required ACLs](/api#acls). +[blocking queries](/api-docs#blocking-queries) and +[required ACLs](/api-docs#acls). | Blocking Queries | ACL Required | | ---------------- | ------------ | @@ -506,8 +506,8 @@ This endpoint streams logs from the local agent until the connection is closed | `GET` | `/agent/monitor` | `application/json` | The table below shows this endpoint's support for -[blocking queries](/api#blocking-queries) and -[required ACLs](/api#acls). +[blocking queries](/api-docs#blocking-queries) and +[required ACLs](/api-docs#acls). | Blocking Queries | ACL Required | | ---------------- | ------------ | @@ -578,8 +578,8 @@ by ACLs and supports remote forwarding to a client node or server. See the | `GET` | `/agent/pprof/<pprof profile>` | `application/octet-stream` | The table below shows this endpoint's support for -[blocking queries](/api#blocking-queries) and -[required ACLs](/api#acls). +[blocking queries](/api-docs#blocking-queries) and +[required ACLs](/api-docs#acls). | Blocking Queries | ACL Required | | ---------------- | ------------- | diff --git a/website/pages/api-docs/allocations.mdx b/website/pages/api-docs/allocations.mdx index a633446aa6..60436c473a 100644 --- a/website/pages/api-docs/allocations.mdx +++ b/website/pages/api-docs/allocations.mdx @@ -18,8 +18,8 @@ This endpoint lists all allocations. | `GET` | `/v1/allocations` | `application/json` | The table below shows this endpoint's support for -[blocking queries](/api#blocking-queries) and -[required ACLs](/api#acls). +[blocking queries](/api-docs#blocking-queries) and +[required ACLs](/api-docs#acls). | Blocking Queries | ACL Required | | ---------------- | -------------------- | @@ -169,8 +169,8 @@ This endpoint reads information about a specific allocation. | `GET` | `/v1/allocation/:alloc_id` | `application/json` | The table below shows this endpoint's support for -[blocking queries](/api#blocking-queries) and -[required ACLs](/api#acls). +[blocking queries](/api-docs#blocking-queries) and +[required ACLs](/api-docs#acls). | Blocking Queries | ACL Required | | ---------------- | -------------------- | @@ -573,8 +573,8 @@ This endpoint stops and reschedules a specific allocation. | `POST` / `PUT` | `/v1/allocation/:alloc_id/stop` | `application/json` | The table below shows this endpoint's support for -[blocking queries](/api#blocking-queries) and -[required ACLs](/api#acls). +[blocking queries](/api-docs#blocking-queries) and +[required ACLs](/api-docs#acls). | Blocking Queries | ACL Required | | ---------------- | --------------------------- | @@ -611,8 +611,8 @@ This endpoint sends a signal to an allocation or task. | `POST` / `PUT` | `/v1/client/allocation/:alloc_id/signal` | `application/json` | The table below shows this endpoint's support for -[blocking queries](/api#blocking-queries) and -[required ACLs](/api#acls). +[blocking queries](/api-docs#blocking-queries) and +[required ACLs](/api-docs#acls). | Blocking Queries | ACL Required | | ---------------- | --------------------------- | @@ -655,8 +655,8 @@ This endpoint restarts an allocation or task in-place. | `POST` / `PUT` | `/v1/client/allocation/:alloc_id/restart` | `application/json` | The table below shows this endpoint's support for -[blocking queries](/api#blocking-queries) and -[required ACLs](/api#acls). +[blocking queries](/api-docs#blocking-queries) and +[required ACLs](/api-docs#acls). | Blocking Queries | ACL Required | | ---------------- | --------------------------- | diff --git a/website/pages/api-docs/client.mdx b/website/pages/api-docs/client.mdx index 979af7032c..db776e454c 100644 --- a/website/pages/api-docs/client.mdx +++ b/website/pages/api-docs/client.mdx @@ -32,8 +32,8 @@ whose resource usage metrics are of interest. | `GET` | `/client/stats` | `application/json` | The table below shows this endpoint's support for -[blocking queries](/api#blocking-queries) and -[required ACLs](/api#acls). +[blocking queries](/api-docs#blocking-queries) and +[required ACLs](/api-docs#acls). | Blocking Queries | ACL Required | | ---------------- | ------------ | @@ -157,8 +157,8 @@ by an allocation. | `GET` | `/client/allocation/:alloc_id/stats` | `application/json` | The table below shows this endpoint's support for -[blocking queries](/api#blocking-queries) and -[required ACLs](/api#acls). +[blocking queries](/api-docs#blocking-queries) and +[required ACLs](/api-docs#acls). | Blocking Queries | ACL Required | | ---------------- | -------------------- | @@ -240,8 +240,8 @@ This endpoint reads the contents of a file in an allocation directory. | `GET` | `/client/fs/cat/:alloc_id` | `text/plain` | The table below shows this endpoint's support for -[blocking queries](/api#blocking-queries) and -[required ACLs](/api#acls). +[blocking queries](/api-docs#blocking-queries) and +[required ACLs](/api-docs#acls). | Blocking Queries | ACL Required | | ---------------- | ------------------- | @@ -284,8 +284,8 @@ particular offset and limit. | `GET` | `/client/fs/readat/:alloc_id` | `text/plain` | The table below shows this endpoint's support for -[blocking queries](/api#blocking-queries) and -[required ACLs](/api#acls). +[blocking queries](/api-docs#blocking-queries) and +[required ACLs](/api-docs#acls). | Blocking Queries | ACL Required | | ---------------- | ------------------- | @@ -328,8 +328,8 @@ This endpoint streams the contents of a file in an allocation directory. | `GET` | `/client/fs/stream/:alloc_id` | `text/plain` | The table below shows this endpoint's support for -[blocking queries](/api#blocking-queries) and -[required ACLs](/api#acls). +[blocking queries](/api-docs#blocking-queries) and +[required ACLs](/api-docs#acls). | Blocking Queries | ACL Required | | ---------------- | ------------------- | @@ -396,8 +396,8 @@ This endpoint streams a task's stderr/stdout logs. | `GET` | `/client/fs/logs/:alloc_id` | `text/plain` | The table below shows this endpoint's support for -[blocking queries](/api#blocking-queries) and -[required ACLs](/api#acls). +[blocking queries](/api-docs#blocking-queries) and +[required ACLs](/api-docs#acls). | Blocking Queries | ACL Required | | ---------------- | -------------------------------------------- | @@ -469,8 +469,8 @@ This endpoint lists files in an allocation directory. | `GET` | `/client/fs/ls/:alloc_id` | `text/plain` | The table below shows this endpoint's support for -[blocking queries](/api#blocking-queries) and -[required ACLs](/api#acls). +[blocking queries](/api-docs#blocking-queries) and +[required ACLs](/api-docs#acls). | Blocking Queries | ACL Required | | ---------------- | ------------------- | @@ -522,8 +522,8 @@ This endpoint stats a file in an allocation. | `GET` | `/client/fs/stat/:alloc_id` | `text/plain` | The table below shows this endpoint's support for -[blocking queries](/api#blocking-queries) and -[required ACLs](/api#acls). +[blocking queries](/api-docs#blocking-queries) and +[required ACLs](/api-docs#acls). | Blocking Queries | ACL Required | | ---------------- | ------------------- | @@ -567,8 +567,8 @@ on a node. | `GET` | `/client/allocation/:alloc_id/gc` | `application/json` | The table below shows this endpoint's support for -[blocking queries](/api#blocking-queries) and -[required ACLs](/api#acls). +[blocking queries](/api-docs#blocking-queries) and +[required ACLs](/api-docs#acls). | Blocking Queries | ACL Required | | ---------------- | ---------------------- | @@ -596,8 +596,8 @@ This endpoint forces a garbage collection of all stopped allocations on a node. | `GET` | `/client/gc` | `text/plain` | The table below shows this endpoint's support for -[blocking queries](/api#blocking-queries) and -[required ACLs](/api#acls). +[blocking queries](/api-docs#blocking-queries) and +[required ACLs](/api-docs#acls). | Blocking Queries | ACL Required | | ---------------- | ------------ | diff --git a/website/pages/api-docs/deployments.mdx b/website/pages/api-docs/deployments.mdx index b02858b6f9..b70e04178c 100644 --- a/website/pages/api-docs/deployments.mdx +++ b/website/pages/api-docs/deployments.mdx @@ -18,8 +18,8 @@ This endpoint lists all deployments. | `GET` | `/v1/deployments` | `application/json` | The table below shows this endpoint's support for -[blocking queries](/api#blocking-queries) and -[required ACLs](/api#acls). +[blocking queries](/api-docs#blocking-queries) and +[required ACLs](/api-docs#acls). | Blocking Queries | ACL Required | | ---------------- | -------------------- | @@ -82,8 +82,8 @@ This endpoint reads information about a specific deployment by ID. | `GET` | `/v1/deployment/:deployment_id` | `application/json` | The table below shows this endpoint's support for -[blocking queries](/api#blocking-queries) and -[required ACLs](/api#acls). +[blocking queries](/api-docs#blocking-queries) and +[required ACLs](/api-docs#acls). | Blocking Queries | ACL Required | | ---------------- | -------------------- | @@ -139,8 +139,8 @@ deployment. | `GET` | `/v1/deployment/allocations/:deployment_id` | `application/json` | The table below shows this endpoint's support for -[blocking queries](/api#blocking-queries) and -[required ACLs](/api#acls). +[blocking queries](/api-docs#blocking-queries) and +[required ACLs](/api-docs#acls). | Blocking Queries | ACL Required | | ---------------- | -------------------- | @@ -275,8 +275,8 @@ the job being reverted. | `POST` | `/v1/deployment/fail/:deployment_id` | `application/json` | The table below shows this endpoint's support for -[blocking queries](/api#blocking-queries) and -[required ACLs](/api#acls). +[blocking queries](/api-docs#blocking-queries) and +[required ACLs](/api-docs#acls). | Blocking Queries | ACL Required | | ---------------- | ---------------------- | @@ -318,8 +318,8 @@ a rolling upgrade or resume it. | `POST` | `/v1/deployment/pause/:deployment_id` | `application/json` | The table below shows this endpoint's support for -[blocking queries](/api#blocking-queries) and -[required ACLs](/api#acls). +[blocking queries](/api-docs#blocking-queries) and +[required ACLs](/api-docs#acls). | Blocking Queries | ACL Required | | ---------------- | ---------------------- | @@ -372,8 +372,8 @@ rolling upgrade of the remaining allocations should begin. | `POST` | `/v1/deployment/promote/:deployment_id` | `application/json` | The table below shows this endpoint's support for -[blocking queries](/api#blocking-queries) and -[required ACLs](/api#acls). +[blocking queries](/api-docs#blocking-queries) and +[required ACLs](/api-docs#acls). | Blocking Queries | ACL Required | | ---------------- | ---------------------- | @@ -441,8 +441,8 @@ version of the job has a different specification than the job being reverted. | `POST` | `/v1/deployment/allocation-health/:deployment_id` | `application/json` | The table below shows this endpoint's support for -[blocking queries](/api#blocking-queries) and -[required ACLs](/api#acls). +[blocking queries](/api-docs#blocking-queries) and +[required ACLs](/api-docs#acls). | Blocking Queries | ACL Required | | ---------------- | ---------------------- | diff --git a/website/pages/api-docs/evaluations.mdx b/website/pages/api-docs/evaluations.mdx index f09fe126cb..6384b18561 100644 --- a/website/pages/api-docs/evaluations.mdx +++ b/website/pages/api-docs/evaluations.mdx @@ -18,8 +18,8 @@ This endpoint lists all evaluations. | `GET` | `/v1/evaluations` | `application/json` | The table below shows this endpoint's support for -[blocking queries](/api#blocking-queries) and -[required ACLs](/api#acls). +[blocking queries](/api-docs#blocking-queries) and +[required ACLs](/api-docs#acls). | Blocking Queries | ACL Required | | ---------------- | -------------------- | @@ -86,8 +86,8 @@ This endpoint reads information about a specific evaluation by ID. | `GET` | `/v1/evaluation/:eval_id` | `application/json` | The table below shows this endpoint's support for -[blocking queries](/api#blocking-queries) and -[required ACLs](/api#acls). +[blocking queries](/api-docs#blocking-queries) and +[required ACLs](/api-docs#acls). | Blocking Queries | ACL Required | | ---------------- | -------------------- | @@ -147,8 +147,8 @@ evaluation. | `GET` | `/v1/evaluation/:eval_id/allocations` | `application/json` | The table below shows this endpoint's support for -[blocking queries](/api#blocking-queries) and -[required ACLs](/api#acls). +[blocking queries](/api-docs#blocking-queries) and +[required ACLs](/api-docs#acls). | Blocking Queries | ACL Required | | ---------------- | -------------------- | diff --git a/website/pages/api-docs/jobs.mdx b/website/pages/api-docs/jobs.mdx index d830b8596f..97baf32744 100644 --- a/website/pages/api-docs/jobs.mdx +++ b/website/pages/api-docs/jobs.mdx @@ -18,8 +18,8 @@ This endpoint lists all known jobs in the system registered with Nomad. | `GET` | `/v1/jobs` | `application/json` | The table below shows this endpoint's support for -[blocking queries](/api#blocking-queries) and -[required ACLs](/api#acls). +[blocking queries](/api-docs#blocking-queries) and +[required ACLs](/api-docs#acls). | Blocking Queries | ACL Required | | ---------------- | --------------------- | @@ -90,8 +90,8 @@ This endpoint creates (aka "registers") a new job in the system. | `POST` | `/v1/jobs` | `application/json` | The table below shows this endpoint's support for -[blocking queries](/api#blocking-queries) and -[required ACLs](/api#acls). +[blocking queries](/api-docs#blocking-queries) and +[required ACLs](/api-docs#acls). | Blocking Queries | ACL Required | | ---------------- | --------------------------------------------------------------------------------- | @@ -252,8 +252,8 @@ job. | `POST` | `/v1/jobs/parse` | `application/json` | The table below shows this endpoint's support for -[blocking queries](/api#blocking-queries) and -[required ACLs](/api#acls). +[blocking queries](/api-docs#blocking-queries) and +[required ACLs](/api-docs#acls). | Blocking Queries | ACL Required | | ---------------- | ------------ | @@ -330,8 +330,8 @@ status. | `GET` | `/v1/job/:job_id` | `application/json` | The table below shows this endpoint's support for -[blocking queries](/api#blocking-queries) and -[required ACLs](/api#acls). +[blocking queries](/api-docs#blocking-queries) and +[required ACLs](/api-docs#acls). | Blocking Queries | ACL Required | | ---------------- | -------------------- | @@ -543,8 +543,8 @@ This endpoint reads information about all versions of a job. | `GET` | `/v1/job/:job_id/versions` | `application/json` | The table below shows this endpoint's support for -[blocking queries](/api#blocking-queries) and -[required ACLs](/api#acls). +[blocking queries](/api-docs#blocking-queries) and +[required ACLs](/api-docs#acls). | Blocking Queries | ACL Required | | ---------------- | -------------------- | @@ -721,8 +721,8 @@ This endpoint reads information about a single job's allocations. | `GET` | `/v1/job/:job_id/allocations` | `application/json` | The table below shows this endpoint's support for -[blocking queries](/api#blocking-queries) and -[required ACLs](/api#acls). +[blocking queries](/api-docs#blocking-queries) and +[required ACLs](/api-docs#acls). | Blocking Queries | ACL Required | | ---------------- | -------------------- | @@ -890,8 +890,8 @@ This endpoint reads information about a single job's evaluations | `GET` | `/v1/job/:job_id/evaluations` | `application/json` | The table below shows this endpoint's support for -[blocking queries](/api#blocking-queries) and -[required ACLs](/api#acls). +[blocking queries](/api-docs#blocking-queries) and +[required ACLs](/api-docs#acls). | Blocking Queries | ACL Required | | ---------------- | -------------------- | @@ -951,8 +951,8 @@ This endpoint lists a single job's deployments | `GET` | `/v1/job/:job_id/deployments` | `application/json` | The table below shows this endpoint's support for -[blocking queries](/api#blocking-queries) and -[required ACLs](/api#acls). +[blocking queries](/api-docs#blocking-queries) and +[required ACLs](/api-docs#acls). | Blocking Queries | ACL Required | | ---------------- | -------------------- | @@ -1039,8 +1039,8 @@ This endpoint returns a single job's most recent deployment. | `GET` | `/v1/job/:job_id/deployment` | `application/json` | The table below shows this endpoint's support for -[blocking queries](/api#blocking-queries) and -[required ACLs](/api#acls). +[blocking queries](/api-docs#blocking-queries) and +[required ACLs](/api-docs#acls). | Blocking Queries | ACL Required | | ---------------- | -------------------- | @@ -1098,8 +1098,8 @@ This endpoint reads summary information about a job. | `GET` | `/v1/job/:job_id/summary` | `application/json` | The table below shows this endpoint's support for -[blocking queries](/api#blocking-queries) and -[required ACLs](/api#acls). +[blocking queries](/api-docs#blocking-queries) and +[required ACLs](/api-docs#acls). | Blocking Queries | ACL Required | | ---------------- | -------------------- | @@ -1151,8 +1151,8 @@ This endpoint registers a new job or updates an existing job. | `POST` | `/v1/job/:job_id` | `application/json` | The table below shows this endpoint's support for -[blocking queries](/api#blocking-queries) and -[required ACLs](/api#acls). +[blocking queries](/api-docs#blocking-queries) and +[required ACLs](/api-docs#acls). | Blocking Queries | ACL Required | | ---------------- | --------------------------------------------------------------------------------- | @@ -1217,8 +1217,8 @@ This endpoint dispatches a new instance of a parameterized job. | `POST` | `/v1/job/:job_id/dispatch` | `application/json` | The table below shows this endpoint's support for -[blocking queries](/api#blocking-queries) and -[required ACLs](/api#acls). +[blocking queries](/api-docs#blocking-queries) and +[required ACLs](/api-docs#acls). | Blocking Queries | ACL Required | | ---------------- | ------------------------ | @@ -1276,8 +1276,8 @@ This endpoint reverts the job to an older version. | `POST` | `/v1/job/:job_id/revert` | `application/json` | The table below shows this endpoint's support for -[blocking queries](/api#blocking-queries) and -[required ACLs](/api#acls). +[blocking queries](/api-docs#blocking-queries) and +[required ACLs](/api-docs#acls). | Blocking Queries | ACL Required | | ---------------- | ---------------------- | @@ -1337,8 +1337,8 @@ This endpoint sets the job's stability. | `POST` | `/v1/job/:job_id/stable` | `application/json` | The table below shows this endpoint's support for -[blocking queries](/api#blocking-queries) and -[required ACLs](/api#acls). +[blocking queries](/api-docs#blocking-queries) and +[required ACLs](/api-docs#acls). | Blocking Queries | ACL Required | | ---------------- | ---------------------- | @@ -1393,8 +1393,8 @@ without a JSON payload will be removed in Nomad 0.9. | `POST` | `/v1/job/:job_id/evaluate` | `application/json` | The table below shows this endpoint's support for -[blocking queries](/api#blocking-queries) and -[required ACLs](/api#acls). +[blocking queries](/api-docs#blocking-queries) and +[required ACLs](/api-docs#acls). | Blocking Queries | ACL Required | | ---------------- | -------------------- | @@ -1451,8 +1451,8 @@ This endpoint invokes a dry-run of the scheduler for the job. | `POST` | `/v1/job/:job_id/plan` | `application/json` | The table below shows this endpoint's support for -[blocking queries](/api#blocking-queries) and -[required ACLs](/api#acls). +[blocking queries](/api-docs#blocking-queries) and +[required ACLs](/api-docs#acls). | Blocking Queries | ACL Required | | ---------------- | --------------------------------------------------------------------------------- | @@ -1655,8 +1655,8 @@ settings. As such, this should be only used to immediately run a periodic job. | `POST` | `/v1/job/:job_id/periodic/force` | `application/json` | The table below shows this endpoint's support for -[blocking queries](/api#blocking-queries) and -[required ACLs](/api#acls). +[blocking queries](/api-docs#blocking-queries) and +[required ACLs](/api-docs#acls). | Blocking Queries | ACL Required | | ---------------- | ---------------------- | @@ -1693,8 +1693,8 @@ This endpoint deregisters a job, and stops all allocations part of it. | `DELETE` | `/v1/job/:job_id` | `application/json` | The table below shows this endpoint's support for -[blocking queries](/api#blocking-queries) and -[required ACLs](/api#acls). +[blocking queries](/api-docs#blocking-queries) and +[required ACLs](/api-docs#acls). | Blocking Queries | ACL Required | | ---------------- | ---------------------- | diff --git a/website/pages/api-docs/json-jobs.mdx b/website/pages/api-docs/json-jobs.mdx index ea87f00615..b0fa169fda 100644 --- a/website/pages/api-docs/json-jobs.mdx +++ b/website/pages/api-docs/json-jobs.mdx @@ -680,7 +680,7 @@ attributes: - "manual" - Specifies that Nomad should not automatically determine health and that the operator will specify allocation health using the [HTTP - API](/api/deployments#set-allocation-health-in-deployment). + API]/1/api-docs/deployments#set-allocation-health-in-deployment). - `MinHealthyTime` - Specifies the minimum time the allocation must be in the healthy state before it is marked as healthy and unblocks further allocations diff --git a/website/pages/api-docs/metrics.mdx b/website/pages/api-docs/metrics.mdx index 6a2677ccfb..bc374e4886 100644 --- a/website/pages/api-docs/metrics.mdx +++ b/website/pages/api-docs/metrics.mdx @@ -14,8 +14,8 @@ The `/metrics` endpoint returns metrics for the current Nomad process. | `GET` | `/v1/metrics` | `application/json` | The table below shows this endpoint's support for -[blocking queries](/api#blocking-queries) and -[required ACLs](/api#acls). +[blocking queries](/api-docs#blocking-queries) and +[required ACLs](/api-docs#acls). | Blocking Queries | ACL Required | | ---------------- | ------------ | diff --git a/website/pages/api-docs/namespaces.mdx b/website/pages/api-docs/namespaces.mdx index b8708bcdf2..f44ab37a1f 100644 --- a/website/pages/api-docs/namespaces.mdx +++ b/website/pages/api-docs/namespaces.mdx @@ -21,8 +21,8 @@ This endpoint lists all namespaces. | `GET` | `/v1/namespaces` | `application/json` | The table below shows this endpoint's support for -[blocking queries](/api#blocking-queries) and -[required ACLs](/api#acls). +[blocking queries](/api-docs#blocking-queries) and +[required ACLs](/api-docs#acls). | Blocking Queries | ACL Required | | ---------------- | -------------------------------------------------------------------------- | @@ -75,8 +75,8 @@ This endpoint reads information about a specific namespace. | `GET` | `/v1/namespace/:namespace` | `application/json` | The table below shows this endpoint's support for -[blocking queries](/api#blocking-queries) and -[required ACLs](/api#acls). +[blocking queries](/api-docs#blocking-queries) and +[required ACLs](/api-docs#acls). | Blocking Queries | ACL Required | | ---------------- | -------------------------------------------------------------------------- | @@ -115,8 +115,8 @@ This endpoint is used to create or update a namespace. | `POST` | `/v1/namespace/:namespace` <br /> `/v1/namespace` | `application/json` | The table below shows this endpoint's support for -[blocking queries](/api#blocking-queries) and -[required ACLs](/api#acls). +[blocking queries](/api-docs#blocking-queries) and +[required ACLs](/api-docs#acls). | Blocking Queries | ACL Required | | ---------------- | ------------ | @@ -167,8 +167,8 @@ This endpoint is used to delete a namespace. | `DELETE` | `/v1/namespace/:namespace` | `application/json` | The table below shows this endpoint's support for -[blocking queries](/api#blocking-queries) and -[required ACLs](/api#acls). +[blocking queries](/api-docs#blocking-queries) and +[required ACLs](/api-docs#acls). | Blocking Queries | ACL Required | | ---------------- | ------------ | diff --git a/website/pages/api-docs/nodes.mdx b/website/pages/api-docs/nodes.mdx index edf7b4fa24..7bb14b933b 100644 --- a/website/pages/api-docs/nodes.mdx +++ b/website/pages/api-docs/nodes.mdx @@ -18,8 +18,8 @@ This endpoint lists all nodes registered with Nomad. | `GET` | `/v1/nodes` | `application/json` | The table below shows this endpoint's support for -[blocking queries](/api#blocking-queries) and -[required ACLs](/api#acls). +[blocking queries](/api-docs#blocking-queries) and +[required ACLs](/api-docs#acls). | Blocking Queries | ACL Required | | ---------------- | ------------ | @@ -130,8 +130,8 @@ This endpoint queries the status of a client node. | `GET` | `/v1/node/:node_id` | `application/json` | The table below shows this endpoint's support for -[blocking queries](/api#blocking-queries) and -[required ACLs](/api#acls). +[blocking queries](/api-docs#blocking-queries) and +[required ACLs](/api-docs#acls). | Blocking Queries | ACL Required | | ---------------- | ------------ | @@ -391,8 +391,8 @@ and the values of dynamically assigned resources, like ports. | `GET` | `/v1/node/:node_id/allocations` | `application/json` | The table below shows this endpoint's support for -[blocking queries](/api#blocking-queries) and -[required ACLs](/api#acls). +[blocking queries](/api-docs#blocking-queries) and +[required ACLs](/api-docs#acls). | Blocking Queries | ACL Required | | ---------------- | ------------------------------ | @@ -764,8 +764,8 @@ force a run of the scheduling logic. | `POST` | `/v1/node/:node_id/evaluate` | `application/json` | The table below shows this endpoint's support for -[blocking queries](/api#blocking-queries) and -[required ACLs](/api#acls). +[blocking queries](/api-docs#blocking-queries) and +[required ACLs](/api-docs#acls). | Blocking Queries | ACL Required | | ---------------- | ------------ | @@ -832,8 +832,8 @@ Guide](ttps://learn.hashicorp.com/nomad/operating-nomad/node-draining) for sugge | `POST` | `/v1/node/:node_id/drain` | `application/json` | The table below shows this endpoint's support for -[blocking queries](/api#blocking-queries) and -[required ACLs](/api#acls). +[blocking queries](/api-docs#blocking-queries) and +[required ACLs](/api-docs#acls). | Blocking Queries | ACL Required | | ---------------- | ------------ | @@ -901,8 +901,8 @@ they are alive. | `POST` | `/v1/node/:node_id/purge` | `application/json` | The table below shows this endpoint's support for -[blocking queries](/api#blocking-queries) and -[required ACLs](/api#acls). +[blocking queries](/api-docs#blocking-queries) and +[required ACLs](/api-docs#acls). | Blocking Queries | ACL Required | | ---------------- | ------------ | @@ -947,8 +947,8 @@ This endpoint toggles the scheduling eligibility of the node. | `POST` | `/v1/node/:node_id/eligibility` | `application/json` | The table below shows this endpoint's support for -[blocking queries](/api#blocking-queries) and -[required ACLs](/api#acls). +[blocking queries](/api-docs#blocking-queries) and +[required ACLs](/api-docs#acls). | Blocking Queries | ACL Required | | ---------------- | ------------ | diff --git a/website/pages/api-docs/operator.mdx b/website/pages/api-docs/operator.mdx index 69afdd5bbc..57f458418b 100644 --- a/website/pages/api-docs/operator.mdx +++ b/website/pages/api-docs/operator.mdx @@ -29,8 +29,8 @@ This endpoint queries the status of a client node registered with Nomad. | `GET` | `/v1/operator/raft/configuration` | `application/json` | The table below shows this endpoint's support for -[blocking queries](/api#blocking-queries) and -[required ACLs](/api#acls). +[blocking queries](/api-docs#blocking-queries) and +[required ACLs](/api-docs#acls). | Blocking Queries | ACL Required | | ---------------- | ------------ | @@ -100,8 +100,8 @@ configuration. The return code signifies success or failure. | `DELETE` | `/v1/operator/raft/peer` | `application/json` | The table below shows this endpoint's support for -[blocking queries](/api#blocking-queries) and -[required ACLs](/api#acls). +[blocking queries](/api-docs#blocking-queries) and +[required ACLs](/api-docs#acls). | Blocking Queries | ACL Required | | ---------------- | ------------ | @@ -132,8 +132,8 @@ This endpoint retrieves its latest Autopilot configuration. | `GET` | `/v1/operator/autopilot/configuration` | `application/json` | The table below shows this endpoint's support for -[blocking queries](/api#blocking-queries) and -[required ACLs](/api#acls). +[blocking queries](/api-docs#blocking-queries) and +[required ACLs](/api-docs#acls). | Blocking Queries | ACL Required | | ---------------- | --------------- | @@ -174,8 +174,8 @@ This endpoint updates the Autopilot configuration of the cluster. | `PUT` | `/v1/operator/autopilot/configuration` | `application/json` | The table below shows this endpoint's support for -[blocking queries](/api#blocking-queries) and -[required ACLs](/api#acls). +[blocking queries](/api-docs#blocking-queries) and +[required ACLs](/api-docs#acls). | Blocking Queries | ACL Required | | ---------------- | ---------------- | @@ -238,8 +238,8 @@ This endpoint queries the health of the autopilot status. | `GET` | `/v1/operator/autopilot/health` | `application/json` | The table below shows this endpoint's support for -[blocking queries](/api#blocking-queries) and -[required ACLs](/api#acls). +[blocking queries](/api-docs#blocking-queries) and +[required ACLs](/api-docs#acls). | Blocking Queries | ACL Required | | ---------------- | --------------- | @@ -337,8 +337,8 @@ the future. | `GET` | `/v1/operator/scheduler/configuration` | `application/json` | The table below shows this endpoint's support for -[blocking queries](/api#blocking-queries) and -[required ACLs](/api#acls). +[blocking queries](/api-docs#blocking-queries) and +[required ACLs](/api-docs#acls). | Blocking Queries | ACL Required | | ---------------- | --------------- | @@ -394,8 +394,8 @@ This endpoint updates the scheduler configuration of the cluster. | `PUT`, `POST` | `/v1/operator/scheduler/configuration` | `application/json` | The table below shows this endpoint's support for -[blocking queries](/api#blocking-queries) and -[required ACLs](/api#acls). +[blocking queries](/api-docs#blocking-queries) and +[required ACLs](/api-docs#acls). | Blocking Queries | ACL Required | | ---------------- | ---------------- | diff --git a/website/pages/api-docs/quotas.mdx b/website/pages/api-docs/quotas.mdx index d8ca1f16c2..642fb01cec 100644 --- a/website/pages/api-docs/quotas.mdx +++ b/website/pages/api-docs/quotas.mdx @@ -21,8 +21,8 @@ This endpoint lists all quota specifications. | `GET` | `/v1/quotas` | `application/json` | The table below shows this endpoint's support for -[blocking queries](/api#blocking-queries) and -[required ACLs](/api#acls). +[blocking queries](/api-docs#blocking-queries) and +[required ACLs](/api-docs#acls). | Blocking Queries | ACL Required | | ---------------- | --------------------------------------------------------------- | @@ -90,8 +90,8 @@ This endpoint reads information about a specific quota specification. | `GET` | `/v1/quota/:quota` | `application/json` | The table below shows this endpoint's support for -[blocking queries](/api#blocking-queries) and -[required ACLs](/api#acls). +[blocking queries](/api-docs#blocking-queries) and +[required ACLs](/api-docs#acls). | Blocking Queries | ACL Required | | ---------------- | --------------------------------------------------------------- | @@ -152,8 +152,8 @@ This endpoint is used to create or update a quota specification. | `POST` | `/v1/quota/:quota` <br /> `/v1/quota` | `application/json` | The table below shows this endpoint's support for -[blocking queries](/api#blocking-queries) and -[required ACLs](/api#acls). +[blocking queries](/api-docs#blocking-queries) and +[required ACLs](/api-docs#acls). | Blocking Queries | ACL Required | | ---------------- | ------------- | @@ -213,8 +213,8 @@ This endpoint is used to delete a quota specification. | `DELETE` | `/v1/quota/:quota` | `application/json` | The table below shows this endpoint's support for -[blocking queries](/api#blocking-queries) and -[required ACLs](/api#acls). +[blocking queries](/api-docs#blocking-queries) and +[required ACLs](/api-docs#acls). | Blocking Queries | ACL Required | | ---------------- | ------------- | @@ -242,8 +242,8 @@ This endpoint lists all quota usages. | `GET` | `/v1/quota-usages` | `application/json` | The table below shows this endpoint's support for -[blocking queries](/api#blocking-queries) and -[required ACLs](/api#acls). +[blocking queries](/api-docs#blocking-queries) and +[required ACLs](/api-docs#acls). | Blocking Queries | ACL Required | | ---------------- | --------------------------------------------------------------- | @@ -299,8 +299,8 @@ This endpoint reads information about a specific quota usage. | `GET` | `/v1/quota/usage/:quota` | `application/json` | The table below shows this endpoint's support for -[blocking queries](/api#blocking-queries) and -[required ACLs](/api#acls). +[blocking queries](/api-docs#blocking-queries) and +[required ACLs](/api-docs#acls). | Blocking Queries | ACL Required | | ---------------- | --------------------------------------------------------------- | diff --git a/website/pages/api-docs/regions.mdx b/website/pages/api-docs/regions.mdx index 7f59f83afe..b6b784e78b 100644 --- a/website/pages/api-docs/regions.mdx +++ b/website/pages/api-docs/regions.mdx @@ -16,8 +16,8 @@ The `/regions` endpoints list all known regions. | `GET` | `/regions` | `application/json` | The table below shows this endpoint's support for -[blocking queries](/api#blocking-queries) and -[required ACLs](/api#acls). +[blocking queries](/api-docs#blocking-queries) and +[required ACLs](/api-docs#acls). | Blocking Queries | ACL Required | | ---------------- | ------------ | diff --git a/website/pages/api-docs/search.mdx b/website/pages/api-docs/search.mdx index a9aa961e87..416f430add 100644 --- a/website/pages/api-docs/search.mdx +++ b/website/pages/api-docs/search.mdx @@ -17,8 +17,8 @@ Additionally, a prefix can be searched for within every context. | `POST` | `/v1/search` | `application/json` | The table below shows this endpoint's support for -[blocking queries](/api#blocking-queries) and -[required ACLs](/api#acls). +[blocking queries](/api-docs#blocking-queries) and +[required ACLs](/api-docs#acls). | Blocking Queries | ACL Required | | ---------------- | -------------------------------- | diff --git a/website/pages/api-docs/sentinel-policies.mdx b/website/pages/api-docs/sentinel-policies.mdx index 2bfe354ca8..13785ee0dc 100644 --- a/website/pages/api-docs/sentinel-policies.mdx +++ b/website/pages/api-docs/sentinel-policies.mdx @@ -27,8 +27,8 @@ to the region, and may lag behind the authoritative region. | `GET` | `/sentinel/policies` | `application/json` | The table below shows this endpoint's support for -[blocking queries](/api#blocking-queries), [consistency modes](/api#consistency-modes) and -[required ACLs](/api#acls). +[blocking queries](/api-docs#blocking-queries), [consistency modes](/api-docs#consistency-modes) and +[required ACLs](/api-docs#acls). | Blocking Queries | Consistency Modes | ACL Required | | ---------------- | ----------------- | ------------ | @@ -67,8 +67,8 @@ authoritative region. | `POST` | `/sentinel/policy/:policy_name` | `(empty body)` | The table below shows this endpoint's support for -[blocking queries](/api#blocking-queries) and -[required ACLs](/api#acls). +[blocking queries](/api-docs#blocking-queries) and +[required ACLs](/api-docs#acls). | Blocking Queries | ACL Required | | ---------------- | ------------ | @@ -119,8 +119,8 @@ replicated to the region, and may lag behind the authoritative region. | `GET` | `/sentinel/policy/:policy_name` | `application/json` | The table below shows this endpoint's support for -[blocking queries](/api#blocking-queries), [consistency modes](/api#consistency-modes) and -[required ACLs](/api#acls). +[blocking queries](/api-docs#blocking-queries), [consistency modes](/api-docs#consistency-modes) and +[required ACLs](/api-docs#acls). | Blocking Queries | Consistency Modes | ACL Required | | ---------------- | ----------------- | ------------ | @@ -158,8 +158,8 @@ authoritative region. | `DELETE` | `/sentinel/policy/:policy_name` | `(empty body)` | The table below shows this endpoint's support for -[blocking queries](/api#blocking-queries) and -[required ACLs](/api#acls). +[blocking queries](/api-docs#blocking-queries) and +[required ACLs](/api-docs#acls). | Blocking Queries | ACL Required | | ---------------- | ------------ | diff --git a/website/pages/api-docs/status.mdx b/website/pages/api-docs/status.mdx index c3a24fab05..66b2a7621a 100644 --- a/website/pages/api-docs/status.mdx +++ b/website/pages/api-docs/status.mdx @@ -18,8 +18,8 @@ This endpoint returns the address of the current leader in the region. | `GET` | `/status/leader` | `application/json` | The table below shows this endpoint's support for -[blocking queries](/api#blocking-queries) and -[required ACLs](/api#acls). +[blocking queries](/api-docs#blocking-queries) and +[required ACLs](/api-docs#acls). | Blocking Queries | ACL Required | | ---------------- | ------------ | @@ -47,8 +47,8 @@ This endpoint returns the set of raft peers in the region. | `GET` | `/status/peers` | `application/json` | The table below shows this endpoint's support for -[blocking queries](/api#blocking-queries) and -[required ACLs](/api#acls). +[blocking queries](/api-docs#blocking-queries) and +[required ACLs](/api-docs#acls). | Blocking Queries | ACL Required | | ---------------- | ------------ | diff --git a/website/pages/api-docs/system.mdx b/website/pages/api-docs/system.mdx index dda7cf552d..42111d620e 100644 --- a/website/pages/api-docs/system.mdx +++ b/website/pages/api-docs/system.mdx @@ -20,8 +20,8 @@ nodes. This is an asynchronous operation. | `PUT` | `/v1/system/gc` | `application/json` | The table below shows this endpoint's support for -[blocking queries](/api#blocking-queries) and -[required ACLs](/api#acls). +[blocking queries](/api-docs#blocking-queries) and +[required ACLs](/api-docs#acls). | Blocking Queries | ACL Required | | ---------------- | ------------ | @@ -44,8 +44,8 @@ This endpoint reconciles the summaries of all registered jobs. | `PUT` | `/v1/system/reconcile/summaries` | `application/json` | The table below shows this endpoint's support for -[blocking queries](/api#blocking-queries) and -[required ACLs](/api#acls). +[blocking queries](/api-docs#blocking-queries) and +[required ACLs](/api-docs#acls). | Blocking Queries | ACL Required | | ---------------- | ------------ | diff --git a/website/pages/api-docs/validate.mdx b/website/pages/api-docs/validate.mdx index 6e94187dd6..7f59f62adf 100644 --- a/website/pages/api-docs/validate.mdx +++ b/website/pages/api-docs/validate.mdx @@ -25,8 +25,8 @@ the job file locally but skips validating driver configurations. | `POST` | `/v1/validate/job` | `application/json` | The table below shows this endpoint's support for -[blocking queries](/api#blocking-queries) and -[required ACLs](/api#acls). +[blocking queries](/api-docs#blocking-queries) and +[required ACLs](/api-docs#acls). | Blocking Queries | ACL Required | | ---------------- | -------------------- | diff --git a/website/pages/docs/commands/job/inspect.mdx b/website/pages/docs/commands/job/inspect.mdx index 6a91f57a10..ea9f95a42d 100644 --- a/website/pages/docs/commands/job/inspect.mdx +++ b/website/pages/docs/commands/job/inspect.mdx @@ -153,4 +153,4 @@ $ nomad job inspect redis } ``` -[job http api]: /api/jobs +[job http api]:/1/api-docs/jobs diff --git a/website/pages/docs/commands/job/periodic-force.mdx b/website/pages/docs/commands/job/periodic-force.mdx index 4aad56adfc..bc80364e2e 100644 --- a/website/pages/docs/commands/job/periodic-force.mdx +++ b/website/pages/docs/commands/job/periodic-force.mdx @@ -62,5 +62,5 @@ Evaluation ID: 0865fbf3-30de-5f53-0811-821e73e63178 ``` [eval status]: /docs/commands/eval-status -[force the evaluation]: /api/jobs#force-new-periodic-instance +[force the evaluation]:/1/api-docs/jobs#force-new-periodic-instance [periodic job]: /docs/job-specification/periodic diff --git a/website/pages/docs/commands/operator/index.mdx b/website/pages/docs/commands/operator/index.mdx index 7776688beb..aba636c0d5 100644 --- a/website/pages/docs/commands/operator/index.mdx +++ b/website/pages/docs/commands/operator/index.mdx @@ -45,7 +45,7 @@ The following subcommands are available: [keygen]: /docs/commands/operator/keygen 'Generates a new encryption key' [keyring]: /docs/commands/operator/keyring 'Manages gossip layer encryption keys' [list]: /docs/commands/operator/raft-list-peers 'Raft List Peers command' -[operator]: /api/operator 'Operator API documentation' +[operator]:/1/api-docs/operator 'Operator API documentation' [outage recovery guide]: https://learn.hashicorp.com/nomad/operating-nomad/outage [remove]: /docs/commands/operator/raft-remove-peer 'Raft Remove Peer command' [set-config]: /docs/commands/operator/autopilot-set-config 'Autopilot Set Config command' diff --git a/website/pages/docs/commands/operator/raft-list-peers.mdx b/website/pages/docs/commands/operator/raft-list-peers.mdx index a4637fec3a..17942a2a7e 100644 --- a/website/pages/docs/commands/operator/raft-list-peers.mdx +++ b/website/pages/docs/commands/operator/raft-list-peers.mdx @@ -58,5 +58,5 @@ nomad-server03.global 10.10.11.7:4647 10.10.11.7:4647 follower true - `Voter` is "true" or "false", indicating if the server has a vote in the Raft configuration. Future versions of Nomad may add support for non-voting servers. -[operator]: /api/operator +[operator]:/1/api-docs/operator [outage recovery]: https://learn.hashicorp.com/nomad/operating-nomad/outage diff --git a/website/pages/docs/commands/operator/raft-remove-peer.mdx b/website/pages/docs/commands/operator/raft-remove-peer.mdx index 9c300df1aa..e8869edf66 100644 --- a/website/pages/docs/commands/operator/raft-remove-peer.mdx +++ b/website/pages/docs/commands/operator/raft-remove-peer.mdx @@ -41,5 +41,5 @@ nomad operator raft remove-peer [options] [`nomad server force-leave`]: /docs/commands/server/force-leave 'Nomad server force-leave command' [`nomad server members`]: /docs/commands/server/members 'Nomad server members command' -[operator]: /api/operator 'Nomad Operator API' +[operator]:/1/api-docs/operator 'Nomad Operator API' [outage recovery]: https://learn.hashicorp.com/nomad/operating-nomad/outage diff --git a/website/pages/docs/configuration/index.mdx b/website/pages/docs/configuration/index.mdx index 071017bde4..19f3ebb132 100644 --- a/website/pages/docs/configuration/index.mdx +++ b/website/pages/docs/configuration/index.mdx @@ -340,5 +340,5 @@ http_api_response_headers { [tls]: /docs/configuration/tls 'Nomad Agent tls Configuration' [`vault`]: /docs/configuration/vault 'Nomad Agent vault Configuration' [go-sockaddr/template]: https://godoc.org/github.com/hashicorp/go-sockaddr/template -[log-api]: /api/client#stream-logs +[log-api]:/1/api-docs/client#stream-logs [hcl]: https://github.com/hashicorp/hcl 'HashiCorp Configuration Language' diff --git a/website/pages/docs/configuration/server.mdx b/website/pages/docs/configuration/server.mdx index cf1ce6f2dd..532d71dfd2 100644 --- a/website/pages/docs/configuration/server.mdx +++ b/website/pages/docs/configuration/server.mdx @@ -257,4 +257,4 @@ endpoint, that is always preferred. [encryption]: https://learn.hashicorp.com/nomad/transport-security/gossip-encryption 'Nomad Encryption Overview' [server-join]: /docs/configuration/server_join 'Server Join' -[update-scheduler-config]: /api/operator#update-scheduler-configuration 'Scheduler Config' +[update-scheduler-config]:/1/api-docs/operator#update-scheduler-configuration 'Scheduler Config' diff --git a/website/pages/docs/drivers/index.mdx b/website/pages/docs/drivers/index.mdx index d7aa1e4811..ad191d9413 100644 --- a/website/pages/docs/drivers/index.mdx +++ b/website/pages/docs/drivers/index.mdx @@ -36,7 +36,7 @@ security-related controls, but the Nomad client to task interface should not be considered a security boundary. See the [access control guide][acl_guide] for more information on how to protect Nomad cluster operations. -[plugin]: /docs/configuration/plugin.html +[plugin]: /docs/configuration/plugin [docker_plugin]: /docs/drivers/docker#client-requirements [plugin_guide]: /docs/internals/plugins [acl_guide]: https://learn.hashicorp.com/nomad?track=acls#operations-and-development diff --git a/website/pages/docs/internals/scheduling/preemption.mdx b/website/pages/docs/internals/scheduling/preemption.mdx index eb164cb1dc..50d9f85dbc 100644 --- a/website/pages/docs/internals/scheduling/preemption.mdx +++ b/website/pages/docs/internals/scheduling/preemption.mdx @@ -31,7 +31,7 @@ into the plan queue. # Details -Preemption is enabled by default in Nomad 0.9. Operators can use the [scheduler config](/api/operator#update-scheduler-configuration) API endpoint to disable preemption. +Preemption is enabled by default in Nomad 0.9. Operators can use the [scheduler config]/1/api-docs/operator#update-scheduler-configuration) API endpoint to disable preemption. Nomad uses the [job priority](/docs/job-specification/job#priority) field to determine what running allocations can be preempted. In order to prevent a cascade of preemptions due to jobs close in priority being preempted, only allocations from jobs with a priority @@ -55,7 +55,7 @@ allocations `a1`, `a2` and `a4` to satisfy those requirements. # Preemption Visibility -Operators can use the [allocation API](/api/allocations#read-allocation) or the `alloc status` command to get visibility into +Operators can use the [allocation API]/1/api-docs/allocations#read-allocation) or the `alloc status` command to get visibility into whether an allocation has been preempted. Preempted allocations will have their DesiredStatus set to 鈥渆vict鈥�. The `Allocation` object in the API also has two additional fields related to preemption. diff --git a/website/pages/docs/job-specification/device.mdx b/website/pages/docs/job-specification/device.mdx index dc562302af..2c4c6b83a6 100644 --- a/website/pages/docs/job-specification/device.mdx +++ b/website/pages/docs/job-specification/device.mdx @@ -299,6 +299,6 @@ device "nvidia/gpu" { } ``` -[affinity]: /docs/job-specification/affinity.html 'Nomad affinity Job Specification' -[constraint]: /docs/job-specification/constraint.html 'Nomad constraint Job Specification' +[affinity]: /docs/job-specification/affinity 'Nomad affinity Job Specification' +[constraint]: /docs/job-specification/constraint 'Nomad constraint Job Specification' [devices]: /docs/devices 'Nomad Device Plugins' diff --git a/website/pages/docs/job-specification/update.mdx b/website/pages/docs/job-specification/update.mdx index c5a178628b..3392dd8f1c 100644 --- a/website/pages/docs/job-specification/update.mdx +++ b/website/pages/docs/job-specification/update.mdx @@ -66,7 +66,7 @@ a future release. - "manual" - Specifies that Nomad should not automatically determine health and that the operator will specify allocation health using the [HTTP - API](/api/deployments#set-allocation-health-in-deployment). + API]/1/api-docs/deployments#set-allocation-health-in-deployment). - `min_healthy_time` `(string: "10s")` - Specifies the minimum time the allocation must be in the healthy state before it is marked as healthy and diff --git a/website/pages/docs/telemetry/index.mdx b/website/pages/docs/telemetry/index.mdx index 296118dcd3..92a3c905da 100644 --- a/website/pages/docs/telemetry/index.mdx +++ b/website/pages/docs/telemetry/index.mdx @@ -157,7 +157,7 @@ in particular. [datadog-alerting]: https://www.datadoghq.com/blog/monitoring-101-alerting/ [datadog-telem]: /docs/configuration/telemetry#datadog [prometheus-telem]: /docs/configuration/telemetry#prometheus -[metrics-api-endpoint]: /api/metrics +[metrics-api-endpoint]:/1/api-docs/metrics [metric-types]: /docs/telemetry/metrics#metric-types [statsd-exporter]: https://github.com/prometheus/statsd_exporter [statsd-telem]: /docs/configuration/telemetry#statsd diff --git a/website/pages/docs/telemetry/metrics.mdx b/website/pages/docs/telemetry/metrics.mdx index da8371b17a..b10923824b 100644 --- a/website/pages/docs/telemetry/metrics.mdx +++ b/website/pages/docs/telemetry/metrics.mdx @@ -15,7 +15,7 @@ This data can be accessed via an HTTP endpoint or via sending a signal to the Nomad process. As of Nomad version 0.7, this data is available via HTTP at `/metrics`. See -[Metrics](/api/metrics) for more information. +[Metrics]/1/api-docs/metrics) for more information. To view this data via sending a signal to the Nomad process: on Unix, this is `USR1` while on Windows it is `BREAK`. Once Nomad receives the signal, diff --git a/website/pages/docs/upgrade/upgrade-specific.mdx b/website/pages/docs/upgrade/upgrade-specific.mdx index e3dcc30b4a..16bd917dad 100644 --- a/website/pages/docs/upgrade/upgrade-specific.mdx +++ b/website/pages/docs/upgrade/upgrade-specific.mdx @@ -457,7 +457,7 @@ draining the node so no tasks are running on it. This can be verified by running state. Once that is done the client can be killed, the `data_dir` should be deleted and then Nomad 0.3.0 can be launched. -[drain-api]: /api/nodes#drain-node +[drain-api]:/1/api-docs/nodes#drain-node [drain-cli]: /docs/commands/node/drain [dangling-containers]: /docs/drivers/docker#dangling-containers [gh-6787]: https://github.com/hashicorp/nomad/issues/6787 @@ -468,7 +468,7 @@ deleted and then Nomad 0.3.0 can be launched. [plugins]: /docs/drivers/external [plugin-stanza]: /docs/configuration/plugin [preemption]: /docs/internals/scheduling/preemption -[preemption-api]: /api/operator#update-scheduler-configuration +[preemption-api]:/1/api-docs/operator#update-scheduler-configuration [task-config]: /docs/job-specification/task#config [validate]: /docs/commands/job/validate [vault_grace]: /docs/job-specification/template diff --git a/website/pages/intro/getting-started/running.mdx b/website/pages/intro/getting-started/running.mdx index fb20273a36..a89c1e77dd 100644 --- a/website/pages/intro/getting-started/running.mdx +++ b/website/pages/intro/getting-started/running.mdx @@ -142,4 +142,4 @@ be used to force the server from a _failed_ to a _left_ state. ## Next Steps -If you shut down the development Nomad agent as instructed above, ensure that it is back up and running again and let's try to [run a job](jobs)! +If you shut down the development Nomad agent as instructed above, ensure that it is back up and running again and let's try to [run a job](/intro/getting-started/jobs)! -- GitLab