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", then look for `CWL (Rabix/Benten)` and click `Install`
  61    1. On the information page for `CWL (Rabix/Benten)`
  62       1. If you see a warning `Install the extension on 'SSH: ...' to enable` then click the button `Install in SSH: ...`
  63    1. You should now see a message `Extension is enabled on 'SSH: ...' and disabled locally.`
  64 1. Vscode: On the left sidebar, choose `Explorer` ![](images/Explorer.png)
  65    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`
  66    1. If asked `Would you like to open the cloned repository?` choose `Open`
  67 1. Vscode: Click on the `Terminal` menu
  68    1. Vscode: Click `Run Task…`
  69    1. Vscode: Select `Configure Arvados`
  70    1. Go to Arvados Workbench
  71    1. Workbench: In the user menu, select `Current token`
  72    1. Workbench: Copy the text following `ARVADOS_API_HOST=` to the end of the line
  73    1. Vscode: Paste the string at the `Value for ARVADOS_API_HOST` prompt
  74    1. Workbench: Copy the text following `ARVADOS_API_TOKEN=` to the end of the line
  75    1. Vscode: Paste the string at the `Value for ARVADOS_API_TOKEN` prompt
  76    1. This will create files called `API_HOST` and `API_TOKEN`
  77
  78 ## 3. Register & run a workflow
  79
  80 1. Vscode: Click on the `lesson1/main.cwl` file
  81    1. Click on the `Terminal` menu
  82    1. Click `Run Task…`
  83    1. Select `Register or update CWL workflow on Arvados Workbench`
  84    1. This will create a file called `WORKFLOW_UUID`
  85 1. Workbench: Go to `+NEW` and select `New project`
  86    1. Enter a name for the project like "Lesson 1"
  87    1. You should arrive at the panel for the new project
  88 1. Workbench: With `Lesson 1` selected
  89    1. Click on `+NEW` and select `Run a process`
  90    1. Select `CWL training lesson 1` from the list and click `Next`
  91    1. Enter a name for this run like `First training run`
  92    1. Enter a message (under `#main/message`) like "Hello world"
  93    1. Click `Run process`
  94    1. This should take you to a panel showing the workflow run status
  95 1. Workbench: workflow run status panel
  96    1. Wait for the badge in the upper right to say `Completed`
  97    1. In the lower panel, double click on the `echo` workflow step
  98    1. This will take you to the status panel for the `echo` step
  99    1. Click on the three vertical dots in the top-right corner next to `Completed`
 100    1. Choose `Log`
 101    1. This will take you to the log viewer panel
 102    1. Under `Event Type` choose `stdout`
 103    1. You should see your message
 104
 105 ## 4. Working with input and output files
 106
 107 1. Vscode: Click on the `lesson2/main.cwl` file
 108    1. Click on the `Terminal` menu
 109    1. Click `Run Task…`
 110    1. Select `Register or update CWL workflow on Arvados Workbench`
 111 1. Go to your desktop
 112    1. Right click on the desktop, select `New > Text Document`
 113    1. Name the file `message`
 114    1. Enter a message like "Hello earth" and save
 115 1. Workbench: Go to `+NEW` and select `New project`
 116    1. Enter a name for the project like "Lesson 2"
 117    1. You should arrive at the panel for the new project
 118 1. Arvados workbench: With `Lesson 2` project selected
 119    1. Click on +NEW and select `New collection`
 120    1. For Collection Name enter "my message"
 121    1. Drag and drop `message.txt` into the browser
 122    1. Click `Create a collection`
 123    1. The file should be uploaded and then you will be on the collection page
 124 1. Workbench: Select the `Lesson 2` project
 125    1. Click on `+NEW` and select `Run a process`
 126    1. Select `CWL training lesson 2` from the list and click `Next`
 127    1. Enter a name for this run like "Second training run"
 128    1. Click on `#main/message`
 129    1. A selection dialog box will appear
 130    1. Navigate to the collection you created in step (4.4.4) and choose `message.txt`
 131    1. Click `Run process`
 132    1. This should take you to a panel showing the workflow run status
 133 1. Workbench: workflow run status panel
 134    1. Wait for the process to complete
 135    1. Click on the dot menu
 136    1. Choose `Outputs`
 137    1. Right click on `reverse.txt`
 138    1. Click on `Open in new tab`
 139    1. The results should be visible in a new browser tab.
 140
 141 ## 5. Register a workflow with default inputs
 142
 143 The default value for the `message` parameter will taken from the `lesson3/defaults.yaml` file
 144
 145 1. Vscode: Click on the `lesson3/main.cwl` file
 146    1. Click on the `Terminal` menu
 147    1. Click `Run Task…`
 148    1. Select `Register or update CWL workflow on Arvados Workbench`
 149 1. Workbench: Go to `+NEW` and select `New project`
 150    1. Enter a name for the project like "Lesson 3"
 151    1. You should arrive at the panel for the new project
 152 1. Workbench: With `Lesson 3` selected
 153    1. Click on `+NEW` and select `Run a process`
 154    1. Select `CWL training lesson 3` from the list and click `Next`
 155    1. Enter a name for this run like "Third training run"
 156    1. The `#main/message` parameter will be pre-filled with your default value.  You can choose to change it or use the default.
 157    1. Click `Run process`
 158    1. This should take you to the status page for this workflow
 159    1. The greeting will appear in the `Log` of the `echo` task, which
 160       can be found the same way as described earlier in section 3.
 161
 162 ## 6. Run a workflow without registering it
 163
 164 The `message` parameter will be taken from the file `lesson4/main-input.yaml`.  This is useful during development.
 165
 166 1. Workbench: Go to `+NEW` and select `New project`
 167    1. Enter a name for the project like "Lesson 4"
 168    1. You should arrive at the panel for the new project
 169    1. Click on `Additional info` in the upper right to expand the `info` panel
 170    1. Under `Project UUID` click the `Copy to clipboard` button
 171 1. Vscode: Select the file `lesson4/main.cwl`
 172    1. Click on the `Terminal` menu
 173    1. Click `Run Task…`
 174    1. Select `Set Arvados project UUID`
 175    1. Paste the project UUID from workbench at the prompt
 176 1. Vscode: Select the file `lesson4/main.cwl`
 177    1. Click on the `Terminal` menu
 178    1. Click `Run Task…`
 179    1. Select `Run CWL workflow on Arvados`
 180 1. Vscode: In the bottom panel select the `Terminal` tab
 181    1. In the upper right corner of the Terminal tab select `Task - Run CWL Workflow` from the drop-down
 182    1. Look for logging text like `submitted container_request zzzzz-xvhdp-0123456789abcde`
 183    1. Highlight and copy the workflow identifier (this the string containing `-xvhdp-` in the middle)
 184    1. The results of this run will appear in the terminal when the run completes.
 185 1. Workbench: Paste the workflow identifier into the search box
 186    1. This will take you to the status page for this workflow
 187
 188
 189 ## Notes
 190
 191 If you need to change something about the environment of the user on
 192 the remote host (for example, the user has been added to a new unix
 193 group) you need to restart the vscode server that runs on the remote
 194 host.  Do this in vscode:
 195
 196 ctrl+shift+p: `Remote-SSH: Kill VS Code Server on Host`
 197
 198 This is because the vscode server remains running on the remote host
 199 even after you disconnect, so exiting/restarting vscode on the desktop
 200 has no effect.