18874: Add 'services/workbench2/' from commit 'f6f88d9ca9cdeeeebfadcfe999789bfb9f69e5c6'

[arvados.git] / doc / user / debugging / container-shell-access.html.textile.liquid

diff --git a/doc/user/debugging/container-shell-access.html.textile.liquid b/doc/user/debugging/container-shell-access.html.textile.liquid
index a352b33b52f03b89d845c99d7ab70630ae88fe31..9c249800492109cdab9fba962547fd6171d1d917 100644 (file)
--- a/doc/user/debugging/container-shell-access.html.textile.liquid
+++ b/doc/user/debugging/container-shell-access.html.textile.liquid
@@ -9,6 +9,8 @@ Copyright (C) The Arvados Authors. All rights reserved.
 SPDX-License-Identifier: CC-BY-SA-3.0
 {% endcomment %}
 
+{% include 'tutorial_expectations' %}
+
 {% include 'notebox_begin' %}
 
 To use this feature, your Arvados installation must be configured to allow container shell access. See "the install guide":{{site.baseurl}}/install/container-shell-access.html for more information.
@@ -19,7 +21,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,12 +36,14 @@ 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.
+
 h2(#Examples). Examples
 
 Connect to a running container, using the container request UUID:
 
 <notextile>
-<pre><code>~$ <span class="userinput">./arvados-client shell ce8i5-xvhdp-e6wnujfslyyqn4b</span>
+<pre><code>~$ <span class="userinput">arvados-client shell ce8i5-xvhdp-e6wnujfslyyqn4b</span>
 root@0f13dcd755fa:~#
 </code></pre>
 </notextile>
@@ -47,7 +51,7 @@ root@0f13dcd755fa:~#
 The container UUID also works:
 
 <notextile>
-<pre><code>~$ <span class="userinput">./arvados-client shell ce8i5-dz642-h1cl0sa62d4i430</span>
+<pre><code>~$ <span class="userinput">arvados-client shell ce8i5-dz642-h1cl0sa62d4i430</span>
 root@0f13dcd755fa:~#
 </code></pre>
 </notextile>
@@ -55,7 +59,7 @@ root@0f13dcd755fa:~#
 SSH port forwarding is supported:
 
 <notextile>
-<pre><code>~$ <span class="userinput">./arvados-client shell ce8i5-dz642-h1cl0sa62d4i430 -L8888:localhost:80</span>
+<pre><code>~$ <span class="userinput">arvados-client shell ce8i5-dz642-h1cl0sa62d4i430 -L8888:localhost:80</span>
 root@0f13dcd755fa:~# nc -l -p 80
 </code></pre>
 </notextile>
@@ -63,15 +67,14 @@ 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>
 
 Which appears on the other end:
 
 <notextile>
-<pre><code>~$ <span class="userinput">./arvados-client shell ce8i5-dz642-h1cl0sa62d4i430 -L8888:localhost:80</span>
+<pre><code>~$ <span class="userinput">arvados-client shell ce8i5-dz642-h1cl0sa62d4i430 -L8888:localhost:80</span>
 root@0f13dcd755fa:~# nc -l -p 80
 hello
 </code></pre>