4 title: Debugging workflows - shell access
7 Copyright (C) The Arvados Authors. All rights reserved.
9 SPDX-License-Identifier: CC-BY-SA-3.0
12 {% include 'notebox_begin' %}
14 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.
16 {% include 'notebox_end' %}
18 The @arvados-client@ program can be used to connect to a container in a running workflow. It can be installed from packages (@apt install arvados-client@ or @yum install arvados-client@). The @arvados-client shell@ command provides an ssh connection into a running container.
22 The @arvados-client shell@ tool has a number of command line arguments:
25 <pre><code>~$ <span class="userinput">arvados-client shell -h</span>
26 arvados-client shell: open an interactive shell on a running container.
28 Usage: arvados-client shell [options] [username@]container-uuid [ssh-options] [remote-command [args...]]
32 set detach key sequence, as in docker-attach(1) (default "ctrl-],ctrl-]")
37 h2(#Examples). Examples
39 Connect to a running container, using the container request UUID:
42 <pre><code>~$ <span class="userinput">./arvados-client shell ce8i5-xvhdp-e6wnujfslyyqn4b</span>
47 The container UUID also works:
50 <pre><code>~$ <span class="userinput">./arvados-client shell ce8i5-dz642-h1cl0sa62d4i430</span>
55 SSH port forwarding is supported:
58 <pre><code>~$ <span class="userinput">./arvados-client shell ce8i5-dz642-h1cl0sa62d4i430 -L8888:localhost:80</span>
59 root@0f13dcd755fa:~# nc -l -p 80
63 And then, connecting to port 8888 locally:
66 <pre><code>~$ <span class="userinput">nc localhost 8888</span>
71 Which appears on the other end:
74 <pre><code>~$ <span class="userinput">./arvados-client shell ce8i5-dz642-h1cl0sa62d4i430 -L8888:localhost:80</span>
75 root@0f13dcd755fa:~# nc -l -p 80