isilon search installation and administration guide · guide. table 1 isilon search revision...

Dell EMC Isilon SearchVersion 2.0

Installation and Administration Guide302-003-764

REV 02

Copyright © 2017 Dell Inc. or its subsidiaries. All rights reserved.

Published March 2017

Dell believes the information in this publication is accurate as of its publication date. The information is subject to change without notice.

THE INFORMATION IN THIS PUBLICATION IS PROVIDED “AS-IS.“ DELL MAKES NO REPRESENTATIONS OR WARRANTIES OF ANY KIND

WITH RESPECT TO THE INFORMATION IN THIS PUBLICATION, AND SPECIFICALLY DISCLAIMS IMPLIED WARRANTIES OF

MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. USE, COPYING, AND DISTRIBUTION OF ANY DELL SOFTWARE DESCRIBED

IN THIS PUBLICATION REQUIRES AN APPLICABLE SOFTWARE LICENSE.

Dell, EMC, and other trademarks are trademarks of Dell Inc. or its subsidiaries. Other trademarks may be the property of their respective owners.

Published in the USA.

Dell EMCHopkinton, Massachusetts 01748-91031-508-435-1000 In North America 1-866-464-7381www.DellEMC.com

2 Dell EMC Isilon Search 2.0 Installation and Administration Guide

Preface 7

About Isilon Search 11About Isilon Search..................................................................................... 12

Product architecture...................................................................... 12About the user interface............................................................................. 15

Administration windows................................................................. 16About Searches..............................................................................19

Installing Isilon Search 23System requirements..................................................................................24Configuring DHCP server........................................................................... 25Configuring Static IPs................................................................................ 25Deploying the OVA in a single-node environment....................................... 26Deploying the OVA in a multi-node environment.........................................27

Deploying the master node............................................................ 28Adding more Isilon Search nodes................................................... 29

Logging in to Isilon Search for the first time...............................................30

Configuring Isilon Search 33Accessing the Administration window.........................................................34Configuring an Isilon source........................................................................35

Creating an SMB share on /ifs...................................................... 35Adding an Isilon user account for a dedicated Isilon Search user... 35Adding the source Isilon cluster..................................................... 36Selecting an analyzer.....................................................................38Managing Protocol Audit Monitoring............................................. 39Indexing files within containers.......................................................41Setting connection limitations........................................................ 41Setting the blackout window for indexing......................................42

Viewing the status and summary of the source.......................................... 43Rescanning the source and updating the index...........................................43Configuring LDAP and AD...........................................................................44Managing Indexes.......................................................................................46

Indexing overview..........................................................................46Restricting index access................................................................ 46Viewing indexes............................................................................. 48Updating an index.......................................................................... 48

Managing notifications............................................................................... 49Configuring System notifications...................................................49Configuring Isilon notifications...................................................... 50Configuring Email notifications.......................................................51

Configuring container indexing (zip and tar files)........................................51Enabling index replication for data indexes................................................. 52Enabling search operations on SmartLink files............................................53Setting search timeout options...................................................................53Optimizing search performance..................................................................54Configuring Full Content Indexing.............................................................. 54

Chapter 1

Chapter 2

Chapter 3

CONTENTS

Dell EMC Isilon Search 2.0 Installation and Administration Guide 3

About Full Content Indexing.......................................................... 54Amount of Index space used and Full Content Indexing ................ 55Application-specific metadata....................................................... 56Limiting files that are full content indexed..................................... 56

Managing Roles and Users 59About Roles................................................................................................60

System Administrator role............................................................. 60Application Administrator role........................................................ 61Search Administrator role..............................................................63Search User role............................................................................64Index specific search roles.............................................................66

Managing roles........................................................................................... 72Adding users or groups.................................................................. 72Removing users or groups..............................................................74Editing role assignments................................................................ 74

Configuring LDAP and AD...........................................................................75

Using the Dashboard 79Viewing collector nodes..............................................................................80Viewing index cluster..................................................................................80Viewing indexes..........................................................................................80Viewing source servers...............................................................................80Viewing system notifications.......................................................................81Viewing application notifications................................................................. 81

Monitoring Jobs, Services, and System Health 83Viewing job type and status........................................................................84Monitoring search jobs............................................................................... 86Monitoring index jobs................................................................................. 86Monitoring system jobs...............................................................................87Viewing system health................................................................................ 87Viewing system services.............................................................................88

Performing Search and Viewing Search Results 91About Searches.......................................................................................... 92

Accessing only the Search window................................................92Optimizing search performance..................................................................93Using filters to optimize search results.......................................................93

Narrowing a search by folder or file............................................... 94Narrowing a search by file type..................................................... 95Narrowing a search by file attributes.............................................96Narrowing a search by date and time attributes............................ 96Specifying an Isilon cluster............................................................ 97Including content that was not indexed in the search.................... 98Narrowing a search by owner........................................................ 98

Using keywords to search...........................................................................98Sorting search results................................................................................101Viewing the metadata of search results.................................................... 102Downloading files from search results....................................................... 102Searching for files within containers......................................................... 103Managing full content index searches....................................................... 103

Performing a Full Context Index on containers.............................104

Chapter 4

Chapter 5

Chapter 6

Chapter 7

CONTENTS


Performing a full content index on search results.........................104Searching for files that have not been full content indexed..........106Restricting a search to only include files that have been full contentindexed.........................................................................................107Searching for application specific metadata................................. 107

Troubleshooting 109Deployment troubleshooting......................................................................110Log files..................................................................................................... 110

Copying log files by using WinSCP................................................ 111Copying log files by using PuTTy ..................................................112

Troubleshooting the web server.................................................................113Configuration files.........................................................................114

Troubleshooting web services for collector issues..................................... 115Increasing the maximum memory for the search-Isilon-worker service......116Troubleshooting Elasticsearch................................................................... 116

Controlling the Elasticsearch service............................................ 116Viewing Elasticsearch logs............................................................ 117Viewing or changing Elasticsearch configuration.......................... 117Monitoring the health of the Elasticsearch cluster........................ 117

Appendix A

CONTENTS

Dell EMC Isilon Search 2.0 Installation and Administration Guide 5

CONTENTS


Preface

As part of an effort to improve its product lines, Dell EMC periodically releasesrevisions of its software and hardware. Therefore, all versions of the software orhardware in use may not support some functions that are described in this document.The product release notes provide the most up-to-date information about productfeatures.

If a product does not function correctly or does not function as described in thisdocument, contact a Dell EMC technical support professional.

If a product does not function correctly or does not function as described in thisdocument, contact a Dell EMC technical support professional.

Note

This document was accurate at publication time. To ensure that you are using thelatest version of this document, go to the Dell EMC Support website at:https://support.emc.com

Revision historyThis revision history provides a description for each revision of this Administrationguide.

Table 1 Isilon Search Revision History

Revision Date Changes

02 April 28, 2017 Editorial changes.

01 March 30, 2017 Initial release of the IsilonSearch Installation andAdministration Guide.

PurposeThis document describes how to install, configure and use Isilon Search.

AudienceThis document is intended for an administrator who manages Isilon Search.

Related documentationThe Isilon Search documentation set includes the following publications:

l Isilon Search Installation and Administration Guide

l Isilon Search User Guide

l Isilon Search Security Configuration Guide

l Isilon Search Release Notes

Special notice conventions that are used in this documentDell EMC uses the following conventions for special notices:

Preface 7

https://support.emc.com/

NOTICE

Identifies content that warns of potential business or data loss.

Note

Contains information that is incidental, but not essential, to the topic.

Typographical conventionsDell EMC uses the following type style conventions in this document:

Table 2 Style conventions

Bold Used for names of interface elements, such as names of buttons,fields, tab names, and menu paths (what the user specifically selectsor clicks)

Italic Used for full titles of publications that are referenced in text

Monospace Used for:

l System code

l System output, such as an error message or script

l Pathnames, file names, prompts, and syntax

l Commands and options

Monospace italic Used for variables

Monospace bold Used for user input

[ ] Square brackets enclose optional values

| Vertical bar indicates alternate selections - the bar means “or”

{ } Braces enclose content that the user must specify, such as x or y orz

... Ellipses indicate non-essential information that is omitted from theexample

Where to get helpDell EMC support, product, and licensing information can be obtained as follows:

Product information

For documentation, release notes, software updates, or information about DellEMC products, go to the Dell EMC Support website at:

https://support.emc.com

Technical support

Go to the Dell EMC Support website, and then click Service Center. Severaloptions for contacting Dell EMC Technical Support appear on the site. To open aservice request, you must have a valid support agreement. Contact a Dell EMCsales representative for details about obtaining a valid support agreement or withquestions about an account.

Preface



Online communities

For peer contacts, conversations, content on product support and solutions, or tointeractively engage online with customers, partners, and certified professionalsfor all Dell EMC products, go to the Dell EMC Community Network at:

https://community.emc.com

CommentsSuggestions help to improve the accuracy, organization, and overall quality of the userpublications. Send opinions of this document to [email protected].

Preface

9

https://community.emc.com

mailto:[email protected]

Preface


CHAPTER 1

About Isilon Search

This section includes the following topics:

l About Isilon Search............................................................................................. 12l About the user interface..................................................................................... 15

About Isilon Search 11

About Isilon SearchIsilon Search is a virtual appliance that supports indexing and search across one ormore EMC Isilon clusters.

With Isilon Search you can perform the following actions:

l Index and search for files by name, location, size, owner, file type, and date.

l Index files within containers such as zip and tar files.

l Perform a targeted full content index (FCI) on search results to view a preview ofthe content and search for keywords and content inside.

l Perform advanced search queries including symbols, wildcards, filters, andoperators.

l Preview and download search results.

l Review the size the selected files or directories.

Product architectureIsilon Search is a pre-installed, Linux-based virtual appliance.

The following figures illustrate the architectural components of Isilon Search.

Figure 1 Isilon Search architecture

The following table describes Isilon Search components.

Table 3 Isilon Search components

Component Description

Elasticsearch A highly scalable, high performance full-text indexand search technology with built-in replication,capable of searching billions of objects withinseconds. Elasticsearch leverages Apache Lucenefor its indexes.

About Isilon Search


Table 3 Isilon Search components (continued)

Component Description

Common Index Service (CIS) An abstraction layer above Elasticsearch thatprovides the ability for multiple applications toshare the same Elasticsearch cluster, enablingcross-platform searches. CIS also provides asecurity layer above Elasticsearch to preventunauthorized access.

Worker Service A service that handles interactions with Isilonclusters. The Worker Service includes bothmetadata indexing like scanning and monitoringand search actions like downloading and fullcontent indexing.

Apache Tika An open source toolkit to extract full-text contentand application-specific metadata from a widevariety of file types.

NGINX web server An open source reverse proxy web server thathosts the web-facing components of IsilonSearch.

Isilon Search user interface The primary interface for administrators toconfigure Isilon Search and users to search,preview, and download indexed content.

LDAP Authentication Server Isilon Search includes a built-in OpenLDAPauthentication server with predefined users foradministration and search operations. AdditionalActive Directory and OpenLDAP authenticationsservers can be added after configuration.

Single-node or multi-node deploymentEach Isilon Search virtual appliance contains all the components that are required toprovide index and search operations. Additional nodes can be added to form an IsilonSearch cluster.

Add extra nodes to:

l Improve the speed of indexing, monitoring, and search queries

l Store more indexed metadata and full content indexed content

l Provide replication

The following image illustrates an example of a multi-node environment.

About Isilon Search

Product architecture 13

Figure 2 Multi-node environment

ReplicationAn Isilon Search cluster can include one or more nodes. Additional nodes improvesearch performance and provide the option for replication.

With the Isilon Application Administrator role, you can enable data index replication.Click Administration > Options > Index Options, and then toggle the Index replicaswitch to ON. The Index replica option is disabled by default.

If there is more than one Isilon Search node, system indexes are replicatedautomatically. Data indexes are only replicated when enabled.

Note

If there are multiple nodes, it is recommended that the Index replica option is not setto 0. If the Index replica option is not set, failover cannot occur.

About Isilon Search


Data flowThe following figure illustrates the flow of data within Isilon Search.

Figure 3 Data flow

About the user interfaceThe Isilon Search virtual appliance is accessed as a web based interface. Depending onyour user privileges, you can perform administration or search tasks.

Figure 4 Main Tabs

About Isilon Search

About the user interface 15

Administration windowsThe Administration windows provide the ability to administer, configure, andcustomize Isilon Search.

There are two main Administration window views:

l System Administration view

l Isilon Administration view

To select the System Administration view, select Manage > System.

To select the Isilon Administration view, select Manage > Isilon.

Figure 5 Toggling between the System Administration view and Isilon Administration view

Application Administration windowOnly an Application Administrator can access the Application Administration view.

The following figure shows the Isilon Search Application Administrator view.

Figure 6 Administration window

The following table lists and describes the sections of the Application Administrationwindow.

About Isilon Search


Table 4 Application Administration icons

Icon Description

View a summary of the health and status for the various Isilon SearchComponents.

Modify or enable the following:

l Container Indexing

l Index Options

l LDAP Options

l Notifications

l Search Options

Add, update, or remove source Isilon Clusters.

Manage access to individual indexes.

Assign the following roles:

l Search Admin—All Access

l Search Admin—Read Only

l Search User

Lists running and completed activities and jobs.

Details include type, status, and duration.

Add, update, or remove the following roles:

l Application Administrator

l Search Administrator

l Search User

Accessing the Administration window

The Isilon Search virtual appliance is accessed as a web-based interface. Dependingon your user privileges, you can perform administration or search tasks.

Note

To log in to the Administration window for the first time, use the default OpenLDAPuser Admin and the password that was configured during installation. Ensure thatcookies are enabled in the browser.

To perform administration tasks, you must be assigned one or both of the followingroles:

l System Administrator role

l Application Administrator role

About Isilon Search

Administration windows 17

Note

You must log in to the Isilon Search UI each time it is opened, or after an inactivitytime out of 20 minutes or more. The default inactivity timeout is 20 minutes.

To perform administration tasks, complete the following steps.

Procedure

1. In a web browser, type the following:

https://nodename/admin

For example:https://10.25.110.211/admin

https://IsilonSearch/admin

Note

You might be required to acknowledge a browser warning regarding self-signedcertificates before continuing.

2. To log in:

a. Type the username and password.

Note

The default username is Admin. A System Administrator or ApplicationAdministrator can assign roles to users.

b. Click Sign In.

The Administration UI opens.

3. To open the Administration window, click the following button:

The Administration window appears and displays the available menu icons.

4. To open the Search window, click the following button:

The Search window appears and displays the search options.

Note

Search cannot begin until at least one Isilon cluster has been indexed.

System Administration windowOnly a System Administrator can access the System Administration view.

The following figure shows the Isilon Search System Administrator view.

About Isilon Search


Figure 7 System Administration view

The following table lists and describes the sections of the System Administrationwindow.

Table 5 System Administration icons

Icon Description

View a summary of the health and status for the Isilon Searchsystem.

Modify or enable the following:

l Search Options

l LDAP Options

l Notification Options

Monitor Search nodes.

Add, update, or remove the System Administrator role.

About SearchesIsilon Search performs metadata searches on indexed files and folders, and performsfull content searches on files that have had their full content indexed. Isilon Searchsupports keyword and advanced Lucene search queries. Search results include asummary of certain fields for the file, such as file name, location, size, and date.

Consider the following:

l If a file is indexed for metadata, keywords or phrases that are found in the name ofthe file or path are highlighted.

l If a file is indexed for full content indexing (FCI), keywords or phrases that arefound in the body of the file are returned with a preview of the full contents. Thepreview displays, and highlights the words around the matched text.

About Isilon Search

About Searches 19

By default, the search is sorted by Relevance (score), which defines how well thesearch results match the search criteria.

Figure 8 Search window

Accessing only the Search windowThe Isilon Search virtual appliance is accessed as a web-based interface. Dependingon your user privileges, you can perform administration or search tasks.

To perform searches, you must be assigned one of the following roles:



l Search User

Note


To perform searches, complete the following steps.

Procedure


https://nodename/search

Note


2. To log in:

About Isilon Search



Note


b. Click Sign In.

The Search UI opens.

About Isilon Search

About Searches 21

About Isilon Search


CHAPTER 2

Installing Isilon Search


l System requirements......................................................................................... 24l Configuring DHCP server...................................................................................25l Configuring Static IPs........................................................................................ 25l Deploying the OVA in a single-node environment............................................... 26l Deploying the OVA in a multi-node environment................................................ 27l Logging in to Isilon Search for the first time...................................................... 30

Installing Isilon Search 23

System requirementsEnsure that the following system requirements are met before installing Isilon Search:

BrowsersThe following browsers are supported:

l Microsoft Internet Explorer 11

l The latest version of Google Chrome

l The latest version of Mozilla Firefox

Isilon SystemOneFS 7.2 or later with latest patches:

l OneFS 7.2.1.2 through 7.2.1.4 with patch 182136

l OneFS 7.2.1.5 and later (no patch required)

l OneFS 8.0.0.2, 8.0.0.3 with patch 182070


l OneFS 8.0.1.0 with patch 182925


To access these patches, go to the downloads page on the EMC support site.

VMwareThe following VMware requirements:

l 8 CPU

Note

Using fewer than 8 CPUs might decrease index and search performance.

l 32 GB of RAM

l VMware vCenter with VMware ESX 5.x or 6.x

l The virtual machine is preconfigured with three disks with a total of 150G space:

n Disk 1: 10 GB of system disk space

n Disk 2: 100 GB of index data space

n Disk 3: 30 GB of temporary space

l If required, to support a larger number of metadata files, the size of the index datadisk on Disk 2 can be increased.

Note

This step must be performed before the virtual machine is first started

Index disk size:

n 100 GB supports approximately 190 million files

n 250 GB supports approximately 650 million files

n 500 GB supports approximately 1.3 billion files

n 1 TB supports approximately 2.5 billion files

n 2 TB supports approximately 5 billion files



https://support.emc.com/downloads/15209_Isilon-OneFS%20

l Data disk space size requirements are based on the following projected number ofmetadata records:

n 100 GB for 190 million files

n 250 GB for 650 million files

n 500 GB for 1.3 billion files

n 1 TB for 2.5 billion files

n 2 TB for 5 billion files

Note

More disk space is required when implementing full content indexing. Whenexpanding the limit of the system, data of temporary drives, the partition limit is 2TB.

ReplicationAt least two Isilon Search nodes are required to leverage Elasticsearch replication.Single node configuration is supported.

If replication is enabled, disk requirements are doubled because each record is storedtwice, once on two separate nodes.

Static network settings or DHCPThe Isilon Search environment can use static network settings or DHCP.

If static network settings are used, the following information is required:

l Static IP

l Netmask

l Gateway

l Server Name

Configuring DHCP serverIf you are using a DHCP server, perform the following steps.

Procedure

1. Set up the DHCP server to dynamically update the DNS for clients that do notrequest updates.

2. Select the following option:

Dynamically update DNS A and PTR records for DHCP clients that do notrequest updates. For example, clients running Windows NT 4.0

Configuring Static IPsIf you are planning a multi-node deployment environment, configure the DNS serverwith the node names and IPs of all the nodes you plan to deploy.

Configuring Static IPs is not required for a single node deployment, but it isrecommended.


Configuring DHCP server 25

Deploying the OVA in a single-node environmentEach Isilon Search virtual appliance contains all of the components that are required toprovide index and search operations. Additional nodes can be added to form an IsilonSearch cluster.

Deploy the Isilon Search OVA on a VMware vSphere client. Refer to the VMwaredocumentation for specific information regarding how to deploy an OVA template.

Procedure

1. Download the OVA package from the Dell EMC Online Support site:


2. Log in to the vSphere client.

Note

Ensure that the vSphere client is connected to vCenter, not an ESXi host.Deploy the Isilon Search OVA to vCenter Server, not to bare metal ESXi, ornon-VMWare solutions.

3. Select a server.

4. Deploy an OVA template:

a. Accept the end user license agreement.

b. Select the virtual disk format.

When selecting the virtual disk format, the Thick Provision LazyZeroed option is recommended.

Note

The Thick Provision Eager Zeroed option yields the bestperformance but also take the most time to initialize. Thick provisioning doesnot fill the drive unless eager zeroed is selected.If thick provisioning is selected, the storage capacity for the entire virtualdisk is allocated on the data store at virtual disk create time. With Thinprovisioning, the capacity on the data store is allocated to the virtual disk asrequired, up to the file size of the virtual disk.

5. For the first node in the cluster specify the following network properties:

a. In the Zinc Master field, ensure the option True is selected.

b. In the Zinc Master Address field, leave the option blank.

6. For the Root Password field, specify the root password to be used for initiallogin.

7. For the Administrator Password field, specify the administrator password.

8. For the Time server field, specify the Time server.

9. For the Time Zone field, specify the time zone for the Isilon Search node.

10. If using DHCP, in the DHCP mode field, leave the default setting set to True.

11. If using static IPs, configure the following fields:




a. For the DHCP mode field, select False.

b. For the Network Address field, specify an IP address and a Netmask.

c. For the Default Gateway field, specify a network gateway address.

d. For the DNS field, specify one or more DNS servers.

Note

Configure the DNS server with the node name and IP of the node that youplan to deploy.

12. For the Network IP address field, specify an IPv4 address.

(Optional) To support a mixed mode, you can specify an IPv6 address.

a. Specify an address and gateway for IPv6 addresses in the following fields:

l Network IPv6 Address

l Default IPv6 Gateway

Note

If IPv6 is not required, leave these fields blank.

b. To resolve the hostname of the appliance to the IP address, use thenslookup command.

c. Specify the IPv6 address in the format that appears in the nslookupoutput.

d. If the nslookup output returns the expanded form of the IP address,(2620:0000:0170:0714:6d63:c749:beec:c2e4), do not specify thecompressed form of the IP address (2620:0:170:714:6d63:c749:beec:c2e4).

13. In the Ready to Complete window:

a. Review the settings.

b. Click Finish.

14. Power on the OVA.

The first time the OVA is started, it might take several minutes to load. Thevirtual machine might automatically restart one or more times during theinstallation process.

Deploying the OVA in a multi-node environmentEach Isilon Search virtual appliance contains all of the components required to provideindex and search operations. Additional nodes can be added to form an Isilon Searchcluster.

Add extra nodes to:

l Improve the speed of indexing, monitoring, and search queries

l Store more indexed metadata and full content indexed content

l Provide replication


Deploying the OVA in a multi-node environment 27

If planning a multi-node deployment environment, configure the DNS server with thenode names and IPs of all of the nodes that you plan to deploy.

Deploying the master nodeDeploy the Isilon Search OVA on a VMware vSphere client. Refer to the VMwaredocumentation for specific information regarding how to deploy an OVA template.

Procedure

1. Download the OVA package from the Dell EMC Online Support site:


2. Log in to the vSphere client.

Note

Ensure that the vSphere client is connected to vCenter, not an ESXi host.Deploy the Isilon Search OVA to vCenter Server, not to bare metal ESXi, ornon-VMWare solutions.

3. Select a server.

4. Deploy an OVA template:

a. Accept the end user license agreement.

b. Select the virtual disk format.

When selecting the virtual disk format, the Thick Provision LazyZeroed option is recommended.

Note

The Thick Provision Eager Zeroed option yields the bestperformance but also take the most time to initialize. Thick provisioning doesnot fill the drive unless eager zeroed is selected.If thick provisioning is selected, the storage capacity for the entire virtualdisk is allocated on the data store at virtual disk create time. With Thinprovisioning, the capacity on the data store is allocated to the virtual disk asrequired, up to the file size of the virtual disk.

5. For the first node in the cluster specify the following network properties:

a. In the Zinc Master field, ensure the option True is selected.

b. In the Zinc Master Address field, leave the option blank.














Note

Configure the DNS server with the node names and IPs of all the nodes thatyou plan to deploy.






Note





Adding more Isilon Search nodesUse the following procedure to deploy additional nodes.

Before you begin

When deploying additional nodes, ensure that the following requirements are met:

l The deployment of the master node is complete.

l The DNS/DHCP servers have been configured, as described in previousprocedures.

Procedure

1. In the Zinc Master field, set the checkbox to False.

2. In the Zinc Master Address field:

a. Specify the name of the master node that was first deployed.

b. Ensure that there is a DNS record for all records including the master node.





Adding more Isilon Search nodes 29








Note

Configure the DNS server with the node names and IPs of all the nodes thatyou plan to deploy.






Note





10. Power on the OVA.

Wait for the new node to appear. This process may take up to ten minutes.

Logging in to Isilon Search for the first timeBefore you begin

Wait a minimum of 10 minutes after the deployment has finished before attempting tolog in. If sufficient time has not elapsed, the web page might not appear, or login triesare rejected.

If an OVA installation was performed, ensure that the virtual machine where the OVAfile that was deployed is powered on.

To ensure that Isilon Search was deployed successfully, perform the following steps.Procedure


https://<node>/admin



The Login page appears.

Note

You might be required to acknowledge a browser warning regarding self-signedcertificates before proceeding.

2. To log in to the UI, type the username and password.

a. For the Username field, type the following:

Admin

b. For the Password field, type the root password that was specified whendeploying the OVA.

Results

After installation, to manage user accounts and roles, you can add one or moreadditional directory servers.

Supported directory server types include the following:

l Open LDAP

l Microsoft Active Directory server (AD)


Logging in to Isilon Search for the first time 31

CHAPTER 3

Configuring Isilon Search


l Accessing the Administration window................................................................ 34l Configuring an Isilon source............................................................................... 35l Viewing the status and summary of the source.................................................. 43l Rescanning the source and updating the index.................................................. 43l Configuring LDAP and AD.................................................................................. 44l Managing Indexes.............................................................................................. 46l Managing notifications.......................................................................................49l Configuring container indexing (zip and tar files)............................................... 51l Enabling index replication for data indexes.........................................................52l Enabling search operations on SmartLink files................................................... 53l Setting search timeout options.......................................................................... 53l Optimizing search performance......................................................................... 54l Configuring Full Content Indexing......................................................................54

Configuring Isilon Search 33

Accessing the Administration windowThe Isilon Search virtual appliance is accessed as a web-based interface. Dependingon your user privileges, you can perform administration or search tasks.

Note

To log in to the Administration window for the first time, use the default OpenLDAPuser Admin and the password that was configured during installation. Ensure thatcookies are enabled in the browser.

To perform administration tasks, you must be assigned one or both of the followingroles:

l System Administrator role

l Application Administrator role

Note


To perform administration tasks, complete the following steps.

Procedure


https://nodename/admin

For example:https://10.25.110.211/admin

https://IsilonSearch/admin

Note


2. To log in:


Note


b. Click Sign In.

The Administration UI opens.

3. To open the Administration window, click the following button:

The Administration window appears and displays the available menu icons.





Note

Search cannot begin until at least one Isilon cluster has been indexed.

Configuring an Isilon sourceFollow the procedures in this section to configure an Isilon source.

Creating an SMB share on /ifsTo download files and access them for full content indexing, create a share on OneFS.

Procedure

1. Create a share on /ifs.

2. Name the share:

l For versions of OneFS that support $, name the share zinc$.

l For versions of OneFS that do not support $, name the share zinc.

Note

Use zinc$ unless you are using a version of OneFS that does not supportzinc$.

Adding an Isilon user account for a dedicated Isilon Search userProcedure

1. Configure permissions for Isilon Search:

a. Start the OneFS software on the Isilon cluster.

b. Create a user with the following privileges:

Table 6 User privileges

Name Description Access

Platform API Log in to Platform API andWebUI

Read-Only

Auth Configure identities andauthentication sources

Read-Only

Audit Configure audit capabilities Read-Write


Configuring an Isilon source 35

Table 6 User privileges (continued)


Note

If real time monitoring isnot required, set the Auditprivilege to Read-Only.

CloudPool Configure CloudPools Read-Only

Network Configure networkinterfaces

Read-Only

SMB Configure SMB server Read-Only

Smartpools Configure Smartpools Read-Only

Statistics View file systemperformance statistics

Read-Only

Namespace Traverse Traverse and view directorymetadata

Read-Only

Namespace Access Access /ifs via RESTfulAccess to Namespaceservice

Read-Only

2. To download or perform a full content index (FCI) of a file:

a. Assign the dedicated Isilon Search user with the following access level:

run as root read-only

b. Provide the dedicated Isilon Search user with access to one of the followingshares:

l /zinc$ sharel /zinc share

Adding the source Isilon clusterIn the Isilon Search Admin UI, identify one or more source Isilon clusters to be indexed.Indexing begins automatically after a source has been added.

You can only add an Isilon source cluster with the Application Administrator role.

Procedure

1. To select the Isilon Administration view, select Manage > Isilon from the topright of the Admin UI.

2. Select Administration > Sources.

3. To add a source, click the following button:

The Add Source window appears.



4. The Platform field is set to Isilon.

This field cannot be modified.

5. In the Name field:

a. Type a display name to easily identify the Isilon cluster.

b. Ensure that the name meets the following requirements:

l Between 1 to 50 characters in length.

l No spaces are permitted in the name.

l The name must be combination of the following English characters,symbols, and numbers:

n Lowercase characters (a-z)

n Uppercase characters (A-Z)

n Numeric characters (0-9)

n Dash (-)

n Underscore (_)

6. In the Hostname field, type the fully qualified Smart Connect hostname of theIsilon cluster by using one of the following formats:

l IP address

l FQDN

7. In the Port field, leave the default entry unless the Isilon cluster has beenconfigured with a different port.

8. In the User ID field:

a. Type the account name of the user that you created for Isilon Search in theprevious procedure.

This account should have the following permissions:

Table 7 User privileges


Platform API Log in to Platform API andWebUI

Read-Only

Auth Configure identities andauthentication sources

Read-Only

Audit Configure audit capabilities Read-Write

Note

If real time monitoring isnot required, set the Auditprivilege to Read-Only.

CloudPool Configure CloudPools Read-Only

Network Configure networkinterfaces

Read-Only


Adding the source Isilon cluster 37

Table 7 User privileges (continued)


SMB Configure SMB server Read-Only

Smartpools Configure Smartpools Read-Only

Statistics View file systemperformance statistics

Read-Only

Namespace Traverse Traverse and view directorymetadata

Read-Only

Namespace Access Access /ifs via RESTfulAccess to Namespaceservice

Read-Only

b. Ensure that the account has full access to either of the following shares:

l /zinc$ sharel /zinc share

9. In the Password field, type the password for the corresponding user asidentified in the User ID field.

10. Continue the configuration steps for selecting an analyzer.

Selecting an analyzerThe analyzer is the criteria or language that the content is indexed with.

Although the default standard analyzers are recommended for the majority of usecases, advanced users can select different analyzers for specific indexes.

Procedure



The list of Isilon clusters appears.

3. Select the Isilon cluster and click the following button:


4. In the Analyzer field specify the criteria or language that you would like to use:

Option Description

Standard l Default analyzer

Simple l Includes lowercase words

l Disregards numeric values

l Splits text into tokens for non-letter characters



Option Description

Whitespace l Does not support lowercasing

l Splits text into tokens for whitespace characters

Languages l Supports language-specific stop words

l Supports stemming

5. Continue the configuration steps for adding a source.

Managing Protocol Audit MonitoringThe Protocol Audit Monitoring feature uses the OneFS software on the Isilon clusterto send events when a change occurs in the file system to Isilon Search through theCommon Event Enabler (CEE).

To keep the Isilon Search index updated with file system changes, enable the ProtocolAudit Monitoring feature. When enabled, Isilon Search automatically configures theIsilon cluster for Protocol Audit Monitoring and CEE forwarding.

If required, you can disable the Protocol Audit Monitoring feature and trigger manualrescans to keep the index updated with changes that occur after that initial scan.

Consider disabling the Protocol Audit Monitoring feature for the following reasons:

l CEE forwarding is already configured for another third-party application.

l The extra load on the Isilon of Protocol Audit Monitoring is not desirable.

l An updated index is not required after a system change occurs.

OneFS ConsiderationsIf using the Protocol Audit Monitoring feature on Isilon nodes running the followingOneFS versions, consider the following:

l For Isilon nodes running OneFS versions earlier than 8.0.1, if events are generatedat a faster rate than the Isilon cluster can forward, an index backlog might occur.

Isilon nodes are limited to sending up to 8 million audit events per day. If more than8 million events are generated, Isilon Search index rescans are required to updateindexes.

l For Isilon clusters running OneFS versions 8.0.1 or later, the Isilon Search systemmight not be able to process incoming events fast enough.

If the Isilon Search system is unable to process the rate of delivered events,incoming queues overload the system and the CEE service drops events. IsilonSearch index rescans are required to resynchronize indexes.

Note

Protocol Audit Monitoring only tracks changes that occur on the SMB/CIFS and NFSshares. Changes that are made through other methods, such as FTP, HTTP, or byusing the local terminal, are not updated in the index.

Use the following procedures in the sections that follow to enable or disable ProtocolAudit Monitoring.


Managing Protocol Audit Monitoring 39

Enabling the Protocol Audit Monitoring featureSelect the Protocol Audit Monitoring feature to enable auditing and Common EventEnabler (CEE) forwarding from the Isilon cluster to Isilon Search.

To keep Isilon Search indexes updated with file system changes, perform the followingsteps.

Procedure






4. For the Protocol Audit Monitoring field, select Enable.

Isilon Search performs the following actions:

a. Checks to determine if auditing and CEE forwarding have been enabled onthe Isilon cluster.

b. Adds all Access Zones to the audited Zones list.

c. Adds Isilon Search nodes to the list of CEE servers.

5. If existing CEE forwarding servers are detected, perform one of the followingactions:

l To keep the existing CEE URIs and disable protocol audit monitoring:

a. Select Keep the CEE forwarding settings.

b. Follow the procedure to disable protocol audit monitoring for IsilonSearch.

l To overwrite the existing CEE URIs with the Isilon Search CEE URIs, selectSet events forwarding URL to Isilon Search CEE Server.

Note

Overwriting the existing CEE URIs is not recommended. If the settings areoverwritten, the current application that it is configured with will not workcorrectly.


Disabling the Protocol Audit Monitoring featureUse this procedure to disable automatic index updates when the file system ischanged. If auditing is configured for another software program, disable the ProtocolAudit Monitoring feature.

Disabling protocol audit monitoring decreases the workload on the Isilon clusterbecause the Isilon cluster does not need to process and forward audit messages fromIsilon Search each time the file system is updated.



Procedure






4. In the Add Source window, ensure that the Protocol Audit Monitoring field isnot enabled.

5. Click Confirm.


Indexing files within containersWhen enabled, the Indexing files within containers feature indexes the metadata of allthe files (.zip, .tar, .gz, .tgz) and folders inside a container. By default, thisfeature is disabled when adding a source.

This feature is separate from the initial scan, because it implements lazy indexingwhere containers are processed in the background after a scan completes.

Procedure






4. In the Files Within Containers field, click Enable.


Setting connection limitationsUse the following procedure to restrict the number of connections that are madeacross all Isilon Search nodes.

Procedure






Indexing files within containers 41


4. In the Connection Limitation field, click Enable.

Note

The Connection Limitation is disabled by default.

5. In the Indexing field, type a numeric value for the number of concurrent searchoperation connections, which include download or full content indexing (FCI),that are allowed to the Isilon cluster.

6. In the Action field, type a numeric value for the number of search actions thatare allowed to the Isilon cluster.


Setting the blackout window for indexingUse the following procedure to restrict indexing during a certain time period by settinga blackout window.

Enabling this option prevents Isilon Search from interacting with the Isilon clusterduring specific hours each day. By default, the blackout window applies to all activitiesincluding indexing, monitoring, and search actions. However, the blackout window canbe applied only to full content indexing actions. Full content indexing can involvereading the entire file content.

Procedure


2. Selecting Administration > Sources.




4. In the Blackout Window field, click Enable.

5. Specify the time range.

Note

If the Only apply to full-content indexing box is selected, operations thatcollect metadata which include scan and rescan, can run at any time, includingthe blackout window. Only full content indexing is restricted during thisblackout window.

6. Click Connect.

The Isilon cluster is now available in the list of servers in Sources window.When a server is added, a system job is added to register the Isilon node andindexing begins.



Viewing the status and summary of the sourceView the configuration details of the source Isilon cluster.

You can only view a summary of the Source from the Application Administrator role.

Procedure

1. In the Administration window, select Manage > Isilon.

The Isilon Administrator view appears.


The Sources window appears.

3. Select the source.

4. Click the Details button:

A summary of the source details appears.For Isilon clusters with OneFS 8.0 or later, the summary includes an estimate ofthe number of files on the cluster and the time remaining to complete the scan.The number of displayed files includes snapshots and other file types that arenot scanned by Isilon Search, which results in a higher than accurate file count.

Rescanning the source and updating the indexYou might need to rescan the source and update the indexes in the followingscenarios:

l The Protocol Audit Monitoring feature has been disabled, and you want to updatethe index with the latest changes.

l You have restored from a disaster recovery event and must update the index fromthe point that the index was last snapshot.

l If changes were made on the Isilon through FTP or HTTP, because the CommonEvent Enabler (CEE) monitoring code does not catch those changes.

l If monitoring the system is interrupted.

l If monitoring the system is disabled.

You can only rescan a source from the Application Administrator role. You cannotrescan a source while another scan is in progress.

Procedure





4. Go to the Scan Summary section.


Viewing the status and summary of the source 43

5. Select Trigger scan jobs.

6. Select one of the options for the duration of time:

l Hours

l Days

l Weeks

l Months

7. In the Rescan all file/folder changes in the last field, specify a timeframe.

Note

The timeframe refers to a period during which data was added to, removedfrom, or changed on the OneFS file system. The timeframe does not refer tothe last modified date.

8. Click Trigger.

Configuring LDAP and ADIsilon Search comes with a built-in OpenLDAP service with preconfigured accounts.For example, the Admin user. The default Admin user is not configured with an emailaddress and cannot receive email notifications.

With the System Administrator role, you can add additional LDAP or AD services todefine additional users who can administer Isilon Search and perform searchoperations.

Isilon Search does not authenticate the user against the LDAP authority. TheAuthentication Service uses the UUID of either the user or the group that the userbelongs to is used in the external authority. When authentication succeeds, theAuthentication Service issues a token for the user. The GUI uses the token informationto ensure that the user can perform only the activities that the user has privileges toperform.

You can only configure LDAP and AD users with the Application Administrator role.

Procedure

1. In the Administration window, select Manage > System.

The System Administrator view appears.

2. Select Administration > Options > LDAP Options.

The LDAP Options window appears.

3. To add an LDAP server, click the following button:

The Add LDAP Configuration window appears.

4. In the Name field, type the LDAP configuration name.

5. In the Server Type field, select either of the following authentication types:

l Active Directory

l OpenLDAP



6. In the LDAP Server field, type either of the following:

l Hostname of the LDAP or AD server

l IP address of the LDAP or AD server

7. In the LDAP port field, type the port number that is used by the externalauthentication authority.

For LDAP, the default port number is 389.

For SSL, the default number for LDAPS changes to 636 when True is selected.

8. In the Base DN field, type the scope of the users and groups that areconsidered within the LDAP server.

For example:

DC=example, DC=comThe Base DN determines the structure of the LDAP server where the searchfilter is applied. This is usually similar to the domain name over which the LDAPserver has authority.

9. In the Username field:

a. Type a user account that has full read access to the LDAP or AD directory, inthe following format:

[email protected] example, [email protected]

b. For Active Directory, ensure that the username is one of the following:

l Common name

l Email address

l Display name

l User principle name (UPN)

l Same account name

l Distinguished name (DN)

c. For OpenLDAP, ensure that the username is one of the following:

l Common name

l Email address

l Entry distinguished name

d. Ensure that the user has read access to the directory.

e. To include email notification, define the email address for the account.

Note

Only admin accounts with defined email addresses can receive emailnotifications. The default admin user is not configured with an email addressand cannot receive email notifications.

10. In the Password field, type the password of the user account that you specifiedin the Username field.


Configuring LDAP and AD 45

11. In the SSL field, select either of the following options:

l To connect to an external authentication server using LDAPS, select True.

The default port number automatically changes to 636.

l To not apply secure connection settings, select False.

12. In the Default field, leave the option set to False.

Default refers to the Isilon Search built-in OpenLDAP server.

13. To test the connection, click Test Connection.

14. Click Save.

Managing IndexesAfter a source is added, indexing begins automatically. This section describes how torename an index, restrict access to an index, and view an index.

Indexing overviewIndexing extracts metadata and content from files and stores them in indexes. You canspecify the user and groups that can access them.

An index may be one of the following types:

l Metadata-only indexing allows for the search of basic file attributes which includethe following:

n File name

n File type

n Path

n Size

n Date last modified

n Date created

n Date last accessed

n Owner or Group ID

n Access Mode

Metadata-only indexing does not index the content of the files.

l Full content indexing allows for the search of any text inside a file, in addition tobasic file attributes.

Restricting index accessRestrict index access to limit the users of groups that can search the content.

As an Application Administrator, you can restrict the indexes that a user or user groupcan access from the Search window.

Procedure



2. Ensure that the user or group has been added as an Active Directory orOpenLDAP source.



3. Select Administration > Indexes.

The list of indexes appears.

4. Select the Index that you would like to give the user or group access to.

5. To manage search roles, click the following button:

The Manage Search Roles window appears.

6. Click the add button:

The Select User window appears.

7. In the Select User window, perform the following steps:

a. In the Name field, restrict the search to one of the following categories:

l Users or Groups

l Users

l Groups

b. Type the name of the user or group.

c. In the Directory field, select one of the configured LDAP servers.

d. Click Find.

The list of user or user groups appears.

Note

If you click Find before specifying a substring, the entire directory is returned,which might be slow. For example, to search for all users that contain Admin,type Admin, and click Find.

8. Select a user or group, or select Select all, and then click OK.


9. To assign roles to a user or group, select one of the following options:

Option Description

Search Admin—All access

l No restrictions

Search Admin—Read only

l Cannot see inline preview for hits

l Cannot view full preview for hits

l Cannot download files locally

Search User l A specified user can only see the files that they ownand have access rights to through a configuredCIFS/SMB share.


Restricting index access 47

Option Description

l A specified user can perform all actions on the filesthat they own

Viewing indexesIndexes hold the indexed metadata and content extracted from the Isilon cluster.There is one index created for each Isilon cluster. You can specify the users andgroups that have access to the index.

You can only view Indexes with the Application Administrator role.

Procedure




The Index window appears.

For each index, the following information is displayed:

l The name and description of the index

l The size of the index

l The number of items in the index

l The date and time the index was created

l The analyzer that is used

l The current scan status

l The date of the last completed scan

Updating an indexYou might need to rescan the source and update the indexes in the followingscenarios:

l The Protocol Audit Monitoring feature has been disabled, and you want to updatethe index with the latest changes.

l You have restored from a disaster recovery event and must update the index fromthe point that the index was last snapshot.

l If changes were made on the Isilon through FTP or HTTP, because the CommonEvent Enabler (CEE) monitoring code does not catch those changes.

l If monitoring the system is interrupted.

l If monitoring the system is disabled.

You can only rescan a source from the Application Administrator role. You cannotrescan a source while another scan is in progress.

Procedure







4. Go to the Scan Summary section.

5. Select Trigger scan jobs.

6. Select one of the options for the duration of time:

l Hours

l Days

l Weeks

l Months

7. In the Rescan all file/folder changes in the last field, specify a timeframe.

Note

The timeframe refers to a period during which data was added to, removedfrom, or changed on the OneFS file system. The timeframe does not refer tothe last modified date.

8. Click Trigger.

Managing notificationsNotifications alert you to activities, issues, and events within the Isilon Search systemand Isilon cluster.

This section describes how to configure system, Isilon cluster, and email notifications.

Configuring System notificationsSystem notifications provide information on issues with the system at the cluster,node, index, and service levels.

You can only configure and view System notifications with the System Administratorrole.

Procedure



2. Select Administration > Options > Notification Options.

The Notification Options window appears.

3. Click to toggle the Notification switch to ON.

Notifications are enabled (ON) by default.

4. Select one or more of the following categories that you would like to receivenotifications for:

l Cluster

l Node


Managing notifications 49

l Index

l Service

5. Select the preferred language.

6. To configure email notifications, click to toggle the Email switch to ON.

Email notifications are disabled (OFF) by default.

7. Configure the following fields:

l Host (IP of the SMTP host)

l Port (Set a port, typically 25 or 587)

l User (An account authorized to connect to the SMTP service)

l Password

8. Click Save.

Results

Email Notifications take effect 15 minutes after this setting is enabled.

Configuring Isilon notificationsIsilon notifications alert you to index events, issues with the Isilon source cluster, andthe status of search action events.

You can only configure and view Isilon notifications with the Isilon Administrator role.

Procedure





3. Click to toggle the Notification switch to ON.

Notifications are enabled (ON) by default.

4. Select one or more of the following categories that you would like to receivenotifications for:

l Index

l Source

l Job

5. Select one or more of the following job types that you would like to receivenotifications for:

l Scan

l Monitor

l Rescan

l FCI (full content indexing)

l Download

6. Select the preferred language.

7. To configure email notifications, click to toggle the Email switch to ON.








l Password

9. Click Save.

Results


Configuring Email notificationsYou can configure Isilon Search to send email notifications to specified SMTP usersand hosts.

Note

The default admin user is not configured with an email address and cannot receiveemail notifications.

Procedure



2. Click to toggle the Email switch to ON.






l Password

4. Click Save.

Results


Configuring container indexing (zip and tar files)When enabled, the Indexing files within containers feature indexes the metadata of allthe files (.zip, .tar, .gz, .tgz) and folders inside a container. By default, thisfeature is disabled when adding a source.


You can only configure container indexing with the Application Administrator role.

Procedure

1. Ensure that the Files Within Containers option was enabled for the sourceIsilon cluster.


Configuring Email notifications 51

2. Select Administration > Options > Container indexing.

The Container Indexing Options window appears.

3. In the Maximum container size to download for metadata indexing field,specify the maximum file size.

4. In the Maximum depth of embedded container to index field, specify thenumber of levels of zip files that should be indexed. For example, a .tar filewithin a .zip file within a .gz file equals two levels.

5. To determine the container types that are indexed, review the SupportedContainers field:

Supported containers include:

l .zipl .tarl .gzl .tgz

6. Click Save.

Enabling index replication for data indexesIf you have more than one Isilon Search node, you can enable replicas. Indexreplication keeps a redundant copy of index data that is spread over available nodesfor high availability. If one node fails, the indexes are still available. However, if theMaster node is down, the system will not work correctly. Replication requires thedeployment of at least two indexing nodes. If more than one Isilon Search node isconfigured, system indexes are automatically replicated.

Each index is divided into shards. The shards are distributed over the available indexnodes. If the index replica feature has been enabled, each primary shard has a replicashard. Replica shards must be stored on a different node from the correspondingprimary shard.

When an Elasticsearch node becomes unavailable, replica shards are automaticallypromoted to replace any unavailable primary shards without required administratorinteraction.

System data is automatically replicated when there is more than one Isilon Searchnode configured. However, replication for data indexes is disabled by default.

Note

Enabling replication for data indexes doubles the amount of data and therefore theamount of space used.

Procedure

1. Select Administration > Options > Index options.

The Search Options window appears.

2. Click to toggle the Index replica switch to ON.

3. Click Save.



Enabling search operations on SmartLink filesIsilon Search supports the ability to move file data to the cloud. When a file is movedoff the Isilon cluster, a stub file that acts as a pointer to the file's new location is leftbehind. This stub file is called a SmartLink file. Support for stub files is disabled bydefault.

If the Support actions for stubbed files option is enabled, Isilon Search triggers theIsilon cluster to retrieve the file that is linked to the SmartLink file from the remotelocation. A search user can download, preview, or perform a full content index on thefile.

To prevent unwanted recalls of data from cloud storage, Isilon Search skips stubbedfiles for the following operations:

l Download

l Full content index (FCI)

Procedure



2. Select Administration > Options > Search Options.


3. To enable search actions on stub files, select Yes in the Support actions forstubbed files field.

Setting search timeout optionsThe search timeout option sets a limit on the duration of a search operation.Only the System Administrator role can set search timeout options.

Procedure


The System Administration view appears.

2. Select Administration > Options > Search Options.


3. To set a limit on the duration of a search operation, specify a time in seconds inthe Search timeout field.

If a search operation is not completed in the time that is specified, a warningmessage is displayed indicating that results are incomplete.

4. To set a limit on the time it takes to build a visual filter graph from the searchresults, specify a time in seconds in the Aggregation search timeout field.


l Visual filter graphs require that matching items from the current search areaggregated.

l If a visual filter is not completed in the time that is specified, the currentresults display with a warning message indicating that the results areincomplete.


Enabling search operations on SmartLink files 53

Figure 9 Visual filter graphs examples

Optimizing search performanceAt the core of Isilon Search is Elasticsearch, a high performance indexing and searchsystem capable of searching billions of objects within seconds.

To leverage Elasticsearch replication at least two nodes are required, although a singlenode is supported.

To further increase the speed at which search results are returned, observe thefollowing best practices:

l Use search filters to narrow the search scope, and limit the number of results.

l Only add specific queries if you know the details of the content that you arelooking for.For example, specify the file type, date, and owner using the search filters insteadof typing them directly into the Search bar.

l Limit the number of simultaneous queries by different users.

Configuring Full Content IndexingThe sections that follow describe the Full Content Indexing (FCI) feature and how toconfigure FCI options.

About Full Content IndexingIsilon Search performs metadata searches on indexed files and folders, and performsfull content searches on files that have had their full content indexed. Isilon Searchsupports keyword and advanced Lucene search queries. Search results include asummary of certain fields for the file, such as file name, path, size, date, andownership. By default, the search is sorted by Relevance (score), which defines howwell the search results match the search criteria.


l If a file is indexed for metadata, keywords or phrases that are found in the name ofthe file or path are highlighted.Search results include a summary of certain fields for the file, such as file name,path, size, date, and ownership.



l If a file is indexed for full content, keywords or phrases that are found in the bodyof the file are returned with a preview of the full contents.The preview displays and highlights the words around the matched text.

FCI Use casesIf two billion files have been indexed with Isilon Search, you might want to only fullcontent index two million of those files. File types that you might want to full contentindex include Microsoft Office documents, PDF, and text files.

If you do not recall the name of a particular file, you can use FCI to search for a certainkeyword that exists inside the file. Processing the full content of a large number offiles can be time consuming and take up significantly more space in the index,depending on the type and size of the files that are processed.

Updated contentWhen a file is full content indexed, the state of the file is classified as sticky. If anychanges are made to the file, its full content is updated in the index. However, sincefiles might be edited many times in a typical day, the process to index the new contentonly runs once each day. A lag might exist in the updates that reach the index.


l Some applications do not modify existing files when edits are made. Theseapplications, like Microsoft Office, create files, rename the old versions, and thendelete them. In these cases, since the file is new, it is not automatically full contentindexed.

l A new FCI job can be applied to files at any time. Any files that are already fullcontent indexed are skipped.

Amount of Index space used and Full Content IndexingThe metadata for each indexed object typically takes up a few hundred bytes, with anyvariation depending mostly on the path length. By contract, the size that is used byfull content indexing can vary widely depending on the amount of text in the file.

The amount of index space that is used by the full content indexing (FCI) featurediffers depending on the file type.

Table 8 File Type Index Space for FCI

File Type Index Size Requirements

Video file A 20 GB video file might only take up a couple of kilobytes whichreflects the video metadata in the file.

Text file If the FCI preview option is enabled, a 15 KB text file might take up 30KB or more of index space.

Microsoft Officedocuments

The amount of index space that is used is usually smaller than the filesize because pictures and other formatting are removed.

PDF The amount of index space that is used is usually smaller than the filesize because pictures and other formatting are removed.

Note

The amount of index space that is used is usually smaller than the file size becausepictures and other formatting are removed.


Amount of Index space used and Full Content Indexing 55

To manage low disk space, add additional nodes that have the same disk space withexisting node. For example, an Isilon Search cluster already has three nodes with eachnode containing a 500 GB disk, add one or more nodes with a 500 GB disk to thecluster.

Application-specific metadataIn addition to the basic file system metadata that is stored in the index, full contentindexing reads additional application-specific metadata for processed files whereavailable.

Examples of application-specific metadata include the following:

l Author

l Title

l Title and artist for audio files

l Word-count for Microsoft Office files

l Camera name

l Resolution for image files

Limiting files that are full content indexedSet limits to further increase the speed of full content indexing and limit the size ofthe index.

Procedure

1. Select Administration > Options > Full Content Indexing.

The Full Content Indexing Options window appears.

2. To set a limit on the maximum file size within the index, in the Maximum itemsize to full content index field, specify the maximum file size.

Note

Files over the maximum item size are skipped during full content indexing.

3. To display preview text in the search results, in the Include preview textduring FCI field, select Yes.

Note

Disabling this option reduces the size of the index and also makes the fullcontent indexing process slightly faster. By default, up to 20 KB of preview textfor any file full content indexed is stored in the index. You can display thepreview text without reaching back out to the Isilon cluster. For image files, asmall thumbnail of the image is stored.

4. In the Max preview size field, specify the maximum size of the preview text.

Note

Any additional text over the maximum preview size is truncated.

5. To process all files, select Processes all files.



6. To exclude certain file types:

a. Select Processes all files.

b. Select Exclude the types below.

The following file types are excluded:

l .jarl .logl .jsonl .exel .dlll .obj

7. To include only certain file types, select Include only the types below.

The following file types are included:

l .docx, .docl .xlsx, .xlsl .txtl .pdfl .html


Limiting files that are full content indexed 57

CHAPTER 4

Managing Roles and Users


l About Roles....................................................................................................... 60l Managing roles...................................................................................................72l Configuring LDAP and AD.................................................................................. 75

Managing Roles and Users 59

About RolesA role is a set of privileges that are defined by the role.

When you configure the Isilon virtual appliance, there are already predefined usersfrom an OpenDLAP.

System Administrator roleOnly a System Administrator can assign another System Administrator role.

The System Administrator can:

l Assign the System Administrator role to other users and groups

l View the system health

l Configure and view system notifications

l Manage LDAP sources

Assigning the System Administrator role

Only a System Administrator can add another System Administrator role.

Procedure


The System view appears.

2. Select Administration > Roles.

The Manage Application Admins window appears.

3. Click the following button:




l Users or Groups

l Users

l Groups



For example, the following options might appear:

l Default OpenLDAP server

l 3 AD directories

l 2 OpenLDAP directories

d. Click Find.




Note

If you click Find before specifying a substring, the entire directory is returned.This action might slow performance.For example, to search for all users that contain Admin:

a. Type Admin.

b. Click Find.

5. Select a user, group, or click Select all.


6. To assign the role to the user or group that has been added, select SystemAdministrator.

Application Administrator roleThe Application Administrator can manage Isilon specific configurations.

Only an Application Administrator can assign another Application Administrator role.

The Application Administrator can perform the following tasks:

l Assign the following roles to users and groups:

n Application Administrator

n Search Administrator

n Search User

l View the status of jobs on the Isilon cluster

l Manage search roles for an index including the following:

n Search Admin—All Access

n Search Admin—Read Only

n Search User

l Add or edit a source Isilon cluster

l Manage LDAP sources

l Configure and view Isilon cluster notifications

l View the health of the Isilon cluster


Application Administrator role 61

Figure 10 Manage Application Admins

Assigning the Application Administrator role

Only an Application Administrator can assign the Application Administrator role.

Procedure


The Isilon Administration view appears.



3. To add a user or group, click the following button:




l Users or Groups

l Users

l Groups


c. In the Directory field, specify an authentication provider.

For example, the name of the Active Directory.

d. Click Find.




Note


a. Type Admin.

b. Click Find.

5. Select a user, group, or select Select all.


6. To assign a role, select Application Administrator.

Search Administrator roleThe Search Administrator is a global search administrator that overrides any setting onindexes.

Only an Application Administrator can assign the Search Administrator role.

The Search Administrator can perform the following actions:

l Perform a full content index of a search result

l Preview search results

l Download files locally

Assigning the Search Administrator role

Only an Application Administrator can assign the Search Administrator role.

Procedure







4. In the Select User window, perform the following steps.


l Users or Groups

l Users

l Groups





Search Administrator role 63

d. Click Find.


Note


a. Type Admin.

b. Click Find.

5. Select a user or group or select Select all.


6. To assign a role, select the Search Administrator checkbox.

Search User roleThe Search User is a global search user that overrides any settings on indexes.

Only an Application Administrator can assign the Search User role.

A Search User can only see the files that they own and have access rights to througha configured CIFS/SMB share.

Figure 11 Manage Search Roles

A Search user can perform the following actions only on files that they own:






Figure 12 Search User View

Assigning the Search User role


Procedure









l Users or Groups

l Users

l Groups




Search User role 65


d. Click Find.


Note

If you click Find before specifying a substring, the entire directory is returned,which might slow performance.For example, to search for all users that contain Admin:

a. Type Admin.

b. Click Find.



6. To assign a role, select the Search User checkbox.

Index specific search rolesThe following roles can be applied to specific indexes.

Search Admin—All access role

Only an Application Administrator can assign the Search Admin—All access role.

The Search Admin—All access role can perform the following actions inside aspecified index:




Figure 13 Search Administrator—All access role



Assigning Search Admin—All access role

Only an Application Administrator can assign the Search Admin—All access role for aspecific index.

Procedure











l Users or Groups

l Users

l Groups





l 3 AD directories


d. Click Find.


Note


a. Type Admin.

b. Click Find.


Index specific search roles 67



8. Click OK.


9. To assign the role to a user or group, select Search Admin—All access.

Search Admin–Read only roleOnly an Application Administrator can assign the Search Admin–Read only role.

The Search Administrator–Read only role can perform the following actions inside aspecific index:

l Perform keyword searches

l Perform filter searches

l View metadata for the search results

Figure 14 Search Administrator–Read only role

Assigning a Search Admin—Read only role

Only an Application Administrator can assign the Search Admin—Read only role for aspecific index.

Procedure













l Users or Groups

l Users

l Groups





l 3 AD directories


d. Click Find.

The list of users or user groups appears.

Note


a. Type Admin.

b. Click Find.

7. Select a user or group or click the Select all checkbox.


8. Click OK.


9. To assign the role to a user or group, select Search Admin—Read only.

The Search Admin—Read only role cannot perform the following actions:

l See inline preview for hits

l View full preview for hits




Search User roleThe Search User is a global search user that overrides any settings on indexes.


A Search User can only see the files that they own and have access rights to througha configured CIFS/SMB share.

Figure 15 Manage Search Roles

A Search user can perform the following actions only on files that they own:






Figure 16 Search User View

Assigning an index specific Search User role

Only an Application Administrator can assign the Search User role for a specific index.

Procedure











l Users or Groups



l Users

l Groups





l 3 AD directories


d. Click Find.


Note


a. Type Admin.

b. Click Find.



8. Click OK.


9. To assign the role to a user or group, select Search User.

Note

A search user can only see the files that they own and have access rights tothrough a configured CIFS/SMB share. They can perform all actions on thesefiles.

Managing rolesThis section describes how to add and edit user roles and assign access privileges toadministrators.

Adding users or groupsWith the System Administrator or Application Administrator role, you can assign rolesto users.

Procedure

1. In the Administration window, select either Manage > Isilon or Manage >System.

The Administration view appears.









l Users or Groups

l Users

l Groups





l 3 AD directories


d. Click Find.


Note


a. Type Admin.

b. Click Find.



6. To assign a role to a user or group, click one or more of the following options:



l Search User


Adding users or groups 73

Figure 17 Manage Roles Window

Removing users or groupsWith the System Administrator or Application Administrator role, you can removeusers or groups.

Procedure





3. Click the name of the user or group you would like to delete.

4. Click the Delete button:

5. In the Confirm window, to remove the user or group, click Confirm.

Results

The users or groups are no longer listed.

Editing role assignmentsWith the System Administrator or Application Administrator role, you can assign oredit roles.

Procedure







3. Choose a user or group whose role you want to edit.

4. Click one or more of the following options:



l Search User

Figure 18 Manage Roles Window

Configuring LDAP and ADIsilon Search comes with a built-in OpenLDAP service with preconfigured accounts.For example, the Admin user. The default Admin user is not configured with an emailaddress and cannot receive email notifications.

With the System Administrator role, you can add additional LDAP or AD services todefine additional users who can administer Isilon Search and perform searchoperations.

Isilon Search does not authenticate the user against the LDAP authority. TheAuthentication Service uses the UUID of either the user or the group that the userbelongs to is used in the external authority. When authentication succeeds, theAuthentication Service issues a token for the user. The GUI uses the token informationto ensure that the user can perform only the activities that the user has privileges toperform.

You can only configure LDAP and AD users with the Application Administrator role.

Procedure



2. Select Administration > Options > LDAP Options.

The LDAP Options window appears.

3. To add an LDAP server, click the following button:

The Add LDAP Configuration window appears.



4. In the Name field, type the LDAP configuration name.

5. In the Server Type field, select either of the following authentication types:

l Active Directory

l OpenLDAP

6. In the LDAP Server field, type either of the following:

l Hostname of the LDAP or AD server

l IP address of the LDAP or AD server

7. In the LDAP port field, type the port number that is used by the externalauthentication authority.

For LDAP, the default port number is 389.

For SSL, the default number for LDAPS changes to 636 when True is selected.

8. In the Base DN field, type the scope of the users and groups that areconsidered within the LDAP server.

For example:

DC=example, DC=comThe Base DN determines the structure of the LDAP server where the searchfilter is applied. This is usually similar to the domain name over which the LDAPserver has authority.

9. In the Username field:

a. Type a user account that has full read access to the LDAP or AD directory, inthe following format:

[email protected] example, [email protected]

b. For Active Directory, ensure that the username is one of the following:

l Common name

l Email address

l Display name

l User principle name (UPN)

l Same account name

l Distinguished name (DN)

c. For OpenLDAP, ensure that the username is one of the following:

l Common name

l Email address

l Entry distinguished name

d. Ensure that the user has read access to the directory.

e. To include email notification, define the email address for the account.



Note

Only admin accounts with defined email addresses can receive emailnotifications. The default admin user is not configured with an email addressand cannot receive email notifications.

10. In the Password field, type the password of the user account that you specifiedin the Username field.

11. In the SSL field, select either of the following options:

l To connect to an external authentication server using LDAPS, select True.

The default port number automatically changes to 636.

l To not apply secure connection settings, select False.

12. In the Default field, leave the option set to False.

Default refers to the Isilon Search built-in OpenLDAP server.

13. To test the connection, click Test Connection.

14. Click Save.



CHAPTER 5

Using the Dashboard


l Viewing collector nodes..................................................................................... 80l Viewing index cluster......................................................................................... 80l Viewing indexes................................................................................................. 80l Viewing source servers...................................................................................... 80l Viewing system notifications.............................................................................. 81l Viewing application notifications.........................................................................81

Using the Dashboard 79

Viewing collector nodesOnly a System Administrator can view the health of the collector nodes.

Procedure

1. To select the System Administration view, select Manage > System.

2. To view the health of the collector nodes, select Administration > Dashboard >Collector Nodes.

Viewing index clusterOnly a System Administrator can view the health of the index cluster.

Procedure


2. To view the health of the index cluster, select Administration > Dashboard >Index Cluster.

3. To see more details, click More.

Viewing indexesYou can view index health as a System Administrator or as an ApplicationAdministrator.

To view the health of the indexes, select Administration > Dashboard > Indexes >More.

Viewing source serversOnly an Application Administrator can view the health of the source servers.

Procedure

1. To select the Isilon Administration view, select Manage > Isilon.

2. To view the health of the collector nodes, select Administration > Dashboard >Index Cluster.

Using the Dashboard


3. To go to the Sources page, click More.

Viewing system notificationsThe notification pane allows you to view up to five recent notifications for the system.

Procedure


2. To view system notifications, select Administration > Dashboard >Notifications.

Notifications display chronologically. The first five notifications are displayed.

3. To view all notifications, click More.

4. To change the view to display unread, read, or all notifications, click thefollowing button and select an option:

5. To mark a notification as read or unread, select the following button:

Viewing application notificationsThe notification pane allows you to view up to five recent notifications for tasks andjobs.

Procedure


2. To view application notifications, select Administration > Dashboard >Notifications.

Notifications display chronologically. The first five notifications are displayed.

3. To view all notifications, click More.

4. Select a notification and click the following button to mark it as read:

Using the Dashboard

Viewing system notifications 81

Using the Dashboard


CHAPTER 6

Monitoring Jobs, Services, and System Health


l Viewing job type and status................................................................................84l Monitoring search jobs.......................................................................................86l Monitoring index jobs.........................................................................................86l Monitoring system jobs...................................................................................... 87l Viewing system health........................................................................................87l Viewing system services.................................................................................... 88

Monitoring Jobs, Services, and System Health 83

Viewing job type and statusTo determine a job type or status, hover over a job button.

To view the list of jobs, select Administration > Jobs.

The following table describes the job types.

Table 9 Job Types

Job Types Description

FCI

Performing a targeted full content index of search results.

Scan

Scanning the source Isilon cluster to prepare an index.

Rescan

Scanning the source Isilon cluster to update the index.

Monitor

Monitoring the system health and services of the cluster, nodes, and indexes.

Add Source

Adding a new source Isilon cluster.

Delete Source

Deleting a source Isilon cluster.

Download

Downloading a search result.

System

Performing system jobs and services, including the updating of the status andcache for configured Isilon clusters.

Note

System jobs are hidden by default. They can be seen by updating the filters.

The following table describes the task status.



Table 10 Task Status

Status Description

Spawning

Indicates a job has been triggered.

Pending

Indicates a job is waiting to begin.

Running

Indicates a job is currently being performed.

Stopping

Indicates a job is being stopped.

Success

Indicates a job has been performed successfully.

Failed

Indicates a job has failed.

Stopped

Indicates a job has stopped.

Timeout

Indicates a job has timed out.

If an adding a source job is still running after 10 minutes, the job is marked astimeout.

Paused

Indicates a job has been paused.

A job can be paused manually.

A job pauses automatically when there is minimal disk space.

Pausing

Indicates a job is being paused.

Resuming

Indicates a paused job is starting up again.


Viewing job type and status 85

Monitoring search jobsSearch jobs include full content indexing (FCI) and downloading.

To monitor search jobs as a Search User or Search Administrator, select Search >View Jobs.

To monitor jobs as an Application Administrator, select Administration > Jobs.Use the following procedure to limit the jobs view to search jobs only.

Procedure

1. Select Administration > Jobs.

The Jobs window opens.

2. To open the list of available job filters, click the following button:

The filters menu appears.

3. To narrow the jobs list to display only search jobs, ensure that only the followingjob types are selected:

l FCI

l Download

4. Click Apply

Only search jobs display in the job list.

5. To view a detailed list of tasks for a job, click View tasks.

The status of each task displays.

6. To refresh the list of jobs, click the following button:

Monitoring index jobsProcedure



2. To open the list of available job filters, click the following button:


3. To narrow the jobs list to display only index jobs, ensure that only the followingjob types are selected:

l Scan

l Rescan

l Monitor



l Add Source

l Delete Source

4. Click Apply.

Only index jobs display in the job list.




Monitoring system jobsSystem jobs run at typical intervals. By default, system jobs do not appear in the JobsView.

To view system jobs, use the following procedure.

Procedure




3. To view the system jobs together with all job types, click the following button:

System jobs appear along with all other jobs.

4. To narrow the jobs list to display only system jobs:

a. Click the following button:


b. Ensure that only the System filter is selected.

c. Click Apply.

Only system jobs appear in the list of jobs.




Viewing system healthYou can view storage and memory thresholds and current values within the SystemHealth window.


Monitoring system jobs 87

Procedure


Figure 19 System Administrator view

2. To view the health of the system, select Administration > System.

The value in the Current column is color coded according to the followingthreshold values:

Option Description

Green Acceptable value

Yellow Near threshold value

Red Exceeds threshold value

Notifications are sent when thresholds are exceeded.

Note

If free Data Disk space falls below the lower threshold of the space that isrequired, all active jobs are paused. Manually resume the paused jobs once moredisk space becomes available.

3. To view system notifications, select Administration > Dashboard >Notifications > More.

Viewing system servicesYou can view the components, status, and version of each Isilon cluster within theSystem Services window.

Note

The status is updated every ten minutes. Clicking the refresh button will not causethe status to update more quickly.

Procedure




Figure 20 System Administrator view

2. To view system services, select Administration > System.

Notifications are sent when the status changes.

Note

If a service stops running, the system tries to restart the service automatically.If a problem that stopped the service is unresolved, the system might notrestart. For example, the system is out of disk space or the network is down.After a service is restarted, the UI might not reflect the change in status untilthe next 10 minute refresh cycle.

3. To view system notifications, select Administration > Dashboard >Notifications > More.


Viewing system services 89

CHAPTER 7

Performing Search and Viewing Search Results


l About Searches..................................................................................................92l Optimizing search performance......................................................................... 93l Using filters to optimize search results.............................................................. 93l Using keywords to search.................................................................................. 98l Sorting search results....................................................................................... 101l Viewing the metadata of search results............................................................ 102l Downloading files from search results...............................................................102l Searching for files within containers.................................................................103l Managing full content index searches...............................................................103

Performing Search and Viewing Search Results 91

About SearchesIsilon Search performs metadata searches on indexed files and folders, and performsfull content searches on files that have had their full content indexed. Isilon Searchsupports keyword and advanced Lucene search queries. Search results include asummary of certain fields for the file, such as file name, location, size, and date.



l If a file is indexed for full content indexing (FCI), keywords or phrases that arefound in the body of the file are returned with a preview of the full contents. Thepreview displays, and highlights the words around the matched text.

By default, the search is sorted by Relevance (score), which defines how well thesearch results match the search criteria.

Figure 21 Search window

Accessing only the Search windowThe Isilon Search virtual appliance is accessed as a web-based interface. Dependingon your user privileges, you can perform administration or search tasks.

To perform searches, you must be assigned one of the following roles:



l Search User



Note


To perform searches, complete the following steps.

Procedure


https://nodename/search

Note


2. To log in:


Note


b. Click Sign In.

The Search UI opens.

Optimizing search performanceAt the core of Isilon Search is Elasticsearch, a high performance indexing and searchsystem capable of searching billions of objects within seconds.

To leverage Elasticsearch replication at least two nodes are required, although a singlenode is supported.

To further increase the speed at which search results are returned, observe thefollowing best practices:

l Use search filters to narrow the search scope, and limit the number of results.

l Only add specific queries if you know the details of the content that you arelooking for.For example, specify the file type, date, and owner using the search filters insteadof typing them directly into the Search bar.

l Limit the number of simultaneous queries by different users.

Using filters to optimize search resultsYou can use one or a combination of the following filter options to narrow andoptimize search results:

l File type

l File name


Optimizing search performance 93

l File size

l Location

l Source

l Unindexable content

l Create time

l Access Time

l Owner

To change filter selection and modify the search, click Add | Remove Filters.

To view jobs for search results, click View Jobs.

To apply the selected search filters, click Save and Close. The Search resultswindow appears.

Figure 22 Search filters

Narrowing a search by folder or fileProcedure

1. Open the Search window.

2. Click Search Type.

3. Select one or both of the following options:

l Isilon folder

l Isilon file



Narrowing a search by file typeTo narrow the search by file type, perform one of the following steps from the Searchwindow.

Search by file typeTo narrow the search by file type, type a file name extension in the Type field:

1. Click Type.

2. Type a file name extension, or multiple file extensions separated by commas.

View and select from available file types

To view and select from available file types, click the pie chart button .

The pie chart breaks down the current search by frequency of file type:

l Only the top 10 most frequent file types in the search display.

l Each file type extension is listed below the pie chart.

Narrow the view of the pie chartTo narrow the view of the pie chart:

1. Click the pie chart button:

2. Click a section of the pie chart or a file extension from the legend.The pie chart adjusts and narrower slices are expanded for easier viewing.

Figure 23 File type pie chart


Narrowing a search by file type 95

Narrowing a search by file attributesYou can narrow the search results by applying one or more of the following searchfilters.

File nameProcedure

1. In the Search window, click the Name field.

2. Specify the placement of the keyword. You can select from the following:

l Contains with (default)

l Begins with

l Ends with

3. Type the name.

The name can include wildcard characters (*).

File sizeProcedure


2. Click Size.

3. Specify a minimum or maximum file size.

4. To select a range of sizes, click the following button:

File locationProcedure


2. Click Location.

3. To search for a specific file path, enclose the entire file path in quotations.

For example: "/ifs/data/projects"

4. To search for a keyword inside of the file path, type the keyword with no extracharacters.

Narrowing a search by date and time attributesYou can narrow the search results by applying one or more of the following searchfilters.

Date

The date represents the date the file or folder was last modified.

Procedure


2. Click Date.



3. Specify a minimum or maximum date.

4. To display a breakdown of results and filter the search by the month of a year:


b. Select a specific month in which to search.

Date created

Procedure


2. Click Date Created.





5. To display a visual breakdown of the current search results, click the followingbutton:

Date last accessed

Procedure


2. Click Date Last Accessed.





Specifying an Isilon clusterProcedure


2. Click Source.

3. To display a visual breakdown of the current search results and filter for specificclusters, click the following button:


Specifying an Isilon cluster 97

Including content that was not indexed in the searchTo search for items that were not successfully full content indexed, consider thefollowing factors:

l The file type or size.

l The text was not extracted from the file.

Procedure


2. Click Unindexable Content.

3. Select Yes.

Narrowing a search by ownerTo narrow the search by owner perform one of the following steps from the Searchwindow:

To narrow the search by content owner

1. Open the Search window, by clicking the following button:


2. Click Owner.

3. Type any of the following:

l The owner username.

l The owner domain.

l The owner domain and username.

To view available owners


2. Consider the following:

l The pie chart breaks down the current search by ownership.

l Only the top 10 owners are displayed.

To narrow the view of the pie chart


2. Click a section of the pie chart.The pie chart adjusts and narrower slices are expanded for easier viewing.

Using keywords to searchTo use keywords to search, perform one of the following steps from the Searchwindow:



Procedure



2. To perform a basic search:

a. In the Search dialog box, type a keyword.

b. Click Search.

The Search Results page appears.

3. To perform an advanced search:

a. In the Search field, type a Lucene query.

b. Click Search.

The following table includes Lucene syntax examples.

Table 11 Example Lucene syntax

Syntax examples Description

field:value The field contains the value

field:"phrase" The field contains the exact phrase

field :(value1 OR value2) The field contains one or both values

_ missing_:field The field has no value or is missing

_ exists_: field The field has any non-null value

field:qu?ck bro * Use wildcards

xvname:/joh?n(ath[oa]n)/ Use regular expression

field:quikc~brwn~foks~ Words that are similar

field:"fox quick"~ 5 No more than 5 words between them

xvdate:[2003-01-01 TO 2004-01-01] Match any day in range

xvdate:{TO 2012-12-31} Specified date search

xvsize:>10000 All files with sizes over 10000 bytes

quick brown +fox -news The word fox must be present, news must notbe

Note

Isilon Search uses Elasticsearch 2.3.3 to leverage Lucene 5.5

The Search results page appears.

4. To enable a search for key words within a file that has been full content indexed(FCI):


Using keywords to search 99

Note

You can only perform a full content index or preview the contents of a file if youare the owner of the file, or if you have search administrator rights with allaccess privileges.

a. On the Search Results page, select FCI from the list box of actions.

b. To full content index a file, click the checkbox next to the files that youwould like to full content index.

c. Perform a full content index of the content of the file:

l To perform an FCI operation on all the file entries that appear on thepage, click Select All.

l To perform an FCI on only the selected files, click Selected.

l To perform an FCI operation on search hits that match the current query,click All.

Note

Full content indexing a large number of items can take a long time;potentially days. Carefully filter the search to include only files thatshould be full content indexed.

d. To monitor progress of a full content indexing job, click View Jobs.

e. To refresh the search results, click Search and then re-run the search.

The FCI button appears next to the file that has been full content indexedand the Preview option appears.

f. To preview the file content, click Preview.

You are now able to search for content within the file from the search bar.



Figure 24 FCI Enabled Search Results

5. To view the metadata of a file, in the Search results page click Detail for thefile.

6. To download a file, full access permissions are required:

Note

You can only download files locally if you are the owner of the file, or if you havesearch administrator rights with all access privileges.

a. On the Search Results page, select Download from the list box of actions.

b. Next to the files that you would like to download, click the checkbox.

c. Download the file:

l To download all the file entries that appear on the page, click Select All.

l To download only the selected files, click Selected.

l To download search hits that match the current query, click All.

d. To monitor progress of the download, click View Jobs.

Sorting search resultsTo change the criteria on which the results are sorted, perform the following steps.


Sorting search results 101

Procedure

1. From the Sort By (DESC) filter, select another item.

The default sorting method is Relevance (sort score). The Relevance scoredetermines how well the search results match the search criteria.

2. To change the filter order from ascending to descending, click the Z to Abutton beside the list box words.

3. Review the search results.

Viewing the metadata of search resultsYou can only view metadata details if you are the owner of the file, or if you havesearch administrator rights with all access or read only privileges.

To view the metadata of a search result, in the Search results window click Detail forthe file.

The following search result information displays:

l The name of the application that stores the data, for example, Isilon

l The name of the index

l File name, location, type, and size

l The date the file was indexed

l For a file that was full content indexed, the application level metadata

l If the file resides in a container

l If the file cannot be indexed

l Share path

Downloading files from search resultsYou can only download files locally if you are the owner of the file, or if you havesearch administrator rights with all access privileges.

Procedure

1. To download a single file:

a. Select a file from the search results by clicking the checkbox.

b. Click Download from the list box of actions.

c. In the browser, view the download progress.

2. To download multiple files:

a. Select multiple files by clicking their checkboxes. Alternatively, click SelectAll.

b. Click Actions > Download.

c. To monitor the progress of the download, click View Jobs.



Note

Downloading a folder downloads all of the files inside of it. However, nested filesare not downloaded.

Searching for files within containersA file that resides inside a container is labeled as a Child file. If a .zip or .tar file isexpanded, the file is labeled as Expanded.

To browse and search for files within containers, use the following methods:

l To view all the children of an expanded file, next to the file click the checkbox, andthen click Expand.

l To view the expanded file that the child file belongs to, next to the file click thecheckbox, and then click Child.

Figure 25 Container labels

Managing full content index searchesThe sections that follow describe how to perform full content index (FCI) searches.

Isilon Search performs metadata searches on indexed files and folders, and performsfull content searches on files that have had their full content indexed. Isilon Searchsupports keyword and advanced Lucene search queries. Search results include asummary of certain fields for the file, such as file name, path, size, date, andownership. By default, the search is sorted by Relevance (score), which defines howwell the search results match the search criteria.




Searching for files within containers 103

Search results include a summary of certain fields for the file, such as file name,path, size, date, and ownership.

l If a file is indexed for full content, keywords or phrases that are found in the bodyof the file are returned with a preview of the full contents.The preview displays and highlights the words around the matched text.

Performing a Full Context Index on containersThe Indexing files within containers feature allows individual files and folders inside acontainer (zip, tar, gz, tgz) files to be indexed as individual items. By default,this feature is disabled when adding a new source. In this scenario, when one of thesefile types is full content indexed, only the container is processed. The text for itemsthat reside inside the container is included in the index. However, all that text in thecontainer is considered part of the full content of the container and not an individualobject.


If the Indexing files within containers feature is enabled for the source, each individualitem inside the container is full content indexed separately and stored as separateitems.

For example, a zip file DocumentArchive.zip contains twenty Microsoft Worddocuments. One of these documents, CustomerList.docx, includes the wordConfidential. After the initial scan, the administrator chooses to full content indexDocumentArchive.zip:

l If the Files Within Containers option is Disabled, a search for Confidentialmatches the DocumentArchive.zip file.

l If the Files Within Containers option is Enabled, a search for Confidentialmatches the CustomerList.docx which resides in theDocumentArchive.zip file.

Performing a full content index on search resultsUse the full content index (FCI) feature to perform a targeted full content index ofsearch results so that you can view a preview of the content and search for keywords.

You can only perform a FCI or preview the contents of a file or directory if you are theowner of the file or directory, or if you have Search Administrator rights with allaccess privileges.

Procedure

1. Open the Search window by clicking the following button:

The Search window appears.

2. Perform a search.

The Search Results window opens.

3. To enable a search for key words within a file (FCI):



Note

You can only perform a full content index or preview the contents of a file if youare the owner of the file, or if you have search administrator rights with allaccess privileges.

a. On the Search Results page, select FCI from the list box of actions.

b. Next to the files that you would like to full context index, click the checkbox.

c. Perform a FCI of the content of the file:

l To perform an FCI operation on all the file entries that appear on thepage, click Select All.

l To perfom an FCI on only the selected files, click Selected.

l To perform an FCI operation on search hits that match the current query,click All.

Note

Full content indexing a large number of items can take a long time;potentially days. Carefully filter the search to include only files thatshould be full content indexed.

4. To refresh the search results, click Search, and then re-run the search.

The FCI button appears next to the file that has been full content indexed andthe Preview option appears.


Performing a full content index on search results 105

Figure 26 FCI Enabled Search Results

5. To monitor progress of a full content indexing job, click View Jobs.

6. To preview the file content, click Preview.

You can now search for content within the file from the Search bar.

7. To perform a basic search of the Preview content:

a. In the Search dialog box, type a keyword.

b. Click Search.

Searching for files that have not been full content indexedYou can only perform a full content index (FCI) or preview the contents of a file ordirectory if you are the owner of the file or directory, or if you have SearchAdministrator rights with all access privileges.

Procedure



2. (Optional) To further limit the search, select a search filter.

3. In the Search bar, type the following keyword:

_missing_:xvcontent



4. Click Search.

Restricting a search to only include files that have been full content indexedYou can only perform a full content index (FCI) or preview the contents of a file ordirectory if you are the owner of the file or directory, or if you have SearchAdministrator rights with all access privileges.

Procedure



2. (Optional) To further to limit the search, select a search filter.


xvhascontent:true

4. Click Search.

Searching for application specific metadataIn addition to the basic file system metadata that is stored in the index, full contentindexing reads additional application-specific metadata for processed files whereavailable.

Examples of application-specific metadata include the following:

l Author

l Title

l Title and artist for audio files

l Word-count for Microsoft Office files

l Camera name

l Resolution for image files

Note

You can only perform a full content index (FCI) or preview the contents of a file ordirectory if you are the owner of the file or directory, or if you have SearchAdministrator rights with all access privileges.

Procedure



2. (Optional) To further limit the search, select a search filter.


xvmetadata:"metadata_subject:keyword"

4. Click Search.


Restricting a search to only include files that have been full content indexed 107

Matches are highlighted in a short snippet.

Figure 27 Application-specific metadata search results

5. To view the application-specific metadata, click Details.

Figure 28 Details view



APPENDIX A

Troubleshooting


l Deployment troubleshooting............................................................................. 110l Log files.............................................................................................................110l Troubleshooting the web server........................................................................ 113l Troubleshooting web services for collector issues.............................................115l Increasing the maximum memory for the search-Isilon-worker service............. 116l Troubleshooting Elasticsearch...........................................................................116

Troubleshooting 109

Deployment troubleshootingIf you are unable to access the virtual appliance online after ten minutes, there mightbe an issue with deployment. Use the following steps to resolve common issues.

Procedure

1. Log in to the virtual machine as the root user.

2. To check the network settings, run the following:

yast

If static IPs were specified during deployment, ensure that Dynamic Addresses(DHCP) are not specified.

3. Ensure that you can ping the following:

l Default gateway

l DNS servers

l Isilon server

4. Validate the installation by running the following command:

cd /home/search

bash validate_install.sh

If content appears red, contact Dell EMC Support. When contacting Support,provide all the logs in the following location:

l /home/search/logl /user/local/firstboot/logs

5. Verify the deployment log in /home/search/log.

The message "deployment finished" should appear.

Log filesAll logs files are stored on disk 3, the temporary disk. The /usr/local/search/logis mapped to the mnt/search/log. The logs are filed to a dedicated disk so that thelogs do not cause the system disk to fill up.

The default log directory, /usr/local/search/log, contains the following logs.

Table 12 Log files

Logs Description

search- adminapi -nodename

Main log file for the Admin REST API

Troubleshooting


Table 12 Log files (continued)

Logs Description

search- adminapi - stderr-nodename

A concise list of API calls made into the Admin REST API

search- adminapi - stdout-nodename

Details the debugging output for the Admin REST API

search- api - nodename Main log file for the Search REST API

search- stderr - nodename A concise list of API calls made into the Search REST API

search- stdout -nodename

Details the debugging output for Search REST API

search- isilon - actionapi-nodename

Main log file for the Isilon action service REST API

search- isilon_action -stderr- nodename

A succinct list of API calls made into the Isilon action serviceREST API

search- isilon_action -stdout- nodename

Details the debugging output for the Isilon action service RESTAPI

search- isilon -worker-nodename

Main log file for the Isilon Java worker service

search- isilon -worker-stdout - nodename

Details Isilon Java worker service settings

search-worker- nodename Main log file for the Isilon platform Java worker service

search-worker- stdout -nodename

Details Isilon platform Java worker service settings

Subdirectories contain the logs for the following services.

Table 13 Services and logs

Logs Description

Elasticsearch Index engine logs

CIS Common Index Service logs

nginx Web server logs

Use a secure FTP client, such as WinSCP or PuTTy (psftp) to copy log files from theIsilon Search nodes to a Windows computer.

Note

The WinSCP tool provides a GUI, and retains the settings, including both local andremote directory locations.

Copying log files by using WinSCPProcedure

1. Install WinSCP by downloading WinSCP from winscp.net.

Troubleshooting

Copying log files by using WinSCP 111

The WinSCP wizard appears.

2. Select Stored sessions, and click New.

3. Add a session by completing the following fields:

l Hostname

l Port number (default is 22)

l Root username

l Password

4. Click Directories and complete the following fields:

l For the Remote directory field, type the following:

cd/usr/local/search/log

l For the Local directory field, type the following:

local directory

5. To save the session:

a. Click Save.

b. Click Login.

6. Drag the logs from the Remote Directory section of the window to the LocalDirectory section of the window.

Copying log files by using PuTTyUse a secure FTP client, such as PuTTy (psftp) to copy log files from the Isilon Searchnodes to a Microsoft Windows computer.

Before you begin

You can download and install PuTTy from winscp.net.

Procedure

1. Log in with the Isilon Search Root user credentials that are created duringdeployment.

2. Change to the log directory:

cd/usr/local/search/log

3. Use the mget* command to download the log files.

4. If required, unzip the log files.

Older versions of the logs are compressed based on size or date.

Troubleshooting


Troubleshooting the web serverThis section lists the log files, commands, and configuration files for troubleshootingthe Isilon Search Web server.

Web server control commandsThe following service commands are available for managing the web server (NGINX):

l service nginx reload

l service nginx stop

l service nginx start

l service nginx reopen

Configuration filesThe following table lists the available configuration files.

Table 14 Available configuration files

Configurationfile

Description Location

nginx.conf Defines ports and SSL certificates. /etc/nginx/

system.conf Provides the ability to manage theIsilon Search log files.

/usr/local/search/etc

Web server logsYou can view the following log files by using the Isilon Search log viewer on aMicrosoft Windows computer:

l /usr/local/search/log/search-isilon-action-stderr-[hostname].log

l /usr/local/search/log/search-isilon-action-stdout-[hostname].log

l /usr/local/search/log/search-isilon-actionapi-[hostname].logl /usr/local/search/log/search-isilon-worker-[hostname].logl /usr/local/search/log/search-adminapi-[hostname].logl /usr/local/search/log/search-adminapi-stderr[hostname].logl /usr/local/search/log/search-adminapi-stdout[hostname].logl /usr/local/search/log/search-api-[hostname].logl /usr/local/search/log/search-api-stderr[hostname].logl /usr/local/search/log/search-api-stdout[hostname].logl /usr/local/search/log/search-worker [hostname].logl /usr/local/search/log/search-worker-stdout[hostname].log

Troubleshooting

Troubleshooting the web server 113

Configuration filesYou can use a text editor such as vi or vim to edit the nginx.conf andsystem.conf files on a Linux terminal.

The following sections provide more information on editing configuration files.

Editing the Isilon Search nginx.conf fileUse a text editor such as vi or vim to edit the nginx.conf file on the Linux terminal.

Use the nginx.conf file to define ports, and manage SSL certificates and keys.

To edit the Isilon Search nginx.conf file, perform the following tasks.

Procedure

1. With a text editor, open the following file:

root /etc/nginx.conf2. If required, modify the ports, SSL certs, and keys for the following:

l Admin UI and Search UI:root /usr/local/nginx/httpdsn Port 443 (default)

n SSL_certificate nginx.certn SSL_certificate_key nginx.key

l Admin Rest API:root /usr/local/nginx/httpds/admin/api/publicn Port 448 (default)


l Search Rest API:root /usr/local/nginx/httpds/search/api/publicn Port 449 (default)


3. To save the changes, restart nginx.

Managing logs with the system.conf file

The system.conf file provides the ability to manage the following:

l Log file location

l log level

l log count

l log size

Procedure

1. Open the usr/local/search/etc/system.conf file with a text editor.

2. Modify any of the following:

Troubleshooting


l Log file location:

n log_path_admin_api: /logs/search-adminapi.log (default)

n log_path_admin_web: /logs/search-adminweb.log (default)

n log_path_search_api: /logs/search-searchapi.log(default)

n log_path_search_web: /logs/search-searchweb.log(default)

l Log level:

n 0 = verbose

n 1 = info (default)

n 2 = warning

n 3 = error

l Log count—The number of old log files to keep (10 default)

l Log size—The threshold at which the log files roll over (100,000 default)

3. Restart nginx for the changes to take effect.

Troubleshooting web services for collector issuesThis section outlines the log files, commands, and configuration files available fortroubleshooting the Isilon Search Worker service.

Collector service control commandsYou can use the following commands to troubleshoot the Isilon Search Collectorservice:

l service search-Isilon-worker statusl service search-Isilon-worker stopl service search-Isilon-worker startl service search-Isilon-worker restartWorker service log fileView the log file by using the Isilon Search log viewer on a Windows computer.

The search-Isilon-worker is located at, /usr/local/search/logs/search-Isilon-worker.

The search-Isilon-worker.log rolls over at 100 MB, or every 7 days by default.

You can modify the settings in the /usr/local/search/etc/log4j2-search-Isilon-worker.xml file. To save the changes, restart search-Isilon-worker.

Table 15 Example log messages

Log message Description

INDEX FAIL: Connect failed to retrieveitem

Cannot find the item on the local disk that wasrestored by connector

INDEX FAIL: Cannot read retrieved localitem

Cannot read the item on local disk. Usually, theerror is a permission issue

Troubleshooting

Troubleshooting web services for collector issues 115

Table 15 Example log messages (continued)

Log message Description

UNINDEXABLE: Failed to scrap text Tika cannot process the item

UNINDEXABLE: System error whenscrapping text

JVM error when Tika is processing this item.Out-of-memory is the prime cause

INDEX FAIL: BulkResponse with failmessage

Elasticsearch reports that it cannot process theindex/update sub-request for this item

INDEX FAIL: Bulk request failure Elasticsearch might be unavailable, a networkissue, and so on

Increasing the maximum memory for the search-Isilon-worker service

If there is a lack of memory, but there is enough system memory, it can be increased.Memory issues occur when performing full content indexing on large files.

Procedure

1. Open the following file:

/etc/init.d/search-Isilon-worker

2. Change the following line:

-Xmx memory value in the ARGUMENTS="-Xms1024M -Xmx3072M -XX:-UseGCOverheadLimit...

3. Save the file.

4. Restart the search-Isilon-worker service.

Troubleshooting ElasticsearchTo troubleshoot the Elasticsearch service, use the following log files, commands, andconfiguration files.

Controlling the Elasticsearch serviceTo control the Elasticsearch service, use the following command:

service elasticsearch stopTo stop the search-Isilon-worker service before stopping the Elasticsearch service,use the following command:

service elasticsearch start

Troubleshooting


Viewing Elasticsearch logsProcedure

1. Use one of the following commands to view the Elasticsearch logs:

l /usr/local/search/log/elasticsearch/search_cluster.logl tail /usr/local/search/log/elasticsearch/

search_cluster.logl vim /usr/local/search/log/elasticsearch/

search_cluster.log

2. Download the logs to another computer by using psftp.

Note

You cannot use the Isilon Search log viewer for Elasticsearch logs.

Viewing or changing Elasticsearch configurationTo view or modify Elasticsearch configuration, use the following commands:

l more /etc/elasticsearch/elasticsearch.ymll vim /etc/elasticsearch/elasticsearch.yml

Monitoring the health of the Elasticsearch clusterProcedure

1. To check the health of the Elasticsearch cluster:

a. Log in to Isilon Search as a System Administrator.

b. Select Administration > System > Services.

c. Review the status of the Elasticsearch component.

2. Verify that the Elasticsearch node has been correctly connected to the cluster:

a. Review the following firewall configuration file:

/etc/sysconfig/SuSEfirewall2

b. Verify that the port 9300–9400 in the node network is open. For example:

FW_TRUSTED_NETS=" 10.98.27.0/24,tcp,440:449 127.0.0.0/24,tcp,9200 10.98.27.0/24,tcp,9300:9400

Troubleshooting

Viewing Elasticsearch logs 117

Troubleshooting


Copyright © 2015 EMC Corporation. All rights reserved. Published in USA. EMC believes the information in this publication is accurate as of its publication date. The information is subject to change without notice. The information in this publication is provided as is. EMC Corporation makes no representations or warranties of any kind with respect to the information in this publication, and specifically disclaims implied warranties of merchantability or fitness for a particular purpose. Use, copying, and distribution of any EMC software described in this publication requires an applicable software license. EMC², EMC, and the EMC logo are registered trademarks or trademarks of EMC Corporation in the United States and other countries. All other trademarks used herein are the property of their respective owners. For the most up-to-date regulatory document for your product line, go to EMC Online Support (https://support.emc.com).


isilon search installation and administration guide · guide. table 1 isilon search revision...

Documents