Using AzureTRE for Research Documentation (#2714)

microsoft · Oct 18, 2022 · c036af7 · c036af7
1 parent 0d64b67
commit c036af7
Show file tree

Hide file tree

Showing 9 changed files with 79 additions and 0 deletions.
diff --git a/docs/assets/using-tre/deallocated-vm.png b/docs/assets/using-tre/deallocated-vm.png
diff --git a/docs/assets/using-tre/delete-vm.png b/docs/assets/using-tre/delete-vm.png
diff --git a/docs/assets/using-tre/disable-vm.png b/docs/assets/using-tre/disable-vm.png
diff --git a/docs/assets/using-tre/updating-vm.png b/docs/assets/using-tre/updating-vm.png
diff --git a/docs/assets/using-tre/vm-access.png b/docs/assets/using-tre/vm-access.png
diff --git a/docs/assets/using-tre/vm-start-stop.png b/docs/assets/using-tre/vm-start-stop.png
diff --git a/docs/using-tre/tre-for-research/index.md b/docs/using-tre/tre-for-research/index.md
@@ -0,0 +1,3 @@
+# Using the Azure TRE for Research
+
+This section contains information relevant on how to conduct research in a TRE workspace.
diff --git a/docs/using-tre/tre-for-research/using-vms.md b/docs/using-tre/tre-for-research/using-vms.md
@@ -0,0 +1,73 @@
+
+# Set up of a Virtual Machine
+This document will talk you through how to deploy a Virtual Machine via the Guacamole Workspace Service and access imported data.
+
+## Creating your VM
+
+1. Open the UI link `https://<TRE_ID>.<LOCATION>.cloudapp.azure.com/`
+
+   1. You will need the Microsoft Authenticator app on your phone. The above will take you through the set up process.
+
+2. Within the UI, under the Workspaces tab you should be able to see any Workspaces assigned to you.
+
+3. Click on the title of the Workspace to go into it. Within there should be the Guacamole Workspace Service, click the title to go into the Workspace Service.
+
+   1. Clicking Connect will take you to the Guacamole Home Page where it will list out all of your deployed VMs.
+
+4. Within the Workspace Service tab, you’ll need to choose Create new to create a user resource. This will be your VM.
+
+5. Choose the template you’d like to base your VM on, at the moment the choice will be between a Windows or Linux VM.
+
+   1. Fill in all of the details to your requirements.
+
+6. Once the resource is deployed, you should be able to choose Connect and view your VM in a browser.
+
+
+[![Connect to VM](../../assets/using-tre/vm-access.png)](../../assets/using-tre/vm-access.png)
+
+
+*You may see a pop-up asking for guacamole to have permission to use your clipboard, please allow that.*
+
+
+## Accessing Data
+You may have data pre-provisioned into your workspace, or you may import data via the airlock.
+
+
+## Starting and Stopping your VM
+When you are no longer using a VM, it is good practice to stop it so that the VM is deallocated and no unnecessary costs will be applied.
+To do this, navigate to the UI and find your VM.
+
+1. Click on the three small dots in the top right of the user resource card and choose Actions and then Stop.
+2. It will take a few minutes to take effect and the card should then display 'VM deallocated'.
+
+The same steps can be followed to Start your VM.
+
+[![Start and Stop VM](../../assets/using-tre/vm-start-stop.png)](../../assets/using-tre/vm-access.png)
+
+[![Deallocated VM](../../assets/using-tre/deallocated-vm.png)](../../assets/using-tre/deallocated-vm.png)
+
+
+
+## Deleting your VM
+If you no longer wish to use the VM you have created there is an option to delete it. First you'll need to disable the VM, similar to above when stopping it:
+
+1. Click on the three small dots in the top right and choose Disable.
+2. Once it is disabled (this can take a few minutes), click on the three dots again and you should then have the option to delete it.
+
+[![Disable VM](../../assets/using-tre/disable-vm.png)](../../assets/using-tre/disable-vm.png)
+
+
+[![Delete VM](../../assets/using-tre/delete-vm.png)](../../assets/using-tre/delete-vm.png)
+
+
+## VM Actions
+
+Whilst the VM is currently updating due to an invoked action it will display a message similar to the one below. This will occur any time a service or user resource is deployed, disabled, deleted etc.
+
+[![Update VM](../../assets/using-tre/updating-vm.png)](../../assets/using-tre/updating-vm.png)
+
+You can also view any current operations by clicking on the bell in the top right hand corner of the screen.
+
+
+## How to Contribute to our Documentation
+[Contribute to Documentation](https://microsoft.github.io/AzureTRE/coming-soon/)
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -66,6 +66,9 @@ nav:
   - Using the Azure TRE: # Documentation for users of the TRE
       - Introduction: using-tre/index.md
       - Custom Templates: using-tre/templates/index.md
+      - Using AzureTRE for Research:
+          - Introduction: using-tre/tre-for-research/index.md
+          - Set up of a Virtual Machine: using-tre/tre-for-research/using-vms.md
       # - Workspaces:
       #    - using-tre/wks/index.md # Documentation describing what a workspace is
       #    - Using Workspaces: using-tre/wks/using-wks.md # Interacting with workspaces (via the UI)
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# Using the Azure TRE for Research

		This section contains information relevant on how to conduct research in a TRE workspace.