README.md

   1 These lessons give step by step instructions for using Visual Studio
   2 Code (abbreviated "vscode") to develop CWL workflows on Arvados.
   3
   4 1. Set up SSH
   5 1. Install vscode and necessary extensions, then use vscode to connect to an Arvados shell node for development
   6 1. Register a workflow, run it on workbench, and view the log
   7 1. Upload input, run a workflow on it, and view the output
   8 1. Register a workflow with default inputs
   9 1. Run a workflow without registering it
  10
  11 ## 1. SSH Setup
  12
  13 1. (Windows only) Install Git for Windows [https://git-scm.com/download/win](https://git-scm.com/download/win)
  14    1. Choose "64-bit Git for Windows Setup".  It does not require admin privileges to install.
  15    1. Hit "Next" a bunch of times to accept the defaults
  16    1. The most important things is that "install git bash" and "install OpenSSH" are enabled (this is the default).
  17    1. At the end of the installation, you can launch tick a box to git bash directly.
  18    1. Open "Git Bash" (installed in the "Git" folder of the start menu)
  19 1. (All operating systems) Starting from bash shell (on MacOS or Linux you will open "Terminal")
  20    1. Shell: Run `ssh-keygen`
  21       1. Hit enter to save to a default location
  22       1. You can choose to protect the key with a password, or just hit enter for no password.
  23    1. Shell: Look for a message like `Your public key has been saved
  24       in /c/Users/MyUsername/.ssh/id_rsa.pub` (Windows git bash
  25       example, on MacOS or Linux this will probably start with `/Users` or `/home`)
  26       1. Shell: Run `cat /c/Users/MyUsername/.ssh/id_rsa.pub`
  27    1. Shell: Use the pointer to highlight and copy the lines starting
  28       with `ssh-rsa …` up to the next blank line.  Right click and
  29       select "Copy"
  30 1. Open Arvados workbench 2.  If necessary, go to the user menu and
  31    select "Go to Workbench 2"
  32    1. Workbench: Go to `SSH keys` in the user menu
  33    1. Workbench:Click `+Add new ssh key`
  34    1. Workbench: Paste the key into `Public key` and enter something for `name`
  35    1. Workbench: Go to `Virtual Machines` in the user menu
  36    1. Workbench: Highlight and copy the value in in the `Command line` column.
  37 1. At the git bash command line
  38    1. Shell: paste the `ssh shell…` command line you got from workbench.
  39    1. Shell: type "yes" if it asks `Are you sure you want to continue connecting`.
  40    1. Note: it can take up to two minutes for the SSH key to be copied to
  41       the shell node.  If you get "Permission denied" the first time, wait 60
  42       seconds and try again.
  43    1. Shell: You should now be logged into the Arvados shell node.
  44    1. Shell: Log out by typing `exit`
  45
  46 ## 2. VSCode setup
  47
  48 1. Install [Visual Studio Code](https://code.visualstudio.com/) and start it up
  49 1. Vscode: On the left sidebar, select `Extensions` ![](images/Extensions.png)
  50    1. In `Search Extensions in Marketplace` enter "remote development".
  51    1. Choose and install the "Remote Development" extension pack from Microsoft
  52 1. Vscode: On the left sidebar, choose `Remote Explorer` ![](images/RemoteExplorer.png)
  53    1. At the top of the Remote Explorer panel choose `SSH targets` ![](images/SSHTargets.png)
  54    1. Click `Add New` ![](images/AddNew.png)
  55    1. Enter the `ssh shell…` command line you used in the previous section, step 1.4.1
  56       1. If it asks you `Select SSH configuration file to update` choose the first one in the list.
  57    1. Right click the newly added ssh target in the list and select “connect to host in current window`
  58    1. If it asks `Select platform of the remote host` select `Linux`.
  59 1. Vscode: On the left sidebar, go back to `Extensions` ![](images/Extensions.png)
  60    1. Search for "benten" and install `CWL (Rabix/Benten)`
  61    1. You should see a message `Extension is enabled on 'SSH: ...' and disabled locally.`
  62 1. Vscode: On the left sidebar, choose `Explorer` ![](images/Explorer.png)
  63    1. Select `Clone Repository` and enter [https://github.com/arvados/arvados-vscode-cwl-training](https://github.com/arvados/arvados-vscode-cwl-training), then click `Open`
  64    1. If asked `Would you like to open the cloned repository?` choose `Open`
  65 1. Go to Arvados Workbench
  66    1. Workbench: In the user menu, select `Current token`
  67    1. Vscode: Click on the `Terminal` menu
  68    1. Vscode: Click `Run Task…`
  69    1. Vscode: Select `Configure Arvados`
  70    1. Workbench: Copy the string following `ARVADOS_API_HOST=`
  71    1. Vscode: Paste the string at the `Value for ARVADOS_API_HOST` prompt
  72    1. Workbench: Copy the string following `ARVADOS_API_TOKEN=`
  73    1. Vscode: Paste the string at the `Value for ARVADOS_API_TOKEN` prompt
  74
  75 ## 3. Register & run a workflow
  76
  77 1. Vscode: Click on the `lesson1/main.cwl` file
  78    1. Click on the `Terminal` menu
  79    1. Click `Run Task…`
  80    1. Select `Register or update CWL workflow on Arvados Workbench`
  81 1. Workbench: Go to `+NEW` and select `New project`
  82    1. Enter a name for the project like "Lesson 1"
  83    1. You should arrive at the panel for the new project
  84 1. Workbench: With `Lesson 1` selected
  85    1. Click on `+NEW` and select `Run a process`
  86    1. Select `CWL training lesson 1` from the list and click `Next`
  87    1. Enter a name for this run like `First training run`
  88    1. Enter a message (under `#main/message`) like "Hello world"
  89    1. Click `Run process`
  90    1. This should take you to a panel showing the workflow run status
  91 1. Workbench: workflow run status panel
  92    1. Wait for the badge in the upper right to say `Completed`
  93    1. In the lower panel, double click on the `echo` workflow step
  94    1. This will take you to the status panel for the `echo` step
  95    1. Click on the three vertical dots in the top-right corner next to `Completed`
  96    1. Choose `Log`
  97    1. This will take you to the log viewer panel
  98    1. Under `Event Type` choose `stdout`
  99    1. You should see your message
 100
 101 ## 4. Working with input and output files
 102
 103 1. Vscode: Click on the `lesson2/main.cwl` file
 104    1. Click on the `Terminal` menu
 105    1. Click `Run Task…`
 106    1. Select `Register or update CWL workflow on Arvados Workbench`
 107 1. Go to your desktop
 108    1. Right click on the desktop, select `New > Text Document`
 109    1. Name the file `message`
 110    1. Enter a message like "Hello earth" and save
 111 1. Workbench: Go to `+NEW` and select `New project`
 112    1. Enter a name for the project like "Lesson 2"
 113    1. You should arrive at the panel for the new project
 114 1. Arvados workbench: With `Lesson 2` project selected
 115    1. Click on +NEW and select `New collection`
 116    1. For Collection Name enter "my message"
 117    1. Drag and drop `message.txt` into the browser
 118    1. Click `Create a collection`
 119    1. The file should be uploaded and then you will be on the collection page
 120 1. Workbench: Select the `Lesson 2` project
 121    1. Click on `+NEW` and select `Run a process`
 122    1. Select `CWL training lesson 2` from the list and click `Next`
 123    1. Enter a name for this run like "Second training run"
 124    1. Click on `#main/message`
 125    1. A selection dialog box will appear
 126    1. Navigate to the collection you created in step (4.4.4) and choose `message.txt`
 127    1. Click `Run process`
 128    1. This should take you to a panel showing the workflow run status
 129 1. Workbench: workflow run status panel
 130    1. Wait for the process to complete
 131    1. Click on the dot menu
 132    1. Choose `Outputs`
 133    1. Right click on `reverse.txt`
 134    1. Click on `Open in new tab`
 135    1. The results should be visible in a new browser tab.
 136
 137 ## 5. Register a workflow with default inputs
 138
 139 The default value for the `message` parameter will taken from the `lesson3/defaults.yaml` file
 140
 141 1. Vscode: Click on the `lesson3/main.cwl` file
 142    1. Click on the `Terminal` menu
 143    1. Click `Run Task…`
 144    1. Select `Register or update CWL workflow on Arvados Workbench`
 145 1. Workbench: Go to `+NEW` and select `New project`
 146    1. Enter a name for the project like "Lesson 3"
 147    1. You should arrive at the panel for the new project
 148 1. Workbench: With `Lesson 3` selected
 149    1. Click on `+NEW` and select `Run a process`
 150    1. Select `CWL training lesson 3` from the list and click `Next`
 151    1. Enter a name for this run like "Third training run"
 152    1. The `#main/message` parameter will be pre-filled with your default value.  You can choose to change it or use the default.
 153    1. Click `Run process`
 154    1. This should take you to the status page for this workflow
 155    1. The greeting will appear in the `Log` of the `echo` task, which
 156       can be found the same way as described earlier in section 3.
 157
 158 ## 6. Run a workflow without registering it
 159
 160 The `message` parameter will be taken from the file `lesson4/main-input.yaml`.  This is useful during development.
 161
 162 1. Workbench: Go to `+NEW` and select `New project`
 163    1. Enter a name for the project like "Lesson 4"
 164    1. You should arrive at the panel for the new project
 165    1. Click on `Additional info` in the upper right to expand the `info` panel
 166    1. Under `Project UUID` click the `Copy to clipboard` button
 167 1. Vscode: Select the file `lesson4/main.cwl`
 168    1. Click on the `Terminal` menu
 169    1. Click `Run Task…`
 170    1. Select `Set Arvados project UUID`
 171    1. Paste the project UUID from workbench at the prompt
 172 1. Vscode: Select the file `lesson4/main.cwl`
 173    1. Click on the `Terminal` menu
 174    1. Click `Run Task…`
 175    1. Select `Run CWL workflow on Arvados`
 176 1. Vscode: In the bottom panel select the `Terminal` tab
 177    1. In the upper right corner of the Terminal tab select `Task - Run CWL Workflow` from the drop-down
 178    1. Look for logging text like `submitted container_request zzzzz-xvhdp-0123456789abcde`
 179    1. Highlight and copy the workflow identifier (this the string containing `-xvhdp-` in the middle)
 180    1. The results of this run will appear in the terminal when the run completes.
 181 1. Workbench: Paste the workflow identifier into the search box
 182    1. This will take you to the status page for this workflow
 183
 184
 185 ## Notes
 186
 187 If you need to change something about the environment of the user on
 188 the remote host (for example, the user has been added to a new unix
 189 group) you need to restart the vscode server that runs on the remote
 190 host.  Do this in vscode:
 191
 192 ctrl+shift+p: `Remote-SSH: Kill VS Code Server on Host`
 193
 194 This is because the vscode server remains running on the remote host
 195 even after you disconnect, so exiting/restarting vscode on the desktop
 196 has no effect.