diff --git a/README.md b/README.md index 0fd19a328..651121163 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,7 @@ Nomad

-Nomad is a simple and flexible workload orchestrator to deploy and manage containers ([docker](https://developer.hashicorp.com/nomad/docs/drivers/docker), [podman](https://developer.hashicorp.com/nomad/plugins/drivers/podman)), non-containerized applications ([executable](https://developer.hashicorp.com/nomad/docs/drivers/exec), [Java](https://developer.hashicorp.com/nomad/docs/drivers/java)), and virtual machines ([qemu](https://developer.hashicorp.com/nomad/docs/drivers/qemu)) across on-prem and clouds at scale. +Nomad is a simple and flexible workload orchestrator to deploy and manage containers ([docker](https://developer.hashicorp.com/nomad/docs/deploy/task-driver/docker), [podman](https://developer.hashicorp.com/nomad/plugins/drivers/podman)), non-containerized applications ([executable](https://developer.hashicorp.com/nomad/docs/deploy/task-driver/exec), [Java](https://developer.hashicorp.com/nomad/docs/deploy/task-driver/java)), and virtual machines ([qemu](https://developer.hashicorp.com/nomad/docs/deploy/task-driver/qemu)) across on-prem and clouds at scale. Nomad is supported on Linux, Windows, and macOS. A commercial version of Nomad, [Nomad Enterprise](https://developer.hashicorp.com/nomad/docs/enterprise), is also available. diff --git a/command/acl_binding_rule.go b/command/acl_binding_rule.go index 1d1833f80..a264090d1 100644 --- a/command/acl_binding_rule.go +++ b/command/acl_binding_rule.go @@ -26,7 +26,7 @@ Usage: nomad acl binding-rule [options] [args] This command groups subcommands for interacting with ACL binding rules. Nomad's ACL system can be used to control access to data and APIs. For a full - guide see: https://developer.hashicorp.com/nomad/tutorials/access-control + guide see: https://developer.hashicorp.com/nomad/docs/secure/acl Create an ACL binding rule: diff --git a/command/acl_policy.go b/command/acl_policy.go index b5ee4a3f5..cc73b280c 100644 --- a/command/acl_policy.go +++ b/command/acl_policy.go @@ -20,7 +20,7 @@ Usage: nomad acl policy [options] [args] This command groups subcommands for interacting with ACL policies. Nomad's ACL system can be used to control access to data and APIs. ACL policies allow a set of capabilities or actions to be granted or allowlisted. For a full guide - see: https://developer.hashicorp.com/nomad/tutorials/access-control + see: https://developer.hashicorp.com/nomad/docs/secure/acl Create an ACL policy: diff --git a/command/acl_role.go b/command/acl_role.go index b203f03b3..cdcf5cf8e 100644 --- a/command/acl_role.go +++ b/command/acl_role.go @@ -28,7 +28,7 @@ Usage: nomad acl role [options] [args] This command groups subcommands for interacting with ACL roles. Nomad's ACL system can be used to control access to data and APIs. ACL roles are associated with one or more ACL policies which grant specific capabilities. - For a full guide see: https://developer.hashicorp.com/nomad/tutorials/access-control + For a full guide see: https://developer.hashicorp.com/nomad/docs/secure/acl Create an ACL role: diff --git a/command/acl_token.go b/command/acl_token.go index 4accc4e3d..1c160a693 100644 --- a/command/acl_token.go +++ b/command/acl_token.go @@ -20,7 +20,7 @@ Usage: nomad acl token [options] [args] This command groups subcommands for interacting with ACL tokens. Nomad's ACL system can be used to control access to data and APIs. ACL tokens are associated with one or more ACL policies which grant specific capabilities. - For a full guide see: https://developer.hashicorp.com/nomad/tutorials/access-control + For a full guide see: https://developer.hashicorp.com/nomad/docs/secure/acl Create an ACL token: diff --git a/command/asset/pool.nomad.hcl b/command/asset/pool.nomad.hcl index b9a111359..d242d97ae 100644 --- a/command/asset/pool.nomad.hcl +++ b/command/asset/pool.nomad.hcl @@ -12,7 +12,7 @@ node_pool "example" { # The scheduler configuration options specific to this node pool. This block # supports a subset of the fields supported in the global scheduler # configuration as described at: - # https://developer.hashicorp.com/nomad/docs/commands/operator/scheduler/set-config + # https://developer.hashicorp.com/nomad/commands/operator/scheduler/set-config # # * scheduler_algorithm is the scheduling algorithm to use for the pool. # If not defined, the global cluster scheduling algorithm is used. diff --git a/command/license.go b/command/license.go index fd96030a3..3190b8e46 100644 --- a/command/license.go +++ b/command/license.go @@ -24,7 +24,7 @@ Usage: nomad license [options] [args] This command has subcommands for managing the Nomad Enterprise license. For more detailed examples see: -https://developer.hashicorp.com/nomad/docs/commands/license +https://developer.hashicorp.com/nomad/commands/license Retrieve the server's license: diff --git a/command/namespace.go b/command/namespace.go index 4dca28f22..3b5e3dee7 100644 --- a/command/namespace.go +++ b/command/namespace.go @@ -22,7 +22,7 @@ Usage: nomad namespace [options] [args] This command groups subcommands for interacting with namespaces. Namespaces allow jobs and their associated objects to be segmented from each other and other users of the cluster. For a full guide on namespaces see: - https://developer.hashicorp.com/nomad/tutorials/manage-clusters/namespaces + https://developer.hashicorp.com/nomad/docs/govern/namespaces Create or update a namespace: diff --git a/command/operator_autopilot.go b/command/operator_autopilot.go index 522e3d24d..56873b7ef 100644 --- a/command/operator_autopilot.go +++ b/command/operator_autopilot.go @@ -30,7 +30,7 @@ Usage: nomad operator autopilot [options] This command groups subcommands for interacting with Nomad's Autopilot subsystem. Autopilot provides automatic, operator-friendly management of Nomad servers. The command can be used to view or modify the current Autopilot - configuration. For a full guide see: https://developer.hashicorp.com/nomad/tutorials/manage-clusters/autopilot + configuration. For a full guide see: https://developer.hashicorp.com/nomad/docs/manage/autopilot Get the current Autopilot configuration: diff --git a/command/quota.go b/command/quota.go index c1b69d544..f0ead4a8b 100644 --- a/command/quota.go +++ b/command/quota.go @@ -23,7 +23,7 @@ Usage: nomad quota [options] [args] quotas allow operators to restrict the aggregate resource usage of namespaces. Users can inspect existing quota specifications, create new quotas, delete and list existing quotas, and more. For a full guide on resource quotas see: - https://developer.hashicorp.com/nomad/tutorials/governance-and-policy/quotas + https://developer.hashicorp.com/nomad/docs/govern/resource-quotas Examine a quota's status: diff --git a/command/sentinel.go b/command/sentinel.go index 9b0629a05..8c74f0991 100644 --- a/command/sentinel.go +++ b/command/sentinel.go @@ -24,7 +24,7 @@ Usage: nomad sentinel [options] [args] Sentinel integration builds on the ACL System. Users can read existing Sentinel policies, create new policies, delete and list existing policies, and more. For a full guide on Sentinel policies see: - https://developer.hashicorp.com/nomad/tutorials/governance-and-policy/sentinel + https://developer.hashicorp.com/nomad/docs/govern/sentinel Read an existing policy: diff --git a/contributing/architecture-drainer.md b/contributing/architecture-drainer.md index 3c33d1c23..881d43748 100644 --- a/contributing/architecture-drainer.md +++ b/contributing/architecture-drainer.md @@ -175,8 +175,8 @@ flowchart TD NodeDrainer -- "4. NodesDrainComplete\n(raft shim)" --> StateStore ``` -[`nomad node drain`]: https://developer.hashicorp.com/nomad/docs/commands/node/drain -[node drain tutorial]: https://developer.hashicorp.com/nomad/tutorials/manage-clusters/node-drain +[`nomad node drain`]: https://developer.hashicorp.com/nomad/commands/node/drain +[node drain tutorial]: https://developer.hashicorp.com/nomad/docs/manage/migrate-workloads [`nomad/drainer`]: https://github.com/hashicorp/nomad/tree/main/nomad/drainer [`watch_nodes.go`]: https://github.com/hashicorp/nomad/blob/main/nomad/drainer/watch_nodes.go [`watch_jobs.go`]: https://github.com/hashicorp/nomad/blob/main/nomad/drainer/watch_jobs.go diff --git a/contributing/architecture-eval-lifecycle.md b/contributing/architecture-eval-lifecycle.md index a42eb0b70..cb8cb997a 100644 --- a/contributing/architecture-eval-lifecycle.md +++ b/contributing/architecture-eval-lifecycle.md @@ -338,5 +338,5 @@ sequenceDiagram ``` -[Scheduling Concepts]: https://developer.hashicorp.com/nomad/docs/concepts/scheduling/scheduling +[Scheduling Concepts]: https://developer.hashicorp.com/nomad/docs/concepts/scheduling/how-scheduling-works [`update`]: https://developer.hashicorp.com/nomad/docs/job-specification/update diff --git a/contributing/architecture-eval-states.md b/contributing/architecture-eval-states.md index badb6844c..04e77fd48 100644 --- a/contributing/architecture-eval-states.md +++ b/contributing/architecture-eval-states.md @@ -198,4 +198,4 @@ flowchart LR ``` -[Scheduling in Nomad]: https://developer.hashicorp.com/nomad/docs/internals/scheduling/scheduling +[Scheduling in Nomad]: https://developer.hashicorp.com/nomad/docs/concepts/scheduling/how-scheduling-works diff --git a/contributing/architecture-eval-triggers.md b/contributing/architecture-eval-triggers.md index af11f1290..08d43ea1a 100644 --- a/contributing/architecture-eval-triggers.md +++ b/contributing/architecture-eval-triggers.md @@ -252,7 +252,7 @@ and eventually need to be garbage collected. -[Scheduling in Nomad]: https://developer.hashicorp.com/nomad/docs/internals/scheduling/scheduling +[Scheduling in Nomad]: https://developer.hashicorp.com/nomad/docs/concepts/scheduling/how-scheduling-works [`structs.go`]: https://github.com/hashicorp/nomad/blob/v1.4.0-beta.1/nomad/structs/structs.go#L10857-L10875 [`update`]: https://developer.hashicorp.com/nomad/docs/job-specification/update [`restart` attempts]: https://developer.hashicorp.com/nomad/docs/job-specification/restart diff --git a/contributing/checklist-command.md b/contributing/checklist-command.md index 23b12f320..e7c146ca6 100644 --- a/contributing/checklist-command.md +++ b/contributing/checklist-command.md @@ -38,6 +38,6 @@ CLI (command/) -> API Client (api/) -> HTTP API (command/agent) -> RPC (nomad/) * [ ] Changelog * [ ] API docs https://developer.hashicorp.com/nomad/api -* [ ] CLI docs https://developer.hashicorp.com/nomad/docs/commands +* [ ] CLI docs https://developer.hashicorp.com/nomad/commands * [ ] If adding new docs see [website README](../website/README.md#editing-navigation-sidebars) * [ ] Consider if it needs a guide https://developer.hashicorp.com/nomad/guides/index.html diff --git a/contributing/checklist-rpc-endpoint.md b/contributing/checklist-rpc-endpoint.md index 8aacee0c4..6a79c4c2e 100644 --- a/contributing/checklist-rpc-endpoint.md +++ b/contributing/checklist-rpc-endpoint.md @@ -55,5 +55,5 @@ Prefer adding a new message to changing any existing RPC messages. ## Docs * [ ] Changelog -* [ ] [Metrics](https://developer.hashicorp.com/nomad/docs/operations/metrics#server-metrics) +* [ ] [Metrics](https://developer.hashicorp.com/nomad/docs/reference/metrics#server-metrics) * [ ] [API docs](https://developer.hashicorp.com/nomad/api-docs) for RPCs with an HTTP endpoint, include ACLs, params, and example response body. diff --git a/demo/csi/README.md b/demo/csi/README.md index 559c344f6..a0251b43d 100644 --- a/demo/csi/README.md +++ b/demo/csi/README.md @@ -16,4 +16,4 @@ in this directory. This folder should include: * Add an `Author: @` field at the top so you can be tagged on issues. * A Nomad job file for the plugin. -* A [volume specification](https://developer.hashicorp.com/nomad/docs/commands/volume/register#volume-specification) file. +* A [volume specification](https://developer.hashicorp.com/nomad/commands/volume/register#volume-specification) file. diff --git a/demo/csi/ceph-csi-plugin/README.md b/demo/csi/ceph-csi-plugin/README.md index c58d2959b..65fec9bef 100644 --- a/demo/csi/ceph-csi-plugin/README.md +++ b/demo/csi/ceph-csi-plugin/README.md @@ -9,7 +9,7 @@ can be modified for the CephFS Driver, as used ## Deployment The Ceph CSI Node task requires that [`privileged = -true`](https://developer.hashicorp.com/nomad/docs/drivers/docker#privileged) be +true`](https://developer.hashicorp.com/nomad/docs/deploy/task-driver/docker#allow_privileged) be set. This is not needed for the Controller task. ### Plugin Arguments diff --git a/demo/csi/cinder-csi-plugin/README.md b/demo/csi/cinder-csi-plugin/README.md index 2ce91dde3..966eb3780 100644 --- a/demo/csi/cinder-csi-plugin/README.md +++ b/demo/csi/cinder-csi-plugin/README.md @@ -20,7 +20,7 @@ region = RegionOne ### Docker Privileged Mode -The Cinder CSI Node task requires that [`privileged = true`](https://developer.hashicorp.com/nomad/docs/drivers/docker#privileged) be set. This is not needed for the Controller task. +The Cinder CSI Node task requires that [`privileged = true`](https://developer.hashicorp.com/nomad/docs/deploy/task-driver/docker#allow_privileged) be set. This is not needed for the Controller task. ## Container Arguments diff --git a/demo/csi/kadalu-csi/controller.nomad b/demo/csi/kadalu-csi/controller.nomad index 3727a16c8..127b51a33 100644 --- a/demo/csi/kadalu-csi/controller.nomad +++ b/demo/csi/kadalu-csi/controller.nomad @@ -113,7 +113,7 @@ job "kadalu-csi-controller" { image = "docker.io/kadalu/kadalu-csi:${var.kadalu_version}" # Nomad client config for docker plugin should have privileged set to 'true' - # refer https://developer.hashicorp.com/nomad/docs/drivers/docker#privileged + # refer https://developer.hashicorp.com/nomad/docs/deploy/task-driver/docker#allow_privileged # Need to access '/dev/fuse' for mounting external gluster volume privileged = true diff --git a/e2e/volume_mounts/input/volumes.nomad b/e2e/volume_mounts/input/volumes.nomad index 3ca974e1b..7ac353eee 100644 --- a/e2e/volume_mounts/input/volumes.nomad +++ b/e2e/volume_mounts/input/volumes.nomad @@ -102,7 +102,7 @@ EOT # /var/nomad/alloc/:alloc_id/:task_name # which is the same as the root directory for exec tasks. # we just need to make sure this doesn't collide with the - # chroot: https://developer.hashicorp.com/nomad/docs/drivers/exec#chroot + # chroot: https://developer.hashicorp.com/nomad/docs/deploy/task-driver/exec#chroot destination = "usr/local/bin/myapplication.sh" } diff --git a/jobspec2/types.variables.go b/jobspec2/types.variables.go index 2607eeedb..ef5a10434 100644 --- a/jobspec2/types.variables.go +++ b/jobspec2/types.variables.go @@ -163,7 +163,7 @@ func (v *Variable) Value() (cty.Value, hcl.Diagnostics) { Severity: hcl.DiagError, Summary: fmt.Sprintf("Unset variable %q", v.Name), Detail: "A used variable must be set or have a default value; see " + - "https://developer.hashicorp.com/nomad/docs/job-specification/hcl2/variables for " + + "https://developer.hashicorp.com/nomad/docs/reference/hcl2/variables for " + "details.", Context: v.Range.Ptr(), }} diff --git a/nomad/auth/auth.go b/nomad/auth/auth.go index 89a798d85..af68a08ea 100644 --- a/nomad/auth/auth.go +++ b/nomad/auth/auth.go @@ -273,7 +273,7 @@ func (s *Authenticator) AuthenticateServerOnly(ctx RPCContext, args structs.Requ // verify them here and only return the server ACL for actual servers even // if mTLS was disabled. Without mTLS, any request can spoof server RPCs. // This is known and documented in the Security Model: - // https://developer.hashicorp.com/nomad/docs/concepts/security#requirements + // https://developer.hashicorp.com/nomad/docs/secure/acl if err := verifyTLS(s.verifyTLS.Load(), ctx, s.validServerCertNames, identity); err != nil { return nil, err } diff --git a/nomad/server.go b/nomad/server.go index 649fecf02..0c7656d6d 100644 --- a/nomad/server.go +++ b/nomad/server.go @@ -2190,7 +2190,7 @@ directory. The "address" field is the address and port of the server. The "non_voter" field controls whether the server is a non-voter, which is used in some advanced Autopilot configurations, please see -https://developer.hashicorp.com/nomad/tutorials/manage-clusters/outage-recovery for more information. If +https://developer.hashicorp.com/nomad/docs/manage/outage-recovery for more information. If "non_voter" is omitted it will default to false, which is typical for most clusters. @@ -2207,5 +2207,5 @@ creating the peers.json file, and that all servers receive the same configuration. Once the peers.json file is successfully ingested and applied, it will be deleted. -Please see https://developer.hashicorp.com/nomad/tutorials/manage-clusters/outage-recovery for more information. +Please see https://developer.hashicorp.com/nomad/docs/manage/outage-recovery for more information. ` diff --git a/scheduler/README.md b/scheduler/README.md index ddc3a57a3..3d5bc1a9e 100644 --- a/scheduler/README.md +++ b/scheduler/README.md @@ -198,4 +198,4 @@ This part of scheduling sits in the `scheduler/feasible/rank.go` file. The `RankIterator` interface, which is implemented by e.g., `SpreadIterator` and `BinPackIterator`, captures the ranking logic in its `Next()` methods. -[0]: https://developer.hashicorp.com/nomad/docs/concepts/scheduling/scheduling +[0]: https://developer.hashicorp.com/nomad/docs/concepts/scheduling/how-scheduling-works diff --git a/scripts/docker-entrypoint.sh b/scripts/docker-entrypoint.sh index 8165d278c..90f75f3ef 100755 --- a/scripts/docker-entrypoint.sh +++ b/scripts/docker-entrypoint.sh @@ -9,7 +9,7 @@ case "$1" in then echo "=======================================================================================================================================" echo "!! Running Nomad clients inside Docker containers is not supported. !!" - echo "!! Refer to https://developer.hashicorp.com/nomad/docs/install/production/requirements#running-nomad-in-docker for more information. !!" + echo "!! Refer to https://developer.hashicorp.com/nomad/docs/deploy/production/requirements#running-nomad-in-docker for more information. !!" echo "!! Set the NOMAD_SKIP_DOCKER_IMAGE_WARN environment variable to skip this warning. !!" echo "=======================================================================================================================================" echo "" diff --git a/terraform/README.md b/terraform/README.md index 2a39e2a7f..d788b6e49 100644 --- a/terraform/README.md +++ b/terraform/README.md @@ -74,7 +74,7 @@ for an introduction to Vault. Use the following links to get started with Nomad and its HashiCorp integrations: * [Getting Started with Nomad](https://developer.hashicorp.com/nomad/intro/getting-started/jobs.html) -* [Consul integration](https://developer.hashicorp.com/nomad/docs/service-discovery/index.html) -* [Vault integration](https://developer.hashicorp.com/nomad/docs/vault-integration/index.html) +* [Consul integration](https://developer.hashicorp.com/nomad/docs/networking/service-discovery) +* [Vault integration](https://developer.hashicorp.com/nomad/docs/secure/vault) * [consul-template integration](https://developer.hashicorp.com/nomad/docs/job-specification/template.html) diff --git a/ui/app/components/token-editor.hbs b/ui/app/components/token-editor.hbs index da3f32081..e322c9566 100644 --- a/ui/app/components/token-editor.hbs +++ b/ui/app/components/token-editor.hbs @@ -66,7 +66,7 @@ {{on "change" this.updateTokenExpirationTime}}> {{/if}} - + {{else}} {{#if @token.expirationTime}} @@ -99,7 +99,7 @@ {{#if this.system.shouldShowRegions}} Token Region - See ACL token fundamentals: Token replication settings for more information. + See ACL token fundamentals: Token replication settings for more information. Client or Management token? - See Token types documentation for more information. + See Token types documentation for more information.

Your Nomad cluster has Access Control enabled, which you can use to control access to data and APIs. Here, you can manage the Tokens, Policies, and Roles for your system.

- - + +
diff --git a/ui/app/templates/administration/roles/role.hbs b/ui/app/templates/administration/roles/role.hbs index 27ecf976a..2f4b8ebf2 100644 --- a/ui/app/templates/administration/roles/role.hbs +++ b/ui/app/templates/administration/roles/role.hbs @@ -59,7 +59,7 @@

Create Tokens from the Nomad CLI

-

When you're ready to create more tokens, you can do so via the Nomad CLI with the following: +

When you're ready to create more tokens, you can do so via the Nomad CLI with the following: 

                 {{this.newTokenString}}
                 
     Sentinel Policies
     
-      Nomad integrates with HashiCorp Sentinel to allow operators to express policies as code and have those policies automatically enforced. This allows operators to define a "sandbox" and restrict actions to only those compliant with that policy.
+      Nomad integrates with HashiCorp Sentinel to allow operators to express policies as code and have those policies automatically enforced. This allows operators to define a "sandbox" and restrict actions to only those compliant with that policy.
     
     
       {{#if (can "write sentinel-policy")}}
diff --git a/ui/app/templates/administration/sentinel-policies/new.hbs b/ui/app/templates/administration/sentinel-policies/new.hbs
index 5a5d93522..f32cc0782 100644
--- a/ui/app/templates/administration/sentinel-policies/new.hbs
+++ b/ui/app/templates/administration/sentinel-policies/new.hbs
@@ -9,7 +9,7 @@
 	
 		Create Sentinel Policy
     
-      Nomad integrates with HashiCorp Sentinel to allow operators to express policies as code and have those policies automatically enforced. This allows operators to define a "sandbox" and restrict actions to only those compliant with that policy.
+      Nomad integrates with HashiCorp Sentinel to allow operators to express policies as code and have those policies automatically enforced. This allows operators to define a "sandbox" and restrict actions to only those compliant with that policy.
     
 		
       No Cluster Leader
         

           The cluster has no leader.
-          
+          
             Read about Outage Recovery.
         

       {{else if this.isOTTExchange}}
diff --git a/ui/app/templates/jobs/index.hbs b/ui/app/templates/jobs/index.hbs
index 3478b7b12..be1ac8ba8 100644
--- a/ui/app/templates/jobs/index.hbs
+++ b/ui/app/templates/jobs/index.hbs
@@ -13,7 +13,7 @@
         
       {{/if}}
       
-      
+      
     
   {{/if}}
 
diff --git a/ui/app/templates/jobs/job/variables.hbs b/ui/app/templates/jobs/job/variables.hbs
index ff9f21ec0..d12a24fe5 100644
--- a/ui/app/templates/jobs/job/variables.hbs
+++ b/ui/app/templates/jobs/job/variables.hbs
@@ -14,7 +14,7 @@
     
       
Tasks in this job can have automatic access to Nomad Variables.

       
    
-        
  • Use 
+        
  • Use
           
             
           
@@ -55,7 +55,7 @@
         
    • 
       

     
-    
+    
   
 
 
diff --git a/ui/app/templates/storage/index.hbs b/ui/app/templates/storage/index.hbs
index ac5141ddb..6c59f6ef9 100644
--- a/ui/app/templates/storage/index.hbs
+++ b/ui/app/templates/storage/index.hbs
@@ -231,7 +231,7 @@
           
             Defined in the Nomad agent's config file, best for infrequently changing storage
           
-           
+           
         
         
           
@@ -240,7 +240,7 @@
           
             Best-effort persistence, ideal for rebuildable data. Stored in the /alloc/data directory in a given allocation.
           
-           
+