Creating a Google Cloud Platform (GCP) Engine VM Image

Last published : Jul 27, 2026
To use the adapter with Google Cloud Platform (GCP), you must first create a Google Cloud Platform VM Engine Image for GridServer Engine for your choice of OS.
Prerequisites
Before creating an Engine Image, ensure that the following requirements are met:
  1. Disable the firewall on the machine or open all the appropriate ports for the Engine.
  2. Install the Engine. You can install the Engine with the Director you plan to use for production or for a Director you use for a development or QA grid.
Related information

Creating an Engine Image on Linux

Procedure
  1. Shut down the Engine Daemon after the Engine starts running against the first Director.
  2. Verify that the Engine Daemon does not start automatically at boot.
  3. Create the image on GCP. For more information, see Creating GCP Image.
    Note: Ensure that you create an image using the --guest-os-features MULTI_IP_SUBNET flag by using Google Cloud.
  4. Create instance templates by using the newly created image and provide a script in the Startup script field. The user must provide the startup script at the automation section during the creation of instance templates. Sample value script:
    #!/bin/bash
    //Stopping the engine
    cd /opt/datasynapse/engine
    ./engine.sh stop
    //running the configure utility
    ./configure.sh -s DIRECTOR_HOST:DIRECTOR_MESSAGE_PORT
    //Re-Starting the engine
    ./engine.sh start
    If you are configuring the adapter over an SSL enabled Manager, then configure by using the following command:
    //running the configure utility
    ./configure.sh -s DIRECTOR_HOST:DIRECTOR_MESSAGE_PORT -l y
  5. Create an Instance Group. For more information, see Creating an Instance Group on Google Cloud Platform (GCP).
  6. Update the cloudprovider.properties file with the Instance Group details.

Creating an Engine Image on Windows

Procedure
  1. Shut down the Engine Daemon after the Engine starts running against the first Director.
  2. Verify that the Engine Daemon does not start automatically at boot time. This is very important for Windows since it installs as a service by default. The service needs to be set for a manual start.
  3. Access gpedit.msc to enable PowerShell scripts. Go to Local Computer Policy > Computer configuration > Administrative Templates > Windows Components > Windows PowerShell > Turn on Script Execution.
  4. In the Turn on Script Execution window, select Enabled in the upper-left, then in the Options section, select Allow all scripts.
  5. Create the image on GCP. For more information, see Creating Windows OS Image. Ensure that you perform the following steps during the creation of the image:
    • Run GCESysprep utility.
    • Create an image using the flag --guest-os-features MULTI_IP_SUBNET from the Google Cloud.
  6. Create instance templates:
    • Use the newly created image.
    • Use the following key and script as a value in the custom metadata subsection under the Automation section.
    • Key = windows-startup-script-ps1
    Sample value script:
    $director="gs-manager-rsm-director"
    $messagePort= 8000

    echo "Director options: $director " >> "C:\gsengine.log"
    echo "messagePort: $messagePort " >> "C:\gsengine.log"

    $datfile="$($dsfolder)\intranet.dat"
    "http://$($director):$($messagePort)/livecluster/public_
    html/register/register.jsp".Trim() | Out-File -Encoding Ascii $datfile

    echo "Starting datasynapse service............" >> "C:\gsengine.log"
    Start-Service DataSynapse

    Start-Sleep -seconds 45
    $datasynapseService = Get-Service -Name DataSynapse

    if ($datasynapseService.Status -ne 'Running'){
         "Datasynapse Service is not running, trying to rerun it." >> "C:\gsengine.log"
         Start-Service DataSynapse
         Start-Sleep -seconds 15
         $datasynapseService.Refresh()
        if ($datasynapseService.Status -eq 'Running')
        {
            "Datasynapse Service is running" >> "C:\gsengine.log"
        }

    }
  7. Create an Instance Group. For more information, see Creating an Instance Group on Google Cloud Platform (GCP).
  8. Update the cloudprovider.properties file with the Instance Group details.