asc.core.services_guacamole role – Deploy the Apache Guacamole access gateway and generate its connections

Note

This role is part of the asc.core collection (version 2.0.0).

It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it use: git clone git@ssh.dev.azure.com:v3/cloudasc/iac-ansible-collections/core $HOME/.ansible/collections/ansible_collections/asc/core.

To use it in a playbook, specify: asc.core.services_guacamole.

Entry point main – Deploy the Apache Guacamole access gateway and generate its connections

New in asc.core 1.0.0

Synopsis

  • Deploys Apache Guacamole (the guacd daemon, the web application on Tomcat and its PostgreSQL database) as the browser-based RDP/SSH/VNC gateway to the whole environment, with HTTPS provisioned via certbot.

  • Connections and connection groups are generated per host from the Terraform state, and users plus their permissions are driven entirely by the tags in users.csv (guac_admin grants the Guacamole admin role).

  • Because the Guacamole 1.6.0 WAR is still javax-based, this host is pinned to Ubuntu 22.04 with tomcat9; its Azure SDK is isolated in a virtualenv so certbot keeps working.

Parameters

Parameter

Comments

services_guacamole

dictionary

‘services_guacamole’ role configuration

admins

list / elements=string

List of email addresses of users that will be granted admin access to the Guacamole web interface

Default: []

enable_aad_auth

boolean

Whether to enable AAD authentication to access the Guacamole web interface

Choices:

  • false ← (default)

  • true

enabled

boolean

Whether to enable the role

Choices:

  • false ← (default)

  • true

guac_version

string

Guacamole version to deploy

See https://github.com/apache/guacamole-server/tags for available versions

Default: "1.4.0"

vm_disk_size

integer

Size of the extra data disk (in GB)

Default: 64

vm_name

string

Name of the VM to deploy

Default: "vmguacamole01"

vm_size

string

Size of the VM to deploy (Azure VM size)

Default: "Standard_B2as_v2"

services_guacamole_azure_venv

path

added in asc.core 2.0.0

Virtualenv holding the Azure SDK used for the Key Vault lookup, kept apart from the system Python so its modern cryptography does not replace the one the apt certbot needs.

Default: "/opt/guac-azure-venv"

Authors

  • Ignace De Cock