Wiki source code of Using Guacamole in HDC

Version 3.1 by Dennis Segebarth on 2023/09/13 17:21
Show last authors
1 {{box cssClass="floatinginfobox" title="**Contents**"}}
2 {{toc/}}
3 {{/box}}
4
5
6 (% class="wikigeneratedid" %)
7 Apache Guacamole is a clientless remote desktop gateway that gives you access to Project-based Virtual Machines (VMs) to perform computational analyses on your Project data. Guacamole supports standard protocols like VNC, RDP, and SSH. To learn more about the application, visit the [[Guacamole documentation>>https://guacamole.apache.org/]] and [[administration guide>>https://guacamole.apache.org/doc/gug/administration.html]].
8
9 (% class="wikigeneratedid" %)
10 [[image:Guacamole-Logo-300x100px cropped.png||data-xwiki-image-style-alignment="center" height="146" width="376"]]
11
12 = How it works =
13
14 After the Guacamole application and the VMs have been set up by a Platform Administrator, Project members can request access to the Guacamole-connected VMs. After access is granted, Project members can fetch data from the Core storage, perform computational workflows on the data inside the VM, then write the derivative outputs back to the Core where other Project members can access them.
15
16 = Prerequisites =
17
18 * Project Collaborator role or higher.
19 * Guacamole application and connected virtual machines pre-configured for the Project by the Platform Administrator. See //Getting Access to Guacamole//.
20
21 = Data Stewardship =
22
23 Users are reminded to abide by the Platform Terms of Use and any Project-specific restrictions when using Workspace tools to access data and code.
24
25 = Getting Access to Guacamole =
26
27 [[image:Project Workspace tool navigation Guacamole v2.1.5 2023-01-23.png||height="179" width="322"]]
28
29 1. (((
30 Launch your Project and click **Guacamole **in the workspace icon group.
31
32 1. If you launch Guacamole and receive a notice that it hasn’t been deployed for your project, please contact your Platform Administrator.
33 1. After the Platform Administrator has deployed Guacamole as a workspace tool for your Project, you can request access to the Guacamole-connected VMs. Every project member must complete this step to initialize their identity in the Guacamole system.
34 )))
35 1. In the pop-up window, enter a message to the Project Administrator containing the details of your access request, then click **Send Request**.
36 1. A message confirms the request has been sent. Project Administrators receive a notification by email and in the portal notification system.
37
38 After the Project Administrator receives the notification and sets up the requested access to the Guacamole-connected VM(s), you will receive credentials that you can use to log into VMs and you can begin using Guacamole.
39
40 = Launching a Guacamole VM Connection =
41
42 After the first-time setup has been completed, you can start using Guacamole to access your Project Virtual Machines (VMs). Both Desktop and Command Line Interface VM connections are possible, depending on which VMs have been deployed for the Project and which VMs you have access to.
43
44 1. (((
45 Launch your Project and click **Guacamole **in the workspace icon group.
46
47 (% start="1" style="list-style-type:lower-alpha" %)
48 1. If you have access to **both** Desktop **and **Command Line Interface VM connections, the Connections screen lists the available VMs. Each VM connection is identified by a name and ID number indicating
49 whether it is a Desktop or Command Line connection. Click a **VM connection **to initiate it.
50 \\[[image:HDC Guacamole VMs from XWiki.png]]
51
52 1. If you only have access to **either** a Desktop connection **or **a Command Line Interface connection, the relevant login screen (Desktop or Command Line Interface) appears.
53 )))
54 1. Follow the instructions for establishing a **Desktop** or **Command Line Interface** VM connection.
55
56 == Establishing a Desktop VM Connection ==
57
58 [[image:Guacamole login modal from XWiki 2023-01-23.png||height="285" width="244"]]
59
60 1. On the Desktop login screen, enter your VM-specific username and password, which were provided to you by the Platform Administrator, then click **OK. **
61 1. The VM connection is established.
62 1. After connecting, you can begin working in your Desktop VM. To launch a Linux terminal, see //Launching a Linux Terminal inside a Desktop VM//.
63
64 //Note: //We recommend to change your VM-specific password upon first login to the VM. For this, type {{code language="none"}}passwd{{/code}} in a Linux terminal inside the VM, hit return on your keyboard and follow the instructions to change your password. Please make sure to save the new password in a secure location.
65
66 == Establishing a Command Line VM connection ==
67
68 [[image:Project Workspace Guacamole CLI Connection Login v2.1.5 2023-02-06.png||height="68" width="566"]]
69
70 {{code language="none" width="50%"}}
71 Welcome to Ubuntu 20.04.5 LTS (GNU/Linux 5.15.0-1019-azure x86_64)
72
73 * Documentation: https://help.ubuntu.com
74 * Management: https://landscape.canonical.com
75 * Support: https://ubuntu.com/advantage
76 {{/code}}
77
78 1. On the Command Line login screen, enter your VM-specific username and password, which were provided to you by the Platform Administrator.
79 1. The VM connection is established.
80
81 //Note: //We recommend to change your VM-specific password upon first login to the VM. For this, type {{code language="none"}}passwd{{/code}} in the Command Line VM, hit return on your keyboard and follow the instructions to change your password. Please make sure to save the new password in a secure location.
82
83 == Launching a Linux Terminal inside a Desktop VM ==
84
85 After successfully logging into a Desktop VM, the default desktop is displayed. To launch the pre-installed Linux applications such as a standard terminal,
86
87 [[image:Project Workspace Guacamole Desktop Linux Terminal v2.1.5 2023-02-06 1422.png||height="446" width="802"]]
88
89 1. Click **Activities **in the upper left corner.
90 1. Enter {{code language="none"}}terminal{{/code}} in the search box.
91 1. The terminal launches in a new window.
92
93 = Command Line Interface operations with different HDC zones =
94
95 The Command Line Interface is deployed within each Workspace VM as extension resource. The file operations permitted by the Command Line Interface depend on the zone you want to interact with, as shown in the table below:
96
97 (% style="height:122px; width:689.833px" %)
98 |=(% style="width: 236px;" %)File Operation|=(% style="width: 196px;" %)Green Room|=(% style="width: 255px;" %)Core
99 |(% style="width:236px" %)(((
100 File upload to indicated zone
101 )))|(% style="width:196px" %)Yes|(% style="width:255px" %)Yes
102 |(% style="width:236px" %)File download to indicated zone|(% style="width:196px" %)NO|(% style="width:255px" %)Yes
103