From baff94f3ba4ec0fc03c23c325ce1295952d7ee21 Mon Sep 17 00:00:00 2001 From: Alex Dadgar Date: Tue, 7 Jun 2016 11:33:55 -0700 Subject: [PATCH] docs --- command/meta.go | 2 +- command/plan.go | 2 +- command/run.go | 2 +- website/helpers/command_helpers.rb | 4 ++++ website/source/docs/commands/run.html.md.erb | 3 +++ 5 files changed, 10 insertions(+), 3 deletions(-) diff --git a/command/meta.go b/command/meta.go index d4095a6bb..354346d83 100644 --- a/command/meta.go +++ b/command/meta.go @@ -115,7 +115,7 @@ func generalOptionsUsage() string { Default = http://127.0.0.1:4646 -region= - The region of the Nomad servers to forward commands too. + The region of the Nomad servers to forward commands to. Overrides the NOMAD_REGION environment variable if set. Defaults to the Agent's local region. ` diff --git a/command/plan.go b/command/plan.go index b153d1b4b..e17bd4622 100644 --- a/command/plan.go +++ b/command/plan.go @@ -45,7 +45,7 @@ Usage: nomad plan [options] 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 to the job's region. + environment variable are overridden and the the job's region is used. General Options: diff --git a/command/run.go b/command/run.go index 032f54e68..30c9fc7d0 100644 --- a/command/run.go +++ b/command/run.go @@ -38,7 +38,7 @@ Usage: nomad run [options] 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 to the job's region. + environment variable are overridden and the the job's region is used. General Options: diff --git a/website/helpers/command_helpers.rb b/website/helpers/command_helpers.rb index 0718f2d48..73e52ee30 100644 --- a/website/helpers/command_helpers.rb +++ b/website/helpers/command_helpers.rb @@ -4,6 +4,10 @@ module CommandHelpers <`: The address of the Nomad server. Overrides the `NOMAD_ADDR` environment variable if set. Defaults to `http://127.0.0.1:4646`. + +* `-region=`: The region of the Nomad server to forward commands to. + Overrides the `NOMAD_REGION` environment variable if set. Defaults to the + Agent's local region. EOF end end diff --git a/website/source/docs/commands/run.html.md.erb b/website/source/docs/commands/run.html.md.erb index 0c3d7d5f6..3e83aa51f 100644 --- a/website/source/docs/commands/run.html.md.erb +++ b/website/source/docs/commands/run.html.md.erb @@ -32,6 +32,9 @@ there are job placement issues encountered (unsatisfiable constraints, resource exhaustion, etc), then the exit code will be 2. Any other errors, including client connection 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. + ## General Options <%= general_options_usage %>