/
Deploying Guacamole and VMs for a Project

Deploying Guacamole and VMs for a Project

Owned by Mojib Javadi
Last updated: Feb 26, 2025 by Jonathan Gane
2 min read

Apache Guacamole is a clientless remote desktop gateway that provides access to Project Virtual Machines (VMs) (for details, see Using Apache Guacamole VMs). Before Project members can use Guacamole-connected VMs, one or VMs must be deployed into the Project. This article describes the steps for Platform Administrators to deploy Guacamole and connected VMs for a Project.

Prerequisites

  • Platform Administrator Role

 Instructions

To check the status of Guacamole deployment in a Project:

  1. Launch the Project and click the Settings icon in the left menu bar, then click the Workspace tab.

  2. Check the Guacamole section:

    1. If Guacamole has not yet been deployed for the Project, the Deploy button is displayed.

    2. After Guacamole been deployed for the Project and the , the message “Deployed for project on {date} By: {Platform Admin’s username}.” is displayed. VMs deployed into the Project will also be displayed here.

To deploy Guacamole to a Project:

  1. Launch the Project and click the Settings icon in the left menu bar, then click the Workspace tab.

  2. Click the Deploy button in the Guacamole section.

To provision a VM to a Guacamole-enabled Project:

  1. Navigate to the Platform Management in the main menu, then click the Resources tab.

  2. VMs available to your organization are listed. VMs that have already been deployed to Projects are identified by a green header, while those that are available to be deployed have a white header.

  3. Select an available VM and click the toggle switch in the top right corner from Available to Deployed.

  4. In the pop-up window, select the Project into which you would like to deploy the VM and then click Next.

  5. Select the zone (Green Room or Core) you would like the VM deployed to, and then click Next.

  6. Click Confirm.

Please contact the Pilot Support team for assistance with adding more virtual machines or managing any custom deployed virtual machines.

Once Guacamole has been deployed to a Project and a VM has been provisioned, Project Administrators will need to assign VM connections to Project members who have permission to access to Guacamole. Please see:
Managing Project Workspace Tools | Granting Access to Guacamole VMs

Creating Custom Project Roles

To decommission a VM from a Guacamole-enabled Project:

  1. Navigate to the Platform Management in the main menu, then click the Resources tab.

  2. VMs available to your organization are listed. VMs that have already been deployed to Projects are identified by a green header, while those that are available to be deployed have a white header.

  3. Select a VM that has been provisioned to a project and click the Deployed toggle switch in the top right corner.

  4. A window will pop up. Type “delete and then click Confirm.

Warning: This action cannot be undone.

When a VM is decommissioned from a Project, all user data and applications stored in the VM will be permanently deleted, and the decommissioned VM will be returned to the Platform VM resource pool and available for re-deployment.

Once a VM has been decommissioned all Platform Administrators and Project Administrators assigned to the Project will be sent and email notifying them of the change.

 Related articles