Updated on 8/15/2019
All Product Installation and Upgrade Guides
Eyeglass Search & Recover Installation and Upgrade Guide
Direct link to topic in this publication:

VMware ESX Host Compute Configuration and Cluster Sizing 

See Sizing guide here.

Firewall Rules and Direction Table

NOTE: These rules apply to traffic into the VM and out of the VM. All ports must be open between VM's, private VLAN's and firewall between VM's is not supported.





Browser  → Search Cluster

UI Access, management tools (password protected)


Admin PC → Search Cluster

Management access to the CLI

8080 (HTTPS) over

Search Cluster → Isilon

NFS (optional for content)Search Cluster IsilonFile Content Ingestion

    Eyeglass Search & Recover Installation Prep Steps

    The Search & Recover appliance is based on the ECA cluster architecture and has similar steps to complete installation.

    Before you begin, collect the information below and verify all pre-requistes are completed:

    1. See the sizing your cluster based on your environment to determine the number of nodes required.  Guide Here.
    2. Must have 4-7 IP addresses to assign during OVA deployment of the Search & Recover cluster depending on the size of the cluster ( 4 node or 7 node cluster)
      1. Must have DNS IP, router IP, subnetmask, NTP server IP 
    3. Permissions for Service Account: Isilon REST API access with file traverse permissions to ingest files and directories by the Search & Recover cluster. See the minimum permissions guide for a full list of permissions required for the eyeglass service account used by all ECA cluster products. Guide here.
    4. (optional skip this section if Meta Data only indexing is needed
      1. File Full Content data Indexing Requirements 
      2. Must have DNS smartconnect name assigned to a management IP pool in the System zone for the NFS export used to ingest content from the snapshots folder.
      3. Get each Cluster GUID and name that will be indexed.  Record these values for steps below.
        1. Login to the cluster OneFS GUI and open the Cluster Management --> General settings menu and record the cluster GUID and cluster name. Example below.
      4. Repeat for each cluster that will be licensed and indexed.
      5. Create an NFS export in the System Access Zone for full content on all clusters that will be indexed.  See example below where the IP addresses entered are the Search & Recover cluster IP addresses. The export is created on the /ifs/.snapshot directory with root client list used and add all nodes except node 1.


    Search & Recover OVA Deployment and Cluster VM Configuration

    1. Download the OVA following instructions here
    2. Deploy with vCenter
      vCenter 6.5 and 6.7 use FLASH or FLEX interface.  HTML5 interface is not supported.
      1. Select the OVF file with the required node count based on cluster sizing pre-requisite step.
      2. Set the node ip addresses, gateway IP, DNS, NTP IP and index volume size during the OVA deployment.  Use the disk size values from this sizing table.  
      3. Note: Data disk size value  MUST be left at the default.
      4. Set the ECA cluster name (no special characters should be used, all lower case)
      5. Power on the OVA
      6. SSH to the node 1 IP address
      7. Login with user ecaadmin and default password 3y3gl4ss
    3. Configure and test NTP (NOTE if Internet access is allowed for NTP protocol, then no configuration is needed, use this procedure to test access and or change NTP to an internal server IP)
      1. sudo -s
      2. Enter ecaadmin password
      3. type yast    (NOTE navigation uses the Arrow keys and TAB key and shift TAB key to move between selections on the UI) 
      4. Select Network Services to enter NTP Configuration
      5. Test Access to Internet NTP servers
        1. TAB to the Edit button and press enter

        2. Now Tab to the Test button and press enter

        3. If Internet access is enabled then test response will look like the image above.
        4. If it fails
          1. Replace the NTP server entry with your Internal NTP server IP address
          2. Use the TAB key to select the OK button, press enter
          3. Press F10 to exit the NTP configuration screen
          4. Use the TAB key to Select the YAST Exit button.
        5. Repeat NTP test and/or configuration on ALL Search nodes 
    4. Configure Cluster Master Configuration file
    5. IMPORTANT: Next step must be run as ecaadmin user.  If still root user from previous steps exit before continuing.
    6. IMPORTANT: Next step must be run from Search node 1
      1. Run the cluster setup command (sets up SSH between nodes, configures master file, set password for administration WebUI)
        1. NOTE: This will setup ssh access between nodes and configure the cluster.  
        2. Type y or yes when prompted to continue.
        3. You will be prompted to enter the default password  to complete this setup process.  The default password is 3y3gl4ss. 
        4. You will prompted to login to each node during this one time process
        5. Run setup command: ecactl components install eca
        6. Administration WebUI password
          1. When prompted enter a secure strong password 8 characters or longer with upper case, lower case , numbers and special characters.   This password protects access to administration webUI.
        7. After the setup completes on all nodes verify the contents of the master configuration file
          1. cat /opt/superna/eca/eca-env-common.conf
          2. Verify the ip addresses are listed for each node
          3. Verify the cluster name is correctly set in the file variable export ECA_CLUSTER_ID=
      2. (Skip section if you only plan on indexing metadata) Configure NFS Export for Content Ingestion ONLY
        1. Search and Recover uses Isilon snapshots to ingest content. Follow the steps below to add the export to each of the VM's.
        2. What you will need to complete this step on nodes 2 - x (where x is the last node IP in the cluster):
          1. Cluster GUID and cluster name for each cluster to be indexed
          2. Cluster name as shown on top right corner after login to OneFS GUI 
        3. Change to Root user
          1. sudo -s
          2. enter ecaadmin password 3y3gl4ss
        4. Create local mount directory (repeat for each cluster) 
          1. mkdir -p /opt/superna/mnt/search/GUID/clusternamehere/    (replace GUID and clusternamehere with correct values)
          2. Repeat these steps on Each node in the cluster 
        5.  (Skip section if you only plan on indexing metadata) Configure automatic mount on VM reboot for Full Text Indexing NFS mount 
          1. Complete these steps on nodes 2 - X (X is the last node in the cluster , depending on the size of your Search & Recover cluster)
          2. vim /etc/fstab
          3. At the end of the file the mount will be added.  To jump to the end of the file and turn on insert mode type the below key sequence
            1. Press ESC key,  Then hold Shift key and then press g then press o
            2. This will place the cursor on a blank line.  
          4. Replace yellow highlight with the correct values for your cluster. NOTE: the FQDN should be a smartconnect name for a pool in the System Access Zone IP Pool. 
            1. FQDN:/ifs/.snapshot /opt/superna/mnt/search/GUID/clustername nfs nfsvers=3 0 0
            2. NOTE:  copy the mount text for use on remaining nodes
          5. Then paste the edited text into the file at the current cursor location 
          6. Press Esc key to exit insert mode
          7. press the key (colon)  :  then type wq  Enter key
          8. Save the file
        6. Test the mount
          1. type mount -a
          2. This will read the fstab file and mount the export.
        7. Verify the mount
          1. Type mount Enter Key
          2. Verify the mount is visible in the output
        8. Repeat on remaining nodes
        9. Repeat mount steps above for additional cluster that require content indexing. NOTE: The mount must exist BEFORE you start the cluster.
    7. Start up the cluster
    8. IMPORTANT: Next step must be run as ecaadmin user. If still root user from previous steps exit before continuing.
    9. IMPORTANT: Next step must be run from Search node 1
      ecactl cluster up

      1. Wait until all steps complete on all nodes verify no error messages are deplayed
    10. Get the Search appliance id and make a record of it - will be required to retrieve license
      ecactl version

    11. Deployment done
    12. NEXT Steps Search & Recover Cluster Logical Configuration
      1. Configuration steps to add licenses, add clusters,  add index folders is covered in the Quick Start Steps of the Search & Recover Admin guide.

    How To Upgrade Search & Recover Cluster

    Internet connected appliance method

    NOTE: The applicance requires https access to the Internet   Internet <-- to appliance port 443 tcp https to download upgrades and check for upgrades

    1. Login to node 1 as ecaadmin
    2. If a new release is available online a message will be displayed with how to run the online upgrade command.  This will stop the cluster , upgrade to the new release.

    3. Run the command ecactl cluster upgrade
    4. monitor the upgrade process completes correctly, open a support case if you see an error message
    5. Once complete the cluster will need to be started up
    6. ecactl cluster up
    7. Done

    Offline Cluster No Internet Method

    1. Login to the support site https://support.superna.net and download the offline Search & Recover upgrade file
    2. Using a tool like Winscp copy the upgrade file to node 1 using ecaadmin user to authenitcate 
    3. shutdown the cluster
      1. Login to node 1 as ecaadmin over ssh
      2. run the command "ecactl cluster down"  
      3. wait for the cluster to shutdown
      4. Update EyeglassAdminSR service account with an additional permission or verify the service account has the correct permissions.  Verify all permissions listed here have been applied by running the command isi auth roles view EyeglassAdminSR .  The networking previlege is now required.
      5. Modify the install file copied to the cluster node 1
        1. Assuming the file was copied to default location in /home/ecaadmin
        2. cd /home/ecaadmin
        3. chmod 777 <name of install file here>
      6. Run the installer
        1. ./name of install file here
        2. when prompted enter the ecaadmin password
        3. wait for all nodes to be upgraded to the new version
      7. Start the cluster
        1. ecactl cluster up
        2. wait until all nodes are started
      8. done.

    Copyright Superna LLC