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