Ctrlk
For the complete documentation index, see llms.txt. This page is also available as Markdown.

OpenSearch

Create an integration to manage access to an OpenSearch instance

OpenSearch is a community-driven, open-source search and analytics suite. Through this integration, Apono discovers OpenSearch indices and roles and manages access to these resources.

Prerequisites

Item
Description

Apono Connector

On-prem connection serving as a bridge between an OpenSearch instance and Apono:

Minimum Required Version: 1.4.0 Learn how to update an existing AWS, Azure, GCP, or Kubernetes connector.

OpenSearch Account Access

Account that can create internal users, roles, and role mappings in OpenSearch

OpenSearch Endpoint

URL of the OpenSearch console

Create an OpenSearch user

You must create a user in your OpenSearch instance for the Apono connector and grant that user permissions to your resources.

Follow these steps to create a user and grant it permissions:

  1. In OpenSearch, create a new user:

    1. In the side navigation, click Security > Internal users. The Internal users page opens.

    2. Click Create internal user.

    3. Enter a username, such as apono_connector.

    4. Enter a strong password. Be sure to save this password to create a secret later.

    5. Click Submit.

  2. Create a new role. This new role grants the monitoring permissions required to identify the cluster and discover indices.

    1. In the side navigation, click Security > Roles.

    2. Click Create role.

    3. Enter a role name, such as apono_connector.

    4. Under Cluster permissions, add the following permissions:

      • cluster:monitor/state

      • cluster:monitor/health

      • cluster:monitor/main

    5. Under Index permissions > Index, enter * as the index pattern.

    6. Under Index permissions, add the following permissions:

      • indices:monitor/settings/get

      • indices:monitor/stats

    7. Click Submit.

  3. Map the new user to the new Apono connector role:

    1. In the side navigation, click Security > Roles.

    2. Click the new role. The role settings page appears.

    3. On the Mapped users tab, click Manage mapping.

    4. Under Users, add the Apono connector username.

    5. Click Map.

  4. Map the security_manager role to the Apono connector user. This role lets Apono manage OpenSearch security configurations, including roles and role mappings.

    1. In the side navigation, click Security > Roles.

    2. Click the security_manager role. The role settings page appears.

    3. On the Mapped users tab, click Manage mapping.

    4. Under Users, add the Apono connector username.

    5. Click Map.

  5. Create a secret with the credentials from step 1. Use the following key-value pair structure when generating the secret. Be sure to replace <OPENSEARCH_CONNECTOR_USERNAME> and <OPENSEARCH_CONNECTOR_USERNAME_PASSWORD> with the actual value.

lightbulb

You can also input the user credentials directly into the Apono UI during the integration process.

Integrate OpenSearch

OpenSearch tile

You can also use the steps below to integrate with Apono using Terraform.

In step 12, instead of clicking Confirm, follow the Are you integrating with Apono using Terraform? guidance.

Follow these steps to complete the integration:

  1. On the Catalog tab, click OpenSearch. The Connect Integration page appears.

  2. Under Discovery, select one or multiple resource types.

Apono automatically discovers and syncs all the instances in the environment. After syncing, you can manage access flows to these resources.

  1. Click Next. The Apono connector section expands.

  2. From the Select Connector From List dropdown menu, select a connector. Choosing a connector links Apono to all the services available on the account where the connector is located.

lightbulb

If the desired connector is not listed, click New Connector and follow the instructions for creating a connector (AWS, Azure, GCP, Kubernetes).

  1. Click Next. The Integration Config page appears.

  2. Define the Integration Config settings.

Setting
Description

Integration Name

Unique, alphanumeric, user-friendly name used to identify the integration when constructing an access flow

Url

OpenSearch console URL

  1. Click Next. The Secret Store section expands.

  2. Associate the secret or credentials.

If you select the Apono secret manager, enter the OpenSearch Username and Password for the Apono Connector.

  1. Click Next. The Get more with Apono section expands.

  2. Define the Get more with Apono settings.

Setting
Description

Credential rotation period (in days)

(Optional) Number of days after which the database credentials must be rotated

Learn more about the Credentials Rotation Policy.

User cleanup after access is revoked (in days)

(Optional) Defines the number of days after access has been revoked that the user should be deleted

Learn more about Periodic User Cleanup & Deletion.

Custom Access Details

(Optional) Instructions explaining how to access this integration's resources Upon accessing an integration, a message with these instructions will be displayed to end users in the User Portal. The message may include up to 400 characters. To view the message as it appears to end users, click Preview.

Integration Owner

(Optional) Fallback approver if no resource owner is found Follow these steps to define one or several integration owners:

  1. From the Attribute dropdown menu, select User or Group under the relevant identity provider (IdP) platform.

  2. From the Value dropdown menu, select one or multiple users or groups.

NOTE: When Resource Owner is defined, an Integration Owner must be defined.

Resource Owner

(Optional) Group or role responsible for managing access approvals or rejections for the resource Follow these steps to define one or several resource owners:

  1. Enter a Key name. This value is the name of the tag created in your cloud environment.

  2. From the Attribute dropdown menu, select an attribute under the IdP platform to which the key name is associated. Apono will use the value associated with the key (tag) to identify the resource owner. When you update the membership of the group or role in your IdP platform, this change is also reflected in Apono.

NOTE: When this setting is defined, an Integration Owner must also be defined.

  1. (Recommended) Click Test Integration to validate the integration.

Test Integration is available after you have entered or selected values for all required integration fields.

During the test, Apono runs the following validation checks:

  • Connectivity: The connector can reach the integration.

  • Configuration: The integration is set up correctly.

  • Authentication: The credentials are valid.

  • Discovery: Resources can be fetched.

The Test Validation checklist shows the result of each check.

If a check fails, Apono identifies the failed check and highlights the fields that need correction.

  1. Click Confirm.

💡Are you integrating with Apono using Terraform?

If you want to integrate with Apono using Terraform, follow these steps instead of clicking Confirm:

  1. At the top of the screen, click View as Code. A modal appears with the completed Terraform configuration code.

  2. Click to copy the code.

  3. Make any additional edits.

  4. Deploy the code in your Terraform.

Refer to Integration Config Metadata for more details about the schema definition.

Usage

Now that the integration is complete, you can add OpenSearch as a resource in an access flow. This allows requesters to securely request temporary access to those resources based on your approval and provisioning rules.

Follow the guidance in these articles to define OpenSearch resources:

PreviousMicrosoft SQL Server
NextMongoDB

Last updated

Was this helpful?