luxolus
/
open-nomad
2
0
Fork 0
Code Issues 1 Pull Requests Packages Releases Wiki Activity

docs: Migrate link formats (#15779) 

* Adding check-legacy-links-format workflow

* Adding test-link-rewrites workflow

* chore: updates link checker workflow hash

* Migrating links to new format

Co-authored-by: Kendall Strautman <kendallstrautman@gmail.com>
This commit is contained in:
Ashlee M Boyer 2023-01-25 11:31:14 -06:00 committed by GitHub
parent cf9e5f3327
commit 57f8ebfa26
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
337 changed files with 1864 additions and 1831 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
.github/workflows/check-legacy-links-format.yml vendored Normal file
View File

@ -0,0 +1,17 @@
name: Legacy Link Format Checker
on:
push:
paths:
- "website/content/**/*.mdx"
- "website/data/*-nav-data.json"
jobs:
check-links:
uses: hashicorp/dev-portal/.github/workflows/docs-content-check-legacy-links-format.yml@475289345d312552b745224b46895f51cc5fc490
with:
repo-owner: "hashicorp"
repo-name: "nomad"
commit-sha: ${{ github.sha }}
mdx-directory: "website/content"
nav-data-directory: "website/data"

16
.github/workflows/test-link-rewrites.yml vendored Normal file
View File

@ -0,0 +1,16 @@
name: Test Link Rewrites
on: [deployment_status]
jobs:
test-link-rewrites:
if: github.event.deployment_status.state == 'success'
uses: hashicorp/dev-portal/.github/workflows/docs-content-link-rewrites-e2e.yml@2aceb60125f6c15f4c8dbe2e4d79148047bfa437
with:
repo-owner: "hashicorp"
repo-name: "nomad"
commit-sha: ${{ github.sha }}
main-branch-preview-url: "https://nomad-git-main-hashicorp.vercel.app/"
# Workflow is only intended to run for one single migration PR
# This variable does not need to be updated
pr-branch-preview-url: "https://nomad-git-docs-ambmigrate-link-formats-hashicorp.vercel.app/"

22
website/content/api-docs/acl/auth-methods.mdx
View File

@ -18,8 +18,8 @@ authoritative region.
| `POST` | `/acl/auth-method` | `application/json` |
The table below shows this endpoint's support for
[blocking queries](/api-docs#blocking-queries) and
[required ACLs](/api-docs#acls).
[blocking queries](/nomad/api-docs#blocking-queries) and
[required ACLs](/nomad/api-docs#acls).
| Blocking Queries | ACL Required |
| ---------------- | ------------ |
@ -178,7 +178,7 @@ forwarded to the authoritative region.
| `POST` | `/acl/auth-method/:method_name` | `application/json` |
The table below shows this endpoint's support for [blocking
queries](/api-docs#blocking-queries) and [required ACLs](/api-docs#acls).
queries](/nomad/api-docs#blocking-queries) and [required ACLs](/nomad/api-docs#acls).
| Blocking Queries | ACL Required |
| ---------------- | ------------ |
@ -335,9 +335,9 @@ been replicated to the region, and may lag behind the authoritative region.
| `GET` | `/acl/auth-methods` | `application/json` |
The table below shows this endpoint's support for
[blocking queries](/api-docs#blocking-queries),
[consistency modes](/api-docs#consistency-modes) and
[required ACLs](/api-docs#acls).
[blocking queries](/nomad/api-docs#blocking-queries),
[consistency modes](/nomad/api-docs#consistency-modes) and
[required ACLs](/nomad/api-docs#acls).
| Blocking Queries | Consistency Modes | ACL Required |
| ---------------- | ----------------- | ---- |
@ -376,9 +376,9 @@ authoritative region.
| `GET` | `/acl/auth-method/:method_name` | `application/json` |
The table below shows this endpoint's support for
[blocking queries](/api-docs#blocking-queries),
[consistency modes](/api-docs#consistency-modes) and
[required ACLs](/api-docs#acls).
[blocking queries](/nomad/api-docs#blocking-queries),
[consistency modes](/nomad/api-docs#consistency-modes) and
[required ACLs](/nomad/api-docs#acls).
| Blocking Queries | Consistency Modes | ACL Required |
| ---------------- | ----------------- | ------------------ |
@ -444,8 +444,8 @@ request is always forwarded to the authoritative region.
| `DELETE` | `/acl/auth-method/:method_name` | `(empty body)` |
The table below shows this endpoint's support for
[blocking queries](/api-docs#blocking-queries) and
[required ACLs](/api-docs#acls).
[blocking queries](/nomad/api-docs#blocking-queries) and
[required ACLs](/nomad/api-docs#acls).
| Blocking Queries | ACL Required |
| ---------------- | ------------ |

22
website/content/api-docs/acl/binding-rules.mdx
View File

@ -19,9 +19,9 @@ authoritative region.
| `GET` | `/acl/binding-rule/:rule_id` | `application/json` |
The table below shows this endpoint's support for
[blocking queries](/api-docs#blocking-queries),
[consistency modes](/api-docs#consistency-modes) and
[required ACLs](/api-docs#acls).
[blocking queries](/nomad/api-docs#blocking-queries),
[consistency modes](/nomad/api-docs#consistency-modes) and
[required ACLs](/nomad/api-docs#acls).
| Blocking Queries | Consistency Modes | ACL Required |
| ---------------- | ----------------- | ------------ |
@ -67,9 +67,9 @@ been replicated to the region, and may lag behind the authoritative region.
| `GET` | `/acl/binding-rules` | `application/json` |
The table below shows this endpoint's support for
[blocking queries](/api-docs#blocking-queries),
[consistency modes](/api-docs#consistency-modes) and
[required ACLs](/api-docs#acls).
[blocking queries](/nomad/api-docs#blocking-queries),
[consistency modes](/nomad/api-docs#consistency-modes) and
[required ACLs](/nomad/api-docs#acls).
| Blocking Queries | Consistency Modes | ACL Required |
| ---------------- | ----------------- | ------------ |
@ -108,8 +108,8 @@ authoritative region.
| `POST` | `/acl/binding-rule` | `application/json` |
The table below shows this endpoint's support for
[blocking queries](/api-docs#blocking-queries) and
[required ACLs](/api-docs#acls).
[blocking queries](/nomad/api-docs#blocking-queries) and
[required ACLs](/nomad/api-docs#acls).
| Blocking Queries | ACL Required |
| ---------------- | ------------ |
@ -185,7 +185,7 @@ forwarded to the authoritative region.
| `POST` | `/acl/binding-rule/:rule_id` | `application/json` |
The table below shows this endpoint's support for [blocking
queries](/api-docs#blocking-queries) and [required ACLs](/api-docs#acls).
queries](/nomad/api-docs#blocking-queries) and [required ACLs](/nomad/api-docs#acls).
| Blocking Queries | ACL Required |
| ---------------- | ------------ |
@ -253,8 +253,8 @@ is always forwarded to the authoritative region.
| `DELETE` | `/acl/binding-rule/:rule_id` | `(empty body)` |
The table below shows this endpoint's support for
[blocking queries](/api-docs#blocking-queries) and
[required ACLs](/api-docs#acls).
[blocking queries](/nomad/api-docs#blocking-queries) and
[required ACLs](/nomad/api-docs#acls).
| Blocking Queries | ACL Required |
| ---------------- | ------------ |

2
website/content/api-docs/acl/index.mdx
View File

@ -10,6 +10,6 @@ description: |-
The `/acl` endpoints provide access to the ACL subsystem which includes ACL
bootstrapping, ACL Policies, ACL Roles, ACL Tokens, ACL Auth Methods, and ACL
Binding Rules. For more details about ACLs, please see the [ACL
Guide](https://learn.hashicorp.com/collections/nomad/access-control).
Guide](/nomad/tutorials/access-control).
Please choose a subsection in the navigation for more information.

8
website/content/api-docs/acl/oidc.mdx
View File

@ -18,8 +18,8 @@ OIDC provider and log in. The returned string is URL encoded.
| `POST` | `/v1/acl/oidc/auth-url` | `application/json` |
The table below shows this endpoint's support for
[blocking queries](/api-docs#blocking-queries) and
[required ACLs](/api-docs#acls).
[blocking queries](/nomad/api-docs#blocking-queries) and
[required ACLs](/nomad/api-docs#acls).
| Blocking Queries | ACL Required |
| ---------------- | ------------ |
@ -74,8 +74,8 @@ authoritative region.
| `POST` | `/v1/acl/oidc/complete-auth` | `application/json` |
The table below shows this endpoint's support for
[blocking queries](/api-docs#blocking-queries) and
[required ACLs](/api-docs#acls).
[blocking queries](/nomad/api-docs#blocking-queries) and
[required ACLs](/nomad/api-docs#acls).
| Blocking Queries | ACL Required |
| ---------------- | ------------ |

18
website/content/api-docs/acl/policies.mdx
View File

@ -7,7 +7,7 @@ description: The /acl/policy endpoints are used to configure and manage ACL poli
# ACL Policies HTTP API
The `/acl/policies` and `/acl/policy/` endpoints are used to manage ACL policies.
For more details about ACLs, please see the [ACL Guide](https://learn.hashicorp.com/collections/nomad/access-control).
For more details about ACLs, please see the [ACL Guide](/nomad/tutorials/access-control).
## List Policies
@ -19,8 +19,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-docs#blocking-queries), [consistency modes](/api-docs#consistency-modes) and
[required ACLs](/api-docs#acls).
[blocking queries](/nomad/api-docs#blocking-queries), [consistency modes](/nomad/api-docs#consistency-modes) and
[required ACLs](/nomad/api-docs#acls).
| Blocking Queries | Consistency Modes | ACL Required |
| ---------------- | ----------------- | -------------------------------------------------------------------------------------------------------------------------------- |
@ -66,8 +66,8 @@ authoritative region.
| `POST` | `/acl/policy/:policy_name` | `(empty body)` |
The table below shows this endpoint's support for
[blocking queries](/api-docs#blocking-queries) and
[required ACLs](/api-docs#acls).
[blocking queries](/nomad/api-docs#blocking-queries) and
[required ACLs](/nomad/api-docs#acls).
| Blocking Queries | ACL Required |
| ---------------- | ------------ |
@ -111,8 +111,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-docs#blocking-queries), [consistency modes](/api-docs#consistency-modes) and
[required ACLs](/api-docs#acls).
[blocking queries](/nomad/api-docs#blocking-queries), [consistency modes](/nomad/api-docs#consistency-modes) and
[required ACLs](/nomad/api-docs#acls).
| Blocking Queries | Consistency Modes | ACL Required |
| ---------------- | ----------------- | ------------------------------------------- |
@ -147,8 +147,8 @@ authoritative region.
| `DELETE` | `/acl/policy/:policy_name` | `(empty body)` |
The table below shows this endpoint's support for
[blocking queries](/api-docs#blocking-queries) and
[required ACLs](/api-docs#acls).
[blocking queries](/nomad/api-docs#blocking-queries) and
[required ACLs](/nomad/api-docs#acls).
| Blocking Queries | ACL Required |
| ---------------- | ------------ |

30
website/content/api-docs/acl/roles.mdx
View File

@ -18,8 +18,8 @@ authoritative region.
| `POST` | `/acl/role` | `application/json` |
The table below shows this endpoint's support for
[blocking queries](/api-docs#blocking-queries) and
[required ACLs](/api-docs#acls).
[blocking queries](/nomad/api-docs#blocking-queries) and
[required ACLs](/nomad/api-docs#acls).
| Blocking Queries | ACL Required |
| ---------------- | ------------ |
@ -89,8 +89,8 @@ authoritative region.
| `POST` | `/acl/role/:role_id` | `application/json` |
The table below shows this endpoint's support for
[blocking queries](/api-docs#blocking-queries) and
[required ACLs](/api-docs#acls).
[blocking queries](/nomad/api-docs#blocking-queries) and
[required ACLs](/nomad/api-docs#acls).
| Blocking Queries | ACL Required |
| ---------------- | ------------ |
@ -164,9 +164,9 @@ to the region, and may lag behind the authoritative region.
| `GET` | `/acl/roles` | `application/json` |
The table below shows this endpoint's support for
[blocking queries](/api-docs#blocking-queries),
[consistency modes](/api-docs#consistency-modes) and
[required ACLs](/api-docs#acls).
[blocking queries](/nomad/api-docs#blocking-queries),
[consistency modes](/nomad/api-docs#consistency-modes) and
[required ACLs](/nomad/api-docs#acls).
| Blocking Queries | Consistency Modes | ACL Required |
| ---------------- | ----------------- | -------------------------------------------------------------------------------------------------------------------------- |
@ -222,9 +222,9 @@ has been replicated to the region, and may lag behind the authoritative region.
| `GET` | `/acl/role/:role_id` | `application/json` |
The table below shows this endpoint's support for
[blocking queries](/api-docs#blocking-queries),
[consistency modes](/api-docs#consistency-modes) and
[required ACLs](/api-docs#acls).
[blocking queries](/nomad/api-docs#blocking-queries),
[consistency modes](/nomad/api-docs#consistency-modes) and
[required ACLs](/nomad/api-docs#acls).
| Blocking Queries | Consistency Modes | ACL Required |
| ---------------- | ----------------- | ----------------------------------------- |
@ -270,9 +270,9 @@ has been replicated to the region, and may lag behind the authoritative region.
| `GET` | `/acl/role/name/:role_name` | `application/json` |
The table below shows this endpoint's support for
[blocking queries](/api-docs#blocking-queries),
[consistency modes](/api-docs#consistency-modes) and
[required ACLs](/api-docs#acls).
[blocking queries](/nomad/api-docs#blocking-queries),
[consistency modes](/nomad/api-docs#consistency-modes) and
[required ACLs](/nomad/api-docs#acls).
| Blocking Queries | Consistency Modes | ACL Required |
| ---------------- | ----------------- | ----------------------------------------- |
@ -318,8 +318,8 @@ always forwarded to the authoritative region.
| `DELETE` | `/acl/role/:role_id` | `(empty body)` |
The table below shows this endpoint's support for
[blocking queries](/api-docs#blocking-queries) and
[required ACLs](/api-docs#acls).
[blocking queries](/nomad/api-docs#blocking-queries) and
[required ACLs](/nomad/api-docs#acls).
| Blocking Queries | ACL Required |
| ---------------- | ------------ |

42
website/content/api-docs/acl/tokens.mdx
View File

@ -7,7 +7,7 @@ description: The /acl/token/ endpoints are used to configure and manage ACL toke
# ACL Tokens HTTP API
The `/acl/bootstrap`, `/acl/tokens`, and `/acl/token/` endpoints are used to manage ACL tokens.
For more details about ACLs, please see the [ACL Guide](https://learn.hashicorp.com/collections/nomad/access-control).
For more details about ACLs, please see the [ACL Guide](/nomad/tutorials/access-control).
## Bootstrap Token
@ -16,15 +16,15 @@ An operator created token can be provided in the body of the request to bootstra
if required. If no header is provided the cluster will return a generated management token.
The provided token should be presented in a UUID format.
This request is always forwarded to the authoritative region. It can only be invoked once
until a [bootstrap reset](https://learn.hashicorp.com/tutorials/nomad/access-control-bootstrap#re-bootstrap-acl-system) is performed.
until a [bootstrap reset](/nomad/tutorials/access-control/access-control-bootstrap#re-bootstrap-acl-system) is performed.
| Method | Path | Produces |
| ------ | ---------------- | ------------------ |
| `POST` | `/acl/bootstrap` | `application/json` |
The table below shows this endpoint's support for
[blocking queries](/api-docs#blocking-queries) and
[required ACLs](/api-docs#acls).
[blocking queries](/nomad/api-docs#blocking-queries) and
[required ACLs](/nomad/api-docs#acls).
| Blocking Queries | ACL Required |
| ---------------- | ------------ |
@ -97,8 +97,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-docs#blocking-queries), [consistency modes](/api-docs#consistency-modes) and
[required ACLs](/api-docs#acls).
[blocking queries](/nomad/api-docs#blocking-queries), [consistency modes](/nomad/api-docs#consistency-modes) and
[required ACLs](/nomad/api-docs#acls).
| Blocking Queries | Consistency Modes | ACL Required |
| ---------------- | ----------------- | ------------ |
@ -124,7 +124,7 @@ The table below shows this endpoint's support for
`X-Nomad-NextToken` header of the last response can be used as the
`next_token` of the next request to fetch additional pages.
- `filter` `(string: "")` - Specifies the [expression](/api-docs#filtering)
- `filter` `(string: "")` - Specifies the [expression](/nomad/api-docs#filtering)
used to filter the results. Consider using pagination or a query parameter to
reduce resource used to serve the request.
@ -173,8 +173,8 @@ is forwarded to the authoritative region.
| `POST` | `/acl/token` | `application/json` |
The table below shows this endpoint's support for
[blocking queries](/api-docs#blocking-queries) and
[required ACLs](/api-docs#acls).
[blocking queries](/nomad/api-docs#blocking-queries) and
[required ACLs](/nomad/api-docs#acls).
| Blocking Queries | ACL Required |
| ---------------- | ------------ |
@ -250,8 +250,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-docs#blocking-queries) and
[required ACLs](/api-docs#acls).
[blocking queries](/nomad/api-docs#blocking-queries) and
[required ACLs](/nomad/api-docs#acls).
| Blocking Queries | ACL Required |
| ---------------- | ------------ |
@ -313,8 +313,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-docs#blocking-queries), [consistency modes](/api-docs#consistency-modes) and
[required ACLs](/api-docs#acls).
[blocking queries](/nomad/api-docs#blocking-queries), [consistency modes](/nomad/api-docs#consistency-modes) and
[required ACLs](/nomad/api-docs#acls).
| Blocking Queries | Consistency Modes | ACL Required |
| ---------------- | ----------------- | -------------------------------------------------- |
@ -353,8 +353,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-docs#blocking-queries), [consistency modes](/api-docs#consistency-modes) and
[required ACLs](/api-docs#acls).
[blocking queries](/nomad/api-docs#blocking-queries), [consistency modes](/nomad/api-docs#consistency-modes) and
[required ACLs](/nomad/api-docs#acls).
| Blocking Queries | Consistency Modes | ACL Required |
| ---------------- | ----------------- | ------------------- |
@ -394,8 +394,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-docs#blocking-queries) and
[required ACLs](/api-docs#acls).
[blocking queries](/nomad/api-docs#blocking-queries) and
[required ACLs](/nomad/api-docs#acls).
| Blocking Queries | ACL Required |
| ---------------- | ------------ |
@ -423,8 +423,8 @@ This endpoint creates a one-time token for the ACL token provided in the
| `POST` | `/acl/token/onetime` | `application/json` |
The table below shows this endpoint's support for
[blocking queries](/api-docs#blocking-queries) and
[required ACLs](/api-docs#acls).
[blocking queries](/nomad/api-docs#blocking-queries) and
[required ACLs](/nomad/api-docs#acls).
| Blocking Queries | ACL Required |
| ---------------- | ------------ |
@ -464,8 +464,8 @@ create it.
| `POST` | `/acl/token/onetime/exchange` | `application/json` |
The table below shows this endpoint's support for
[blocking queries](/api-docs#blocking-queries) and
[required ACLs](/api-docs#acls).
[blocking queries](/nomad/api-docs#blocking-queries) and
[required ACLs](/nomad/api-docs#acls).
| Blocking Queries | ACL Required |
| ---------------- | ------------ |

58
website/content/api-docs/agent.mdx
View File

@ -21,8 +21,8 @@ eventually consistent.
| `GET` | `/agent/members` | `application/json` |
The table below shows this endpoint's support for
[blocking queries](/api-docs#blocking-queries) and
[required ACLs](/api-docs#acls).
[blocking queries](/nomad/api-docs#blocking-queries) and
[required ACLs](/nomad/api-docs#acls).
| Blocking Queries | ACL Required |
| ---------------- | ------------ |
@ -82,8 +82,8 @@ are changes in the cluster.
| `GET` | `/agent/servers` | `application/json` |
The table below shows this endpoint's support for
[blocking queries](/api-docs#blocking-queries) and
[required ACLs](/api-docs#acls).
[blocking queries](/nomad/api-docs#blocking-queries) and
[required ACLs](/nomad/api-docs#acls).
| Blocking Queries | ACL Required |
| ---------------- | ------------ |
@ -112,8 +112,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-docs#blocking-queries) and
[required ACLs](/api-docs#acls).
[blocking queries](/nomad/api-docs#blocking-queries) and
[required ACLs](/nomad/api-docs#acls).
| Blocking Queries | ACL Required |
| ---------------- | ------------- |
@ -141,8 +141,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-docs#blocking-queries) and
[required ACLs](/api-docs#acls).
[blocking queries](/nomad/api-docs#blocking-queries) and
[required ACLs](/nomad/api-docs#acls).
| Blocking Queries | ACL Required |
| ---------------- | ------------ |
@ -390,8 +390,8 @@ eligible for servers.
| `POST` | `/agent/join` | `application/json` |
The table below shows this endpoint's support for
[blocking queries](/api-docs#blocking-queries) and
[required ACLs](/api-docs#acls).
[blocking queries](/nomad/api-docs#blocking-queries) and
[required ACLs](/nomad/api-docs#acls).
| Blocking Queries | ACL Required |
| ---------------- | ------------ |
@ -431,8 +431,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-docs#blocking-queries) and
[required ACLs](/api-docs#acls).
[blocking queries](/nomad/api-docs#blocking-queries) and
[required ACLs](/nomad/api-docs#acls).
| Blocking Queries | ACL Required |
| ---------------- | ------------- |
@ -463,8 +463,8 @@ containing an error message.
| `GET` | `/agent/health` | `application/json` |
The table below shows this endpoint's support for
[blocking queries](/api-docs#blocking-queries) and
[required ACLs](/api-docs#acls).
[blocking queries](/nomad/api-docs#blocking-queries) and
[required ACLs](/nomad/api-docs#acls).
| Blocking Queries | ACL Required |
| ---------------- | ------------ |
@ -505,8 +505,8 @@ information.
| `GET` | `/agent/host` | `application/json` |
The table below shows this endpoint's support for
[blocking queries](/api-docs#blocking-queries) and
[required ACLs](/api-docs#acls).
[blocking queries](/nomad/api-docs#blocking-queries) and
[required ACLs](/nomad/api-docs#acls).
| Blocking Queries | ACL Required |
| ---------------- | ------------ |
@ -585,8 +585,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-docs#blocking-queries) and
[required ACLs](/api-docs#acls).
[blocking queries](/nomad/api-docs#blocking-queries) and
[required ACLs](/nomad/api-docs#acls).
| Blocking Queries | ACL Required |
| ---------------- | ------------ |
@ -657,8 +657,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-docs#blocking-queries) and
[required ACLs](/api-docs#acls).
[blocking queries](/nomad/api-docs#blocking-queries) and
[required ACLs](/nomad/api-docs#acls).
| Blocking Queries | ACL Required |
| ---------------- | ------------- |
@ -669,7 +669,7 @@ The table below shows this endpoint's support for
This endpoint is enabled whenever ACLs are enabled. Due to the potentially
sensitive nature of data contained in profiles, as well as their significant
performance impact, the agent/pprof endpoint is protected by a high level ACL:
`agent:write`. For these reasons its recommended to leave [`enable_debug`](/docs/configuration#enable_debug)
`agent:write`. For these reasons its recommended to leave [`enable_debug`](/nomad/docs/configuration#enable_debug)
unset and only use the ACL-protected endpoints.
The following table explains when each endpoint is available:
@ -732,8 +732,8 @@ a Nomad server agent's scheduler workers.
| `GET` | `/agent/schedulers` | `application/json` |
The table below shows this endpoint's support for
[blocking queries](/api-docs#blocking-queries) and
[required ACLs](/api-docs#acls).
[blocking queries](/nomad/api-docs#blocking-queries) and
[required ACLs](/nomad/api-docs#acls).
| Blocking Queries | ACL Required |
| ---------------- | ------------ |
@ -823,8 +823,8 @@ the perspective of the agent. This is only applicable for servers.
| `GET` | `/agent/schedulers/config` | `application/json` |
The table below shows this endpoint's support for
[blocking queries](/api-docs#blocking-queries) and
[required ACLs](/api-docs#acls).
[blocking queries](/nomad/api-docs#blocking-queries) and
[required ACLs](/nomad/api-docs#acls).
| Blocking Queries | ACL Required |
| ---------------- | ------------ |
@ -871,8 +871,8 @@ to apply the provided values. This is only applicable for servers.
| `PUT` | `/agent/schedulers/config` | `application/json` |
The table below shows this endpoint's support for
[blocking queries](/api-docs#blocking-queries) and
[required ACLs](/api-docs#acls).
[blocking queries](/nomad/api-docs#blocking-queries) and
[required ACLs](/nomad/api-docs#acls).
| Blocking Queries | ACL Required |
| ---------------- | ------------- |
@ -919,5 +919,5 @@ $ curl \
}
```
[`enabled_schedulers`]: /docs/configuration/server#enabled_schedulers
[`num_schedulers`]: /docs/configuration/server#num_schedulers
[`enabled_schedulers`]: /nomad/docs/configuration/server#enabled_schedulers
[`num_schedulers`]: /nomad/docs/configuration/server#num_schedulers

32
website/content/api-docs/allocations.mdx
View File

@ -17,8 +17,8 @@ This endpoint lists all allocations.
| `GET` | `/v1/allocations` | `application/json` |
The table below shows this endpoint's support for
[blocking queries](/api-docs#blocking-queries) and
[required ACLs](/api-docs#acls).
[blocking queries](/nomad/api-docs#blocking-queries) and
[required ACLs](/nomad/api-docs#acls).
| Blocking Queries | ACL Required |
| ---------------- | -------------------- |
@ -41,7 +41,7 @@ The table below shows this endpoint's support for
`X-Nomad-NextToken` header of the last response can be used as the
`next_token` of the next request to fetch additional pages.
- `filter` `(string: "")` - Specifies the [expression](/api-docs#filtering)
- `filter` `(string: "")` - Specifies the [expression](/nomad/api-docs#filtering)
used to filter the results. Consider using pagination or a query parameter to
reduce resource used to serve the request.
@ -223,8 +223,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-docs#blocking-queries) and
[required ACLs](/api-docs#acls).
[blocking queries](/nomad/api-docs#blocking-queries) and
[required ACLs](/nomad/api-docs#acls).
| Blocking Queries | ACL Required |
| ---------------- | -------------------- |
@ -549,7 +549,7 @@ $ curl \
updated. This is primarily intended for use by the Nomad client when running
the allocation, and it may include stale information on some job fields.
Up-to-date information about the job status is available from the
[jobs API](/api-docs/jobs); take care to fetch the version of the job
[jobs API](/nomad/api-docs/jobs); take care to fetch the version of the job
associated with this allocation.
- `TaskStates` - A map of tasks to their current state and the latest events
@ -634,8 +634,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-docs#blocking-queries) and
[required ACLs](/api-docs#acls).
[blocking queries](/nomad/api-docs#blocking-queries) and
[required ACLs](/nomad/api-docs#acls).
| Blocking Queries | ACL Required |
| ---------------- | --------------------------- |
@ -672,8 +672,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-docs#blocking-queries) and
[required ACLs](/api-docs#acls).
[blocking queries](/nomad/api-docs#blocking-queries) and
[required ACLs](/nomad/api-docs#acls).
| Blocking Queries | ACL Required |
| ---------------- | --------------------------- |
@ -718,8 +718,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-docs#blocking-queries) and
[required ACLs](/api-docs#acls).
[blocking queries](/nomad/api-docs#blocking-queries) and
[required ACLs](/nomad/api-docs#acls).
| Blocking Queries | ACL Required |
| ---------------- | --------------------------- |
@ -769,8 +769,8 @@ It opens a WebSocket to transmit input to and output from the command.
| `WebSocket` | `/v1/client/allocation/:alloc_id/exec` | WebSocket JSON streams |
The table below shows this endpoint's support for
[blocking queries](/api-docs#blocking-queries) and
[required ACLs](/api-docs#acls).
[blocking queries](/nomad/api-docs#blocking-queries) and
[required ACLs](/nomad/api-docs#acls).
| Blocking Queries | ACL Required |
| ---------------- | -------------------------------------------------------------------------------------------- |
@ -861,8 +861,8 @@ allocation ID.
| `GET` | `/allocation/:alloc_id/services` | `application/json` |
The table below shows this endpoint's support for
[blocking queries](/api-docs#blocking-queries), [consistency modes](/api-docs#consistency-modes) and
[required ACLs](/api-docs#acls).
[blocking queries](/nomad/api-docs#blocking-queries), [consistency modes](/nomad/api-docs#consistency-modes) and
[required ACLs](/nomad/api-docs#acls).
| Blocking Queries | Consistency Modes | ACL Required |
| ---------------- | ----------------- | -------------------- |

40
website/content/api-docs/client.mdx
View File

@ -31,8 +31,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-docs#blocking-queries) and
[required ACLs](/api-docs#acls).
[blocking queries](/nomad/api-docs#blocking-queries) and
[required ACLs](/nomad/api-docs#acls).
| Blocking Queries | ACL Required |
| ---------------- | ------------ |
@ -208,8 +208,8 @@ by an allocation.
| `GET` | `/client/allocation/:alloc_id/stats` | `application/json` |
The table below shows this endpoint's support for
[blocking queries](/api-docs#blocking-queries) and
[required ACLs](/api-docs#acls).
[blocking queries](/nomad/api-docs#blocking-queries) and
[required ACLs](/nomad/api-docs#acls).
| Blocking Queries | ACL Required |
| ---------------- | -------------------- |
@ -291,8 +291,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-docs#blocking-queries) and
[required ACLs](/api-docs#acls).
[blocking queries](/nomad/api-docs#blocking-queries) and
[required ACLs](/nomad/api-docs#acls).
| Blocking Queries | ACL Required |
| ---------------- | ------------------- |
@ -335,8 +335,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-docs#blocking-queries) and
[required ACLs](/api-docs#acls).
[blocking queries](/nomad/api-docs#blocking-queries) and
[required ACLs](/nomad/api-docs#acls).
| Blocking Queries | ACL Required |
| ---------------- | ------------------- |
@ -379,8 +379,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-docs#blocking-queries) and
[required ACLs](/api-docs#acls).
[blocking queries](/nomad/api-docs#blocking-queries) and
[required ACLs](/nomad/api-docs#acls).
| Blocking Queries | ACL Required |
| ---------------- | ------------------- |
@ -447,8 +447,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-docs#blocking-queries) and
[required ACLs](/api-docs#acls).
[blocking queries](/nomad/api-docs#blocking-queries) and
[required ACLs](/nomad/api-docs#acls).
| Blocking Queries | ACL Required |
| ---------------- | -------------------------------------------- |
@ -520,8 +520,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-docs#blocking-queries) and
[required ACLs](/api-docs#acls).
[blocking queries](/nomad/api-docs#blocking-queries) and
[required ACLs](/nomad/api-docs#acls).
| Blocking Queries | ACL Required |
| ---------------- | ------------------- |
@ -573,8 +573,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-docs#blocking-queries) and
[required ACLs](/api-docs#acls).
[blocking queries](/nomad/api-docs#blocking-queries) and
[required ACLs](/nomad/api-docs#acls).
| Blocking Queries | ACL Required |
| ---------------- | ------------------- |
@ -619,8 +619,8 @@ in server responses.
| `GET` | `/client/allocation/:alloc_id/gc` | `application/json` |
The table below shows this endpoint's support for
[blocking queries](/api-docs#blocking-queries) and
[required ACLs](/api-docs#acls).
[blocking queries](/nomad/api-docs#blocking-queries) and
[required ACLs](/nomad/api-docs#acls).
| Blocking Queries | ACL Required |
| ---------------- | ---------------------- |
@ -648,8 +648,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-docs#blocking-queries) and
[required ACLs](/api-docs#acls).
[blocking queries](/nomad/api-docs#blocking-queries) and
[required ACLs](/nomad/api-docs#acls).
| Blocking Queries | ACL Required |
| ---------------- | ------------ |

34
website/content/api-docs/deployments.mdx
View File

@ -17,8 +17,8 @@ This endpoint lists all deployments.
| `GET` | `/v1/deployments` | `application/json` |
The table below shows this endpoint's support for
[blocking queries](/api-docs#blocking-queries) and
[required ACLs](/api-docs#acls).
[blocking queries](/nomad/api-docs#blocking-queries) and
[required ACLs](/nomad/api-docs#acls).
| Blocking Queries | ACL Required |
| ---------------- | -------------------- |
@ -46,7 +46,7 @@ The table below shows this endpoint's support for
used as the `last_token` of the next request to fetch additional
pages.
- `filter` `(string: "")` - Specifies the [expression](/api-docs#filtering)
- `filter` `(string: "")` - Specifies the [expression](/nomad/api-docs#filtering)
used to filter the results. Consider using pagination or a query parameter to
reduce resource used to serve the request.
@ -105,8 +105,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-docs#blocking-queries) and
[required ACLs](/api-docs#acls).
[blocking queries](/nomad/api-docs#blocking-queries) and
[required ACLs](/nomad/api-docs#acls).
| Blocking Queries | ACL Required |
| ---------------- | -------------------- |
@ -162,8 +162,8 @@ deployment.
| `GET` | `/v1/deployment/allocations/:deployment_id` | `application/json` |
The table below shows this endpoint's support for
[blocking queries](/api-docs#blocking-queries) and
[required ACLs](/api-docs#acls).
[blocking queries](/nomad/api-docs#blocking-queries) and
[required ACLs](/nomad/api-docs#acls).
| Blocking Queries | ACL Required |
| ---------------- | -------------------- |
@ -298,8 +298,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-docs#blocking-queries) and
[required ACLs](/api-docs#acls).
[blocking queries](/nomad/api-docs#blocking-queries) and
[required ACLs](/nomad/api-docs#acls).
| Blocking Queries | ACL Required |
| ---------------- | ---------------------- |
@ -341,8 +341,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-docs#blocking-queries) and
[required ACLs](/api-docs#acls).
[blocking queries](/nomad/api-docs#blocking-queries) and
[required ACLs](/nomad/api-docs#acls).
| Blocking Queries | ACL Required |
| ---------------- | ---------------------- |
@ -395,8 +395,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-docs#blocking-queries) and
[required ACLs](/api-docs#acls).
[blocking queries](/nomad/api-docs#blocking-queries) and
[required ACLs](/nomad/api-docs#acls).
| Blocking Queries | ACL Required |
| ---------------- | ---------------------- |
@ -464,8 +464,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-docs#blocking-queries) and
[required ACLs](/api-docs#acls).
[blocking queries](/nomad/api-docs#blocking-queries) and
[required ACLs](/nomad/api-docs#acls).
| Blocking Queries | ACL Required |
| ---------------- | ---------------------- |
@ -529,8 +529,8 @@ deployment to complete.
| `POST` | `/v1/deployment/unblock/:deployment_id` | `application/json` |
The table below shows this endpoint's support for
[blocking queries](/api-docs#blocking-queries) and
[required ACLs](/api-docs#acls).
[blocking queries](/nomad/api-docs#blocking-queries) and
[required ACLs](/nomad/api-docs#acls).
| Blocking Queries | ACL Required |
| ---------------- | ---------------------- |

28
website/content/api-docs/evaluations.mdx
View File

@ -17,8 +17,8 @@ This endpoint lists all evaluations.
| `GET` | `/v1/evaluations` | `application/json` |
The table below shows this endpoint's support for
[blocking queries](/api-docs#blocking-queries) and
[required ACLs](/api-docs#acls).
[blocking queries](/nomad/api-docs#blocking-queries) and
[required ACLs](/nomad/api-docs#acls).
| Blocking Queries | ACL Required |
| ---------------- | -------------------- |
@ -42,7 +42,7 @@ The table below shows this endpoint's support for
used as the `last_token` of the next request to fetch additional
pages.
- `filter` `(string: "")` - Specifies the [expression](/api-docs#filtering)
- `filter` `(string: "")` - Specifies the [expression](/nomad/api-docs#filtering)
used to filter the results. Consider using pagination or a query parameter to
reduce resource used to serve the request.
@ -116,8 +116,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-docs#blocking-queries) and
[required ACLs](/api-docs#acls).
[blocking queries](/nomad/api-docs#blocking-queries) and
[required ACLs](/nomad/api-docs#acls).
| Blocking Queries | ACL Required |
| ---------------- | -------------------- |
@ -221,8 +221,8 @@ evaluations as needed.
| `DELETE` | `/v1/evaluations` | `application/json` |
The table below shows this endpoint's support for
[blocking queries](/api-docs#blocking-queries) and
[required ACLs](/api-docs#acls).
[blocking queries](/nomad/api-docs#blocking-queries) and
[required ACLs](/nomad/api-docs#acls).
| Blocking Queries | ACL Required |
| ---------------- | ------------ |
@ -263,8 +263,8 @@ evaluation.
| `GET` | `/v1/evaluation/:eval_id/allocations` | `application/json` |
The table below shows this endpoint's support for
[blocking queries](/api-docs#blocking-queries) and
[required ACLs](/api-docs#acls).
[blocking queries](/nomad/api-docs#blocking-queries) and
[required ACLs](/nomad/api-docs#acls).
| Blocking Queries | ACL Required |
| ---------------- | -------------------- |
@ -397,8 +397,8 @@ case. See the [metrics reference][] for details.
| `GET` | `/v1/evaluations/count` | `application/json` |
The table below shows this endpoint's support for
[blocking queries](/api-docs#blocking-queries) and
[required ACLs](/api-docs#acls).
[blocking queries](/nomad/api-docs#blocking-queries) and
[required ACLs](/nomad/api-docs#acls).
| Blocking Queries | ACL Required |
| ---------------- | -------------------- |
@ -411,7 +411,7 @@ The table below shows this endpoint's support for
number of hexadecimal characters (0-9a-f). This is specified as a query string
parameter and is used before any `filter` expression is applied.
- `filter` `(string: "")` - Specifies the [expression](/api-docs#filtering) used
- `filter` `(string: "")` - Specifies the [expression](/nomad/api-docs#filtering) used
to filter the results.
- `namespace` `(string: "default")` - Specifies the target namespace.
@ -442,5 +442,5 @@ $ curl \
}
```
[update_scheduler_configuration]: /api-docs/operator/scheduler#update-scheduler-configuration
[metrics reference]: /docs/operations/metrics-reference
[update_scheduler_configuration]: /nomad/api-docs/operator/scheduler#update-scheduler-configuration
[metrics reference]: /nomad/docs/operations/metrics-reference

2
website/content/api-docs/events.mdx
View File

@ -22,7 +22,7 @@ events (heartbeating to keep the connection open).
| ------ | ------------------ | ------------------ |
| `GET` | `/v1/event/stream` | `application/json` |
The table below shows this endpoint's [required ACLs](/api-docs#acls). Due to
The table below shows this endpoint's [required ACLs](/nomad/api-docs#acls). Due to
the nature of this endpoint individual topics require specific policies.
Note that if you do not include a `topic` parameter all topics will be included

2
website/content/api-docs/index.mdx
View File

@ -68,7 +68,7 @@ administration.
Several endpoints in Nomad use or require ACL tokens to operate. The token are used to authenticate the request and determine if the request is allowed based on the associated authorizations. Tokens are specified per-request by using the `X-Nomad-Token` request header or with the Bearer scheme in the authorization header set to the `SecretID` of an ACL Token.
For more details about ACLs, please see the [ACL Guide](https://learn.hashicorp.com/collections/nomad/access-control).
For more details about ACLs, please see the [ACL Guide](/nomad/tutorials/access-control).
## Authentication

98
website/content/api-docs/jobs.mdx
View File

@ -17,8 +17,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-docs#blocking-queries) and
[required ACLs](/api-docs#acls).
[blocking queries](/nomad/api-docs#blocking-queries) and
[required ACLs](/nomad/api-docs#acls).
| Blocking Queries | ACL Required |
| ---------------- | --------------------- |
@ -39,14 +39,14 @@ The table below shows this endpoint's support for
`X-Nomad-NextToken` header of the last response can be used as the
`next_token` of the next request to fetch additional pages.
- `filter` `(string: "")` - Specifies the [expression](/api-docs#filtering)
- `filter` `(string: "")` - Specifies the [expression](/nomad/api-docs#filtering)
used to filter the results. Consider using pagination or a query parameter to
reduce resource used to serve the request.
- `namespace` `(string: "default")` - Specifies the target namespace. Specifying
`*` would return all jobs across all the authorized namespaces.
- `meta` `(bool: false)` - If set, jobs returned will include a [meta](/docs/job-specification/meta) field containing key-value pairs provided in the job specification's `meta` block.
- `meta` `(bool: false)` - If set, jobs returned will include a [meta](/nomad/docs/job-specification/meta) field containing key-value pairs provided in the job specification's `meta` block.
### Sample Request
@ -111,8 +111,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-docs#blocking-queries) and
[required ACLs](/api-docs#acls).
[blocking queries](/nomad/api-docs#blocking-queries) and
[required ACLs](/nomad/api-docs#acls).
| Blocking Queries | ACL Required |
| ---------------- | --------------------------------------------------------------------------------- |
@ -216,8 +216,8 @@ job.
| `POST` | `/v1/jobs/parse` | `application/json` |
The table below shows this endpoint's support for
[blocking queries](/api-docs#blocking-queries) and
[required ACLs](/api-docs#acls).
[blocking queries](/nomad/api-docs#blocking-queries) and
[required ACLs](/nomad/api-docs#acls).
| Blocking Queries | ACL Required |
| ---------------- | ------------------------------------------------- |
@ -308,8 +308,8 @@ status.
| `GET` | `/v1/job/:job_id` | `application/json` |
The table below shows this endpoint's support for
[blocking queries](/api-docs#blocking-queries) and
[required ACLs](/api-docs#acls).
[blocking queries](/nomad/api-docs#blocking-queries) and
[required ACLs](/nomad/api-docs#acls).
| Blocking Queries | ACL Required |
| ---------------- | -------------------- |
@ -556,8 +556,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-docs#blocking-queries) and
[required ACLs](/api-docs#acls).
[blocking queries](/nomad/api-docs#blocking-queries) and
[required ACLs](/nomad/api-docs#acls).
| Blocking Queries | ACL Required |
| ---------------- | -------------------- |
@ -1146,8 +1146,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-docs#blocking-queries) and
[required ACLs](/api-docs#acls).
[blocking queries](/nomad/api-docs#blocking-queries) and
[required ACLs](/nomad/api-docs#acls).
| Blocking Queries | ACL Required |
| ---------------- | -------------------- |
@ -1315,8 +1315,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-docs#blocking-queries) and
[required ACLs](/api-docs#acls).
[blocking queries](/nomad/api-docs#blocking-queries) and
[required ACLs](/nomad/api-docs#acls).
| Blocking Queries | ACL Required |
| ---------------- | -------------------- |
@ -1376,8 +1376,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-docs#blocking-queries) and
[required ACLs](/api-docs#acls).
[blocking queries](/nomad/api-docs#blocking-queries) and
[required ACLs](/nomad/api-docs#acls).
| Blocking Queries | ACL Required |
| ---------------- | -------------------- |
@ -1464,8 +1464,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-docs#blocking-queries) and
[required ACLs](/api-docs#acls).
[blocking queries](/nomad/api-docs#blocking-queries) and
[required ACLs](/nomad/api-docs#acls).
| Blocking Queries | ACL Required |
| ---------------- | -------------------- |
@ -1523,8 +1523,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-docs#blocking-queries) and
[required ACLs](/api-docs#acls).
[blocking queries](/nomad/api-docs#blocking-queries) and
[required ACLs](/nomad/api-docs#acls).
| Blocking Queries | ACL Required |
| ---------------- | -------------------- |
@ -1576,8 +1576,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-docs#blocking-queries) and
[required ACLs](/api-docs#acls).
[blocking queries](/nomad/api-docs#blocking-queries) and
[required ACLs](/nomad/api-docs#acls).
| Blocking Queries | ACL Required |
| ---------------- | --------------------------------------------------------------------------------- |
@ -1646,8 +1646,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-docs#blocking-queries) and
[required ACLs](/api-docs#acls).
[blocking queries](/nomad/api-docs#blocking-queries) and
[required ACLs](/nomad/api-docs#acls).
| Blocking Queries | ACL Required |
| ---------------- | ------------------------ |
@ -1709,8 +1709,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-docs#blocking-queries) and
[required ACLs](/api-docs#acls).
[blocking queries](/nomad/api-docs#blocking-queries) and
[required ACLs](/nomad/api-docs#acls).
| Blocking Queries | ACL Required |
| ---------------- | ---------------------- |
@ -1727,11 +1727,11 @@ The table below shows this endpoint's support for
job's version. This is checked and acts as a check-and-set value before
reverting to the specified job.
- `ConsulToken` `(string:"")` - Optional value specifying the [consul token](/docs/commands/job/revert)
used for Consul [service identity polity authentication checking](/docs/configuration/consul#allow_unauthenticated).
- `ConsulToken` `(string:"")` - Optional value specifying the [consul token](/nomad/docs/commands/job/revert)
used for Consul [service identity polity authentication checking](/nomad/docs/configuration/consul#allow_unauthenticated).
- `VaultToken` `(string: "")` - Optional value specifying the [vault token](/docs/commands/job/revert)
used for Vault [policy authentication checking](/docs/configuration/vault#allow_unauthenticated).
- `VaultToken` `(string: "")` - Optional value specifying the [vault token](/nomad/docs/commands/job/revert)
used for Vault [policy authentication checking](/nomad/docs/configuration/vault#allow_unauthenticated).
### Sample Payload
@ -1770,8 +1770,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-docs#blocking-queries) and
[required ACLs](/api-docs#acls).
[blocking queries](/nomad/api-docs#blocking-queries) and
[required ACLs](/nomad/api-docs#acls).
| Blocking Queries | ACL Required |
| ---------------- | ---------------------- |
@ -1826,8 +1826,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-docs#blocking-queries) and
[required ACLs](/api-docs#acls).
[blocking queries](/nomad/api-docs#blocking-queries) and
[required ACLs](/nomad/api-docs#acls).
| Blocking Queries | ACL Required |
| ---------------- | -------------------- |
@ -1884,8 +1884,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-docs#blocking-queries) and
[required ACLs](/api-docs#acls).
[blocking queries](/nomad/api-docs#blocking-queries) and
[required ACLs](/nomad/api-docs#acls).
| Blocking Queries | ACL Required |
| ---------------- | --------------------------------------------------------------------------------- |
@ -2082,7 +2082,7 @@ $ curl \
This endpoint forces a new instance of the periodic job. A new instance will be
created even if it violates the job's
[`prohibit_overlap`](/docs/job-specification/periodic#prohibit_overlap)
[`prohibit_overlap`](/nomad/docs/job-specification/periodic#prohibit_overlap)
settings. As such, this should be only used to immediately run a periodic job.
| Method | Path | Produces |
@ -2090,8 +2090,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-docs#blocking-queries) and
[required ACLs](/api-docs#acls).
[blocking queries](/nomad/api-docs#blocking-queries) and
[required ACLs](/nomad/api-docs#acls).
| Blocking Queries | ACL Required |
| ---------------- | -------------------------------------------------- |
@ -2128,8 +2128,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-docs#blocking-queries) and
[required ACLs](/api-docs#acls).
[blocking queries](/nomad/api-docs#blocking-queries) and
[required ACLs](/nomad/api-docs#acls).
| Blocking Queries | ACL Required |
| ---------------- | ---------------------- |
@ -2178,8 +2178,8 @@ This endpoint reads scale information about a job.
| `GET` | `/v1/job/:job_id/scale` | `application/json` |
The table below shows this endpoint's support for
[blocking queries](/api-docs#blocking-queries) and
[required ACLs](/api-docs#acls).
[blocking queries](/nomad/api-docs#blocking-queries) and
[required ACLs](/nomad/api-docs#acls).
| Blocking Queries | ACL Required |
| ---------------- | ---------------------------------------------------- |
@ -2230,8 +2230,8 @@ This will return a 400 error if the job has an active deployment.
| `POST` | `/v1/job/:job_id/scale` | `application/json` |
The table below shows this endpoint's support for
[blocking queries](/api-docs#blocking-queries) and
[required ACLs](/api-docs#acls).
[blocking queries](/nomad/api-docs#blocking-queries) and
[required ACLs](/nomad/api-docs#acls).
| Blocking Queries | ACL Required |
| ---------------- | ---------------------------------------------------------------------------------------------------------- |
@ -2312,8 +2312,8 @@ The endpoint is used to read all services registered within Nomad belonging to t
| `GET` | `/job/:job_id/services` | `application/json` |
The table below shows this endpoint's support for
[blocking queries](/api-docs#blocking-queries), [consistency modes](/api-docs#consistency-modes) and
[required ACLs](/api-docs#acls).
[blocking queries](/nomad/api-docs#blocking-queries), [consistency modes](/nomad/api-docs#consistency-modes) and
[required ACLs](/nomad/api-docs#acls).
| Blocking Queries | Consistency Modes | ACL Required |
| ---------------- | ----------------- | -------------------- |

32
website/content/api-docs/json-jobs.mdx
View File

@ -33,10 +33,10 @@ The [`nomad job run -json`][job-run-json] flag submits a JSON formatted job:
$ nomad job run -json example.json
```
[job-inspect]: /docs/commands/job/inspect
[job-output]: /docs/commands/job/run#output
[job-parse]: /api-docs/jobs#parse-job
[job-run-json]: /docs/commands/job/run#json
[job-inspect]: /nomad/docs/commands/job/inspect
[job-output]: /nomad/docs/commands/job/run#output
[job-parse]: /nomad/api-docs/jobs#parse-job
[job-run-json]: /nomad/docs/commands/job/run#json
## Syntax
@ -298,7 +298,7 @@ The `Job` object supports the following keys:
- `Type` - Specifies the job type and switches which scheduler
is used. Nomad provides the `service`, `system` and `batch` schedulers,
and defaults to `service`. To learn more about each scheduler type visit
[here](/docs/schedulers)
[here](/nomad/docs/schedulers)
- `Update` - Specifies an update strategy to be applied to all task groups
within the job. When specified both at the job level and the task group level,
@ -435,13 +435,13 @@ The `Task` object supports the following keys:
to. The file is written relative to the task's local directory.
- `Driver` - Specifies the task driver that should be used to run the
task. See the [driver documentation](/docs/drivers) for what
task. See the [driver documentation](/nomad/docs/drivers) for what
is available. Examples include `docker`, `qemu`, `java`, and `exec`.
- `Env` - A map of key-value representing environment variables that
will be passed along to the running process. Nomad variables are
interpreted when set in the environment variable values. See the table of
interpreted variables [here](/docs/runtime/interpolation).
interpreted variables [here](/nomad/docs/runtime/interpolation).
For example the below environment map will be reinterpreted:
@ -486,7 +486,7 @@ The `Task` object supports the following keys:
Consul for service discovery. A `Service` object represents a routable and
discoverable service on the network. Nomad automatically registers when a task
is started and de-registers it when the task transitions to the dead state.
[Click here](/docs/integrations/consul-integration#service-discovery) to learn more about
[Click here](/nomad/docs/integrations/consul-integration#service-discovery) to learn more about
services. Below is the fields in the `Service` object:
- `Name`: An explicit name for the Service. Nomad will replace `${JOB}`,
@ -781,7 +781,7 @@ attributes:
- "manual" - Specifies that Nomad should not automatically determine health
and that the operator will specify allocation health using the [HTTP
API](/api-docs/deployments#set-allocation-health-in-deployment).
API](/nomad/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
@ -836,7 +836,7 @@ An example `Update` block:
The `Constraint` object supports the following keys:
- `LTarget` - Specifies the attribute to examine for the
constraint. See the table of attributes [here](/docs/runtime/interpolation#interpreted_node_vars).
constraint. See the table of attributes [here](/nomad/docs/runtime/interpolation#interpreted_node_vars).
- `RTarget` - Specifies the value to compare the attribute against.
This can be a literal value, another attribute or a regular expression if
@ -881,12 +881,12 @@ The `Constraint` object supports the following keys:
### Affinity
Affinities allow operators to express placement preferences. More details on how they work
are described in [affinities](/docs/job-specification/affinity)
are described in [affinities](/nomad/docs/job-specification/affinity)
The `Affinity` object supports the following keys:
- `LTarget` - Specifies the attribute to examine for the
affinity. See the table of attributes [here](/docs/runtime/interpolation#interpreted_node_vars).
affinity. See the table of attributes [here](/nomad/docs/runtime/interpolation#interpreted_node_vars).
- `RTarget` - Specifies the value to compare the attribute against.
This can be a literal value, another attribute or a regular expression if
@ -1147,12 +1147,12 @@ README][ct].
Spread allow operators to target specific percentages of allocations based on
any node attribute or metadata. More details on how they work are described
in [spread](/docs/job-specification/spread).
in [spread](/nomad/docs/job-specification/spread).
The `Spread` object supports the following keys:
- `Attribute` - Specifies the attribute to examine for the
spread. See the [table of attributes](/docs/runtime/interpolation#interpreted_node_vars) for examples.
spread. See the [table of attributes](/nomad/docs/runtime/interpolation#interpreted_node_vars) for examples.
- `SpreadTarget` - Specifies a list of attribute values and percentages. This is an optional field, when
left empty Nomad will evenly spread allocations across values of the attribute.
@ -1189,5 +1189,5 @@ The `Scaling` object supports the following keys:
autoscaler (e.g., [nomad-autoscaler](https://github.com/hashicorp/nomad-autoscaler)).
[ct]: https://github.com/hashicorp/consul-template 'Consul Template by HashiCorp'
[drain]: /docs/commands/node/drain
[env]: /docs/runtime/environment 'Nomad Runtime Environment'
[drain]: /nomad/docs/commands/node/drain
[env]: /nomad/docs/runtime/environment 'Nomad Runtime Environment'

4
website/content/api-docs/metrics.mdx
View File

@ -13,8 +13,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-docs#blocking-queries) and
[required ACLs](/api-docs#acls).
[blocking queries](/nomad/api-docs#blocking-queries) and
[required ACLs](/nomad/api-docs#acls).
| Blocking Queries | ACL Required |
| ---------------- | ------------ |

16
website/content/api-docs/namespaces.mdx
View File

@ -19,8 +19,8 @@ This endpoint lists all namespaces.
| `GET` | `/v1/namespaces` | `application/json` |
The table below shows this endpoint's support for
[blocking queries](/api-docs#blocking-queries) and
[required ACLs](/api-docs#acls).
[blocking queries](/nomad/api-docs#blocking-queries) and
[required ACLs](/nomad/api-docs#acls).
| Blocking Queries | ACL Required |
| ---------------- | -------------------------------------------------------------------------- |
@ -80,8 +80,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-docs#blocking-queries) and
[required ACLs](/api-docs#acls).
[blocking queries](/nomad/api-docs#blocking-queries) and
[required ACLs](/nomad/api-docs#acls).
| Blocking Queries | ACL Required |
| ---------------- | -------------------------------------------------------------------------- |
@ -124,8 +124,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-docs#blocking-queries) and
[required ACLs](/api-docs#acls).
[blocking queries](/nomad/api-docs#blocking-queries) and
[required ACLs](/nomad/api-docs#acls).
| Blocking Queries | ACL Required |
| ---------------- | ------------ |
@ -185,8 +185,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-docs#blocking-queries) and
[required ACLs](/api-docs#acls).
[blocking queries](/nomad/api-docs#blocking-queries) and
[required ACLs](/nomad/api-docs#acls).
| Blocking Queries | ACL Required |
| ---------------- | ------------ |

32
website/content/api-docs/nodes.mdx
View File

@ -17,8 +17,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-docs#blocking-queries) and
[required ACLs](/api-docs#acls).
[blocking queries](/nomad/api-docs#blocking-queries) and
[required ACLs](/nomad/api-docs#acls).
| Blocking Queries | ACL Required |
| ---------------- | ------------ |
@ -41,7 +41,7 @@ The table below shows this endpoint's support for
`X-Nomad-NextToken` header of the last response can be used as the
`next_token` of the next request to fetch additional pages.
- `filter` `(string: "")` - Specifies the [expression](/api-docs#filtering)
- `filter` `(string: "")` - Specifies the [expression](/nomad/api-docs#filtering)
used to filter the results. Consider using pagination or a query parameter to
reduce resource used to serve the request.
@ -158,8 +158,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-docs#blocking-queries) and
[required ACLs](/api-docs#acls).
[blocking queries](/nomad/api-docs#blocking-queries) and
[required ACLs](/nomad/api-docs#acls).
| Blocking Queries | ACL Required |
| ---------------- | ------------ |
@ -516,8 +516,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-docs#blocking-queries) and
[required ACLs](/api-docs#acls).
[blocking queries](/nomad/api-docs#blocking-queries) and
[required ACLs](/nomad/api-docs#acls).
| Blocking Queries | ACL Required |
| ---------------- | ------------------------------ |
@ -889,8 +889,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-docs#blocking-queries) and
[required ACLs](/api-docs#acls).
[blocking queries](/nomad/api-docs#blocking-queries) and
[required ACLs](/nomad/api-docs#acls).
| Blocking Queries | ACL Required |
| ---------------- | ------------ |
@ -951,15 +951,15 @@ $ curl \
This endpoint toggles the drain mode of the node. When draining is enabled, no
further allocations will be assigned to this node, and existing allocations will
be migrated to new nodes. See the [Workload Migration
Guide](https://learn.hashicorp.com/tutorials/nomad/node-drain) for suggested usage.
Guide](/nomad/tutorials/manage-clusters/node-drain) for suggested usage.
| Method | Path | Produces |
| ------ | ------------------------- | ------------------ |
| `POST` | `/v1/node/:node_id/drain` | `application/json` |
The table below shows this endpoint's support for
[blocking queries](/api-docs#blocking-queries) and
[required ACLs](/api-docs#acls).
[blocking queries](/nomad/api-docs#blocking-queries) and
[required ACLs](/nomad/api-docs#acls).
| Blocking Queries | ACL Required |
| ---------------- | ------------ |
@ -1033,8 +1033,8 @@ they are alive.
| `POST` | `/v1/node/:node_id/purge` | `application/json` |
The table below shows this endpoint's support for
[blocking queries](/api-docs#blocking-queries) and
[required ACLs](/api-docs#acls).
[blocking queries](/nomad/api-docs#blocking-queries) and
[required ACLs](/nomad/api-docs#acls).
| Blocking Queries | ACL Required |
| ---------------- | ------------ |
@ -1079,8 +1079,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-docs#blocking-queries) and
[required ACLs](/api-docs#acls).
[blocking queries](/nomad/api-docs#blocking-queries) and
[required ACLs](/nomad/api-docs#acls).
| Blocking Queries | ACL Required |
| ---------------- | ------------ |

14
website/content/api-docs/operator/autopilot.mdx
View File

@ -20,8 +20,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-docs#blocking-queries) and
[required ACLs](/api-docs#acls).
[blocking queries](/nomad/api-docs#blocking-queries) and
[required ACLs](/nomad/api-docs#acls).
| Blocking Queries | ACL Required |
| ---------------- | --------------- |
@ -51,7 +51,7 @@ $ curl \
```
For more information about the Autopilot configuration options, see the
[agent configuration section](/docs/configuration/autopilot).
[agent configuration section](/nomad/docs/configuration/autopilot).
## Update Autopilot Configuration
@ -62,8 +62,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-docs#blocking-queries) and
[required ACLs](/api-docs#acls).
[blocking queries](/nomad/api-docs#blocking-queries) and
[required ACLs](/nomad/api-docs#acls).
| Blocking Queries | ACL Required |
| ---------------- | ---------------- |
@ -126,8 +126,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-docs#blocking-queries) and
[required ACLs](/api-docs#acls).
[blocking queries](/nomad/api-docs#blocking-queries) and
[required ACLs](/nomad/api-docs#acls).
| Blocking Queries | ACL Required |
| ---------------- | --------------- |

4
website/content/api-docs/operator/index.mdx
View File

@ -14,9 +14,9 @@ as interacting with the Raft subsystem, licensing, snapshots, autopilot and sche
~> Use this interface with extreme caution, as improper use could lead to a
Nomad outage and even loss of data.
See the [Outage Recovery](https://learn.hashicorp.com/tutorials/nomad/outage-recovery) guide for some examples of how
See the [Outage Recovery](/nomad/tutorials/manage-clusters/outage-recovery) guide for some examples of how
these capabilities are used. For a CLI to perform these operations manually,
please see the documentation for the
[`nomad operator`](/docs/commands/operator) command.
[`nomad operator`](/nomad/docs/commands/operator) command.
Please choose a sub-section in the navigation for more information

8
website/content/api-docs/operator/keyring.mdx
View File

@ -151,7 +151,7 @@ $ curl \
```
[Key Management]: /docs/operations/key-management
[`nomad operator root keyring`]: /docs/commands/operator/root/keyring-rotate
[blocking queries]: /api-docs#blocking-queries
[required ACLs]: /api-docs#acls
[Key Management]: /nomad/docs/operations/key-management
[`nomad operator root keyring`]: /nomad/docs/commands/operator/root/keyring-rotate
[blocking queries]: /nomad/api-docs#blocking-queries
[required ACLs]: /nomad/api-docs#acls

4
website/content/api-docs/operator/license.mdx
View File

@ -18,8 +18,8 @@ This endpoint gets information about the current license.
| `GET` | `/v1/operator/license` | `application/json` |
The table below shows this endpoint's support for
[blocking queries](/api-docs#blocking-queries) and
[required ACLs](/api-docs#acls).
[blocking queries](/nomad/api-docs#blocking-queries) and
[required ACLs](/nomad/api-docs#acls).
| Blocking Queries | ACL Required |
| ---------------- | --------------- |

10
website/content/api-docs/operator/raft.mdx
View File

@ -20,8 +20,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-docs#blocking-queries) and
[required ACLs](/api-docs#acls).
[blocking queries](/nomad/api-docs#blocking-queries) and
[required ACLs](/nomad/api-docs#acls).
| Blocking Queries | ACL Required |
| ---------------- | ------------ |
@ -91,8 +91,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-docs#blocking-queries) and
[required ACLs](/api-docs#acls).
[blocking queries](/nomad/api-docs#blocking-queries) and
[required ACLs](/nomad/api-docs#acls).
| Blocking Queries | ACL Required |
| ---------------- | ------------ |
@ -114,4 +114,4 @@ $ curl \
https://localhost:4646/v1/operator/raft/peer?address=1.2.3.4:4646
```
[consensus protocol guide]: /docs/concepts/consensus
[consensus protocol guide]: /nomad/docs/concepts/consensus

14
website/content/api-docs/operator/scheduler.mdx
View File

@ -19,8 +19,8 @@ the future.
| `GET` | `/v1/operator/scheduler/configuration` | `application/json` |
The table below shows this endpoint's support for
[blocking queries](/api-docs#blocking-queries) and
[required ACLs](/api-docs#acls).
[blocking queries](/nomad/api-docs#blocking-queries) and
[required ACLs](/nomad/api-docs#acls).
| Blocking Queries | ACL Required |
| ---------------- | --------------- |
@ -71,7 +71,7 @@ $ curl \
- `MemoryOversubscriptionEnabled` `(bool: false)` <sup>1.1 Beta</sup> - When
`true`, tasks may exceed their reserved memory limit, if the client has excess
memory capacity. Tasks must specify [`memory_max`](/docs/job-specification/resources#memory_max)
memory capacity. Tasks must specify [`memory_max`](/nomad/docs/job-specification/resources#memory_max)
to take advantage of memory oversubscription.
- `RejectJobRegistration` `(bool: false)` - When `true`, the server will return
@ -110,8 +110,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-docs#blocking-queries) and
[required ACLs](/api-docs#acls).
[blocking queries](/nomad/api-docs#blocking-queries) and
[required ACLs](/nomad/api-docs#acls).
| Blocking Queries | ACL Required |
| ---------------- | ---------------- |
@ -152,7 +152,7 @@ server state is authoritative.
- `MemoryOversubscriptionEnabled` `(bool: false)` <sup>1.1 Beta</sup> - When
`true`, tasks may exceed their reserved memory limit, if the client has excess
memory capacity. Tasks must specify [`memory_max`](/docs/job-specification/resources#memory_max)
memory capacity. Tasks must specify [`memory_max`](/nomad/docs/job-specification/resources#memory_max)
to take advantage of memory oversubscription.
- `RejectJobRegistration` `(bool: false)` - When `true`, the server will return
@ -199,4 +199,4 @@ server state is authoritative.
- `Index` - Current Raft index when the request was received.
[`default_scheduler_config`]: /docs/configuration/server#default_scheduler_config
[`default_scheduler_config`]: /nomad/docs/configuration/server#default_scheduler_config

10
website/content/api-docs/operator/snapshot.mdx
View File

@ -11,7 +11,7 @@ description: |-
This endpoint generates and returns an atomic, point-in-time snapshot of the
Nomad server state for disaster recovery. Snapshots include all state managed by Nomad's
Raft [consensus protocol](/docs/concepts/consensus).
Raft [consensus protocol](/nomad/docs/concepts/consensus).
Snapshots are exposed as gzipped tar archives which internally contain the Raft
metadata required to restore, as well as a binary serialized version of the
@ -26,8 +26,8 @@ restore.
| `GET` | `/v1/operator/snapshot` | `200 application/x-gzip` |
The table below shows this endpoint's support for
[blocking queries](/api-docs#blocking-queries) and
[required ACLs](/api-docs#acls).
[blocking queries](/nomad/api-docs#blocking-queries) and
[required ACLs](/nomad/api-docs#acls).
| Blocking Queries | ACL Required |
| ---------------- | ------------ |
@ -65,8 +65,8 @@ call to the `GET` method.
| `PUT` | `/v1/operator/snapshot` | `200 text/plain (empty body)` |
The table below shows this endpoint's support for
[blocking queries](/api-docs#blocking-queries) and
[required ACLs](/api-docs#acls).
[blocking queries](/nomad/api-docs#blocking-queries) and
[required ACLs](/nomad/api-docs#acls).
| Blocking Queries | ACL Required |
| ---------------- | ------------ |

8
website/content/api-docs/plugins.mdx
View File

@ -19,8 +19,8 @@ This endpoint lists all dynamic plugins.
| `GET` | `/v1/plugins` | `application/json` |
The table below shows this endpoint's support for
[blocking queries](/api-docs#blocking-queries) and
[required ACLs](/api-docs#acls).
[blocking queries](/nomad/api-docs#blocking-queries) and
[required ACLs](/nomad/api-docs#acls).
| Blocking Queries | ACL Required |
| ---------------- | --------------------------- |
@ -67,8 +67,8 @@ plugin's job and client fingerprint data.
| `GET` | `/v1/plugin/csi/:plugin_id` | `application/json` |
The table below shows this endpoint's support for
[blocking queries](/api-docs#blocking-queries) and
[required ACLs](/api-docs#acls).
[blocking queries](/nomad/api-docs#blocking-queries) and
[required ACLs](/nomad/api-docs#acls).
| Blocking Queries | ACL Required |
| ---------------- | --------------------------- |

24
website/content/api-docs/quotas.mdx
View File

@ -22,8 +22,8 @@ This endpoint lists all quota specifications.
| `GET` | `/v1/quotas` | `application/json` |
The table below shows this endpoint's support for
[blocking queries](/api-docs#blocking-queries) and
[required ACLs](/api-docs#acls).
[blocking queries](/nomad/api-docs#blocking-queries) and
[required ACLs](/nomad/api-docs#acls).
| Blocking Queries | ACL Required |
| ---------------- | --------------------------------------------------------------- |
@ -92,8 +92,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-docs#blocking-queries) and
[required ACLs](/api-docs#acls).
[blocking queries](/nomad/api-docs#blocking-queries) and
[required ACLs](/nomad/api-docs#acls).
| Blocking Queries | ACL Required |
| ---------------- | --------------------------------------------------------------- |
@ -155,8 +155,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-docs#blocking-queries) and
[required ACLs](/api-docs#acls).
[blocking queries](/nomad/api-docs#blocking-queries) and
[required ACLs](/nomad/api-docs#acls).
| Blocking Queries | ACL Required |
| ---------------- | ------------- |
@ -216,8 +216,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-docs#blocking-queries) and
[required ACLs](/api-docs#acls).
[blocking queries](/nomad/api-docs#blocking-queries) and
[required ACLs](/nomad/api-docs#acls).
| Blocking Queries | ACL Required |
| ---------------- | ------------- |
@ -245,8 +245,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-docs#blocking-queries) and
[required ACLs](/api-docs#acls).
[blocking queries](/nomad/api-docs#blocking-queries) and
[required ACLs](/nomad/api-docs#acls).
| Blocking Queries | ACL Required |
| ---------------- | --------------------------------------------------------------- |
@ -302,8 +302,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-docs#blocking-queries) and
[required ACLs](/api-docs#acls).
[blocking queries](/nomad/api-docs#blocking-queries) and
[required ACLs](/nomad/api-docs#acls).
| Blocking Queries | ACL Required |
| ---------------- | --------------------------------------------------------------- |

16
website/content/api-docs/recommendations.mdx
View File

@ -26,8 +26,8 @@ optional filtering of that list.
| `GET` | `/v1/recommendations` | `application/json` |
The table below shows this endpoint's support for
[blocking queries](/api-docs#blocking-queries) and
[required ACLs](/api-docs#acls).
[blocking queries](/nomad/api-docs#blocking-queries) and
[required ACLs](/nomad/api-docs#acls).
| Blocking Queries | ACL Required |
| ---------------- | ----------------------------------------------------------------------------------- |
@ -137,8 +137,8 @@ This endpoint reads information about a specific recommendation.
| `GET` | `/v1/recommendation/:recommendation_id` | `application/json` |
The table below shows this endpoint's support for
[blocking queries](/api-docs#blocking-queries) and
[required ACLs](/api-docs#acls).
[blocking queries](/nomad/api-docs#blocking-queries) and
[required ACLs](/nomad/api-docs#acls).
| Blocking Queries | ACL Required |
| ---------------- | -------------------- |
@ -200,8 +200,8 @@ This endpoint is used to apply and dismiss recommendations.
| `POST` | `/v1/recommendations/apply` | `application/json` |
The table below shows this endpoint's support for
[blocking queries](/api-docs#blocking-queries) and
[required ACLs](/api-docs#acls).
[blocking queries](/nomad/api-docs#blocking-queries) and
[required ACLs](/nomad/api-docs#acls).
| Blocking Queries | ACL Required |
| ---------------- | --------------------------------------------------------------------------------- |
@ -267,8 +267,8 @@ This endpoint is used to create or update a recommendation.
| `POST` | `/v1/recommendation` | `application/json` |
The table below shows this endpoint's support for
[blocking queries](/api-docs#blocking-queries) and
[required ACLs](/api-docs#acls).
[blocking queries](/nomad/api-docs#blocking-queries) and
[required ACLs](/nomad/api-docs#acls).
| Blocking Queries | ACL Required |
| ---------------- | ----------------------------------------------------------- |

4
website/content/api-docs/regions.mdx
View File

@ -15,8 +15,8 @@ The `/regions` endpoints list all known regions.
| `GET` | `/v1/regions` | `application/json` |
The table below shows this endpoint's support for
[blocking queries](/api-docs#blocking-queries) and
[required ACLs](/api-docs#acls).
[blocking queries](/nomad/api-docs#blocking-queries) and
[required ACLs](/nomad/api-docs#acls).
| Blocking Queries | ACL Required |
| ---------------- | ------------ |

8
website/content/api-docs/scaling-policies.mdx
View File

@ -17,8 +17,8 @@ This endpoint returns the scaling policies from all jobs.
| `GET` | `/scaling/policies` | `application/json` |
The table below shows this endpoint's support for
[blocking queries](/api-docs#blocking-queries), [consistency modes](/api-docs#consistency-modes) and
[required ACLs](/api-docs#acls).
[blocking queries](/nomad/api-docs#blocking-queries), [consistency modes](/nomad/api-docs#consistency-modes) and
[required ACLs](/nomad/api-docs#acls).
| Blocking Queries | Consistency Modes | ACL Required |
| ---------------- | ----------------- | --------------------------------- |
@ -105,8 +105,8 @@ This endpoint reads a specific scaling policy.
| `GET` | `/scaling/policy/:policy_id` | `application/json` |
The table below shows this endpoint's support for
[blocking queries](/api-docs#blocking-queries), [consistency modes](/api-docs#consistency-modes) and
[required ACLs](/api-docs#acls).
[blocking queries](/nomad/api-docs#blocking-queries), [consistency modes](/nomad/api-docs#consistency-modes) and
[required ACLs](/nomad/api-docs#acls).
| Blocking Queries | Consistency Modes | ACL Required |
| ---------------- | ----------------- | ------------------------------- |

10
website/content/api-docs/search.mdx
View File

@ -19,8 +19,8 @@ context.
| `POST` | `/v1/search` | `application/json` |
The table below shows this endpoint's support for
[blocking queries](/api-docs#blocking-queries) and
[required ACLs](/api-docs#acls).
[blocking queries](/nomad/api-docs#blocking-queries) and
[required ACLs](/nomad/api-docs#acls).
| Blocking Queries | ACL Required |
| ---------------- | -------------------------------- |
@ -137,8 +137,8 @@ a name that exactly matches the search term are listed first.
| `POST` | `/v1/search/fuzzy` | `application/json` |
The table below shows this endpoint's support for
[blocking queries](/api-docs#blocking-queries) and
[required ACLs](/api-docs#acls).
[blocking queries](/nomad/api-docs#blocking-queries) and
[required ACLs](/nomad/api-docs#acls).
| Blocking Queries | ACL Required |
| ---------------- | ----------------------------------------------------------- |
@ -586,4 +586,4 @@ $ curl \
}
```
[search]: /docs/configuration/search
[search]: /nomad/docs/configuration/search

20
website/content/api-docs/sentinel-policies.mdx
View File

@ -9,9 +9,9 @@ description: >-
# Sentinel Policies HTTP API
The `/sentinel/policies` and `/sentinel/policy/` endpoints are used to manage Sentinel policies.
For more details about Sentinel policies, please see the [Sentinel Policy Guide](https://learn.hashicorp.com/tutorials/nomad/sentinel).
For more details about Sentinel policies, please see the [Sentinel Policy Guide](/nomad/tutorials/governance-and-policy/sentinel).
Sentinel endpoints are only available when ACLs are enabled. For more details about ACLs, please see the [ACL Guide](https://learn.hashicorp.com/collections/nomad/access-control).
Sentinel endpoints are only available when ACLs are enabled. For more details about ACLs, please see the [ACL Guide](/nomad/tutorials/access-control).
<EnterpriseAlert>
This API endpoint and functionality only exists in Nomad Enterprise. This is
@ -28,8 +28,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-docs#blocking-queries), [consistency modes](/api-docs#consistency-modes) and
[required ACLs](/api-docs#acls).
[blocking queries](/nomad/api-docs#blocking-queries), [consistency modes](/nomad/api-docs#consistency-modes) and
[required ACLs](/nomad/api-docs#acls).
| Blocking Queries | Consistency Modes | ACL Required |
| ---------------- | ----------------- | ------------ |
@ -68,8 +68,8 @@ authoritative region.
| `POST` | `/sentinel/policy/:policy_name` | `(empty body)` |
The table below shows this endpoint's support for
[blocking queries](/api-docs#blocking-queries) and
[required ACLs](/api-docs#acls).
[blocking queries](/nomad/api-docs#blocking-queries) and
[required ACLs](/nomad/api-docs#acls).
| Blocking Queries | ACL Required |
| ---------------- | ------------ |
@ -120,8 +120,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-docs#blocking-queries), [consistency modes](/api-docs#consistency-modes) and
[required ACLs](/api-docs#acls).
[blocking queries](/nomad/api-docs#blocking-queries), [consistency modes](/nomad/api-docs#consistency-modes) and
[required ACLs](/nomad/api-docs#acls).
| Blocking Queries | Consistency Modes | ACL Required |
| ---------------- | ----------------- | ------------ |
@ -159,8 +159,8 @@ authoritative region.
| `DELETE` | `/sentinel/policy/:policy_name` | `(empty body)` |
The table below shows this endpoint's support for
[blocking queries](/api-docs#blocking-queries) and
[required ACLs](/api-docs#acls).
[blocking queries](/nomad/api-docs#blocking-queries) and
[required ACLs](/nomad/api-docs#acls).
| Blocking Queries | ACL Required |
| ---------------- | ------------ |

14
website/content/api-docs/services.mdx
View File

@ -18,8 +18,8 @@ This endpoint lists all the currently available Nomad services.
| `GET` | `/v1/services` | `application/json` |
The table below shows this endpoint's support for
[blocking queries](/api-docs#blocking-queries) and
[required ACLs](/api-docs#acls).
[blocking queries](/nomad/api-docs#blocking-queries) and
[required ACLs](/nomad/api-docs#acls).
| Blocking Queries | ACL Required |
| ---------------- | -------------------- |
@ -65,8 +65,8 @@ This endpoint reads a specific service.
| `GET` | `/service/:service_name` | `application/json` |
The table below shows this endpoint's support for
[blocking queries](/api-docs#blocking-queries), [consistency modes](/api-docs#consistency-modes) and
[required ACLs](/api-docs#acls).
[blocking queries](/nomad/api-docs#blocking-queries), [consistency modes](/nomad/api-docs#consistency-modes) and
[required ACLs](/nomad/api-docs#acls).
| Blocking Queries | Consistency Modes | ACL Required |
| ---------------- | ----------------- | -------------------- |
@ -90,7 +90,7 @@ The table below shows this endpoint's support for
`X-Nomad-NextToken` header of the last response can be used as the `next_token`
of the next request to fetch additional pages.
- `filter` `(string: "")` - Specifies the [expression](/api-docs#filtering)
- `filter` `(string: "")` - Specifies the [expression](/nomad/api-docs#filtering)
used to filter the results. Consider using pagination or a query parameter to
reduce resource used to serve the request.
@ -156,8 +156,8 @@ This endpoint is used to delete an individual service registration.
| `DELETE` | `/v1/service/:service_name/:service_id` | `application/json` |
The table below shows this endpoint's support for
[blocking queries](/api-docs#blocking-queries) and
[required ACLs](/api-docs#acls).
[blocking queries](/nomad/api-docs#blocking-queries) and
[required ACLs](/nomad/api-docs#acls).
| Blocking Queries | ACL Required |
| ---------------- | ---------------------- |

8
website/content/api-docs/status.mdx
View File

@ -17,8 +17,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-docs#blocking-queries) and
[required ACLs](/api-docs#acls).
[blocking queries](/nomad/api-docs#blocking-queries) and
[required ACLs](/nomad/api-docs#acls).
| Blocking Queries | ACL Required |
| ---------------- | ------------ |
@ -46,8 +46,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-docs#blocking-queries) and
[required ACLs](/api-docs#acls).
[blocking queries](/nomad/api-docs#blocking-queries) and
[required ACLs](/nomad/api-docs#acls).
| Blocking Queries | ACL Required |
| ---------------- | ------------ |

8
website/content/api-docs/system.mdx
View File

@ -19,8 +19,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-docs#blocking-queries) and
[required ACLs](/api-docs#acls).
[blocking queries](/nomad/api-docs#blocking-queries) and
[required ACLs](/nomad/api-docs#acls).
| Blocking Queries | ACL Required |
| ---------------- | ------------ |
@ -43,8 +43,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-docs#blocking-queries) and
[required ACLs](/api-docs#acls).
[blocking queries](/nomad/api-docs#blocking-queries) and
[required ACLs](/nomad/api-docs#acls).
| Blocking Queries | ACL Required |
| ---------------- | ------------ |

2
website/content/api-docs/ui.mdx
View File

@ -498,7 +498,7 @@ This page lists all allocations for a CSI plugin. Each allocation includes the s
~> **Enterprise Only!** This feature depends on functionality only present in Nomad Autoscaler Enterprise.
This page lists all recommendations surfaced by [dynamic application sizing](/tools/autoscaling#dynamic-application-sizing). This page will automatically redirect to the recommendation summary route for the first recommendation sorted by relevance.
This page lists all recommendations surfaced by [dynamic application sizing](/nomad/tools/autoscaling#dynamic-application-sizing). This page will automatically redirect to the recommendation summary route for the first recommendation sorted by relevance.
Each recommendation in the list will contain information including the job and task group the recommendation is for, the time the recommendation was surfaced, the number of allocations impacted, the difference in CPU the recommendation suggests, the difference in memory the recommendation suggests, and the aggregate change in CPU and memory given the number of allocations impacted.

4
website/content/api-docs/validate.mdx
View File

@ -24,8 +24,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-docs#blocking-queries) and
[required ACLs](/api-docs#acls).
[blocking queries](/nomad/api-docs#blocking-queries) and
[required ACLs](/nomad/api-docs#acls).
| Blocking Queries | ACL Required |
| ---------------- | -------------------- |

10
website/content/api-docs/variables.mdx
View File

@ -44,7 +44,7 @@ The table below shows this endpoint's support for [blocking queries] and
`X-Nomad-NextToken` header of the last response can be used as the
`next_token` of the next request to fetch additional pages.
- `filter` `(string: "")` - Specifies the [expression](/api-docs#filtering) used
- `filter` `(string: "")` - Specifies the [expression](/nomad/api-docs#filtering) used
to filter the results. Consider using pagination or a query parameter to
reduce resources used to serve the request.
@ -295,8 +295,8 @@ the response will include only metadata and not the `Items` field:
```
[Variables]: /docs/concepts/variables
[`nomad var`]: /docs/commands/var
[blocking queries]: /api-docs#blocking-queries
[required ACLs]: /api-docs#acls
[Variables]: /nomad/docs/concepts/variables
[`nomad var`]: /nomad/docs/commands/var
[blocking queries]: /nomad/api-docs#blocking-queries
[required ACLs]: /nomad/api-docs#acls
[RFC3986]: https://www.rfc-editor.org/rfc/rfc3986#section-2

50
website/content/api-docs/volumes.mdx
View File

@ -18,8 +18,8 @@ This endpoint lists all volumes.
| `GET` | `/v1/volumes` | `application/json` |
The table below shows this endpoint's support for
[blocking queries](/api-docs#blocking-queries) and
[required ACLs](/api-docs#acls).
[blocking queries](/nomad/api-docs#blocking-queries) and
[required ACLs](/nomad/api-docs#acls).
| Blocking Queries | ACL Required |
| ---------------- | --------------------------- |
@ -51,7 +51,7 @@ The table below shows this endpoint's support for
`X-Nomad-NextToken` header of the last response can be used as the
`next_token` of the next request to fetch additional pages.
- `filter` `(string: "")` - Specifies the [expression](/api-docs#filtering)
- `filter` `(string: "")` - Specifies the [expression](/nomad/api-docs#filtering)
used to filter the results. Consider using pagination or a query parameter to
reduce resource used to serve the request.
@ -104,8 +104,8 @@ This endpoint reads information about a specific volume.
| `GET` | `/v1/volume/csi/:volume_id` | `application/json` |
The table below shows this endpoint's support for
[blocking queries](/api-docs#blocking-queries) and
[required ACLs](/api-docs#acls).
[blocking queries](/nomad/api-docs#blocking-queries) and
[required ACLs](/nomad/api-docs#acls).
| Blocking Queries | ACL Required |
| ---------------- | --------------------------- |
@ -286,8 +286,8 @@ to register an already registered volume.
| `PUT` | `/v1/volume/csi/:volume_id` | `application/json` |
The table below shows this endpoint's support for
[blocking queries](/api-docs#blocking-queries) and
[required ACLs](/api-docs#acls).
[blocking queries](/nomad/api-docs#blocking-queries) and
[required ACLs](/nomad/api-docs#acls).
| Blocking Queries | ACL Required |
| ---------------- | ---------------------------- |
@ -353,8 +353,8 @@ the `CREATE_DELETE_VOLUME` capability support this endpoint.
| `PUT` | `/v1/volume/csi/:volume_id/create` | `application/json` |
The table below shows this endpoint's support for
[blocking queries](/api-docs#blocking-queries) and
[required ACLs](/api-docs#acls).
[blocking queries](/nomad/api-docs#blocking-queries) and
[required ACLs](/nomad/api-docs#acls).
| Blocking Queries | ACL Required |
| ---------------- | ---------------------------- |
@ -425,8 +425,8 @@ deregister a volume that is in use.
| `DELETE` | `/v1/volume/csi/:volume_id` | `application/json` |
The table below shows this endpoint's support for
[blocking queries](/api-docs#blocking-queries) and
[required ACLs](/api-docs#acls).
[blocking queries](/nomad/api-docs#blocking-queries) and
[required ACLs](/nomad/api-docs#acls).
| Blocking Queries | ACL Required |
| ---------------- | ---------------------------- |
@ -463,8 +463,8 @@ interface with the `CREATE_DELETE_VOLUME` capability support this endpoint.
| `DELETE` | `/v1/volume/csi/:volume_id/delete` | `application/json` |
The table below shows this endpoint's support for
[blocking queries](/api-docs#blocking-queries) and
[required ACLs](/api-docs#acls).
[blocking queries](/nomad/api-docs#blocking-queries) and
[required ACLs](/nomad/api-docs#acls).
| Blocking Queries | ACL Required |
| ---------------- | ---------------------------- |
@ -500,8 +500,8 @@ error to detach a volume that is in use.
| `DELETE` | `/v1/volume/csi/:volume_id/detach` | `application/json` |
The table below shows this endpoint's support for
[blocking queries](/api-docs#blocking-queries) and
[required ACLs](/api-docs#acls).
[blocking queries](/nomad/api-docs#blocking-queries) and
[required ACLs](/nomad/api-docs#acls).
| Blocking Queries | ACL Required |
| ---------------- | ---------------------------- |
@ -536,8 +536,8 @@ implement the [Controller][csi_plugins_internals] interface with the
| `GET` | `/v1/volumes/external` | `application/json` |
The table below shows this endpoint's support for
[blocking queries](/api-docs#blocking-queries) and
[required ACLs](/api-docs#acls).
[blocking queries](/nomad/api-docs#blocking-queries) and
[required ACLs](/nomad/api-docs#acls).
| Blocking Queries | ACL Required |
| ---------------- | ---------------------------- |
@ -603,8 +603,8 @@ provider. Only CSI plugins that implement the
| `POST` | `/v1/volumes/snapshot` | `application/json` |
The table below shows this endpoint's support for
[blocking queries](/api-docs#blocking-queries) and
[required ACLs](/api-docs#acls).
[blocking queries](/nomad/api-docs#blocking-queries) and
[required ACLs](/nomad/api-docs#acls).
| Blocking Queries | ACL Required |
| ---------------- | ---------------------------- |
@ -671,8 +671,8 @@ provider. Only CSI plugins that implement the
| `DELETE` | `/v1/volumes/snapshot` | `application/json` |
The table below shows this endpoint's support for
[blocking queries](/api-docs#blocking-queries) and
[required ACLs](/api-docs#acls).
[blocking queries](/nomad/api-docs#blocking-queries) and
[required ACLs](/nomad/api-docs#acls).
| Blocking Queries | ACL Required |
| ---------------- | ---------------------------- |
@ -714,8 +714,8 @@ with the `LIST_SNAPSHOTS` capability support this endpoint.
| `GET` | `/v1/volumes/snapshot` | `application/json` |
The table below shows this endpoint's support for
[blocking queries](/api-docs#blocking-queries) and
[required ACLs](/api-docs#acls).
[blocking queries](/nomad/api-docs#blocking-queries) and
[required ACLs](/nomad/api-docs#acls).
| Blocking Queries | ACL Required |
| ---------------- | --------------------------- |
@ -778,6 +778,6 @@ $ curl \
```
[csi]: https://github.com/container-storage-interface/spec
[csi_plugin]: /docs/job-specification/csi_plugin
[csi_plugins_internals]: /docs/concepts/plugins/csi#csi-plugins
[csi_plugin]: /nomad/docs/job-specification/csi_plugin
[csi_plugins_internals]: /nomad/docs/concepts/plugins/csi#csi-plugins
[Create Volume]: #create-volume

2
website/content/docs/commands/acl/auth-method/create.mdx
View File

@ -97,4 +97,4 @@ Example config file:
}
```
[configuration]: /api-docs/acl/auth-methods#config
[configuration]: /nomad/api-docs/acl/auth-methods#config

54
website/content/docs/commands/acl/index.mdx
View File

@ -45,30 +45,30 @@ subcommands are available:
- [`acl token self`][tokenself] - Get info on self ACL token
- [`acl token update`][tokenupdate] - Update existing ACL token
[bootstrap]: /docs/commands/acl/bootstrap
[authmethodcreate]: /docs/commands/acl/auth-method/create
[authmethoddelete]: /docs/commands/acl/auth-method/delete
[authmethodinfo]: /docs/commands/acl/auth-method/info
[authmethodlist]: /docs/commands/acl/auth-method/list
[authmethodupdate]: /docs/commands/acl/auth-method/update
[bindingrulecreate]: /docs/commands/acl/binding-rule/create
[bindingruledelete]: /docs/commands/acl/binding-rule/delete
[bindingruleinfo]: /docs/commands/acl/binding-rule/info
[bindingrulelist]: /docs/commands/acl/binding-rule/list
[bindingruleupdate]: /docs/commands/acl/binding-rule/update
[policyapply]: /docs/commands/acl/policy/apply
[policydelete]: /docs/commands/acl/policy/delete
[policyinfo]: /docs/commands/acl/policy/info
[policylist]: /docs/commands/acl/policy/list
[tokencreate]: /docs/commands/acl/token/create
[tokenupdate]: /docs/commands/acl/token/update
[tokendelete]: /docs/commands/acl/token/delete
[tokeninfo]: /docs/commands/acl/token/info
[tokenlist]: /docs/commands/acl/token/list
[tokenself]: /docs/commands/acl/token/self
[rolecreate]: /docs/commands/acl/role/create
[roleupdate]: /docs/commands/acl/role/update
[roledelete]: /docs/commands/acl/role/delete
[roleinfo]: /docs/commands/acl/role/info
[rolelist]: /docs/commands/acl/role/list
[secure-guide]: https://learn.hashicorp.com/collections/nomad/access-control
[bootstrap]: /nomad/docs/commands/acl/bootstrap
[authmethodcreate]: /nomad/docs/commands/acl/auth-method/create
[authmethoddelete]: /nomad/docs/commands/acl/auth-method/delete
[authmethodinfo]: /nomad/docs/commands/acl/auth-method/info
[authmethodlist]: /nomad/docs/commands/acl/auth-method/list
[authmethodupdate]: /nomad/docs/commands/acl/auth-method/update
[bindingrulecreate]: /nomad/docs/commands/acl/binding-rule/create
[bindingruledelete]: /nomad/docs/commands/acl/binding-rule/delete
[bindingruleinfo]: /nomad/docs/commands/acl/binding-rule/info
[bindingrulelist]: /nomad/docs/commands/acl/binding-rule/list
[bindingruleupdate]: /nomad/docs/commands/acl/binding-rule/update
[policyapply]: /nomad/docs/commands/acl/policy/apply
[policydelete]: /nomad/docs/commands/acl/policy/delete
[policyinfo]: /nomad/docs/commands/acl/policy/info
[policylist]: /nomad/docs/commands/acl/policy/list
[tokencreate]: /nomad/docs/commands/acl/token/create
[tokenupdate]: /nomad/docs/commands/acl/token/update
[tokendelete]: /nomad/docs/commands/acl/token/delete
[tokeninfo]: /nomad/docs/commands/acl/token/info
[tokenlist]: /nomad/docs/commands/acl/token/list
[tokenself]: /nomad/docs/commands/acl/token/self
[rolecreate]: /nomad/docs/commands/acl/role/create
[roleupdate]: /nomad/docs/commands/acl/role/update
[roledelete]: /nomad/docs/commands/acl/role/delete
[roleinfo]: /nomad/docs/commands/acl/role/info
[rolelist]: /nomad/docs/commands/acl/role/list
[secure-guide]: /nomad/tutorials/access-control

82
website/content/docs/commands/agent.mdx
View File

@ -177,44 +177,44 @@ via CLI arguments. The `agent` command accepts the following arguments:
- `vault-tls-server-name=<name>`: Used to set the SNI host when connecting to
Vault over TLS.
[address]: /docs/configuration/consul#address
[alloc_dir]: /docs/configuration/client#alloc_dir
[auth]: /docs/configuration/consul#auth
[auto_advertise]: /docs/configuration/consul#auto_advertise
[bind_addr]: /docs/configuration#bind_addr
[bootstrap_expect]: /docs/configuration/server#bootstrap_expect
[ca_file]: /docs/configuration/consul#ca_file
[cert_file]: /docs/configuration/consul#cert_file
[checks_use_advertise]: /docs/configuration/consul#checks_use_advertise
[client_auto_join]: /docs/configuration/consul#client_auto_join
[client_http_check_name]: /docs/configuration/consul#client_http_check_name
[client_service_name]: /docs/configuration/consul#client_service_name
[configuration]: /docs/configuration
[data_dir]: /docs/configuration#data_dir
[datacenter]: /docs/configuration#datacenter
[enabled]: /docs/configuration/acl#enabled
[encryption overview]: https://learn.hashicorp.com/tutorials/nomad/security-gossip-encryption
[key_file]: /docs/configuration/consul#key_file
[log_json]: /docs/configuration#log_json
[log_level]: /docs/configuration#log_level
[meta]: /docs/configuration/client#meta
[name]: /docs/configuration#name
[network_interface]: /docs/configuration/client#network_interface
[node_class]: /docs/configuration/client#node_class
[nomad agent]: /docs/operations/nomad-agent
[plugin_dir]: /docs/configuration#plugin_dir
[region]: /docs/configuration#region
[rejoin_after_leave]: /docs/configuration/server#rejoin_after_leave
[replication_token]: /docs/configuration/acl#replication_token
[retry_interval]: /docs/configuration/server#retry_interval
[retry_max]: /docs/configuration/server#retry_max
[server_auto_join]: /docs/configuration/consul#server_auto_join
[server_http_check_name]: /docs/configuration/consul#server_http_check_name
[server_rpc_check_name]: /docs/configuration/consul#server_rpc_check_name
[server_serf_check_name]: /docs/configuration/consul#server_serf_check_name
[server_service_name]: /docs/configuration/consul#server_service_name
[servers]: /docs/configuration/client#servers
[ssl]: /docs/configuration/consul#ssl
[state_dir]: /docs/configuration/client#state_dir
[token]: /docs/configuration/consul#token
[verify_ssl]: /docs/configuration/consul#verify_ssl
[address]: /nomad/docs/configuration/consul#address
[alloc_dir]: /nomad/docs/configuration/client#alloc_dir
[auth]: /nomad/docs/configuration/consul#auth
[auto_advertise]: /nomad/docs/configuration/consul#auto_advertise
[bind_addr]: /nomad/docs/configuration#bind_addr
[bootstrap_expect]: /nomad/docs/configuration/server#bootstrap_expect
[ca_file]: /nomad/docs/configuration/consul#ca_file
[cert_file]: /nomad/docs/configuration/consul#cert_file
[checks_use_advertise]: /nomad/docs/configuration/consul#checks_use_advertise
[client_auto_join]: /nomad/docs/configuration/consul#client_auto_join
[client_http_check_name]: /nomad/docs/configuration/consul#client_http_check_name
[client_service_name]: /nomad/docs/configuration/consul#client_service_name
[configuration]: /nomad/docs/configuration
[data_dir]: /nomad/docs/configuration#data_dir
[datacenter]: /nomad/docs/configuration#datacenter
[enabled]: /nomad/docs/configuration/acl#enabled
[encryption overview]: /nomad/tutorials/transport-security/security-gossip-encryption
[key_file]: /nomad/docs/configuration/consul#key_file
[log_json]: /nomad/docs/configuration#log_json
[log_level]: /nomad/docs/configuration#log_level
[meta]: /nomad/docs/configuration/client#meta
[name]: /nomad/docs/configuration#name
[network_interface]: /nomad/docs/configuration/client#network_interface
[node_class]: /nomad/docs/configuration/client#node_class
[nomad agent]: /nomad/docs/operations/nomad-agent
[plugin_dir]: /nomad/docs/configuration#plugin_dir
[region]: /nomad/docs/configuration#region
[rejoin_after_leave]: /nomad/docs/configuration/server#rejoin_after_leave
[replication_token]: /nomad/docs/configuration/acl#replication_token
[retry_interval]: /nomad/docs/configuration/server#retry_interval
[retry_max]: /nomad/docs/configuration/server#retry_max
[server_auto_join]: /nomad/docs/configuration/consul#server_auto_join
[server_http_check_name]: /nomad/docs/configuration/consul#server_http_check_name
[server_rpc_check_name]: /nomad/docs/configuration/consul#server_rpc_check_name
[server_serf_check_name]: /nomad/docs/configuration/consul#server_serf_check_name
[server_service_name]: /nomad/docs/configuration/consul#server_service_name
[servers]: /nomad/docs/configuration/client#servers
[ssl]: /nomad/docs/configuration/consul#ssl
[state_dir]: /nomad/docs/configuration/client#state_dir
[token]: /nomad/docs/configuration/consul#token
[verify_ssl]: /nomad/docs/configuration/consul#verify_ssl

2
website/content/docs/commands/alloc/exec.mdx
View File

@ -138,4 +138,4 @@ a1827f93$
```
[heredoc]: http://tldp.org/LDP/abs/html/here-docs.html
[disable_remote_exec_flag]: /docs/configuration/client#disable_remote_exec
[disable_remote_exec_flag]: /nomad/docs/configuration/client#disable_remote_exec

2
website/content/docs/commands/alloc/fs.mdx
View File

@ -111,4 +111,4 @@ nomad alloc fs -job <job-id> <path>
This can be useful for debugging a job that has multiple allocations, and it is
not required to observe a specific allocation.
[allocation working directory]: /docs/runtime/environment#task-directories 'Task Directories'
[allocation working directory]: /nomad/docs/runtime/environment#task-directories 'Task Directories'

14
website/content/docs/commands/alloc/index.mdx
View File

@ -24,10 +24,10 @@ subcommands are available:
- [`alloc status`][status] - Display allocation status information and metadata
- [`alloc stop`][stop] - Stop and reschedule a running allocation
[exec]: /docs/commands/alloc/exec 'Run a command in a running allocation'
[fs]: /docs/commands/alloc/fs 'Inspect the contents of an allocation directory'
[logs]: /docs/commands/alloc/logs 'Streams the logs of a task'
[restart]: /docs/commands/alloc/restart 'Restart a running allocation or task'
[signal]: /docs/commands/alloc/signal 'Signal a running allocation'
[status]: /docs/commands/alloc/status 'Display allocation status information and metadata'
[stop]: /docs/commands/alloc/stop 'Stop and reschedule a running allocation'
[exec]: /nomad/docs/commands/alloc/exec 'Run a command in a running allocation'
[fs]: /nomad/docs/commands/alloc/fs 'Inspect the contents of an allocation directory'
[logs]: /nomad/docs/commands/alloc/logs 'Streams the logs of a task'
[restart]: /nomad/docs/commands/alloc/restart 'Restart a running allocation or task'
[signal]: /nomad/docs/commands/alloc/signal 'Signal a running allocation'
[status]: /nomad/docs/commands/alloc/status 'Display allocation status information and metadata'
[stop]: /nomad/docs/commands/alloc/stop 'Stop and reschedule a running allocation'

4
website/content/docs/commands/alloc/stop.mdx
View File

@ -63,5 +63,5 @@ $ nomad alloc stop -detach eb17e557
8a91f0f3-9d6b-ac83-479a-5aa186ab7795
```
[eval status]: /docs/commands/eval/status
[`shutdown_delay`]: /docs/job-specification/group#shutdown_delay
[eval status]: /nomad/docs/commands/eval/status
[`shutdown_delay`]: /nomad/docs/job-specification/group#shutdown_delay

2
website/content/docs/commands/config/index.mdx
View File

@ -18,4 +18,4 @@ following subcommands are available:
- [`config validate`][validate] - Validate configuration files
[validate]: /docs/commands/config/validate 'Validate configuration files'
[validate]: /nomad/docs/commands/config/validate 'Validate configuration files'

2
website/content/docs/commands/deployment/fail.mdx
View File

@ -62,4 +62,4 @@ Task Group Desired Placed Healthy Unhealthy
cache 3 2 1 0
```
[eval status]: /docs/commands/eval/status
[eval status]: /nomad/docs/commands/eval/status

12
website/content/docs/commands/deployment/index.mdx
View File

@ -23,9 +23,9 @@ subcommands are available:
- [`deployment resume`][resume] - Resume a paused deployment
- [`deployment status`][status] - Display the status of a deployment
[fail]: /docs/commands/deployment/fail 'Manually fail a deployment'
[list]: /docs/commands/deployment/list 'List all deployments'
[pause]: /docs/commands/deployment/pause 'Pause a deployment'
[promote]: /docs/commands/deployment/promote 'Promote canaries in a deployment'
[resume]: /docs/commands/deployment/resume 'Resume a paused deployment'
[status]: /docs/commands/deployment/status 'Display the status of a deployment'
[fail]: /nomad/docs/commands/deployment/fail 'Manually fail a deployment'
[list]: /nomad/docs/commands/deployment/list 'List all deployments'
[pause]: /nomad/docs/commands/deployment/pause 'Pause a deployment'
[promote]: /nomad/docs/commands/deployment/promote 'Promote canaries in a deployment'
[resume]: /nomad/docs/commands/deployment/resume 'Resume a paused deployment'
[status]: /nomad/docs/commands/deployment/status 'Display the status of a deployment'

4
website/content/docs/commands/deployment/promote.mdx
View File

@ -222,5 +222,5 @@ ee8f972e 6240eed6 web 0 run running 07/25/17 18:37:08 UT
0ee7800c 6240eed6 cache 0 stop complete 07/25/17 18:37:08 UTC
```
[`job revert`]: /docs/commands/job/revert
[eval status]: /docs/commands/eval/status
[`job revert`]: /nomad/docs/commands/job/revert
[eval status]: /nomad/docs/commands/eval/status

2
website/content/docs/commands/deployment/resume.mdx
View File

@ -53,4 +53,4 @@ Deployment "c848972e-dcd3-7354-e0d2-39d86642cdb1" resumed
==> Evaluation "5e266d42" finished with status "complete"
```
[eval status]: /docs/commands/eval/status
[eval status]: /nomad/docs/commands/eval/status

2
website/content/docs/commands/deployment/status.mdx
View File

@ -139,4 +139,4 @@ $ nomad deployment status -monitor e45
Windows compatible so there may be some formatting differences (different margins, no spinner
indicating deployment is in progress).
[`auto_revert`]: /docs/job-specification/update#auto_revert
[`auto_revert`]: /nomad/docs/job-specification/update#auto_revert

4
website/content/docs/commands/deployment/unblock.mdx
View File

@ -71,5 +71,5 @@ Task Group Desired Placed Healthy Unhealthy
cache 3 2 1 0
```
[eval status]: /docs/commands/eval/status
[federated regions]: https://learn.hashicorp.com/tutorials/nomad/federation
[eval status]: /nomad/docs/commands/eval/status
[federated regions]: /nomad/tutorials/manage-clusters/federation

4
website/content/docs/commands/eval/delete.mdx
View File

@ -69,5 +69,5 @@ $ nomad eval delete -filter='Scheduler == "system" or Scheduler == "service"' -y
Successfuly deleted 23 evaluations
```
[scheduler_get_config]: /docs/commands/operator/scheduler/get-config
[scheduler_set_config]: /docs/commands/operator/scheduler/set-config
[scheduler_get_config]: /nomad/docs/commands/operator/scheduler/get-config
[scheduler_set_config]: /nomad/docs/commands/operator/scheduler/set-config

6
website/content/docs/commands/eval/index.mdx
View File

@ -19,6 +19,6 @@ subcommands are available:
- [`eval list`][list] - List all evals
- [`eval status`][status] - Display the status of a eval
[delete]: /docs/commands/eval/delete 'Delete evals'
[list]: /docs/commands/eval/list 'List all evals'
[status]: /docs/commands/eval/status 'Display the status of a eval'
[delete]: /nomad/docs/commands/eval/delete 'Delete evals'
[list]: /nomad/docs/commands/eval/list 'List all evals'
[status]: /nomad/docs/commands/eval/status 'Display the status of a eval'

2
website/content/docs/commands/job/allocs.mdx
View File

@ -73,4 +73,4 @@ c2b4606d-1b02-0d8d-5fdd-031167cd4c91
Refer to the [Format Nomad Command Output With Templates][format_tutorial]
tutorial for more examples of using Go templates to format Nomad CLI output.
[format_tutorial]: https://learn.hashicorp.com/tutorials/nomad/format-output-with-templates
[format_tutorial]: /nomad/tutorials/templates/format-output-with-templates

6
website/content/docs/commands/job/dispatch.mdx
View File

@ -159,6 +159,6 @@ Evaluation ID = 31199841
==> Evaluation "31199841" finished with status "complete"
```
[eval status]: /docs/commands/eval/status
[parameterized job]: /docs/job-specification/parameterized 'Nomad parameterized Job Specification'
[multiregion]: /docs/job-specification/multiregion#parameterized-dispatch
[eval status]: /nomad/docs/commands/eval/status
[parameterized job]: /nomad/docs/job-specification/parameterized 'Nomad parameterized Job Specification'
[multiregion]: /nomad/docs/job-specification/multiregion#parameterized-dispatch

2
website/content/docs/commands/job/eval.mdx
View File

@ -72,4 +72,4 @@ $ nomad job eval -force-reschedule job1
==> Evaluation "0f3bc0f3" finished with status "complete"
```
[eval status]: /docs/commands/eval/status
[eval status]: /nomad/docs/commands/eval/status

14
website/content/docs/commands/job/index.mdx
View File

@ -24,10 +24,10 @@ subcommands are available:
- [`job revert`][revert] - Revert to a prior version of the job
- [`job status`][status] - Display status information about a job
[deployments]: /docs/commands/job/deployments 'List deployments for a job'
[dispatch]: /docs/commands/job/dispatch 'Dispatch an instance of a parameterized job'
[eval]: /docs/commands/job/eval 'Force an evaluation for a job'
[history]: /docs/commands/job/history 'Display all tracked versions of a job'
[promote]: /docs/commands/job/promote "Promote a job's canaries"
[revert]: /docs/commands/job/revert 'Revert to a prior version of the job'
[status]: /docs/commands/job/status 'Display status information about a job'
[deployments]: /nomad/docs/commands/job/deployments 'List deployments for a job'
[dispatch]: /nomad/docs/commands/job/dispatch 'Dispatch an instance of a parameterized job'
[eval]: /nomad/docs/commands/job/eval 'Force an evaluation for a job'
[history]: /nomad/docs/commands/job/history 'Display all tracked versions of a job'
[promote]: /nomad/docs/commands/job/promote "Promote a job's canaries"
[revert]: /nomad/docs/commands/job/revert 'Revert to a prior version of the job'
[status]: /nomad/docs/commands/job/status 'Display status information about a job'

4
website/content/docs/commands/job/init.mdx
View File

@ -39,5 +39,5 @@ $ nomad job init
Example job file written to example.nomad
```
[jobspec]: /docs/job-specification 'Nomad Job Specification'
[drivers]: /docs/drivers 'Nomad Task Drivers documentation'
[jobspec]: /nomad/docs/job-specification 'Nomad Job Specification'
[drivers]: /nomad/docs/drivers 'Nomad Task Drivers documentation'

2
website/content/docs/commands/job/inspect.mdx
View File

@ -155,4 +155,4 @@ $ nomad job inspect redis
}
```
[job http api]: /api-docs/jobs
[job http api]: /nomad/api-docs/jobs

6
website/content/docs/commands/job/periodic-force.mdx
View File

@ -63,6 +63,6 @@ Force periodic successful
Evaluation ID: 0865fbf3-30de-5f53-0811-821e73e63178
```
[eval status]: /docs/commands/eval/status
[force the evaluation]: /api-docs/jobs#force-new-periodic-instance
[periodic job]: /docs/job-specification/periodic
[eval status]: /nomad/docs/commands/eval/status
[force the evaluation]: /nomad/api-docs/jobs#force-new-periodic-instance
[periodic job]: /nomad/docs/job-specification/periodic

10
website/content/docs/commands/job/plan.mdx
View File

@ -255,10 +255,10 @@ is done to avoid hidden control characters. Adding `|| true` at the end
prevents undesired failures since `nomad job plan` returns a non-zero exit code
if a change is detected.
[job specification]: /docs/job-specification
[hcl job specification]: /docs/job-specification
[job specification]: /nomad/docs/job-specification
[hcl job specification]: /nomad/docs/job-specification
[`go-getter`]: https://github.com/hashicorp/go-getter
[`nomad job run -check-index`]: /docs/commands/job/run#check-index
[`nomad job run -check-index`]: /nomad/docs/commands/job/run#check-index
[`tee`]: https://man7.org/linux/man-pages/man1/tee.1.html
[`vault` stanza `allow_unauthenticated`]: /docs/configuration/vault#allow_unauthenticated
[`vault_token`]: /docs/job-specification/job#vault_token
[`vault` stanza `allow_unauthenticated`]: /nomad/docs/configuration/vault#allow_unauthenticated
[`vault_token`]: /nomad/docs/job-specification/job#vault_token

4
website/content/docs/commands/job/promote.mdx
View File

@ -222,5 +222,5 @@ ee8f972e 6240eed6 web 0 run running 07/25/17 18:37:08 UT
0ee7800c 6240eed6 cache 0 stop complete 07/25/17 18:37:08 UTC
```
[job revert]: /docs/commands/job/revert
[eval status]: /docs/commands/eval/status
[job revert]: /nomad/docs/commands/job/revert
[eval status]: /nomad/docs/commands/eval/status

10
website/content/docs/commands/job/revert.mdx
View File

@ -117,8 +117,8 @@ Stable = false
Submit Date = 07/25/17 21:27:18 UTC
```
[`job history`]: /docs/commands/job/history
[eval status]: /docs/commands/eval/status
[consul service identity]: /docs/configuration/consul#allow_unauthenticated
[vault policy]: /docs/configuration/vault#allow_unauthenticated
[run]: /docs/commands/job/run
[`job history`]: /nomad/docs/commands/job/history
[eval status]: /nomad/docs/commands/eval/status
[consul service identity]: /nomad/docs/configuration/consul#allow_unauthenticated
[vault policy]: /nomad/docs/configuration/vault#allow_unauthenticated
[run]: /nomad/docs/commands/job/run

20
website/content/docs/commands/job/run.mdx
View File

@ -236,14 +236,14 @@ $ nomad job run example.nomad
==> 2021-06-14T09:25:09-07:00: Evaluation "88a91284" finished with status "complete"
```
[`batch`]: /docs/schedulers#batch
[`consul` stanza `allow_unauthenticated`]: /docs/configuration/consul#allow_unauthenticated
[deployment status]: /docs/commands/deployment#status
[eval status]: /docs/commands/eval/status
[`batch`]: /nomad/docs/schedulers#batch
[`consul` stanza `allow_unauthenticated`]: /nomad/docs/configuration/consul#allow_unauthenticated
[deployment status]: /nomad/docs/commands/deployment#status
[eval status]: /nomad/docs/commands/eval/status
[`go-getter`]: https://github.com/hashicorp/go-getter
[`job plan` command]: /docs/commands/job/plan
[job specification]: /docs/job-specification
[JSON jobs]: /api-docs/json-jobs
[`system`]: /docs/schedulers#system
[`vault` stanza `allow_unauthenticated`]: /docs/configuration/vault#allow_unauthenticated
[`vault_token`]: /docs/job-specification/job#vault_token
[`job plan` command]: /nomad/docs/commands/job/plan
[job specification]: /nomad/docs/job-specification
[JSON jobs]: /nomad/api-docs/json-jobs
[`system`]: /nomad/docs/schedulers#system
[`vault` stanza `allow_unauthenticated`]: /nomad/docs/configuration/vault#allow_unauthenticated
[`vault_token`]: /nomad/docs/job-specification/job#vault_token

2
website/content/docs/commands/job/scale.mdx
View File

@ -91,4 +91,4 @@ $ nomad job scale job1 group1 8
==> Evaluation "529cc88e" finished with status "complete"
```
[eval status]: /docs/commands/eval/status
[eval status]: /nomad/docs/commands/eval/status

6
website/content/docs/commands/job/stop.mdx
View File

@ -122,6 +122,6 @@ $ nomad job stop -detach job1
507d26cb
```
[eval status]: /docs/commands/eval/status
[multi-region]: /docs/job-specification/multiregion
[`shutdown_delay`]: /docs/job-specification/group#shutdown_delay
[eval status]: /nomad/docs/commands/eval/status
[multi-region]: /nomad/docs/job-specification/multiregion
[`shutdown_delay`]: /nomad/docs/job-specification/group#shutdown_delay

6
website/content/docs/commands/job/validate.mdx
View File

@ -97,6 +97,6 @@ Job validation successful
```
[`go-getter`]: https://github.com/hashicorp/go-getter
[job specification]: /docs/job-specification
[`vault` stanza `allow_unauthenticated`]: /docs/configuration/vault#allow_unauthenticated
[`vault_token`]: /docs/job-specification/job#vault_token
[job specification]: /nomad/docs/job-specification
[`vault` stanza `allow_unauthenticated`]: /nomad/docs/configuration/vault#allow_unauthenticated
[`vault_token`]: /nomad/docs/job-specification/job#vault_token

2
website/content/docs/commands/license/index.mdx
View File

@ -25,4 +25,4 @@ subcommands are available:
- [`license get`][get] - Get the current license
[get]: /docs/commands/license/get 'Get the current license'
[get]: /nomad/docs/commands/license/get 'Get the current license'

10
website/content/docs/commands/namespace/index.mdx
View File

@ -25,8 +25,8 @@ subcommands are available:
- [`namespace list`][list] - List available namespaces
- [`namespace status`][status] - Display a namespace's status
[apply]: /docs/commands/namespace/apply 'Create or update a namespace'
[delete]: /docs/commands/namespace/delete 'Delete a namespace'
[inspect]: /docs/commands/namespace/inspect 'Inspect a namespace'
[list]: /docs/commands/namespace/list 'List available namespaces'
[status]: /docs/commands/namespace/status "Display a namespace's status"
[apply]: /nomad/docs/commands/namespace/apply 'Create or update a namespace'
[delete]: /nomad/docs/commands/namespace/delete 'Delete a namespace'
[inspect]: /nomad/docs/commands/namespace/inspect 'Inspect a namespace'
[list]: /nomad/docs/commands/namespace/list 'List available namespaces'
[status]: /nomad/docs/commands/namespace/status "Display a namespace's status"

2
website/content/docs/commands/node/config.mdx
View File

@ -61,4 +61,4 @@ $ nomad node config -update-servers server1:4647 server2:4647 server3:4647 serve
```
[`servers`]: /docs/configuration/client#servers
[`servers`]: /nomad/docs/configuration/client#servers

10
website/content/docs/commands/node/drain.mdx
View File

@ -142,8 +142,8 @@ $ nomad node drain -self -monitor
...
```
[eligibility]: /docs/commands/node/eligibility
[migrate]: /docs/job-specification/migrate
[node status]: /docs/commands/node/status
[workload migration guide]: https://learn.hashicorp.com/tutorials/nomad/node-drain
[internals-csi]: /docs/concepts/plugins/csi
[eligibility]: /nomad/docs/commands/node/eligibility
[migrate]: /nomad/docs/job-specification/migrate
[node status]: /nomad/docs/commands/node/status
[workload migration guide]: /nomad/tutorials/manage-clusters/node-drain
[internals-csi]: /nomad/docs/concepts/plugins/csi

2
website/content/docs/commands/node/eligibility.mdx
View File

@ -69,4 +69,4 @@ $ nomad node eligibility -disable -self
Node "574545c5-c2d7-e352-d505-5e2cb9fe169f" scheduling eligibility set: ineligible for scheduling
```
[drain]: /docs/commands/node/drain
[drain]: /nomad/docs/commands/node/drain

8
website/content/docs/commands/node/index.mdx
View File

@ -25,7 +25,7 @@ subcommands are available:
- [`node status`][status] - Display status information about nodes
[config]: /docs/commands/node/config 'View or modify client configuration details'
[drain]: /docs/commands/node/drain 'Set drain mode on a given node'
[eligibility]: /docs/commands/node/eligibility 'Toggle scheduling eligibility on a given node'
[status]: /docs/commands/node/status 'Display status information about nodes'
[config]: /nomad/docs/commands/node/config 'View or modify client configuration details'
[drain]: /nomad/docs/commands/node/drain 'Set drain mode on a given node'
[eligibility]: /nomad/docs/commands/node/eligibility 'Toggle scheduling eligibility on a given node'
[status]: /nomad/docs/commands/node/status 'Display status information about nodes'

4
website/content/docs/commands/operator/api.mdx
View File

@ -91,5 +91,5 @@ curl \
[curl]: https://curl.se/
[envvars]: /docs/commands#environment-variables
[jobs]: /api-docs/jobs
[envvars]: /nomad/docs/commands#environment-variables
[jobs]: /nomad/api-docs/jobs

2
website/content/docs/commands/operator/autopilot/get-config.mdx
View File

@ -65,4 +65,4 @@ UpgradeMigrationTag = ""
version info when performing upgrade migrations. If left blank, the Nomad
version will be used.
[autopilot guide]: https://learn.hashicorp.com/tutorials/nomad/autopilot
[autopilot guide]: /nomad/tutorials/manage-clusters/autopilot

6
website/content/docs/commands/operator/autopilot/set-config.mdx
View File

@ -60,6 +60,6 @@ Configuration updated!
The return code will indicate success or failure.
[`redundancy_zone`]: /docs/configuration/server#redundancy_zone
[`upgrade_version`]: /docs/configuration/server#upgrade_version
[autopilot guide]: https://learn.hashicorp.com/tutorials/nomad/autopilot
[`redundancy_zone`]: /nomad/docs/configuration/server#redundancy_zone
[`upgrade_version`]: /nomad/docs/configuration/server#upgrade_version
[autopilot guide]: /nomad/tutorials/manage-clusters/autopilot

2
website/content/docs/commands/operator/debug.mdx
View File

@ -83,7 +83,7 @@ true.
- `-event-topic=<allocation,evaluation,job,node,*>:<filter>`: Enable event
stream capture. Filter by comma delimited list of topic filters or "all".
Defaults to "none" (disabled). Refer to the [Events API](/api-docs/events) for
Defaults to "none" (disabled). Refer to the [Events API](/nomad/api-docs/events) for
additional detail.
- `-verbose`: Enable verbose output

30
website/content/docs/commands/operator/index.mdx
View File

@ -56,18 +56,18 @@ The following subcommands are available:
- [`operator snapshot inspect`][snapshot-inspect] - Inspects a snapshot of the Nomad server state
[debug]: /docs/commands/operator/debug 'Builds an archive of configuration and state'
[get-config]: /docs/commands/operator/autopilot/get-config 'Autopilot Get Config command'
[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-docs/operator 'Operator API documentation'
[outage recovery guide]: https://learn.hashicorp.com/tutorials/nomad/outage-recovery
[remove]: /docs/commands/operator/raft/remove-peer 'Raft Remove Peer command'
[set-config]: /docs/commands/operator/autopilot/set-config 'Autopilot Set Config command'
[snapshot-save]: /docs/commands/operator/snapshot/save 'Snapshot Save command'
[snapshot-restore]: /docs/commands/operator/snapshot/restore 'Snapshot Restore command'
[snapshot-inspect]: /docs/commands/operator/snapshot/inspect 'Snapshot Inspect command'
[snapshot-agent]: /docs/commands/operator/snapshot/agent 'Snapshot Agent command'
[scheduler-get-config]: /docs/commands/operator/scheduler/get-config 'Scheduler Get Config command'
[scheduler-set-config]: /docs/commands/operator/scheduler/set-config 'Scheduler Set Config command'
[debug]: /nomad/docs/commands/operator/debug 'Builds an archive of configuration and state'
[get-config]: /nomad/docs/commands/operator/autopilot/get-config 'Autopilot Get Config command'
[keygen]: /nomad/docs/commands/operator/keygen 'Generates a new encryption key'
[keyring]: /nomad/docs/commands/operator/keyring 'Manages gossip layer encryption keys'
[list]: /nomad/docs/commands/operator/raft/list-peers 'Raft List Peers command'
[operator]: /nomad/api-docs/operator 'Operator API documentation'
[outage recovery guide]: /nomad/tutorials/manage-clusters/outage-recovery
[remove]: /nomad/docs/commands/operator/raft/remove-peer 'Raft Remove Peer command'
[set-config]: /nomad/docs/commands/operator/autopilot/set-config 'Autopilot Set Config command'
[snapshot-save]: /nomad/docs/commands/operator/snapshot/save 'Snapshot Save command'
[snapshot-restore]: /nomad/docs/commands/operator/snapshot/restore 'Snapshot Restore command'
[snapshot-inspect]: /nomad/docs/commands/operator/snapshot/inspect 'Snapshot Inspect command'
[snapshot-agent]: /nomad/docs/commands/operator/snapshot/agent 'Snapshot Agent command'
[scheduler-get-config]: /nomad/docs/commands/operator/scheduler/get-config 'Scheduler Get Config command'
[scheduler-set-config]: /nomad/docs/commands/operator/scheduler/set-config 'Scheduler Set Config command'

4
website/content/docs/commands/operator/metrics.mdx
View File

@ -5,7 +5,7 @@ page_title: 'Commands: operator metrics'
# Command: operator metrics
The `operator metrics` command queries the [metrics API endpoint](/api-docs/metrics).
The `operator metrics` command queries the [metrics API endpoint](/nomad/api-docs/metrics).
## Usage
@ -27,7 +27,7 @@ nomad operator metrics [options]
## Output
The output of `nomad operator metrics` is a JSON representation of the
[metrics API endpoint](/api-docs/metrics).
[metrics API endpoint](/nomad/api-docs/metrics).
```shell-session
$ nomad operator metrics -pretty

2
website/content/docs/commands/operator/raft/info.mdx
View File

@ -36,4 +36,4 @@ first index: 1
last index: 10
```
[data directory]: /docs/configuration#data_dir
[data directory]: /nomad/docs/configuration#data_dir

4
website/content/docs/commands/operator/raft/list-peers.mdx
View File

@ -59,5 +59,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-docs/operator
[outage recovery]: https://learn.hashicorp.com/tutorials/nomad/outage-recovery
[operator]: /nomad/api-docs/operator
[outage recovery]: /nomad/tutorials/manage-clusters/outage-recovery

2
website/content/docs/commands/operator/raft/logs.mdx
View File

@ -35,4 +35,4 @@ $ sudo nomad operator raft logs /var/nomad/data > ~/raft-logs.json
$ jq . < ~/raft-logs.json
```
[data directory]: /docs/configuration#data_dir
[data directory]: /nomad/docs/configuration#data_dir

8
website/content/docs/commands/operator/raft/remove-peer.mdx
View File

@ -40,7 +40,7 @@ If ACLs are enabled, this command requires a management token.
- `-peer-id`: Remove a Nomad server with the given ID from the Raft
configuration. The format is "id"
[`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-docs/operator 'Nomad Operator API'
[outage recovery]: https://learn.hashicorp.com/tutorials/nomad/outage-recovery
[`nomad server force-leave`]: /nomad/docs/commands/server/force-leave 'Nomad server force-leave command'
[`nomad server members`]: /nomad/docs/commands/server/members 'Nomad server members command'
[operator]: /nomad/api-docs/operator 'Nomad Operator API'
[outage recovery]: /nomad/tutorials/manage-clusters/outage-recovery

2
website/content/docs/commands/operator/raft/state.mdx
View File

@ -43,4 +43,4 @@ $ sudo nomad operator raft state /var/nomad/data > ~/raft-state.json
$ jq . < ~/raft-state.json
```
[data directory]: /docs/configuration#data_dir
[data directory]: /nomad/docs/configuration#data_dir

2
website/content/docs/commands/operator/scheduler/set-config.mdx
View File

@ -79,4 +79,4 @@ $ nomad operator scheduler set-config -scheduler-algorithm=spread -check-index=5
Scheduler configuration updated!
```
[`memory_max`]: /docs/job-specification/resources#memory_max
[`memory_max`]: /nomad/docs/job-specification/resources#memory_max

2
website/content/docs/commands/operator/snapshot/inspect.mdx
View File

@ -26,4 +26,4 @@ Version 1
nomad operator snapshot inspect <file>
```
[outage recovery]: https://learn.hashicorp.com/tutorials/nomad/outage-recovery
[outage recovery]: /nomad/tutorials/manage-clusters/outage-recovery

2
website/content/docs/commands/operator/snapshot/restore.mdx
View File

@ -34,4 +34,4 @@ nomad operator snapshot restore [options] <file>
@include 'general_options_no_namespace.mdx'
[outage recovery]: https://learn.hashicorp.com/tutorials/nomad/outage-recovery
[outage recovery]: /nomad/tutorials/manage-clusters/outage-recovery

2
website/content/docs/commands/operator/snapshot/save.mdx
View File

@ -44,4 +44,4 @@ nomad operator snapshot save [options] <file>
may need to set `-stale` to "true" to get the configuration from a non-leader
server.
[outage recovery]: https://learn.hashicorp.com/tutorials/nomad/outage-recovery
[outage recovery]: /nomad/tutorials/manage-clusters/outage-recovery

2
website/content/docs/commands/plugin/index.mdx
View File

@ -21,4 +21,4 @@ subcommands are available:
- [`plugin status`][status] - Display status information about a plugin
[csi]: https://github.com/container-storage-interface/spec
[status]: /docs/commands/plugin/status 'Display status information about a plugin'
[status]: /nomad/docs/commands/plugin/status 'Display status information about a plugin'

12
website/content/docs/commands/quota/index.mdx
View File

@ -26,9 +26,9 @@ subcommands are available:
- [`quota list`][quotalist] - List quota specifications
- [`quota status`][quotastatus] - Display a quota's status and current usage
[quotaapply]: /docs/commands/quota/apply
[quotadelete]: /docs/commands/quota/delete
[quotainit]: /docs/commands/quota/init
[quotainspect]: /docs/commands/quota/inspect
[quotalist]: /docs/commands/quota/list
[quotastatus]: /docs/commands/quota/status
[quotaapply]: /nomad/docs/commands/quota/apply
[quotadelete]: /nomad/docs/commands/quota/delete
[quotainit]: /nomad/docs/commands/quota/init
[quotainspect]: /nomad/docs/commands/quota/inspect
[quotalist]: /nomad/docs/commands/quota/list
[quotastatus]: /nomad/docs/commands/quota/status

8
website/content/docs/commands/recommendation/index.mdx
View File

@ -24,7 +24,7 @@ subcommands are available:
- [`recommendation info`][recommendationinfo] - Display an individual Nomad recommendation
- [`recommendation list`][recommendationlist] - Display all Nomad recommendations
[recommendationapply]: /docs/commands/recommendation/apply
[recommendationdismiss]: /docs/commands/recommendation/dismiss
[recommendationinfo]: /docs/commands/recommendation/info
[recommendationlist]: /docs/commands/recommendation/list
[recommendationapply]: /nomad/docs/commands/recommendation/apply
[recommendationdismiss]: /nomad/docs/commands/recommendation/dismiss
[recommendationinfo]: /nomad/docs/commands/recommendation/info
[recommendationlist]: /nomad/docs/commands/recommendation/list

4
website/content/docs/commands/scaling/index.mdx
View File

@ -21,5 +21,5 @@ subcommands are available:
- [`policy info`][scalingpolicyinfo] - Display an individual Nomad scaling policy
- [`policy list`][scalingpolicylist] - List all Nomad scaling policies
[scalingpolicyinfo]: /docs/commands/scaling/policy-info
[scalingpolicylist]: /docs/commands/scaling/policy-list
[scalingpolicyinfo]: /nomad/docs/commands/scaling/policy-info
[scalingpolicylist]: /nomad/docs/commands/scaling/policy-list

8
website/content/docs/commands/sentinel/index.mdx
View File

@ -24,7 +24,7 @@ subcommands are available:
- [`sentinel list`][list] - Display all Sentinel policies
- [`sentinel read`][read] - Inspects an existing Sentinel policies
[delete]: /docs/commands/sentinel/delete
[list]: /docs/commands/sentinel/list
[read]: /docs/commands/sentinel/read
[apply]: /docs/commands/sentinel/apply
[delete]: /nomad/docs/commands/sentinel/delete
[list]: /nomad/docs/commands/sentinel/list
[read]: /nomad/docs/commands/sentinel/read
[apply]: /nomad/docs/commands/sentinel/apply

6
website/content/docs/commands/server/index.mdx
View File

@ -22,6 +22,6 @@ subcommands are available:
- [`server join`][join] - Join server nodes together
- [`server members`][members] - Display a list of known servers and their status
[force-leave]: /docs/commands/server/force-leave "Force a server into the 'left' state"
[join]: /docs/commands/server/join 'Join server nodes together'
[members]: /docs/commands/server/members 'Display a list of known servers and their status'
[force-leave]: /nomad/docs/commands/server/force-leave "Force a server into the 'left' state"
[join]: /nomad/docs/commands/server/join 'Join server nodes together'
[members]: /nomad/docs/commands/server/members 'Display a list of known servers and their status'

6
website/content/docs/commands/service/index.mdx
View File

@ -22,6 +22,6 @@ subcommands are available:
- [`service info`][serviceinfo] - Display an individual Nomad service registration
- [`service list`][servicelist] - Display all registered Nomad services
[servicedelete]: /docs/commands/service/delete
[serviceinfo]: /docs/commands/service/info
[servicelist]: /docs/commands/service/list
[servicedelete]: /nomad/docs/commands/service/delete
[serviceinfo]: /nomad/docs/commands/service/info
[servicelist]: /nomad/docs/commands/service/list

Some files were not shown because too many files have changed in this diff Show More