Unverified Commit 4311f5e9 authored by Charlie Voiselle's avatar Charlie Voiselle Committed by GitHub
Browse files

Merge pull request #7322 from hashicorp/docs-fix-guide-links

Working on "/guides" links
parents 5d5469e6 983572f1
No related merge requests found
Showing with 87 additions and 55 deletions
+87 -55
......@@ -6,6 +6,28 @@
// the landing page for the category
export default [
{ category: 'quickstart' },
{
category: 'install',
content: [
{
category: 'production',
content: [
'requirements',
'nomad-agent',
'reference-architecture',
'deployment-guide'
]
},
'windows-service'
]
},
{ category: 'upgrade', content: ['upgrade-specific'] },
{
category: 'integrations',
content: ['consul-integration', 'consul-connect', 'vault-integration']
},
'-----------',
{
category: 'internals',
content: [
......
......@@ -8,7 +8,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](/guides/security/acl).
For more details about ACLs, please see the [ACL Guide](https://learn.hashicorp.com/nomad/acls/fundamentals).
## List Policies
......
......@@ -8,13 +8,13 @@ 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](/guides/security/acl).
For more details about ACLs, please see the [ACL Guide](https://learn.hashicorp.com/nomad/acls/fundamentals).
## Bootstrap 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
until a [bootstrap reset](/guides/security/acl#reseting-acl-bootstrap) is performed.
until a [bootstrap reset](https://learn.hashicorp.com/nomad/acls/bootstrap#re-bootstrap-acl-system) is performed.
| Method | Path | Produces |
| ------ | ---------------- | ------------------ |
......
......@@ -76,7 +76,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.
For more details about ACLs, please see the [ACL Guide](/guides/security/acl).
For more details about ACLs, please see the [ACL Guide](https://learn.hashicorp.com/nomad/acls/fundamentals).
## Authentication
......
......@@ -396,7 +396,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](/guides/integrations/consul-integration#service-discovery) to learn more about
[Click here](/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}`,
......
......@@ -825,7 +825,7 @@ $ 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](/guides/operations/node-draining) for suggested usage.
Guide](https://learn.hashicorp.com/nomad/operating-nomad/node-draining) for suggested usage.
| Method | Path | Produces |
| ------ | ------------------------- | ------------------ |
......
......@@ -15,7 +15,7 @@ as interacting with the Raft subsystem.
~> Use this interface with extreme caution, as improper use could lead to a
Nomad outage and even loss of data.
See the [Outage Recovery](/guides/operations/outage) guide for some examples of how
See the [Outage Recovery](https://learn.hashicorp.com/nomad/operating-nomad/outage) 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.
......
......@@ -12,7 +12,7 @@ description: >-
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/nomad/governance-and-policy/sentinel).
Sentinel endpoints are only available when ACLs are enabled. For more details about ACLs, please see the [ACL Guide](/guides/security/acl).
Sentinel endpoints are only available when ACLs are enabled. For more details about ACLs, please see the [ACL Guide](https://learn.hashicorp.com/nomad/acls/fundamentals).
~> **Enterprise Only!** This API endpoint and functionality only exists in
Nomad Enterprise. This is not present in the open source version of Nomad.
......
......@@ -197,7 +197,7 @@ via CLI arguments. The `agent` command accepts the following arguments:
[data_dir]: /docs/configuration#data_dir
[datacenter]: #datacenter
[enabled]: /docs/configuration/acl#enabled
[encryption overview]: /guides/security/encryption
[encryption overview]: https://learn.hashicorp.com/nomad/transport-security/concepts
[key_file]: /docs/configuration/consul#key_file
[log_json]: /docs/configuration#log_json
[log_level]: /docs/configuration#log_level
......@@ -206,7 +206,7 @@ via CLI arguments. The `agent` command accepts the following arguments:
[network_interface]: #network_interface
[network_speed]: #network_speed
[node_class]: #node_class
[nomad agent]: /guides/install/production/nomad-agent
[nomad agent]: /docs/install/production/nomad-agent
[plugin_dir]: /docs/configuration#plugin_dir
[region]: #region
[rejoin_after_leave]: #rejoin_after_leave
......
......@@ -134,4 +134,4 @@ $ nomad node drain -self -monitor
[eligibility]: /docs/commands/node/eligibility
[migrate]: /docs/job-specification/migrate
[node status]: /docs/commands/node/status
[workload migration guide]: /guides/operations/node-draining
[workload migration guide]: https://learn.hashicorp.com/nomad/operating-nomad/node-draining
......@@ -63,4 +63,4 @@ UpgradeMigrationTag = ""
version info when performing upgrade migrations. If left blank, the Nomad
version will be used.
[autopilot guide]: /guides/operations/autopilot
[autopilot guide]: https://learn.hashicorp.com/nomad/operating-nomad/autopilot
......@@ -60,4 +60,4 @@ The return code will indicate success or failure.
[`redundancy_zone`]: /docs/configuration/server#redundancy_zone
[`upgrade_version`]: /docs/configuration/server#upgrade_version
[autopilot guide]: /guides/operations/autopilot
[autopilot guide]: https://learn.hashicorp.com/nomad/operating-nomad/autopilot
......@@ -46,6 +46,6 @@ The following subcommands are available:
[keyring]: /docs/commands/operator/keyring 'Manages gossip layer encryption keys'
[list]: /docs/commands/operator/raft-list-peers 'Raft List Peers command'
[operator]: /api/operator 'Operator API documentation'
[outage recovery guide]: /guides/operations/outage
[outage recovery guide]: https://learn.hashicorp.com/nomad/operating-nomad/outage
[remove]: /docs/commands/operator/raft-remove-peer 'Raft Remove Peer command'
[set-config]: /docs/commands/operator/autopilot-set-config 'Autopilot Set Config command'
......@@ -59,4 +59,4 @@ nomad-server03.global 10.10.11.7:4647 10.10.11.7:4647 follower true
configuration. Future versions of Nomad may add support for non-voting servers.
[operator]: /api/operator
[outage recovery]: /guides/operations/outage
[outage recovery]: https://learn.hashicorp.com/nomad/operating-nomad/outage
......@@ -42,4 +42,4 @@ nomad operator raft remove-peer [options]
[`nomad server force-leave`]: /docs/commands/server/force-leave 'Nomad server force-leave command'
[`nomad server members`]: /docs/commands/server/members 'Nomad server members command'
[operator]: /api/operator 'Nomad Operator API'
[outage recovery]: /guides/operations/outage
[outage recovery]: https://learn.hashicorp.com/nomad/operating-nomad/outage
......@@ -12,7 +12,7 @@ description: >-
<Placement groups={['autopilot']} />
The `autopilot` stanza configures the Nomad agent to configure Autopilot behavior.
For more information about Autopilot, see the [Autopilot Guide](/guides/operations/autopilot).
For more information about Autopilot, see the [Autopilot Guide].
```hcl
autopilot {
......@@ -56,3 +56,5 @@ autopilot {
- `enable_custom_upgrades` `(bool: false)` - (Enterprise-only) Specifies whether to
enable using custom upgrade versions when performing migrations, in conjunction with
the [upgrade_version](/docs/configuration/server#upgrade_version) parameter.
[Autopilot Guide]: https://learn.hashicorp.com/nomad/operating-nomad/autopilot
......@@ -144,9 +144,12 @@ consul {
### Custom Address and Port
This example shows pointing the Nomad agent at a different Consul address. Note
that you should **never** point directly at a Consul server; always point to a
local client. In this example, the Consul server is bound and listening on the
This example shows pointing the Nomad agent at a different Consul address.
~> **Note**: You should **never** point directly at a Consul server; always
point to a local client.
In this example, the Consul server is bound and listening on the
node's private IP address instead of localhost, so we use that:
```hcl
......@@ -171,4 +174,4 @@ consul {
```
[consul]: https://www.consul.io/ 'Consul by HashiCorp'
[bootstrap]: /guides/operations/cluster/automatic 'Automatic Bootstrapping'
[bootstrap]: https://learn.hashicorp.com/nomad/operating-nomad/clustering 'Automatic Bootstrapping'
......@@ -30,10 +30,11 @@ server {
## `server` Parameters
- `authoritative_region` `(string: "")` - Specifies the authoritative region, which
provides a single source of truth for global configurations such as ACL Policies and
global ACL tokens. Non-authoritative regions will replicate from the authoritative
to act as a mirror. By default, the local region is assumed to be authoritative.
- `authoritative_region` `(string: "")` - Specifies the authoritative region,
which provides a single source of truth for global configurations such as ACL
Policies and global ACL tokens. Non-authoritative regions will replicate from
the authoritative to act as a mirror. By default, the local region is assumed
to be authoritative.
- `bootstrap_expect` `(int: required)` - Specifies the number of server nodes to
wait for before bootstrapping. It is most common to use the odd-numbered
......@@ -72,11 +73,11 @@ server {
- `job_gc_interval` `(string: "5m")` - Specifies the interval between the job
garbage collections. Only jobs who have been terminal for at least
`job_gc_threshold` will be collected. Lowering the interval will perform more
frequent but smaller collections. Raising the interval will perform collections
less frequently but collect more jobs at a time. Reducing this interval is
useful if there is a large throughput of tasks, leading to a large set of
dead jobs. This is specified using a label suffix like "30s" or "3m". `job_gc_interval`
was introduced in Nomad 0.10.0.
frequent but smaller collections. Raising the interval will perform
collections less frequently but collect more jobs at a time. Reducing this
interval is useful if there is a large throughput of tasks, leading to a large
set of dead jobs. This is specified using a label suffix like "30s" or "3m".
`job_gc_interval` was introduced in Nomad 0.10.0.
- `job_gc_threshold` `(string: "4h")` - Specifies the minimum time a job must be
in the terminal state before it is eligible for garbage collection. This is
......@@ -90,12 +91,12 @@ server {
deployment must be in the terminal state before it is eligible for garbage
collection. This is specified using a label suffix like "30s" or "1h".
- `default_scheduler_config` <code>([scheduler_configuration][update-scheduler-config]:
nil)</code> - Specifies the initial default scheduler config when
bootstrapping cluster. The parameter is ignored once the cluster is bootstrapped or
value is updated through the [API endpoint][update-scheduler-config]. See [the
example section](#configuring-scheduler-config) for more details
`default_scheduler_config` was introduced in Nomad 0.11.4.
- `default_scheduler_config` <code>([scheduler_configuration][Update scheduler
config]: nil)</code> - Specifies the initial default scheduler config when
bootstrapping cluster. The parameter is ignored once the cluster is
bootstrapped or value is updated through the [API endpoint][[Update scheduler
config]]. See [the example section](#configuring-scheduler-config) for more
details `default_scheduler_config` was introduced in Nomad 0.11.4.
- `heartbeat_grace` `(string: "10s")` - Specifies the additional time given as a
grace period beyond the heartbeat TTL of nodes to account for network and
......@@ -135,7 +136,7 @@ server {
- `redundancy_zone` `(string: "")` - (Enterprise-only) Specifies the redundancy
zone that this server will be a part of for Autopilot management. For more
information, see the [Autopilot Guide](/guides/operations/autopilot).
information, see the [Autopilot Guide].
- `rejoin_after_leave` `(bool: false)` - Specifies if Nomad will ignore a
previous leave and attempt to rejoin the cluster when starting. By default,
......@@ -143,14 +144,15 @@ server {
cluster again when starting. This flag allows the previous state to be used to
rejoin the cluster.
- `server_join` <code>([server_join][server-join]: nil)</code> - Specifies
how the Nomad server will connect to other Nomad servers. The `retry_join`
fields may directly specify the server address or use go-discover syntax for
auto-discovery. See the [server_join documentation][server-join] for more detail.
- `server_join` <code>([server_join][server-join]: nil)</code> - Specifies how
the Nomad server will connect to other Nomad servers. The `retry_join` fields
may directly specify the server address or use go-discover syntax for
auto-discovery. See the [server_join documentation][server-join] for more
detail.
- `upgrade_version` `(string: "")` - A custom version of the format X.Y.Z to use
in place of the Nomad version when custom upgrades are enabled in Autopilot.
For more information, see the [Autopilot Guide](/guides/operations/autopilot).
For more information, see the [Autopilot Guide].
### Deprecated Parameters
......@@ -161,9 +163,9 @@ server {
succeeds. After one succeeds, no further addresses will be contacted. This is
useful for cases where we know the address will become available eventually.
Use `retry_join` with an array as a replacement for `start_join`, **do not use
both options**. See the [server_join][server-join]
section for more information on the format of the string. This field is
deprecated in favor of the [server_join stanza][server-join].
both options**. See the [server_join][server-join] section for more
information on the format of the string. This field is deprecated in favor of
the [server_join stanza][server-join].
- `retry_interval` `(string: "30s")` - Specifies the time to wait between retry
join attempts. This field is deprecated in favor of the [server_join
......@@ -215,8 +217,8 @@ server {
### Automatic Bootstrapping
The Nomad servers can automatically bootstrap if Consul is configured. For a
more detailed explanation, please see the
[automatic Nomad bootstrapping documentation](/guides/operations/cluster/automatic).
more detailed explanation, please see the [automatic Nomad bootstrapping]
documentation.
### Restricting Schedulers
......@@ -247,14 +249,16 @@ server {
}
```
The structure matches the [Update Scheduler Config][update-scheduler-config] endpoint,
but adopted to hcl syntax (namely using snake case rather than camel case).
The structure matches the [Update Scheduler Config] endpoint, but adopted to hcl
syntax (namely using snake case rather than camel case).
Nomad servers check their `default_scheduler_config` only during cluster
bootstrap. During upgrades, if a previously bootstrapped cluster already set
scheduler configuration via the [Update Scheduler Config][update-scheduler-config]
endpoint, that is always preferred.
scheduler configuration via the [Update Scheduler Config] endpoint, that is
always preferred.
[encryption]: /guides/security/encryption 'Nomad Encryption Overview'
[encryption]: https://learn.hashicorp.com/nomad/transport-security/concepts 'Nomad Encryption Overview'
[server-join]: /docs/configuration/server_join 'Server Join'
[update-scheduler-config]: /api/operator#update-scheduler-configuration 'Scheduler Config'
[Update Scheduler Config]: /api/operator#update-scheduler-configuration 'Scheduler Config'
[Autopilot Guide]: https://learn.hashicorp.com/nomad/operating-nomad/autopilot
[automatic Nomad bootstrapping documentation]: https://learn.hashicorp.com/nomad/operating-nomad/clustering
......@@ -26,7 +26,7 @@ start the Nomad agent.
This section of the documentation only covers the configuration options for
`tls` stanza. To understand how to setup the certificates themselves, please see
the [Encryption Overview Guide](/guides/security/encryption).
the ["Enable TLS Encryption for Nomad" Guide].
## `tls` Parameters
......@@ -101,3 +101,4 @@ tls {
```
[raft]: https://github.com/hashicorp/serf 'Serf by HashiCorp'
["Enable TLS Encryption for Nomad" Guide]: https://learn.hashicorp.com/nomad/transport-security/enable-tls
......@@ -29,7 +29,7 @@ Below is a list of community-supported task drivers you can use with Nomad:
- [Firecracker][firecracker-task-driver]
- [Systemd-Nspawn][nspawn-driver]
[lxc]: /docs/drivers/external/lxc
[lxc]: https://learn.hashicorp.com/nomad/using-plugins/lxc
[plugin_guide]: /docs/internals/plugins
[singularity]: /docs/drivers/external/singularity
[jail-task-driver]: /docs/drivers/external/jail-task-driver
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment