Coveo Platform Deployment Overview

The following list describes the main steps involved in the deployment of the Coveo Platform.

To deploy the Coveo Platform

1. Plan your deployment:

   1. Understand how the Coveo Platform can scale with increasing indexing and search needs (see Coveo Scalability Model and Coveo Platform On-Premises Products).

   2. Identify and analyze the content of the repositories that you want to index (see Planning Repositories to Index).

   3. Determine the search interface needs for various groups of users (see Planning .NET Search Hubs and Search Interfaces).

   4. Determine if one or more Coveo servers are required and select the appropriate server topology and hardware (see Coveo Platform Hardware and Software Requirements).

   5. Determine ports to open

      Depending on the Coveo components you plan to use and your network configuration:

      1. Identify the required ports used by Coveo components you plan to use (see Ports Used By the Coveo Platform) .

      2. Identify special ports used by repositories you plan to index and needed by the Coveo connector to access the content.

      3. Plan to have these ports opened by appropriate authorities in appropriate network infrastructure components such as in firewalls.

      Example: Your CES Master server is deployed in a DMZ with search interfaces and repositories to index on either the internal or external side of the DMZ. You may need to open ports in both the internal and external side firewalls for the search interfaces and for the repositories.

2. Install the Coveo Enterprise Search Back-End components:

   1. Install the hardware for one or more Coveo servers for the selected topology.

   2. Install CES on the Master server, validate your Coveo license, and create an empty index or import the index configuration from your previous CES version (see Installing CES on the Master Server).

   3. When needed by your selected topology, add an index slice to the Master server (see Adding an Index Slice to the Master Server).

   4. For a multiple server topology:

      1. When your topology includes one or more Mirror servers, install the Coveo Mirror components (see Installing CES Mirror Components).

         Note: By default, the remote converter components are installed on a Mirror server.

      2. When your topology includes one or more Remote Converter servers, install the Coveo Remote Converter components (see Installing CES Remote Converter Components).

      3. When two or more Master/Mirror servers are available, consider either of these options:

         • Configure failover alternate servers (see Configuring a .NET Front-End Server to Use Failover Alternate Back-End Servers).

           OR

         • Use a third-party solution to set them up in a network load-balancing configuration (see Configuring Coveo Servers in a Network Load-Balancing Cluster).

3. Populate the unified index:

   1. Create collections for your repositories (see Adding a Collection).

   2. Create and crawl sources using the appropriate connectors for each repository (see Adding a Source and Coveo Platform Connectors).

4. Deploy at least one type of search interface: 

   • Coveo JavaScript Search Framework and REST Search API

     Use the modern Coveo JavaScript Search with the REST Search API when you want developers to easily customize search pages.

     1. Because Coveo JavaScript Search pages communicate with CES through a REST search API, you must first install the search API (see Installing the Coveo Search API) .

     2. Create and deploy one or more JavaScript Search interface (see Getting Started with the JavaScript Search Framework).

   AND / OR

   • Coveo .NET Front-End

     Use the Coveo .NET Front-End when you want to get an out-of-the-box set of enterprise search interfaces that an administrator can customize using the .NET Interface Editor

     1. Install the Coveo .Net Front-End components on one or more Front-End servers of your selected topology. In the case of a one server topology, run the installer on the Master server only (see Installing Coveo .NET Front-End).

     2. When your topology includes two or more Front-End servers, consider setting them up in a network load-balancing configuration (see Configuring Coveo Servers in a Network Load-Balancing Cluster).

     3. Define one or more search hubs (see Creating a Search Hub With the .NET Interface Editor).

     4. For each .NET search hub, select the .NET search interfaces to include (see Making Search Interfaces Available in a Search Hub With the .NET Interface Editor).

     5. For each .NET search interface, select options (see Activating Search Interface Options With the .NET Interface Editor).

     6. Consider deploying the Desktop Integration Package (DIP) on multiple workstations to allow users to take advantage of the Desktop Searchbar and the Outlook Sidebar (see Desktop Integration Package andDesktop Integration Package Deployment Overview).