From 6d2e380e2754922244ce1e470ae0579b24ec75e5 Mon Sep 17 00:00:00 2001 From: Alex Dadgar Date: Tue, 28 Mar 2017 09:47:57 -0700 Subject: [PATCH] remote cli --- website/source/docs/commands/index.html.md.erb | 16 +++++++++++++--- 1 file changed, 13 insertions(+), 3 deletions(-) diff --git a/website/source/docs/commands/index.html.md.erb b/website/source/docs/commands/index.html.md.erb index ed835e6b7c6..82b2e2c43bc 100644 --- a/website/source/docs/commands/index.html.md.erb +++ b/website/source/docs/commands/index.html.md.erb @@ -40,6 +40,16 @@ which operate in the agent or node contexts respectively. ### Remote Usage -You can use Nomad CLI from a different machine event without Nomad agent running on it. - -Make sure your remote agent exposes HTTP endoint (make sure you are in the trusted network, or set up TLS) and `NOMAD_ADDR` environment variable is set on your "external" machine, with the address of the remote agent. +The Nomad CLI may be used to interact with a remote Nomad cluster, even when the +local machine does not have a running Nomad agent. To do so, set the +`NOMAD_ADDR` environment variable or use the `-address=` flag when running +commands. + +``` +$ NOMAD_ADDR=https://remote-address:4646 nomad status +$ nomad status -address=https://remote-address:4646 +``` + +The provided address must be reachable from your local machine. There are a +variety of ways to accomplish this (VPN, SSH Tunnel, etc). If the port is +exposed to the public internet it is highly recommended to configure TLS.