Version 24.2.8980

• Add the Elasticsearch Connector
• Authenticate to Elasticsearch
  • None
  • BASIC
  • Negotiate
  • AWS Root Keys
  • AWS IAM Roles
  • API Key
• Complete Your Connection
• More Information

You can use the Elasticsearch connector from the CData Sync application to capture data from Elasticsearch and move it to any supported destination. To do so, you need to add the connector, authenticate to the connector, and complete your connection.

Add the Elasticsearch Connector

To enable Sync to use data from Elasticsearch, you first must add the connector, as follows:

1. Open the Connections page of the Sync dashboard.

2. Click Add Connection to open the Select Connectors page.

3. Click the Sources tab and locate the Elasticsearch row.

4. Click the Configure Connection icon at the end of that row to open the New Connection page. If the Configure Connection icon is not available, click the Download Connector icon to install the Elasticsearch connector. For more information about installing new connectors, see Connections.

Authenticate to Elasticsearch

After you add the connector, you need to set the required properties.

• Connection Name - Enter a connection name of your choice.

• Server - Enter the host name or IP address of your Elasticsearch REST server. You can specify multiple nodes in a single cluster, also. However, such nodes must be able to support REST API calls.

• Port - Enter the port number for the Elasticsearch REST server. The default port value is 9200.

• Aliases Filter (optional) - Enter a comma-separated list of alias names or filters that you want to use to filter aliases that are exposed as views.

• Indices and Data Streams Filter (optional) - Enter a comma-separated list of index and data stream names or filters.

CData Sync supports authenticating to Elasticsearch in several ways. Select your authentication method below to proceed to the relevant section that contains the authentication details.

• None
• BASIC
• Negotiate
• AwsRootKeys
• AwsIAMRoles
• APIKey

None

To connect without authentication, select None for Auth Scheme. No additional properties are required.

BASIC

To connect with your user credentials, set the following properties:

• Auth Scheme: Select BASIC.

• User - Enter the username that you use to authenticate to your Elasticsearch account.

• Password - Enter the password that you use to authenticate to your Elasticsearch account.

Negotiate

To connect with Kerberos credentials, specify the following properties:

• Auth Scheme – Select Negotiate.

• Kerberos KDC - Enter the Kerberos Key Distribution Center (KDC) service that you use to authenticate.

• Kerberos Realm - Enter the Kerberos Realm that you use to authenticate.

• Kerberos SPN - Enter the service principal name (SPN) for the Kerberos domain controller.

• Kerberos Keytab File (optional) - Enter the keytab file that contains your pairs of the Kerberos principals and encrypted keys.

• Kerberos Ticket Cache (optional) - Enter the full file path to the Kerberos credential cache file.

AWS Root Keys

To connect with your account root credentials, specify the following properties:

• Auth Scheme - Select AwsRootKeys.

• AWS Access Key - Enter your Amazon Web Services (AWS) account access key. You can locate this value on your AWS security credentials page.

• AWS Secret Key - Enter your AWS account secret key. You can locate this value on your AWS security credentials page.

• AWS Region - Select the region that hosts your Amazon Web Services. The default region is NORTHERNVIRGINIA.

AWS IAM Roles

To connect with your IAM user credentials, specify the following properties:

• Auth Scheme - Select AwsIAMRoles.

• AWS Access Key - Enter your Amazon Web Services (AWS) account access key. You can locate this value on your AWS security credentials page.

• AWS Secret Key - Enter your AWS account secret key. You can locate this value on your AWS security credentials page.

• AWS Role ARN - Enter the Amazon Resource Name (ARN) for the role with which you want to authenticate.

• AWS Region - Select the region that hosts your Amazon Web Services. The default region is NORTHERNVIRGINIA.

• AWS External Id (optional) - Enter the unique identifier that is required when you assume a role in another account.

API Key

To connect with an API key, specify the following properties:

• API Key - Enter the API key that you use to authenticate to Elasticsearch.

• API Key Id - Enter the API key that you use to authenticate to Elasticsearch.

Complete Your Connection

To complete your connection:

1. Specify the following properties:

   • Use SSL (optional) - Specify whether you want to use the Secure Sockets Layer (SSL) protocol. The default value is False.

   • Data Model (optional) - Select the data model that you want to use to parse Elasticsearch documents and generating the database metadata. The default data model is Document.

   • Expose Dot Indices (optional) - Specify whether you want to expose dot indices as either tables or views. These indices have names that begin with “.” (dot). The default option is False.

2. Define advanced connection settings on the Advanced tab. (In most cases, though, you should not need these settings.)

3. Click Create & Test to create your connection.

More Information

For more information about interactions between CData Sync and Elasticsearch, see Elasticsearch Connector for CData Sync.