Merge pull request #1805 from barnardb/documentation-edits

Documentation edits

client/alloc_runner_test.go

@@ -68,7 +68,7 @@ func TestAllocRunner_SimpleRun(t *testing.T) {
 }
 
 // TestAllocRuner_RetryArtifact ensures that if one task in a task group is
-// retrying fetching an artifact, other tasks in the the group should be able
+// retrying fetching an artifact, other tasks in the group should be able
 // to proceed.
 func TestAllocRunner_RetryArtifact(t *testing.T) {
 	ctestutil.ExecCompatible(t)

client/allocdir/alloc_dir.go

@@ -47,7 +47,7 @@ var (
 	// regardless of driver.
 	TaskLocal = "local"
 
-	// TaskSecrets is the the name of the secret directory inside each task
+	// TaskSecrets is the name of the secret directory inside each task
 	// directory
 	TaskSecrets = "secrets"
 

client/task_runner.go

@@ -28,7 +28,7 @@ const (
 	// killing a task.
 	killBackoffBaseline = 5 * time.Second
 
-	// killBackoffLimit is the the limit of the exponential backoff for killing
+	// killBackoffLimit is the limit of the exponential backoff for killing
 	// the task.
 	killBackoffLimit = 2 * time.Minute
 

command/plan.go

@@ -18,7 +18,7 @@ const (
 nomad run -check-index %d %s
 
 When running the job with the check-index flag, the job will only be run if the
-server side version matches the the job modify index returned. If the index has
+server side version matches the job modify index returned. If the index has
 changed, another user has modified the job and the plan's results are
 potentially invalid.`
 )
@@ -51,7 +51,7 @@ Usage: nomad plan [options] <file>
   give insight into what the scheduler will attempt to do and why.
 
   If the job has specified the region, the -region flag and NOMAD_REGION
-  environment variable are overridden and the the job's region is used.
+  environment variable are overridden and the job's region is used.
 
   Plan will return one of the following exit codes:
     * 0: No allocations created or destroyed.
@@ -226,7 +226,7 @@ func formatDryRun(resp *api.JobPlanResponse, job *structs.Job) string {
 	return out
 }
 
-// formatJobDiff produces an annoted diff of the the job. If verbose mode is
+// formatJobDiff produces an annoted diff of the job. If verbose mode is
 // set, added or deleted task groups and tasks are expanded.
 func formatJobDiff(job *api.JobDiff, verbose bool) string {
 	marker, _ := getDiffString(job.Type)

command/run.go

@@ -50,7 +50,7 @@ Usage: nomad run [options] <path>
   issues or internal errors, are indicated by exit code 1.
 
   If the job has specified the region, the -region flag and NOMAD_REGION
-  environment variable are overridden and the the job's region is used.
+  environment variable are overridden and the job's region is used.
 
   The run command will set the vault_token of the job based on the following
   precedence, going from highest to lowest: the -vault-token flag, the
@@ -63,7 +63,7 @@ General Options:
 Run Options:
 
   -check-index
-    If set, the job is only registered or updated if the the passed
+    If set, the job is only registered or updated if the passed
     job modify index matches the server side version. If a check-index value of
     zero is passed, the job is only registered if it does not yet exist. If a
     non-zero value is passed, it ensures that the job is being updated from a

nomad/pool.go

@@ -179,7 +179,7 @@ func (p *ConnPool) Shutdown() error {
 // pooled or to return a new connection
 func (p *ConnPool) acquire(region string, addr net.Addr, version int) (*Conn, error) {
 	// Check to see if there's a pooled connection available. This is up
-	// here since it should the the vastly more common case than the rest
+	// here since it should the vastly more common case than the rest
 	// of the code here.
 	p.Lock()
 	c := p.pool[addr.String()]

nomad/structs/structs.go

@@ -2225,7 +2225,7 @@ var (
 
 // Template represents a template configuration to be rendered for a given task
 type Template struct {
-	// SourcePath is the the path to the template to be rendered
+	// SourcePath is the path to the template to be rendered
 	SourcePath string `mapstructure:"source"`
 
 	// DestPath is the path to where the template should be rendered

nomad/worker.go

@@ -112,7 +112,7 @@ func (w *Worker) run() {
 			return
 		}
 
-		// Wait for the the raft log to catchup to the evaluation
+		// Wait for the raft log to catchup to the evaluation
 		if err := w.waitForIndex(eval.ModifyIndex, raftSyncLimit); err != nil {
 			w.sendAck(eval.ID, token, false)
 			continue
@@ -327,7 +327,7 @@ SUBMIT:
 	// allocations.
 	var state scheduler.State
 	if result.RefreshIndex != 0 {
-		// Wait for the the raft log to catchup to the evaluation
+		// Wait for the raft log to catchup to the evaluation
 		w.logger.Printf("[DEBUG] worker: refreshing state to index %d for %q", result.RefreshIndex, plan.EvalID)
 		if err := w.waitForIndex(result.RefreshIndex, raftSyncLimit); err != nil {
 			return nil, nil, err

scheduler/util.go

@@ -520,7 +520,7 @@ func inplaceUpdate(ctx Context, eval *structs.Evaluation, job *structs.Job,
 }
 
 // evictAndPlace is used to mark allocations for evicts and add them to the
-// placement queue. evictAndPlace modifies both the the diffResult and the
+// placement queue. evictAndPlace modifies both the diffResult and the
 // limit. It returns true if the limit has been reached.
 func evictAndPlace(ctx Context, diff *diffResult, allocs []allocTuple, desc string, limit *int) bool {
 	n := len(allocs)
@@ -538,7 +538,7 @@ func evictAndPlace(ctx Context, diff *diffResult, allocs []allocTuple, desc stri
 }
 
 // markLostAndPlace is used to mark allocations as lost and add them to the
-// placement queue. evictAndPlace modifies both the the diffResult and the
+// placement queue. evictAndPlace modifies both the diffResult and the
 // limit. It returns true if the limit has been reached.
 func markLostAndPlace(ctx Context, diff *diffResult, allocs []allocTuple, desc string, limit *int) bool {
 	n := len(allocs)

website/source/docs/agent/config.html.md

@@ -263,10 +263,10 @@ integration and are entirely optional.
     `host:port`. Defaults to `127.0.0.1:8500`, which is the same as the Consul
     default HTTP address.
 
-  * `token`: Token is used to provide a per-request ACL token. This options
+  * `token`: Token is used to provide a per-request ACL token. This option
     overrides the Consul Agent's default token.
 
-  * `auth`: The auth information to use for http access to the Consul Agent
+  * `auth`: The auth information to use for HTTP access to the Consul Agent
     given as `username:password`.
 
   * `ssl`: This boolean option sets the transport scheme to talk to the Consul
@@ -440,9 +440,9 @@ configured on server nodes.
     `max_kill_timeout` is used. This is to prevent a user being able to set an
     unreasonable timeout. If unset, a default is used.
 <a id="reserved"></a>
-  * `reserved`: `reserved` is used to reserve a portion of the nodes resources
+  * `reserved`: `reserved` is used to reserve a portion of the node's resources
     from being used by Nomad when placing tasks.  It can be used to target
-    a certain capacity usage for the node. For example, 20% of the nodes CPU
+    a certain capacity usage for the node. For example, 20% of the node's CPU
     could be reserved to target a CPU utilization of 80%. The block has the
     following format:
 
@@ -458,7 +458,7 @@ configured on server nodes.
     * `cpu`: `cpu` is given as MHz to reserve.
     * `memory`: `memory` is given as MB to reserve.
     * `disk`: `disk` is given as MB to reserve.
-    * `reserved_ports`: `reserved_ports` is a comma separated list of ports
+    * `reserved_ports`: `reserved_ports` is a comma-separated list of ports
       to reserve on all fingerprinted network devices. Ranges can be
       specified by using a hyphen separated the two inclusive ends.
 
@@ -469,13 +469,13 @@ Client, but rather the set of options that configure the Client and not the
 drivers. To find the options supported by an individual driver, see the drivers
 documentation [here](/docs/drivers/index.html)
 
-* `driver.whitelist`: A comma separated list of whitelisted drivers (e.g.
+* `driver.whitelist`: A comma-separated list of whitelisted drivers (e.g.
   "docker,qemu"). If specified, drivers not in the whitelist will be disabled.
   If the whitelist is empty, all drivers are fingerprinted and enabled where
   applicable.
 
 *   `env.blacklist`: Nomad passes the host environment variables to `exec`,
-    `raw_exec` and `java` tasks. `env.blacklist` is a comma separated list of
+    `raw_exec` and `java` tasks. `env.blacklist` is a comma-separated list of
     environment variable keys not to pass to these tasks. If specified, the
     defaults are overridden. The following are the default:
 
@@ -493,21 +493,21 @@ documentation [here](/docs/drivers/index.html)
     * `Administrator`
 
 *   `user.checked_drivers`: An operator specifiable list of drivers to enforce
-    the the `user.blacklist`. For drivers using containers, this enforcement often
+    the `user.blacklist`. For drivers using containers, this enforcement often
     doesn't make sense and as such the default is set to:
 
     * `exec`
     * `qemu`
     * `java`
 
-* `fingerprint.whitelist`: A comma separated list of whitelisted fingerprinters.
+* `fingerprint.whitelist`: A comma-separated list of whitelisted fingerprinters.
   If specified, fingerprinters not in the whitelist will be disabled. If the
   whitelist is empty, all fingerprinters are used.
 
 ### <a id="chroot_env_map"></a>Client ChrootEnv Map
 
 Drivers based on [Isolated Fork/Exec](/docs/drivers/exec.html) implement file
-system isolation using chroot on Linux.  The `chroot_env` map allows the chroot
+system isolation using chroot on Linux. The `chroot_env` map allows the chroot
 environment to be configured using source paths on the host operating system.
 The mapping format is: `source_path -> dest_path`.
 
@@ -534,7 +534,7 @@ environment with the most commonly used parts of the operating system. See
 A subset of the available Nomad agent configuration can optionally be passed in
 via CLI arguments. The `agent` command accepts the following arguments:
 
-* `alloc-dir=<path>`: Equivalent to the Client [alloc_dir](#alloc_dir) config
+* `-alloc-dir=<path>`: Equivalent to the Client [alloc_dir](#alloc_dir) config
    option.
 * `-atlas=<infrastructure>`: Equivalent to the Atlas
   [infrastructure](#infrastructure) config option.
@@ -555,9 +555,9 @@ via CLI arguments. The `agent` command accepts the following arguments:
   be specified multiple times to specify multiple agents to join.
 * `-log-level=<level>`: Equivalent to the [log_level](#log_level) config option.
 * `-meta=<key=value>`: Equivalent to the Client [meta](#meta) config option.
-* `-network-interface<interface>`: Equivalent to the Client
+* `-network-interface=<interface>`: Equivalent to the Client
    [network_interface](#network_interface) config option.
-* `-network-speed<MBits>`: Equivalent to the Client
+* `-network-speed=<MBits>`: Equivalent to the Client
   [network_speed](#network_speed) config option.
 * `-node=<name>`: Equivalent to the [name](#name) config option.
 * `-node-class=<class>`: Equivalent to the Client [node_class](#node_class)

website/source/docs/agent/index.html.md

@@ -92,13 +92,13 @@ respective signals.
 When gracefully exiting, clients will update their status to terminal on
 the servers so that tasks can be migrated to healthy agents. Servers
 will notify their intention to leave the cluster which allows them to
-leave the [consensus quorum](/docs/internals/consensus.html).
+leave the [consensus](/docs/internals/consensus.html) peer set.
 
 It is especially important that a server node be allowed to leave gracefully
 so that there will be a minimal impact on availability as the server leaves
-the consensus quorum. If a server does not gracefully leave, and will not
+the consensus peer set. If a server does not gracefully leave, and will not
 return into service, the [`server-force-leave` command](/docs/commands/server-force-leave.html)
-should be used to eject it from the consensus quorum.
+should be used to eject it from the consensus peer set.
 
 ## Lifecycle
 
@@ -135,5 +135,5 @@ to the entire cluster, meaning all nodes will eventually be aware of each other.
 
 When a server _leaves_, it specifies its intent to do so, and the cluster marks that
 node as having _left_. If the server has _left_, replication to it will stop and it
-is removed as a member of the consensus quorum. If the server has _failed_, replication
+is removed from the consensus peer set. If the server has _failed_, replication
 will attempt to make progress to recover from a software or network failure.

website/source/docs/commands/eval-status.html.md.erb

@@ -14,7 +14,7 @@ evaluation. In the case an evaluation could not place all the requested
 allocations, this command can be used to determine the failure reasons.
 
 Optionally, it can also be invoked in a monitor mode to track an outstanding
-evaluation. In this mode, ogs will be output describing state changes to the
+evaluation. In this mode, logs will be output describing state changes to the
 evaluation or its associated allocations. The monitor will exit when the
 evaluation reaches a terminal state.