Fix broken links in API docs
This commit is contained in:
parent
e4120e34c9
commit
f10155f285
|
@ -9,7 +9,7 @@ description: |-
|
||||||
# ACL Policies HTTP API
|
# ACL Policies HTTP API
|
||||||
|
|
||||||
The `/acl/policies` and `/acl/policy/` endpoints are used to manage ACL policies.
|
The `/acl/policies` and `/acl/policy/` endpoints are used to manage ACL policies.
|
||||||
For more details about ACLs, please see the [ACL Guide](/guides/acl.html).
|
For more details about ACLs, please see the [ACL Guide](/guides/security/acl.html).
|
||||||
|
|
||||||
## List Policies
|
## List Policies
|
||||||
|
|
||||||
|
|
|
@ -9,13 +9,13 @@ description: |-
|
||||||
# ACL Tokens HTTP API
|
# ACL Tokens HTTP API
|
||||||
|
|
||||||
The `/acl/bootstrap`, `/acl/tokens`, and `/acl/token/` endpoints are used to manage ACL tokens.
|
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](/guides/acl.html).
|
For more details about ACLs, please see the [ACL Guide](/guides/security/acl.html).
|
||||||
|
|
||||||
## Bootstrap Token
|
## Bootstrap Token
|
||||||
|
|
||||||
This endpoint is used to bootstrap the ACL system and provide the initial management token.
|
This endpoint is used to bootstrap the ACL system and provide the initial management token.
|
||||||
This request is always forwarded to the authoritative region. It can only be invoked once
|
This request is always forwarded to the authoritative region. It can only be invoked once
|
||||||
until a [bootstrap reset](/guides/acl.html#reseting-acl-bootstrap) is performed.
|
until a [bootstrap reset](/guides/security/acl.html#reseting-acl-bootstrap) is performed.
|
||||||
|
|
||||||
| Method | Path | Produces |
|
| Method | Path | Produces |
|
||||||
| ------ | ---------------------------- | -------------------------- |
|
| ------ | ---------------------------- | -------------------------- |
|
||||||
|
|
|
@ -75,7 +75,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 set to the `SecretID` of an ACL Token.
|
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 set to the `SecretID` of an ACL Token.
|
||||||
|
|
||||||
For more details about ACLs, please see the [ACL Guide](/guides/acl.html).
|
For more details about ACLs, please see the [ACL Guide](/guides/security/acl.html).
|
||||||
|
|
||||||
## Authentication
|
## Authentication
|
||||||
|
|
||||||
|
|
|
@ -197,7 +197,7 @@ The `Job` object supports the following keys:
|
||||||
- `Type` - Specifies the job type and switches which scheduler
|
- `Type` - Specifies the job type and switches which scheduler
|
||||||
is used. Nomad provides the `service`, `system` and `batch` schedulers,
|
is used. Nomad provides the `service`, `system` and `batch` schedulers,
|
||||||
and defaults to `service`. To learn more about each scheduler type visit
|
and defaults to `service`. To learn more about each scheduler type visit
|
||||||
[here](/docs/runtime/schedulers.html)
|
[here](/docs/schedulers.html)
|
||||||
|
|
||||||
- `Update` - Specifies an update strategy to be applied to all task groups
|
- `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,
|
within the job. When specified both at the job level and the task group level,
|
||||||
|
@ -366,7 +366,7 @@ The `Task` object supports the following keys:
|
||||||
Consul for service discovery. A `Service` object represents a routable and
|
Consul for service discovery. A `Service` object represents a routable and
|
||||||
discoverable service on the network. Nomad automatically registers when a task
|
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.
|
is started and de-registers it when the task transitions to the dead state.
|
||||||
[Click here](/docs/service-discovery/index.html) to learn more about
|
[Click here](/guides/operations/consul-integration/index.html#service-discovery) to learn more about
|
||||||
services. Below is the fields in the `Service` object:
|
services. Below is the fields in the `Service` object:
|
||||||
|
|
||||||
- `Name`: An explicit name for the Service. Nomad will replace `${JOB}`,
|
- `Name`: An explicit name for the Service. Nomad will replace `${JOB}`,
|
||||||
|
|
|
@ -759,8 +759,8 @@ $ curl \
|
||||||
|
|
||||||
This endpoint toggles the drain mode of the node. When draining is enabled, no
|
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
|
further allocations will be assigned to this node, and existing allocations will
|
||||||
be migrated to new nodes. See the [Decommissioning Nodes
|
be migrated to new nodes. See the [Workload Migration
|
||||||
guide](/guides/node-draining.html) for suggested usage.
|
Guide](/guides/operations/node-draining.html) for suggested usage.
|
||||||
|
|
||||||
| Method | Path | Produces |
|
| Method | Path | Produces |
|
||||||
| ------- | ------------------------- | -------------------------- |
|
| ------- | ------------------------- | -------------------------- |
|
||||||
|
|
|
@ -14,7 +14,7 @@ as interacting with the Raft subsystem.
|
||||||
~> Use this interface with extreme caution, as improper use could lead to a
|
~> Use this interface with extreme caution, as improper use could lead to a
|
||||||
Nomad outage and even loss of data.
|
Nomad outage and even loss of data.
|
||||||
|
|
||||||
See the [Outage Recovery](/guides/outage.html) guide for some examples of how
|
See the [Outage Recovery](/guides/operations/outage.html) guide for some examples of how
|
||||||
these capabilities are used. For a CLI to perform these operations manually,
|
these capabilities are used. For a CLI to perform these operations manually,
|
||||||
please see the documentation for the
|
please see the documentation for the
|
||||||
[`nomad operator`](/docs/commands/operator.html) command.
|
[`nomad operator`](/docs/commands/operator.html) command.
|
||||||
|
@ -164,7 +164,7 @@ $ curl \
|
||||||
```
|
```
|
||||||
|
|
||||||
For more information about the Autopilot configuration options, see the
|
For more information about the Autopilot configuration options, see the
|
||||||
[agent configuration section](/docs/agent/configuration/autopilot.html).
|
[agent configuration section](/docs/configuration/autopilot.html).
|
||||||
|
|
||||||
## Update Autopilot Configuration
|
## Update Autopilot Configuration
|
||||||
|
|
||||||
|
|
|
@ -9,9 +9,9 @@ description: |-
|
||||||
# Sentinel Policies HTTP API
|
# Sentinel Policies HTTP API
|
||||||
|
|
||||||
The `/sentinel/policies` and `/sentinel/policy/` endpoints are used to manage Sentinel policies.
|
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](/guides/sentinel-policy.html).
|
For more details about Sentinel policies, please see the [Sentinel Policy Guide](/guides/security/sentinel-policy.html).
|
||||||
|
|
||||||
Sentinel endpoints are only available when ACLs are enabled. For more details about ACLs, please see the [ACL Guide](/guides/acl.html).
|
Sentinel endpoints are only available when ACLs are enabled. For more details about ACLs, please see the [ACL Guide](/guides/security/acl.html).
|
||||||
|
|
||||||
~> **Enterprise Only!** This API endpoint and functionality only exists in
|
~> **Enterprise Only!** This API endpoint and functionality only exists in
|
||||||
Nomad Enterprise. This is not present in the open source version of Nomad.
|
Nomad Enterprise. This is not present in the open source version of Nomad.
|
||||||
|
|
Loading…
Reference in a new issue