Creating a Hyper-V Virtual Machine for the Crawling Module (Docker Version)

This article applies to the old Crawling Module, which works with Docker. The old Crawling Module will soon reach its end-of-life. We recommend switching to the new Crawling Module, which doesn’t require Docker.

To identify the Crawling Module you’re currently using, on the Crawling Modules page of the Coveo Cloud Administration Console, look at the Maestro reported version:

  • Versions > 1: new Crawling Module

  • Versions < 1: Crawling Module with Docker

Coveo provides installation steps for the following virtual machine setups:

  • While you can use a different virtual machine setup, Coveo can’t guarantee that Docker Enterprise Edition will install successfully on such a setup (see Installing Docker). See Validating the Installation to ensure Docker works correctly before installing the Crawling Module.

  • Any server running the Crawling Module must have access to the content you want to index, regardless of whether the server is a virtual machine or not.

Follow these steps to create a Hyper-V VM that’s compatible with the Coveo On-Premises Crawling Module.

To create a Hyper-V virtual machine

  1. In Hyper-V Manager, create a VM from a valid Windows Server 2016 iso. Alternatively, this can be done with the Quick Create action.
  2. Before launching the VM, right-click it to change its settings:
    1. Specify an amount of RAM and a number of virtual processors. A good rule of thumb is to aim for one virtual CPU and 4 GB of RAM per worker.

      The number of workers is part of the Crawling Module configuration. It determines the number of sources that can refresh at the same time. That number should be between 1 and the total number of Crawling Module sources in your organization and can be changed at any time. See Number of Workers for more information on workers.

    2. Navigate to Hard Drive > Media, and then reserve at least 500 GB for the VM. Expand the default disk if necessary.
    3. If the Windows version running on the VM is older than 14393.1914, update it.

      You can find your Windows version in About your PC, under OS Build.

    4. Enable nested virtualization in the VM:
      1. Shut down the VM.
      2. Run the following command in an elevated PowerShell window, using the name you gave your VM in Hyper-V Manager: Set-VMProcessor -VMName {VMName} -ExposeVirtualizationExtensions $true
      3. Start the VM.

What’s Next?

Install Docker (see Installing Docker).

Recommended Articles