This guide is only for V2 assemblers being deployed with a virtual machine in VMware. The V1 assembler is no longer supported as of June 30, 2024.

Each assembler you create must be deployed via a virtual machine, and then you can add your technology as a security device in Workbench to complete the full integration. For more information about the Expel Assembler or how it works, see the About the Expel Assembler guide.

Note: The following instructions assume you are using VMWare Fusion, but you’re free to use another tool.

Prerequisites

• You must have completed all of the steps in Add a New Assembler for each assembler you wish to deploy.

Quick Start

Setup includes the following steps (select any step for detailed instructions):

1. Download the Ignition File
2. Import the CoreOS Image and Configure the VM
3. Verify a “Connected” Status in Workbench

Step 1: Download the Ignition File

1. Log in to Workbench.
2. In the side menu, navigate to Organization Settings > Assemblers.
3. Find the assembler you created, select Gzip + Base64 Encoded as the file format, and then Download the CoreOS Ignition File. This action will download a file that you will need in the next section.
   
4. Repeat steps 1-3 for any additional assemblers. Important: you must keep track of the files and output, and which came from which assembler, because each assembler has its own unique ignition file.

Step 2: Import the CoreOS Image and Configure the VM

You will need to create and deploy a new virtual machine using either ESXi Host (ESXi Host 7.x.x users) or vSphere (ESXi Host 8.x.x users). The process may vary slightly between the two, but in general you will need to do the following:

1. Select the Create/Register VM option, and then choose to deploy it via the ova file (the .ova file is the file you downloaded from Fedora in the Add a New Assembler documentation).
2. Select your .ova file to begin the installation process.
3. Select your storage and choose the appropriate VM network.
4. Make sure to uncheck the Power on automatically checkbox.
5. Locate the appropriate area to add the ignition config information.
   • If deploying on vSphere/ESXi version 8, in vSphere go to Edit Settings > Advanced Parameters. 
   • If deploying on vSphere/ESXi version 7, in EXSi Host go to VM Options > Advanced and edit your configuration.
6. Use the Attribute and Value fields or the Add Row option to add the following two sets of parameters:
   • • First Attribute - enter "guestinfo.ignition.config.data.encoding".
     • First Value - enter "gzip+base64".
     • Select Add.
     • Second Attribute - enter "guestinfo.ignition.config.data".
     • Second Value - paste in the contents of the ignition file (Step 1).
     • Select Add.
7.  Update the virtual hardware to meet the minimum requirements.
   • Memory - must be 8GB. 
   • Hard drive - must be at least 20GB.
8. Power on the VM.

Step 3: Verify a "Connected" Status in Workbench

It can take 10 to 15 minutes for the assembler’s status to update in Workbench.

1. Log in to Workbench.
2. In the side menu, navigate to Organization Settings > Assemblers (or, refresh the page if you never logged out).
3. Find your newly created assembler(s) and verify that the status has changed from “Not Yet Connected” to “Connected.” 
   • If the status has not updated yet, make sure you have waited at least 15 minutes, then refresh the page and check again.

Troubleshooting

If you cannot get your assembler VM to initialize in vSphere Client:

Try provisioning the VM directly from the ESXi host. We have seen cases where customers tried to create the assembler VM using vSphere Client, and they ran into errors during the provisioning stage. When they attempted the same task directly from the ESXi host on which the VM would run, the provisioning steps succeeded.

If your assembler is still not showing as “Connected” after 15 minutes:

• Make sure you have the proper firewall configurations to allow our outbound ports (see Add a New Assembler).
• Make sure your chosen machine’s size meets the required minimums (2 virtual CPUs, 8 GB RAM, and 20 GB disk space).

If all firewall and machine size settings are correct and you are still unable to connect the assembler, contact support for help.