Pinnacle Systems Media Index - 2.9 User Manual

Avid Media | Index

Configuration Guide

Version 2.9

Legal Notices

Product specifications are subject to change without notice and do not represent a commitment on the part of Avid Technology, Inc.

This product is subject to the terms and conditions of a software license agreement provided with the software. The product may only be used in accordance with the license agreement.

This product may be protected by one or more U.S. and non-U.S patents. Details are available at www.avid.com/patents.

This guide is protected by copyright. This guide is for your personal use and may not be reproduced or distributed, in whole or in part, without permission of Avid. Reasonable care has been taken in preparing this guide; however, it may contain omissions, technical inaccuracies, or typographical errors. Avid Technology, Inc. disclaims liability for all losses incurred through the use of this document. Product specifications are subject to change without notice.

The following disclaimer is required by Apple Computer, Inc.:

APPLE COMPUTER, INC. MAKES NO WARRANTIES WHATSOEVER, EITHER EXPRESS OR IMPLIED, REGARDING THIS PRODUCT, INCLUDING WARRANTIES WITH RESPECT TO ITS MERCHANTABILITY OR ITS FITNESS FOR ANY PARTICULAR PURPOSE. THE EXCLUSION OF IMPLIED WARRANTIES IS NOT PERMITTED BY SOME STATES. THE ABOVE EXCLUSION MAY NOT APPLY TO YOU. THIS WARRANTY PROVIDES YOU WITH SPECIFIC LEGAL RIGHTS. THERE MAY BE OTHER RIGHTS THAT YOU MAY HAVE WHICH VARY FROM STATE TO STATE.

The following disclaimer is required by Sam Leffler and Silicon Graphics, Inc. for the use of their TIFF library:

Permission to use, copy, modify, distribute, and sell this software [i.e., the TIFF library] and its documentation for any purpose is hereby granted without fee, provided that (i) the above copyright notices and this permission notice appear in all copies of the software and related documentation, and (ii) the names of Sam Leffler and Silicon Graphics may not be used in any advertising or publicity relating to the software without the specific, prior written permission of Sam Leffler and Silicon Graphics.

THE SOFTWARE IS PROVIDED “AS-IS” AND WITHOUT WARRANTY OF ANY KIND, EXPRESS, IMPLIED OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.

IN NO EVENT SHALL SAM LEFFLER OR SILICON GRAPHICS BE LIABLE FOR ANY SPECIAL, INCIDENTAL, INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND, OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER OR NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

The following disclaimer is required by the Independent JPEG Group:

This software is based in part on the work of the Independent JPEG Group.

This Software may contain components licensed under the following conditions:

Redistribution and use in source and binary forms are permitted provided that the above copyright notice and this paragraph are duplicated in all such forms and that any documentation, advertising materials, and other materials related to such distribution and use acknowledge that the software was developed by the University of California, Berkeley. The name of the University may not be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.

Permission to use, copy, modify, and distribute this software and its documentation for any purpose and without fee is hereby granted, provided that the above copyright notice appear in all copies and that both that copyright notice and this permission notice appear in supporting documentation. This software is provided "as is" without express or implied warranty.

Permission to use, copy, modify, distribute, and sell this software for any purpose is hereby granted without fee, provided that the above copyright notice appear in all copies and that both that copyright notice and this permission notice appear in supporting documentation, and that the name of Daniel Dardailler not be used in advertising or publicity pertaining to distribution of the software without specific, written prior permission. Daniel Dardailler makes no representations about the suitability of this software for any purpose. It is provided "as is" without express or implied warranty.

Permission to use, copy, modify, and distribute this software for any purpose without fee is hereby granted, provided that this entire notice is included in all copies of any software which is or includes a copy or modification of this software and in all copies of the supporting documentation for such software.

THIS SOFTWARE IS BEING PROVIDED "AS IS", WITHOUT ANY EXPRESS OR IMPLIED WARRANTY. IN PARTICULAR, NEITHER THE AUTHOR NOR AT&T MAKES ANY REPRESENTATION OR WARRANTY OF ANY KIND CONCERNING THE MERCHANTABILITY OF THIS SOFTWARE OR ITS FITNESS FOR ANY PARTICULAR PURPOSE.

This product includes software developed by the University of California, Berkeley and its contributors.

The following disclaimer is required by Paradigm Matrix:

Portions of this software licensed from Paradigm Matrix.

The following disclaimer is required by Ray Sauers Associates, Inc.:

“Install-It” is licensed from Ray Sauers Associates, Inc. End-User is prohibited from taking any action to derive a source code equivalent of “Install-It,” including by reverse assembly or reverse compilation, Ray Sauers Associates, Inc. shall in no event be liable for any damages resulting from reseller’s failure to perform reseller’s obligation; or any damages arising from use or operation of reseller’s products or the software; or any other damages, including but not limited to, incidental, direct, indirect, special or consequential Damages including lost profits, or damages resulting from loss of use or inability to use reseller’s products or the software for any reason including copyright or patent infringement, or lost data, even if Ray Sauers Associates has been advised, knew or should have known of the possibility of such damages.

The following disclaimer is required by Videomedia, Inc.:

“Videomedia, Inc. makes no warranties whatsoever, either express or implied, regarding this product, including warranties with respect to its merchantability or its fitness for any particular purpose.”

“This software contains V-LAN ver. 3.0 Command Protocols which communicate with V-LAN ver. 3.0 products developed by Videomedia, Inc. and V-LAN ver. 3.0 compatible products developed by third parties under license from Videomedia, Inc. Use of this software will allow “frame accurate” editing control of applicable videotape recorder decks, videodisc recorders/players and the like.”

The following disclaimer is required by Altura Software, Inc. for the use of its Mac2Win software and Sample Source Code:

The following disclaimer is required by 3Prong.com Inc.:

Certain waveform and vector monitoring capabilities are provided under a license from 3Prong.com Inc.

The following disclaimer is required by Interplay Entertainment Corp.:

The “Interplay” name is used with the permission of Interplay Entertainment Corp., which bears no responsibility for Avid products.

This product includes portions of the Alloy Look & Feel software from Incors GmbH.

This product includes software developed by the Apache Software Foundation (http://www.apache.org/).

This product may include the JCifs library, for which the following notice applies:

Avid Interplay contains components licensed from LavanTech. These components may only be used as part of and in connection with Avid Interplay.

Attn. Government User(s). Restricted Rights Legend

U.S. GOVERNMENT RESTRICTED RIGHTS. This Software and its documentation are “commercial computer software” or “commercial computer software documentation.” In the event that such Software or documentation is acquired by or on behalf of a unit or agency of the U.S. Government, all rights with respect to this Software and documentation are subject to the terms of the License Agreement, pursuant to FAR §12.212(a) and/or DFARS §227.7202-1(a), as applicable.

Trademarks

Avid, the Avid Logo, Avid Everywhere, Avid DNXHD, Avid DNXHR, Avid Nexis, AirSpeed, Eleven, EUCON, Interplay, iNEWS, ISIS, Mbox, MediaCentral, Media Composer, NewsCutter, Pro Tools, ProSet and RealSet, Maestro, PlayMaker, Sibelius, Symphony, and all related product names and logos, are registered or unregistered trademarks of Avid Technology, Inc. in the United States and/or other countries. The Interplay name is used with the permission of the Interplay Entertainment Corp. which bears no responsibility for Avid products. All other trademarks are the property of their respective owners. For a full list of Avid trademarks, see:

http://www.avid.com/US/about-avid/legal-notices/trademarks.

Footage

WCAU Fire Story — Courtesy of NBC-10, Philadelphia, PA.

News material provided by WFTV Television Inc.

Avid Media | Index Configuration Guide • Created January 10, 2017 • This document is distributed by Avid in online (electronic) form only, and is not available for purchase in printed form.

Using This Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

Symbols and Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

If You Need Help. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

Avid Training Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

Chapter 1 Media | Index Configuration Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

Prerequisites for Media | Index Configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

Checklist for Configuring Media | Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

Chapter 2 Configuring Media | Index for a Single Server . . . . . . . . . . . . . . . . . . . . . . . . . . 12

Preparing for the Media | Index Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12

Configuring Media | Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

Validating the Media | Index Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

Continuing the Installation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16

Chapter 3 Configuring Media | Index for a Cluster . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

Shard Count and Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

Preparing for the Media | Index Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20

Adding Resources to the Cluster . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

Configuring Media | Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

Validating the Media | Index Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24

Continuing the Installation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26

Chapter 4 Setting Up Multi-Zone Search . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27

Setting the Zone Bindings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27

Validating the Elasticsearch Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31

Chapter 5 Installing the Production Engine Bus Connector . . . . . . . . . . . . . . . . . . . . . . . . 34

Enabling Sync Events in the Interplay Administrator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34

Creating a PEBCo Instance on a Single MCS Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36

Creating a PEBCo Instance on an MCS Cluster. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36

Configuring the ACS Bus Service in Interplay Administrator . . . . . . . . . . . . . . . . . . . . . . . . . 38

Configuring and Using the PEBco Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39

Chapter 6 Installing and Configuring Production Services for MediaCentral Delivery . . 43

Understanding Production Services for MediaCentral Delivery . . . . . . . . . . . . . . . . . . . . . . . 43

Check List for Installing and Configuring Automation and Consolidate Services . . . . . . . . . . 44

Prerequisites for Installing and Configuring Automation and Consolidate Services . . . . . . . . 45

Installing the Automation and Consolidate Services. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46

Registering the Automation and Consolidate Services. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46

Registering a Provider with the Production Services Engine . . . . . . . . . . . . . . . . . . . . . . . . . 48

Creating a Consolidate Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52

Chapter 7 Configuring iNEWS for Media | Index. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55

Editing iNEWS Site Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57

Manually Installing the log4cpp File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59

(Optional) Enabling Logging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59

Assigning the Media | Index Attribute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60

Activating the Mediaindex Program . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60

Chapter 8 Setting Up Interplay | MAM Sync Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61

About Interplay | MAM Sync Service Administrator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61

Opening Sync Service Administrator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64

Understanding the Sync Service Administrator Layout. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65

Quitting Sync Service Administrator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70

Appendix A Upgrading Media | Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71

Upgrading Media Index from v2.2 or Higher. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71

Upgrading Media Index from v2.0.x or v2.1.x . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71

Media | Index Backup Locations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75

Appendix B Working with Media Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76

Media Index Log Locations. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76

Updating Localization Strings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76

Displaying Information about Initialized Systems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77

Checking the Current Index Status. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78

Using the Media | Index Restart Command Line Tool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79

Restarting the Search and PEBCo Services. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81

Re-Sharding a Media Index Database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82

Taking Nodes Offline in a MediaCentral Cluster. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83

Removing Zones from a Multi-Zone Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84

Disabling Media Index. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85

Appendix C Media | Index Custom Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87

Configuring Media Index Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87

Modifying the Media | Index System Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89

Adjusting Settings Through the ACS Monitor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93

Setting Elasticsearch Memory Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103

Configuring the PEBCo for Custom Configurations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104

Changing the Default Search Type. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104

Changing Replica Counts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105

Changing the Index Refresh Interval . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107

Appendix D Updating Media | Index Property Schemas . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108

Property Changes in Production and Schema Updates . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108

Monitor the Re-index Process. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111

Using This Guide

This guide is intended for users of Avid MediaCentral Platform Services (MCS) with the Media | Index feature. This guide describes the configuration procedures for Media Index, such as configuring Media Index for single-server and cluster installations.

For information on installing MCS, see the MediaCentral Platform Services Installation and

Configuration Guide. For administrative information for MediaCentral | UX, see the Avid MediaCentral | UX Administration Guide.

Important: See the following link on the Avid Knowledge Base for the latest updates to this guide and all related documentation:

http://avid.force.com/pkb/articles/en_US/user_guide/Avid-MediaCentral-Documentation

If copying / pasting commands from this document into a command line interface such as Putty, be sure to verify the command after pasting. It is possible that some characters might be replaced during the paste process which can lead to a failed or problematic installation.

Revision History

Date Revised Changes Made

January 10, 2017 Additional detail added to the note on page 42 regarding Interplay Production

database permissions.

December 22, 2016 A progress bar has been added to the PEBCo configuration window in the Interplay

Administrator.

For details, see “Configuring and Using the PEBco Service” on page 39.

Symbols and Conventions

Avid documentation uses the following symbols and conventions:

Symbol or Convention Meaning or Action

A note provides important related information, reminders,

recommendations, and strong suggestions.

A caution means that a specific action you take could cause harm to

> This symbol indicates menu commands (and subcommands) in the

your computer or cause you to lose data.

A warning describes an action that could cause you physical harm. Follow the guidelines in this document or on the unit itself when handling electrical equipment.

order you select them. For example, File > Import means to open the File menu and then select the Import command.

Symbol or Convention Meaning or Action

This symbol indicates a single-step procedure. Multiple arrows in a list indicate that you perform one of the actions listed.

If You Need Help

(Windows), (Windows only), (Macintosh), or (Macintosh only)

Bold font Bold font is primarily used in task instructions to identify user interface

Italic font Italic font is used to emphasize certain words and to indicate variables.

Courier Bold font

Ctrl+key or mouse action Press and hold the first key while you press the last key or perform the

If You Need Help

If you are having trouble using your Avid product:

1. Retry the action, carefully following the instructions given for that task in this guide. It is especially important to check each step of your workflow.

2. Check the latest information that might have become available after the documentation was published. You should always check online for the most up-to-date release notes or ReadMe because the online version is updated whenever new information becomes available. To view these online versions, select ReadMe from the Help menu, or visit the MediaCentral Documentation page at

http://avid.force.com/pkb/articles/en_US/user_guide/Avid-MediaCentral-Documentation.

This text indicates that the information applies only to the specified operating system, either Windows or Macintosh OS X.

items and keyboard sequences.

Courier Bold font identifies text that you type.

mouse action. For example, Command+Option+C or Ctrl+drag.

3. Check the documentation that came with your Avid application or your hardware for maintenance or hardware-related issues.

4. Visit the online Avid Knowledge Base. Online services are available 24 hours per day, 7 days per week. Search this online Knowledge Base to find answers, to view error messages, to access troubleshooting tips, to download updates, and to read or join online message-board discussions.

Avid Training Services

Avid makes lifelong learning, career advancement, and personal development easy and convenient. Avid understands that the knowledge you need to differentiate yourself is always changing, and Avid continually updates course content and offers new training delivery methods that accommodate your pressured and competitive work environment.

For information on courses/schedules, training centers, certifications, courseware, and books, please visit www.avid.com/support and follow the Training links, or call Avid Sales at 800-949-AVID (800-949-2843).

1 Media | Index Configuration Overview

This document describes the tasks required to configure a Media Index system.

Media Index comprises the following components:

• Elasticsearch

• Elasticsearch tribe service, the federated client that enables multi-zone search functionality.

• Data Import API, a bus-based service for metadata indexing, search, configuration, status, permissions, and updates for Media Index.

• Search API, a bus-based service that provides the search API

• Media Index Configuration API, a bus-based service that provides the API for the Media Index configuration

• Media Index Status API, a bus-based service that provides the API for the Media Index

• Media Index Permissions API, a bus-based service that provides per asset permissions for the search service

• Media Index Feed API, a bus-based service that provides an updated assets feed for external services

• Media Index Thesaurus API, a bus-based service that provides API for importing structured metadata (dictionaries)

service, which manages data storage and runs the search engine.

Elasticsearch is an open source, distributed, real-time search and analytics engine. Elasticsearch stores information about assets and makes it accessible across multiple sites.

For more information on Elasticsearch operation and term definitions, visit the Elasticsearch website:

https://www.elastic.co/guide/en/elasticsearch/guide/master/distributed-cluster.html

Prerequisites for Media | Index Configuration

Before you configure Media Index, you need to install and configure the following MediaCentral components:

• MediaCentral Platform Services (MCS) — Media Index is configured after you have installed and set up your MCS system, either for a single server or for a cluster configuration. For more information about installing and configuring MCS, see the MediaCentral Platform Services Installation and Configuration Guide.

• Multi-zone components — If you use MCS in a multi-zone environment, you must first configure the multi-zone components. For information on configuring a multi-zone environment, see the MediaCentral Platform Services Installation and Configuration Guide.

MediaCentral servers configured with Media Index require a minimum of 128 GB of RAM in each server. Prior to configuring Media Index, verify that your server meets these requirements.

Checklist for Configuring Media | Index

For more information on hardware requirements, see the MediaCentral Platform Services Hardware Guide.

Media Index is installed with MediaCentral Platform Services by default, but the Media Index services are not started by default. Once configured, Media Index services start automatically when the server is powered-on.

Media Index can be configured in both standalone and multi-zone environments. Multi-zone configurations federate separate MCS installations, which can be co-located in a single facility or geographically separated — for example, one zone could be located in Toronto and another in Munich.

If configuring Media Index with an Interplay Production system, review the following:

• The Production Engine Bus Connector (PEBCo) service requires Interplay Engine v3.1 or later.

• If you are installing or updating your configuration with Media Index v2.3.x, you must install Interplay Access v3.3. You do not need to update your Interplay Production Engine to v3.3, but you must have the Interplay Administration tool that installs with Interplay Access v3.3 to enable sync events for Media Index.

• If you are installing or updating your configuration with Media Index v2.4 or later, you must install Interplay Access v3.5 or later. You do not need to update your Interplay Production Engine to v3.5, but you must have the Interplay Administration tool that installs with Interplay Access v3.5 or later to enable sync events for Media Index.

• If you are indexing an Interplay Archive Engine, you must use Interplay Access v3.6 or later.

Checklist for Configuring Media | Index

The following table provides a checklist for configuring Media Index components. The checklist also includes chapter and page references to complete each step.

Task Section Reference

Review the prerequisites. “Prerequisites for Media | Index Configuration”

on page 9.

Configure the Media Index and Elasticsearch

services on the MediaCentral server or servers.

Validate your configuration. “Validating the Media | Index Configuration” on

If you have a multi-zone setup, configure

Media Index for multiple zones.

If you are integrating with an Interplay Production

system, configure the Production Engine Bus Connector.

“Configuring Media | Index for a Single Server” on page 12 or “Configuring Media | Index for a Cluster” on page 17.

page 15 or “Validating the Media | Index Configuration” on page 24.

“Setting Up Multi-Zone Search” on page 27.

“Installing the Production Engine Bus Connector” on page 34.

If you are integrating with an Interplay Production

system that includes Production Services such as Interplay Delivery, configure additional provider services used with Media Index workflows.

“Installing and Configuring Production Services for MediaCentral Delivery” on page 43.

Checklist for Configuring Media | Index

Task Section Reference

If you are integrating with an Avid iNEWS system,

configure the iNEWS servers for Media Index.

If you are integrating with an Interplay MAM

system, configure the MAM servers for Media Index.

“Configuring iNEWS for Media | Index” on page 55.

“Setting Up Interplay | MAM Sync Service” on page 61.

For information on installing and configuring Interplay MAM, see the Interplay | MAM

Installation Manual and the Interplay | MAM Sync Service Administrator User’s Guide.

2 Configuring Media | Index for a Single

Server

When you set up Media Index, you enable Elasticsearch and several other services related to Media Index. Elasticsearch and Elasticsearch Tribe are used to index, store and search assets while the Media Index services add specific Avid logic to Elasticsearch.

Elasticsearch indexes are split into “shards” and “replicas”. Each shard contains indexed data and each replica contains a copy of that data. Replicas are used to spread the search load and provide redundancy. Single server installations default to one shard and zero replicas. This is the appropriate number of shards and replicas for single server configuration and in most cases the numbers should not be altered.

The configuration of shards and replicas on a single server is fairly simple, but the deployment becomes more complex in clustered systems. If you are interested in learning more about Elasticsearch shards and replicas, see “Shard Count and Usage” on page 17 of this guide.

Preparing for the Media | Index Configuration

When you install MediaCentral Platform Services, Media Indexes services are stopped, except for avid-acs-media-index-configuration. Before you begin configuring Media Index, you must start this configuration service if it has stopped.

You can also change the default method of naming Elasticsearch nodes. The Media Index API uses the hostname of the Elasticsearch node as the display name of the node. If you disable this default behavior, Elasticsearch automatically generates node names. You can also supply a different value to use for assigning node names.

To check the status of the Media Index configuration service:

1. Open a Linux terminal window on your MCS server and type the following command:

service avid-acs-media-index-configuration status

The result must report that the service has started:

avid-acs-media-index-configuration is running

2. If the configuration service is not running, type the following command:

service avid-acs-media-index-configuration start

To change the default Elasticsearch node name method:

1. Open the configuration file for editing by typing the following command:

vi /etc/sysconfig/avid-acs-media-index-configuration

2. Using the text editor, locate the following line:

export ELASTICSEARCH_NODE_NAME=hostname

Configuring Media | Index

3. Delete the

If the node name variable is not set, Elasticsearch automatically generates node names when your

node starts. If it is set to running.

4. Press the Escape key to return to command mode, then type quit the text editor.

5. Restart the configuration service to enable the configuration changes:

service avid-acs-media-index-configuration restart

hostname

value and type the value you want to use to assign to node.

hostname

, Elasticsearch uses the hostname of the node where the service is

Configuring Media | Index

You configure Media Index in the MediaCentral | UX System Settings. You must provide the following properties in your settings:

• Cluster Name — The “Cluster Name” is simply an identifier for the Media Index configuration on this system. In a standalone configuration (non-multi-zone), Avid recommends using the local hostname or site location (e.g. NewYork). In a multi-zone configuration, Avid recommends using the same value that you used for “Zone Name” during the multi-zone configuration process. Each zone in a multi-zone configuration requires a unique Media Index Cluster Name.

• Elasticsearch Cluster Hosts — Specify the host name or IP address of the MediaCentral server running the Elasticsearch service.

:wq

and press Return to write and

• Elasticsearch TCP Port — Specify the TCP port of the Elasticsearch data node, used for binary connection protocol and for inter-node communications. The default value is 9300. In most cases you, you do not need to modify this property.

• Elasticsearch HTTP Port — Specify the port of the Elasticsearch data node HTTP API. The default value is 9200. In most cases you, you do not need to modify this property.

• Elasticsearch Tribe TCP Port — Specify the TCP port of the Elasticsearch tribe node, used for inter-node communications. The default value is 9305. In most cases you, you do not need to modify this property.

• Elasticsearch Tribe HTTP Port — Specify the port of the Elasticsearch tribe node HTTP API. The default value is 9201. In most cases you, you do not need to modify this property

• Default Shards — Specify default shards count. Avid recommends using a default value of 1 shard.

• Default Replicas — Specify default replica count. The default number of replicas is 0, which is the required replica count for a single-server configuration.

• Supported languages — Lists the languages supported by Media Index.

Media Index supports multiple languages for your search. However, enabling all languages can slow down searches. You should enable only those languages your users require. If you work with a multi-zone configuration, you can enable different languages for each zone, and these languages are then available for all indexes within the specified zone. If possible, your language selection should be the same across all zones, because a search using one language returns results only from indexes that you have configured for this language.

Configuring Media | Index

The following table provides an example of which languages are used in searches within a multi-zone configuration with different languages enabled for different zones.

Enabled Languages Language Selected for Search Languages in Results

Zone 1: English, French

Zone 2: English, Korean

Zone 1: English, French

Zone 2: English, Korean

Zone 1: English, French, Korean

Zone 2: English, French, Korean

English Zone 1: English

Zone 2: English

French Zone 1: French

Zone 2: [no results]

French Zone 1: French

Zone 2: French

If you change your language settings after you have configured Media Index, you must reset Media Index. This deletes all indexes, which you then need to re-index.

To configure Media Index:

1. Sign in to MediaCentral UX as an administrator.

2. Select System Settings from the Layout selector.

The System Settings layout opens.

3. In the Settings pane select Media Index > Settings.

The Media Index Settings display in the Details pane.

4. Specify the required settings for the following properties:

- Cluster Name (custom name for this zone)

Validating the Media | Index Configuration

The Cluster Name field must include only letters, numbers, dashes, and underscore symbols.

- Elasticsearch Cluster Hosts (hostname or IP address of the local MediaCentral node)

- Elasticsearch TCP Port

- Elasticsearch HTTP Port

- Elasticsearch Tribe TCP Port

- Elasticsearch Tribe HTTP Port

- Default Shards

- Default Replicas

5. Click Apply. The system will display a message on the screen indicating “Update in progress...”.

After a few moments, a second message should appear indicating that Index has been configured successfully:

6. Click Close.

Validating the Media | Index Configuration

You can validate your setup by checking the status of the Media Index services and ensuring that they are running. Using the Cluster State pane in MediaCentral UX, you can view your node with core services running and see that the system data index is available.

To check the current status of Media Index:

1. Sign in to MediaCentral UX as an administrator.

2. Select System Settings from the Layout selector.

The System Settings layout opens.

3. In the Settings pane select Media Index > Cluster State.

The Media Index Cluster State display in the Details pane.

Media Index Cluster State pane, with the system_data index and one index available

Continuing the Installation

The core services for your configuration must display a status of “Running,” and the system_data must display the shard count in green.

Later, once you have configured an Interplay Production, MAM or iNEWS system, additional information on the indexes will appear in this window. The following image shows an index for an Interplay Production system:

Once configured, the string of characters listed in the index will match the System ID that appears in the System Settings > Media Index > Indexes pane.

Continuing the Installation

Depending upon your workflow, proceed to one or more of the following sections as applicable:

• If you are installing Media Index in a multi-zone configuration, see “Setting Up Multi-Zone

Search” on page 27.

• If you are integrating with and Interplay Production or Interplay Archive system, you need to configure and start the Production Engine Bus Connector (PEBCo) service. For information on PEBCo, see “Installing the Production Engine Bus Connector” on page 34.

• If you are integrating with an Avid iNEWS system, you must configure the iNEWS servers to synchronize data with the Media Index services. For information, see “Configuring iNEWS for

Media | Index” on page 55.

• If you are integrating with an Interplay MAM system, you must configure the MAM servers to communicate with Media Index. For more information, see “Setting Up Interplay | MAM Sync

Service” on page 61.

• For additional customization of the Media Index configuration, see “Media | Index Custom

Configuration” on page 87.

3 Configuring Media | Index for a Cluster

When you set up Media Index, you enable Elasticsearch and several other services related to Media Index. Every node in an MCS cluster runs an Elasticsearch instance as well as an Elasticsearch-tribe instance. Elasticsearch and Elasticsearch Tribe are used to index, store and search assets while the Media Index services add specific Avid logic to Elasticsearch. Tribe instances allow you to perform read operations against the nodes in multiple zones.

Although the MediaCentral Corosync cluster includes resources that relate to Media Index, the Corosync cluster and the Elasticsearch cluster do not share configuration details and use different mechanisms for the clustering.

You can configure Elasticsearch in a federated way so that a tribe instance of one Elasticsearch zone can be connected to other zones (one or more Elasticsearch data instances). For MediaCentral multi-zone configurations, this functionality is required The tribe node configuration process connects multiple systems to each other so that searches from each zone can find assets from all other remotely connected Elasticsearch zones.

When you create an index, Elasticsearch creates a number of “primary shards” and “replicas,” each shard contains indexed data and each replica contains a copy of that data. You use shards and replicas to spread the search load and provide redundancy.

Shard Count and Usage

Elasticsearch shards are available in two varieties: primaries and replicas. The key difference is that primary shards allow for both read and write while replica shards are read-only.

During the configuration of Media Index, you configure the number of (primary) shards and replicas through the MediaCentral UX System Settings. In a single-server configuration, a single shard is configured with zero replicas. Since there is only one server, there is little benefit to having a replica of the shard on the same system.

In cluster configurations, Avid recommends setting the shard count to one and the replica count to one fewer than the number of cluster nodes to accommodate fail-over safety and load balancing. For example, if your configuration includes a cluster with five nodes, set the replica count to four. This allows for one node to maintain the primary shard with a replica of all your indexed data on the remaining nodes. This horizontal scaling allows the load to be distributed among the nodes which increases efficiency and enables redundancy.

Shard Count and Usage

Configuring a Single Primary Shard

Consider a MediaCentral cluster consisting of three nodes, as shown below:

In this configuration, the MediaCentral UX System Settings were configured for:

• 1 Default (primary) Shard

• 2 Index Replicas

Elasticsearch intelligently locates the shards across the three nodes. In this example the primary shard happens to be located on Node 1, but that might not always the case. A single primary shard, coupled with replicas, provides redundancy and flexibility for your index.

In most situations, a single primary shard provides enough resources to host your entire index. MediaCentral systems that are indexing very large databases, such as large Interplay MAM deployments, can increase the shard count to decrease the amount of data per shard. In such configurations, an MCS cluster is used to spread the increased load of multiple primary shards across the cluster nodes.

Configuring Multiple Primary Shards

In the following example, the System Settings in the same MediaCentral cluster have been configured for 3 primary shards and 2replica shards:

As previously stated, this configuration spreads the load across multiple systems which increases database efficiency and enables additional redundancy. Notice that the primary shard and its replica are never co-located on the same server. The number of primary shards in your configuration affects the amount of data that can be stored in your index, although the type of data and metadata affects the size of the index as well.

It is important to plan your configuration early in the process. Once configured, users can add replicas to the configuration, but primary shards cannot be added without reconfiguring and resynchronizing the indexes which can be a time consuming process. For example, if you start with two server nodes but know that at some point you will scale your configuration up to six nodes, you

Shard Count and Usage

might want to configure Media Index initially for six shards. As the additional nodes are added to the configuration, Elasticsearch relocates the primary shards to the new nodes so that the shards are evenly distributed across the six servers (one shard on each node).

Increasing the amount of shards without increasing the number of nodes on the system adds load to

the system resources. For systems with spinning disks, there should ideally be nor more than two shards per node. Only increase the number of primary shards if you know that additional nodes will be added in the near future or if directed to do so by Avid.

Explaining Failover

If a primary node is lost, it must have a replica for the system to continue to operate normally. If available the former read-only replica shard is automatically promoted to primary, providing uninterrupted read/write access to the Elasticsearch database. If a replica is not available, Indexed searches will fail until the node containing the missing sharded is repaired. Configuring multiple shards and replicas gives your index more stability in case of a failure or if you need to take one or more nodes offline for maintenance.

Example 1: In this illustration, Node 1 has failed. Elasticsearch dynamically promoted the replica of the shard on Node 2 to primary. Since Node 2 and Node 3 both contain a replica of Node 1, Elasticsearch decides which replica becomes the primary based on an internal algorithm.

Note that in this configuration, the system is still fully redundant. The primary shard has a replica on Node 3. Since replicas load-balance read requests, it is possible that users might see a small reduction in search performance.

Example 2: Similar to the previous illustration, Node 2 was taken offline which resulted in Elasticsearch dynamically promoting the replica shard on Node 3 to primary.

Note that in this configuration, the system is still fully redundant. Each primary shard has a replica on another node. Node 3 now hosts two primary shards.

Preparing for the Media | Index Configuration

Example 3: In this final example, MediaCentral has been configured for 3 primary shards and 1 replica:

If Node 1 goes offline, Replica 1 on Node 3 becomes a primary shard and the index remains fully functional. However, since Node 1 also hosted the replica for Node 2, Elasticsearch then re-creates the missing replica, as shown in the following illustration:

If Node 2 goes offline, the index remains functional because Node 3 contains Shards 1 and 3, as well as a replica of Shard 2. However, if Node 2 goes offline before Elasticsearch re-creates the replica on Node 3, then the index is incomplete and cannot function.

Preparing for the Media | Index Configuration

Prior to configuring Media Index on a MediaCentral cluster, it is good practice to check that the cluster is healthy. The Cluster Resource Monitor,

To monitor the cluster:

1. Log in to any node in the cluster and open the Cluster Resource Monitor:

crm_mon -f

2. If any failure are listed, use the cleanup command to reset the fail-counts:

crm resource cleanup <resource>

Where <resource> is the name of the Pacemaker resource you want to clean — for example, avid-acs-search.

3. The Cluster Resource Monitor is needed again in the following process. If desired, you can leave the monitor tool running or close it and reopen it again later.

To close the Cluster Resource Monitor, press CTRL-C on a Windows keyboard or CMD-C on a Mac keyboard.

crm_mon

, is used to verify this information.

For more information on using the cluster resource monitor utility, see “Cluster Resource Monitor”

in the MediaCentral Platform Services Concepts and Clustering Guide.

Adding Resources to the Cluster

When you install a new MediaCentral system, all Media Index services are stopped except for the “avid-acs-media-index-configuration” service. After issuing the setup command, as detailed in the following process, additional services are started and resources are added to the cluster.

To add resources to the cluster:

1. Log in to any node in the cluster as root and type the following command:

/opt/avid/cluster/bin/search-cluster setup

The necessary resources are added to the cluster configuration, and the related services are started. The following example shows the new cluster resources:

pgpool (lsb:pgpool): Started wavd-mcs01

pgpoolchecker (lsb:pgpoolchecker): Started wavd-mcs01 Clone Set: elasticsearchEverywhere [elasticsearch]

Started: [ wavd-mcs01 wavd-mcs02 wavd-mcs03 ]

Clone Set: elasticsearchTribeEverywhere [elasticsearchTribe]

Started: [ wavd-mcs01 wavd-mcs02 wavd-mcs03 ]

Clone Set: AvidSearchConfigEverywhere [AvidSearchConfig]

Started: [ wavd-mcs01 wavd-mcs02 wavd-mcs03 ]

If the cluster is not detected, the following message is displayed:

The cluster services are either down or the cluster is not yet configured. Please make sure that the corosync and pacemaker services are running correctly and that the cluster is properly configured before rerunning the search-cluster script.

Adding Resources to the Cluster

2. If not already running, open the Cluster Resource Monitor to verify that the resources have been added successfully:

crm_mon -f

When configuring a cluster for Media Index a number of new resources are added to Pacemaker, making it difficult to see the fail-counts at the end of the output. If this is the case, you can modify the command with a “1” which tells the Cluster Resource Monitor to print the output to the screen once and exit:

crm_mon -f1

3. If any failure are listed, use the cleanup command to reset the fail-counts:

crm resource cleanup <resource>

Where <resource> is the name of the Pacemaker resource you want to clean — for example, avid-acs-search.

4. Press CTRL-C on a Windows keyboard or CMD-C on a Mac keyboard to exit the crm_mon utility.

Configuring Media | Index

You configure Media Index in the MediaCentral | UX System Settings. You must provide the following properties in your settings:

• Cluster Name — This name has no direct relation to the virtual host name given to the Corosync cluster. The “Cluster Name” is simply an identifier for the Media Index configuration on this system. In a standalone configuration (non-multi-zone), Avid recommends using the Corosync

Configuring Media | Index

cluster hostname or site location (e.g. NewYork). In a multi-zone configuration, Avid recommends using the same value that you used for “Zone Name” during the multi-zone configuration process. Each zone in a multi-zone configuration requires a unique Media Index Cluster Name.

Avid recommends that you not change the Cluster Name after your initial configuration. If you change the cluster name, Elasticsearch creates a new data folder on the next restart. While the index data is not lost, any indexes that existed before changing the cluster name fail to appear in your configuration and the information in them is not accessible. When you work in a multi-zone set-up, you should consider which cluster names you plan to use in all zones and not change them after the indexing process has started.

• Elasticsearch Cluster Hosts — Specify the hostname or IP address of each MediaCentral server running the Elasticsearch service. Each must be separated by a comma.

• Elasticsearch HTTP Port — Specify the port of the Elasticsearch data node HTTP API. The default value is 9200. In most cases you, you do not need to modify this property.

• Elasticsearch Tribe HTTP Port — Specify the port of the Elasticsearch tribe node HTTP API. The default value is 9201. In most cases you, you do not need to modify this property

• Default Shards — Specify the number of default shards. Avid recommends using a default value of 1 shard. This only changes if indexing a very large database such as an Interplay MAM system. If you are considering altering the number of default shards, consult your Avid representative before making this change.

• Default Replicas — Specify default replica count. The default number of replicas is 0, which is the required replica count for a single-server configuration. In an MCS cluster installation, you must set the default number of replicas to a number greater than zero.

A replica count greater than zero is necessary in a cluster configuration in order to ensure that your data gets distributed properly and remains safe. For maximum security, you should set the replica count to a value of <number of MCS cluster nodes> minus 1. Do not set the replica count to a value greater than this. For example, if your configuration consists of two nodes, then set the replica count to 1.

• Supported languages — Lists the languages supported by Media Index.

Configuring Media | Index

Enabled Languages Language Selected for Search Languages in Results

Zone 1: English, French

Zone 2: English, Korean

Zone 1: English, French

Zone 2: English, Korean

Zone 1: English, French, Korean

Zone 2: English, French, Korean

English Zone 1: English

Zone 2: English

French Zone 1: French

Zone 2: [no results]

French Zone 1: French

Zone 2: French

If you change your language settings after you have configured Media Index, you must reset Media Index. This deletes all indexes, which you then need to re-index.

When you set these values and apply your changes, Media Index writes to several configuration files and restarts cluster services and resources. It also creates the system_data index. This process might take some time, depending on your cluster configuration.

To configure Media Index:

1. Sign in to MediaCentral UX as an administrator.

2. Select System Settings from the Layout selector.

The System Settings layout opens.

3. In the Settings pane select Media Index > Settings.

The Media Index Settings display in the Details pane.

Validating the Media | Index Configuration

4. In the Supported Languages section, select the languages you want to make available for searching. You can select as many languages as needed, but Avid recommends you select only those languages your users are likely to use in a search.

5. Click the Default Language menu, and select the default language for indexed searches.

6. Specify the required settings for the following properties:

- Cluster Name (custom name for this zone)

The Cluster Name field must include only letters, numbers, dashes, and underscore symbols.

- Elasticsearch Cluster Hosts

- Elasticsearch TCP Port

- Elasticsearch HTTP Port

- Elasticsearch Tribe TCP Port

- Elasticsearch Tribe HTTP Port

- Default Shards

- Default Replicas

7. Click Apply. The system will display a message on the screen indicating “Update in progress...”.

After a few moments, a second message should appear indicating that Index has been configured successfully:

8. Click Close.

Validating the Media | Index Configuration

You can validate your setup by checking the status of the Media Index services and ensuring that they are running. Using the Cluster State pane in MediaCentral UX, you can view all nodes with core services running and see that the system data index is available. You should also use the Cluster Resource Monitor utility, crm_mon, to verify the status and failure counts of the MediaCentral services. Any failures should be reset or investigated.

For information on using the cluster resource manager, see “Monitoring Services and Resources” in

the MediaCentral Platform Services Installation and Configuration Guide.

To check the current status of Media Index:

1. Sign in to MediaCentral UX as an administrator.

2. Select System Settings from the Layout selector.

The System Settings layout opens.

3. In the Settings pane select Media Index > Cluster State.

The Media Index Cluster State displays in the Details pane.

Validating the Media | Index Configuration

The core services for your configuration must display a status of “Running,” and the indexes must display the shard count in green. Note that the avid-acs-search-import service is installed on all cluster nodes, but is only ever active on one node.

To monitor the fail count within the cluster:

1. Log in to any node in the cluster as root and verify the cluster fail counts by typing the following command:

crm_mon -f

When configuring a cluster for Media Index a number of new resources are added to Pacemaker, making it difficult to see the fail-counts at the end of the output. If this is the case, you can modify the command with a “1” which tells the command to print the output to the screen once and exit:

crm_mon -f1

Additional “AvidSearch” resources will have been added to the cluster.

2. Use the cleanup command to reset any observed failure counts:

crm resource cleanup <resource>

<resource> is the name of the resource you want to monitor — for example, avid-acs-search.

For more information on using the cluster resource monitor utility, see “Cluster Resource Monitor”

in the MediaCentral Platform Services Concepts and Clustering Guide.

Continuing the Installation

Depending upon your workflow, proceed to one or more of the following sections as applicable:

• If you are installing Media Index in a multi-zone configuration, see “Setting Up Multi-Zone

Search” on page 27.

• If you are integrating with an Avid iNEWS system, you must configure the iNEWS servers to synchronize data with the Media Index services. For information, see “Configuring iNEWS for

Media | Index” on page 55.

• If you are integrating with an Interplay MAM system, you must configure the MAM servers to communicate with Media Index. For more information, see “Setting Up Interplay | MAM Sync

Service” on page 61.

• For additional customization of the Media Index configuration, see “Media | Index Custom

Configuration” on page 87.

Once configured, taking a cluster node configured for Media Index offline requires special procedures. for more information, see “Taking Nodes Offline in a MediaCentral Cluster” on page 83.

Continuing the Installation

4 Setting Up Multi-Zone Search

In a multi-zone MCS configuration, each zone runs its own Elasticsearch cluster with its own Elasticsearch Cluster Name. This is true for MCS single-servers as well as MCS servers in a Corosync cluster configuration. Single servers run a Elasticsearch cluster consisting of one node. These different Elasticsearch clusters are then connected to each other using the Elasticsearch tribe service. For example, in a two zone configuration, if you call one cluster “Zone1” and another cluster “Zone2,” you configure the Media Index Cluster Name to Zone1 on all nodes in one MCS cluster and to Zone2 on all nodes in the second MCS cluster.

Avid recommends that you name each cluster using the same value that you used for “Zone Name”

during the multi-zone configuration process.

You can configure the MCS multi-zones before or after starting the Media Index multi-zone configuration. However, if you complete your Media Index multi-zone configuration without having previously configured your MCS multi-zones, you cannot play back remote assets until the multi-zone configuration process is complete. Avid recommends configuring and testing the multi-zone configuration before configuring Media Index.

If you need to change the Media Index Cluster Name, you must make the change before proceeding with the Media Index multi-zone configuration process detailed in this chapter. For information on changing the Cluster Name, see “Modifying the Media | Index System Settings” on page 89.

For information for configuring MCS for multi-zones, see the MediaCentral Platform Services Installation and Configuration Guide. For information on user management and multi-zones in MediaCentral UX, see “Managing Multi-Zone Environments” in the Avid MediaCentral | UX Administration Guide.

Setting the Zone Bindings

To join two or more individual zones in a multi-zone setup, you must update the Elasticsearch tribe configuration on all of your tribe nodes and set bindings for all Elasticsearch clusters. If one or more zones share the same Cluster Name, you also have to reconfigure the Cluster Name so that each zone has a unique name. This requires changes in the Elasticsearch and the Elasticsearch tribe.

You must update the Elasticsearch configuration file — /etc/elasticsearch-tribe/elasticsearch.yml —

on all cluster nodes in each of the zones.

Setting the Zone Bindings

To update the Elasticsearch tribe configuration:

1. Using the Linux text editor, vi, open the Elasticsearch tribe configuration file for editing:

vi /etc/elasticsearch-tribe/elasticsearch.yml

2. Add the following lines in the configuration file to add the binding information that allows the tribe to connect to another Media Index cluster:

tribe.<RemoteClusterName>.cluster.name: <RemoteClusterName> tribe.<RemoteClusterName>.transport.tcp.port: <port>

Where the following variables are used:

the MediaCentral UX System Settings of the remote zone.

<port>

Avid recommends using port number 9313 as the starting port. If additional zones are added to your configuration, increment the port number by one for each zone (9314, 9315, and so on). Avid recommends using sequential port numbers for clarity, but this is not required.

You must use a space between the colon (:) and your custom variable for each of these lines.

3. Add the following line to configure Unicast for tribe node binding:

tribe.<RemoteClusterName>.discovery.zen.ping.unicast.hosts:

- "<remoteMCSNode1>:9300"

- "<remoteMCSNode2>:9300" ...

- "<remoteMCSNodeN>:9300"

Where the following variables are used:

the MediaCentral UX System Settings of the remote zone.

name or IP address of an MCS server in the remote zone. If the remote zone is a single server, only one line is added. If the remote zone is a cluster, a line is added for each node.

- The

transport.tcp.port

remoteMCSNode1

- This value represents the Media Index Cluster Name specified in

number must be unique for each Media Index cluster.

- This value represents the Media Index Cluster Name specified in

> through <

remoteMCSNodeN

> - Each value represents the short host

When adding this information to the configuration file, strict adherence to formatting is important.

You must add two spaces before the dash “-” and one space after the dash. Do not add a space between the node name, the colon and the port number.

4. Save and exit the vi session:

Press <ESC> and type:

5. If you have a cluster configuration, repeat these steps for each node within the cluster.

6. Once complete, restart all Elasticsearch tribe nodes affected by your configuration changes:

t For single-server configurations, type the following command:

service elasticsearch-tribe restart

t For cluster configurations, type the following command on one of the nodes in your cluster:

crm resource restart elasticsearchTribeEverywhere

The following examples show an environment with three zones, where the first zone is a single server, the second zone is a three node cluster and the third zone is another single server.

:wq

Setting the Zone Bindings

Example from the master zone of the multi-zone configuration:

[root@wavd-doc01 ~]# cat /etc/elasticsearch-tribe/elasticsearch.yml

discovery.zen.ping.multicast.enabled: false tribe.local.cluster.name: Master_Zone tribe.local.transport.tcp.port: 9312 tribe.local.discovery.zen.ping.unicast.hosts:

- "wavd-doc01:9300" http.port: 9201 transport.tcp.port: 9305 node.name: wavd-doc01-tribe

tribe.Slave_Zone.cluster.name: Slave_Zone tribe.Slave_Zone.transport.tcp.port: 9313 tribe.Slave_Zone.discovery.zen.ping.unicast.hosts:

- "wavd-mcs01:9300"

- "wavd-mcs02:9300"

- "wavd-mcs03:9300"

tribe.3rd_Zone.cluster.name: 3rd_Zone tribe.3rd_Zone.transport.tcp.port: 9314 tribe.3rd_Zone.discovery.zen.ping.unicast.hosts:

- "wavd-news:9300"

Example from the first slave zone of the multi-zone configuration:

[root@wavd-mcs01 ~]# cat /etc/elasticsearch-tribe/elasticsearch.yml

discovery.zen.ping.multicast.enabled: false tribe.local.cluster.name: Slave_Zone tribe.local.transport.tcp.port: 9312 tribe.local.discovery.zen.ping.unicast.hosts:

- "wavd-mcs01:9300"

- "wavd-mcs02:9300"

- "wavd-mcs03:9300" http.port: 9201 transport.tcp.port: 9305 node.name: wavd-mcs01-tribe

tribe.Master_Zone.cluster.name: Master_Zone tribe.Master_Zone.transport.tcp.port: 9313 tribe.Master_Zone.discovery.zen.ping.unicast.hosts:

- "wavd-doc01:9300"

tribe.3rd_Zone.cluster.name: 3rd_Zone tribe.3rd_Zone.transport.tcp.port: 9314 tribe.3rd_Zone.discovery.zen.ping.unicast.hosts:

- "wavd-news:9300"

Example from the second slave zone of the multi-zone configuration:

[root@wavd-news ~]# cat /etc/elasticsearch-tribe/elasticsearch.yml

discovery.zen.ping.multicast.enabled: false tribe.local.cluster.name: 3rd_Zone tribe.local.transport.tcp.port: 9312 tribe.local.discovery.zen.ping.unicast.hosts:

- "wavd-news:9300"

http.port: 9201 transport.tcp.port: 9305 node.name: wavd-news-tribe

tribe.Master_Zone.cluster.name: Master_Zone tribe.Master_Zone.transport.tcp.port: 9313 tribe.Master_Zone.discovery.zen.ping.unicast.hosts:

- "wavd-doc01:9300"

tribe.Slave_Zone.cluster.name: Slave_Zone tribe.Slave_Zone.transport.tcp.port: 9314 tribe.Slave_Zone.discovery.zen.ping.unicast.hosts:

- "wavd-mcs01:9300"

- "wavd-mcs02:9300"

- "wavd-mcs03:9300"

Setting the Zone Bindings

+ 84 hidden pages

Pinnacle Systems Media Index - 2.9 User Manual

Contents

Using This Guide

Symbols and Conventions

If You Need Help

Avid Training Services

1 Media | Index Configuration Overview

Prerequisites for Media | Index Configuration

Checklist for Configuring Media | Index

Preparing for the Media | Index Configuration

Configuring Media | Index

Validating the Media | Index Configuration

Continuing the Installation

3 Configuring Media | Index for a Cluster

Shard Count and Usage

Preparing for the Media | Index Configuration

Adding Resources to the Cluster

Configuring Media | Index

Validating the Media | Index Configuration

Continuing the Installation

4 Setting Up Multi-Zone Search

Setting the Zone Bindings