X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/be34fa5f0ae5c616798fdc9accae9677c7e53508..afe02764a9209c0c4b0ec75df52b4851ec8ce01f:/doc/user/cwl/arvados-vscode-training.html.md.liquid diff --git a/doc/user/cwl/arvados-vscode-training.html.md.liquid b/doc/user/cwl/arvados-vscode-training.html.md.liquid index 8ade1c7555..804b3ad7bb 100644 --- a/doc/user/cwl/arvados-vscode-training.html.md.liquid +++ b/doc/user/cwl/arvados-vscode-training.html.md.liquid @@ -9,7 +9,7 @@ Copyright (C) The Arvados Authors. All rights reserved. SPDX-License-Identifier: CC-BY-SA-3.0 Imported from https://github.com/arvados/arvados-vscode-cwl-training -git hash: 0a544f917de8bc2538e1582a82af205c1000adf5 +git hash: f39d44c1bdb2f82ec8f22ade874ca70544531289 {% endcomment %} @@ -25,18 +25,20 @@ Code (abbreviated "vscode") to develop CWL workflows on Arvados. ## 1. SSH Setup -1. (Windows only) Install git for windows [https://git-scm.com/download/win](https://git-scm.com/download/win) +1. (Windows only) Install Git for Windows [https://git-scm.com/download/win](https://git-scm.com/download/win) 1. Choose "64-bit Git for Windows Setup". It does not require admin privileges to install. 1. Hit "Next" a bunch of times to accept the defaults - 1. The most important things is that "install git bash" and "install OpenSSH" are enabled. + 1. The most important things is that "install git bash" and "install OpenSSH" are enabled (this is the default). 1. At the end of the installation, you can launch tick a box to git bash directly. 1. Open "Git Bash" (installed in the "Git" folder of the start menu) -1. From an open bash shell +1. (All operating systems) Starting from bash shell (on MacOS or Linux you will open "Terminal") 1. Shell: Run `ssh-keygen` 1. Hit enter to save to a default location 1. You can choose to protect the key with a password, or just hit enter for no password. - 1. Shell: Look for a message like `Your public key has been saved in /c/Users/MyUsername/.ssh/id_rsa.pub` - 1. Shell: Run `cat /c/Users/MyUsername/.ssh/id_rsa.pub` + 1. Shell: Look for a message like `Your public key has been saved + in /c/Users/MyUsername/.ssh/id_rsa.pub` (Windows git bash + example, on MacOS or Linux this will probably start with `/Users` or `/home`) + 1. Shell: Run `cat /c/Users/MyUsername/.ssh/id_rsa.pub` 1. Shell: Use the pointer to highlight and copy the lines starting with `ssh-rsa …` up to the next blank line. Right click and select "Copy" @@ -70,20 +72,25 @@ Code (abbreviated "vscode") to develop CWL workflows on Arvados. 1. Right click the newly added ssh target in the list and select “connect to host in current window` 1. If it asks `Select platform of the remote host` select `Linux`. 1. Vscode: On the left sidebar, go back to `Extensions` ![](images/Extensions.png) - 1. Search for "benten" and install `CWL (Rabix/Benten)` - 1. You should see a message `Extension is enabled on 'SSH: ...' and disabled locally.` + 1. Search for "benten", then look for `CWL (Rabix/Benten)` and click `Install` + 1. On the information page for `CWL (Rabix/Benten)` + 1. If you see a warning `Install the extension on 'SSH: ...' to enable` then click the button `Install in SSH: ...` + 1. You should now see a message `Extension is enabled on 'SSH: ...' and disabled locally.` 1. Vscode: On the left sidebar, choose `Explorer` ![](images/Explorer.png) 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` 1. If asked `Would you like to open the cloned repository?` choose `Open` 1. Go to Arvados Workbench 1. Workbench: In the user menu, select `Current token` + 1. Workbench: Click on `Copy to Clipboard`. + 1. Workbench: You should see a notification `Token copied to clipboard`. + 1. Go to Vscode 1. Vscode: Click on the `Terminal` menu 1. Vscode: Click `Run Task…` - 1. Vscode: Select `Configure Arvados` - 1. Workbench: Copy the string following `ARVADOS_API_HOST=` - 1. Vscode: Paste the string at the `Value for ARVADOS_API_HOST` prompt - 1. Workbench: Copy the string following `ARVADOS_API_TOKEN=` - 1. Vscode: Paste the string at the `Value for ARVADOS_API_TOKEN` prompt + 1. Vscode: Select `Set Arvados Host` + 1. Vscode: Paste the value of API Host from the Workbench `Get API Token` dialog (found in the User menu) at the prompt + 1. Vscode: Next, run task `Set Arvados Token` + 1. Vscode: Paste the value of API Token from the Workbench `Get API Token` dialog + 1. Vscode: These will create files called `API_HOST` and `API_TOKEN` ## 3. Register & run a workflow @@ -91,6 +98,7 @@ Code (abbreviated "vscode") to develop CWL workflows on Arvados. 1. Click on the `Terminal` menu 1. Click `Run Task…` 1. Select `Register or update CWL workflow on Arvados Workbench` + 1. This will create a file called `WORKFLOW_UUID` 1. Workbench: Go to `+NEW` and select `New project` 1. Enter a name for the project like "Lesson 1" 1. You should arrive at the panel for the new project