17668: A few more tweaks after review feedback.

Arvados-DCO-1.1-Signed-off-by: Ward Vandewege <ward@curii.com>

diff --git a/doc/install/container-shell-access.html.textile.liquid b/doc/install/container-shell-access.html.textile.liquid
index 46aa4e3829a44018df8152f2280c29427e178b4f..e011a1c4d746e567d4711dcd1d6c2f4c2f008d10 100644 (file)
--- a/doc/install/container-shell-access.html.textile.liquid
+++ b/doc/install/container-shell-access.html.textile.liquid
@@ -39,6 +39,6 @@ The relevant configuration section is
 
 To enable the feature a firewall change may also be required. Traffic from the machine that runs @arvados-controller@ to the compute nodes in the port range above 1024 must be allowed.
 
-After changing the configuration, @arvados-controller@ must be restarted for the change to take effect. When enabling, the change will only affect containers started from that point on. When disabling, access is removed immediately for any running containers, as well as any containers started subsequently.
+After changing the configuration, @arvados-controller@ must be restarted for the change to take effect. When enabling, shell access will be enabled for any running containers. When disabling, access is removed immediately for any running containers, as well as any containers started subsequently. Restarting @arvados-controller@ will kill any active connections.
 
 Usage instructions for this feature are available in the "User guide":{{site.baseurl}}/user/debugging/container-shell-access.html.

diff --git a/doc/user/debugging/container-shell-access.html.textile.liquid b/doc/user/debugging/container-shell-access.html.textile.liquid
index a352b33b52f03b89d845c99d7ab70630ae88fe31..c17c2a89ade8030ab2a928eb1f23b1db1aacb754 100644 (file)
--- a/doc/user/debugging/container-shell-access.html.textile.liquid
+++ b/doc/user/debugging/container-shell-access.html.textile.liquid
@@ -19,7 +19,7 @@ The @arvados-client@ program can be used to connect to a container in a running
 
 h2(#syntax). Syntax
 
-The @arvados-client shell@ tool has a number of command line arguments:
+The @arvados-client shell@ tool has the following syntax:
 
 <notextile>
 <pre><code>~$ <span class="userinput">arvados-client shell -h</span>
@@ -34,6 +34,8 @@ Options:
 </code></pre>
 </notextile>
 
+The @arvados-client shell@ command calls the ssh binary on your system to make the connection. Everything after _[username@]container-uuid_ is passed through to your OpenSSH client. This means many other SSH features can be used, e.g. -g, -f -N, -n, ...
+
 h2(#Examples). Examples
 
 Connect to a running container, using the container request UUID:
@@ -63,8 +65,7 @@ root@0f13dcd755fa:~# nc -l -p 80
 And then, connecting to port 8888 locally:
 
 <notextile>
-<pre><code>~$ <span class="userinput">nc localhost 8888</span>
-hello
+<pre><code>~$ <span class="userinput">echo hello | nc localhost 8888</span>
 </code></pre>
 </notextile>