Skip to content

Commit 863eb5e

Browse files
authored
[docs] Add AWS Auth OpenSearch (#304)
1 parent 35ed0a8 commit 863eb5e

2 files changed

Lines changed: 25 additions & 2 deletions

File tree

64.4 KB
Loading

docs/deployment/configuration.md

Lines changed: 25 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -104,13 +104,36 @@ Each OpenCTI connection is scoped to an OpenAEV tenant, identified by its UUID (
104104

105105
#### Engine
106106

107+
2 options are available for the engine:
108+
109+
- With a classic authentication, you can use either ElasticSearch or OpenSearch as an engine.
110+
107111
| Parameter | Environment variable | Default value | Description |
108112
|:-----------------------|:-----------------------|:----------------------|:-----------------------------------------------------------------------------------------------|
109-
| engine.engine-aws-mode | ENGINE_ENGINE_AWS_MODE | no | Whether to use AWS SigV4 authentication (yes or no) |
113+
| engine.engine-aws-mode | ENGINE_ENGINE_AWS_MODE | no | Classic authentication (no) |
110114
| engine.engine-selector | ENGINE_ENGINE_SELECTOR | elk | Engine to use for storage and search (`elk` for ElasticSearch and `opensearch` for OpenSearch) |
111115
| engine.url | ENGINE_URL | http://localhost:9200 | URL of the ElasticSearch database |
112116
| engine.username | ENGINE_USERNAME | | This parameter is optional. Login for the database |
113-
| engine.password | ENGINE_PASSWORD | | This parameter is optional. Password for the database |
117+
| engine.password | ENGINE_PASSWORD | | This parameter is optional. Password for the database |
118+
119+
- With AWS SigV4 authentication, you can use Amazon OpenSearch or Amazon OpenSearch Serverless as an engine.
120+
121+
| Parameter | Environment variable | Default value | Description |
122+
|:-------------------------|:-------------------------|:----------------------|:-----------------------------------------------------------------------------------------------------------|
123+
| engine.engine-aws-mode | ENGINE_ENGINE_AWS_MODE | | Whether to use AWS SigV4 authentication Amazon OpenSearch or Amazon OpenSearch Serverless (`es` or `aoss`) |
124+
| engine.engine-selector | ENGINE_ENGINE_SELECTOR | | Engine to use for storage and search (`opensearch` for OpenSearch) |
125+
| engine.engine-aws-host | ENGINE_ENGINE_AWS_HOST | | URL of the OpenSearch database, no http(s) prefix |
126+
| engine.engine-aws-region | ENGINE_ENGINE_AWS_REGION | | Example: eu-west-3 |
127+
128+
!!! tip "Adding the needed authorization to AWS OpenSearch"
129+
130+
* Connect to your AWS opensearch dashboard
131+
* Navigate to Security, Role
132+
* Click on “all_access” role, and “Mapped users” tab
133+
* Add as Backend role the IAM role for your EKS node
134+
* ![Backend role mapping in AWS OpenSearch](assets/backend_role.png)
135+
136+
114137

115138
If you switch your engine selector, you'll need to delete the `indexing_status` table in PostgreSQL to trigger a full
116139
reindex.

0 commit comments

Comments
 (0)