README.md

Description

This module creates a GPU accelerated virtual machine that can be accessed using Chrome Remote Desktop.

Note: This is an experimental module. This module has only been tested in limited capacity with the Cluster Toolkit. The module interface may have undergo breaking changes in the future.

Example

The following example will create a single GPU accelerated remote desktop.

  - id: remote-desktop
    source: community/modules/remote-desktop/chrome-remote-desktop
    use: [network1]
    settings:
      install_nvidia_driver: true

Setting up the Remote Desktop

1. Once the remote desktop has been deployed, navigate to https://remotedesktop.google.com/headless.
2. Click through Begin, Next, & Authorize.
3. Copy the code snippet for Debian Linux.
4. SSH into the remote desktop machine. It will be listed under VM Instances in the Google Cloud web console.
5. Run the copied command and follow instructions to set up a PIN.
6. You should now see your machine listed on the Chrome Remote Desktop page under Remote devices.
7. Click on your machine and enter PIN if prompted.

License

Copyright 2026 Google LLC

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

 http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Requirements

Providers

No providers.

Modules

Resources

No resources.

Inputs

list(object({
    type  = string,
    count = number
  }))

[
  {
    "count": 1,
    "type": "nvidia-tesla-t4-vws"
  }
]

{
  "name": "debian-12-bookworm-v20250610",
  "project": "debian-cloud"
}

list(object({
    network            = string,
    subnetwork         = string,
    subnetwork_project = string,
    network_ip         = string,
    nic_type           = string,
    stack_type         = string,
    queue_count        = number,
    access_config = list(object({
      nat_ip                 = string,
      public_ptr_domain_name = string,
      network_tier           = string
    })),
    ipv6_access_config = list(object({
      public_ptr_domain_name = string,
      network_tier           = string
    })),
    alias_ip_range = list(object({
      ip_cidr_range         = string,
      subnetwork_range_name = string
    }))
  }))

list(object({
    server_ip             = string,
    remote_mount          = string,
    local_mount           = string,
    fs_type               = string,
    mount_options         = string,
    client_install_runner = map(string)
    mount_runner          = map(string)
  }))

object({
    email  = string,
    scopes = set(string)
  })

{
  "email": null,
  "scopes": [
    "https://www.googleapis.com/auth/cloud-platform"
  ]
}

Outputs