ElasticSearch

Overview

Elastic Search is a multitenant-capable full-text search and analytics engine, based on Apache Lucene. One of its main services is the Elastic Cloud, which is the best way to consume all of Elastic’s products across any cloud. It allows for building powerful, modern search experiences for applications, websites, and workplaces. In addition, it allows accessing, viewing, and searching across all data.

Entitle manages the Elastic Search roles in Elastic Cloud.

This page will provide you with instructions on how to integrate Entitle and Elastic Cloud.

General guidelines

👉🏼To integrate your Elastic Cloud in Entitle, you will need to extract the following values for authentication:

1. Cloud ID - Must-have.
2. You have two options to choose from for the second authentication value:
   1. Basic Auth (Username and Password).
   2. Extract an API Key.

Prerequisites

• Please make sure that the Elastic Cloud user you wish to integrate with Entitle has Admin permissions.

Set up Elastic Cloud to work with Entitle

Stage 1: Extract your Cloud ID

1. Log into Elastic Cloud using your preferred method.

2. From the Deployment list on your home page, click Manage for the deployment you wish to give Entitle access to.

3. Copy the Cloud ID on the right side of the page, you will need to insert it later in the configuration.

Stage 2: Extract further authentication values

Once you have extracted your Cloud ID, choose one of the following options for the additional authentication values required.

• Option #1: Extract your Elastic Basic Auth (Username and Password)
  This option is faster, yet less secure - copy your Elastic Username and Password, and add them to the configuration later on.
• Option #2: Extract an API Key

1. Go back to the main page and in your chosen deployment click on Open.

2. In the new page that opens up, scroll down on the left-side menu and click on the Management drop-down.

3. Under the Security section click on API Keys.

4. Click on the blue Create API Key button. In the new window that appears, choose a Name for your API Key and then choose the Personal API Key option under the type section. Finally, click again on the blue Create API Key button.

5. Once you return to the main API Keys page, copy the new key that you have created and save it for the configuration later.

Creating the integration in Entitle

💡

Important

This applies to creating an integration either through Entitle on Pathfinder or through the Entitle standalone product.

1. Log in to Entitle and navigate to the Integrations page.

2. After clicking the Add Integration button, type Elasticsearch in the Application field.

3. Don’t forget to set Save on correctly on your own agent or Entitle’s cloud.

4. In the Connection field, choose either Basic Auth or API Key according to the authentication option you chose in Stage 2.

   • In case you chose the Basic Auth connection:

5. In the connection section JSON cloud_id field, paste the Cloud ID you copied in stage 1.

   💡

   If you are using an on-prem agent:

   Remember to run Check configuration before saving your integration. It will try to access the URL Elastic Search generated for you (coded into the cloud_id). If that URL isn't accessible, you will receive an error message showing you the URL value you need to allow outbound communications from your on-prem agent.

6. In the username and password fields, paste your Elastic Username and Password from Option #1 in stage 2.

Example Connection JSON:

{
  "cloud_id": "<Example_Cloud_Id>",
  "username": "<Example_username>",
  "password": "<Example_password>"
}

• In case you chose the API Key connection:

7. In the connection section JSON cloud_id field, paste the Cloud ID you copied in stage 1.

   💡

   If you are using an on-prem agent:

   Remember to run Check configuration before saving your integration. It will try to access the URL Elastic Search generated for you (coded into the cloud_id). If that URL isn't accessible, you will receive an error message showing you the URL value you need to allow outbound communications from your on-prem agent.

8. In the api_key field, paste your API Key from Option #2 in stage 2.

Example Connection JSON:

{
  "cloud_id": "<Example_Cloud_Id>",
  "api_key": "<Example_Api_key>"
}

9. Click Save, you are done!🎉.