# OpenSearch

Create an integration to manage access to an OpenSearch Integration instance.

OpenSearch is an open-source search and analytics suite, maintained by Amazon Web Services (AWS).

Through this integration, Apono helps you discover your OpenSearch Integration resources and securely manage access to the index and roles through your OpenSearch Integration instance.

***

### Prerequisites

<table><thead><tr><th width="245.42578125">Item</th><th>Description</th></tr></thead><tbody><tr><td>Apono Connector</td><td><p>On-prem connection serving as a bridge between an OpenSearch Integration instance and Apono:</p><ul><li><a href="https://docs.apono.io/docs/apono-connector-for-aws">AWS</a></li><li><a href="https://docs.apono.io/docs/apono-azure-connector">Azure</a></li><li><a href="https://docs.apono.io/docs/apono-connector-for-gcp">GCP</a></li><li><a href="https://docs.apono.io/docs/apono-connector-for-kubernetes">Kubernetes</a></li></ul><p><br></p><p>Minimum Required Version: 1.4.0<br><br>Learn how to update an existing <a href="https://docs.apono.io/docs/aws-environment/apono-connector-for-aws/updating-a-connector-in-aws">AWS</a>, <a href="https://docs.apono.io/docs/azure-environment/installing-a-azure-connector-for-container-instance/updating-a-connector-in-azure">Azure</a>, <a href="https://docs.apono.io/docs/gcp-environment/apono-connector-for-gcp/updating-a-connector-in-google-cloud">GCP</a>, or <a href="https://docs.apono.io/docs/kubernetes-environment/apono-connector-for-kubernetes/updating-a-kubernetes-connector">Kubernetes</a> connector.</p></td></tr><tr><td>OpenSearch Integration Account Access</td><td>OpenSearch Integration account with admin privileges</td></tr><tr><td>OpenSearch Integration</td><td>User for Appono’s connector (User/Password) with assigned roles - <a href="https://docs.opensearch.org/docs/latest/security/access-control/users-roles/">https://docs.opensearch.org/docs/latest/security/access-control/users-roles/</a></td></tr></tbody></table>

***

### Create an OpenSearch Integration user

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

Follow these steps to create a service account for OpenSearch Integration in your Cloud Environment:

1. Create a user for Apono’s connector
2. Assign roles: AWS opensearch > security\_manager, opensource > all\_access\
   To enable the roles: plugins.security.restapi.roles\_enabled
3. Create a new role and provide the following permissions:

```
"cluster:monitor/state"
"cluster:monitor/health"
```

***

### Integrate OpenSearch Integration

<figure><img src="https://1094436629-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fv6MBfUGvblSdAz31yJXm%2Fuploads%2Fgit-blob-3c070aa6f73b3e86bf207e7cd0114f6e6294527f%2Fimage%20(70).png?alt=media" alt=""><figcaption></figcaption></figure>

Follow these steps to complete the integration:

1. On the [Catalog](https://app.apono.io/catalog?search=rancher) tab, click OpenSearch Integration. The Connect Integration page appears.
2. Under Discovery, choose Index or/and Role, and click **Next**. The Apono connector section expands.
3. From the dropdown menu, select a connector.

{% hint style="info" %}
If the desired connector is not listed, click + Add new connector and follow the instructions for creating a connector ([AWS](https://docs.apono.io/docs/aws-environment/apono-connector-for-aws), [Azure](https://docs.apono.io/docs/azure-environment/apono-connector-for-azure), [GCP](https://docs.apono.io/docs/gcp-environment/apono-connector-for-gcp), [Kubernetes](https://docs.apono.io/docs/kubernetes-environment/apono-connector-for-kubernetes)).
{% endhint %}

4. Click **Next**. The Integration Config page appears.
5. 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              | Enter the OpenSearch Url                                                                                   |

6. Click **Next**. The **Secret Store** section expands.

{% hint style="info" %}
If you select the Apono secret manager, enter the following values:\
Username: the OpenSearch user you created.\
Password: the password for the OpenSearch user.
{% endhint %}

6. [Associate the secret or credentials](https://docs.apono.io/docs/connectors-and-secrets/apono-integration-secret).
7. Click Next. The 'Get more with Apono' section expands.
8. Define the Get more with Apono settings.

<table><thead><tr><th width="254.18359375">Setting</th><th>Description</th></tr></thead><tbody><tr><td>Credential Rotation</td><td><p>(Optional) Number of days after which the database credentials must be rotated</p><p><br></p><p>Learn more about the <a href="https://docs.apono.io/docs/architecture-and-security/credentials-rotation-policy">Credentials Rotation Policy</a>.</p></td></tr><tr><td>User cleanup after access is revoked (in days)</td><td><p>(Optional) Defines the number of days after access has been revoked that the user should be deleted</p><p><br></p><p>Learn more about <a href="https://docs.apono.io/docs/architecture-and-security/periodic-user-cleanup-and-deletion">Periodic User Cleanup &#x26; Deletion</a>.</p></td></tr><tr><td>Custom Access Details</td><td><p>(Optional) Instructions explaining how to access this integration's resources</p><p><br></p><p>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.</p><p><br></p><p>To view the message as it appears to end users, click Preview.</p></td></tr><tr><td>Integration Owner</td><td><p>(Optional) Fallback approver if no <a href="https://docs.google.com/document/d/1DgUdWeU2tLBBs0X4dA51HZOTxNfjWDqnoGU7Y_mDsVA/edit">resource owner</a> is found</p><p><br></p><p>Follow these steps to define one or several integration owners:</p><ol><li>From the Attribute dropdown menu, select User or Group under the relevant identity provider (IdP) platform.</li><li>From the Value dropdown menu, select one or multiple users or groups.</li></ol><p><br></p><p>NOTE: When Resource Owner is defined, an Integration Owner must be defined.</p></td></tr><tr><td>Resource Owner</td><td><p>(Optional) Group or role responsible for managing access approvals or rejections for the resource</p><p><br></p><p>Follow these steps to define one or several <a href="https://docs.google.com/document/d/1DgUdWeU2tLBBs0X4dA51HZOTxNfjWDqnoGU7Y_mDsVA/edit">resource owners</a>:</p><ol><li>Enter a Key name. This value is the name of the tag created in your cloud environment.<br><br></li><li>From the Attribute dropdown menu, select an attribute under the IdP platform to which the key name is associated.<br><br>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, this change is also reflected in Apono.</li></ol><p><br></p><p>NOTE: When this setting is defined, an Integration Owner must also be defined.</p></td></tr></tbody></table>

10. Click Confirm.

Now that you have completed this integration, you can [create access flows](https://docs.apono.io/docs/access-flows/access-flows) that grant permission to your OpenSearch Integration instance.