ElasticSearch extension - Compatible with OpenSearch
Plugin ID
The plugin ID for Apache ActiveMQ is fr.cantor.c4i.ElasticSearchDelivery.
Properties
| Property key | Description | Mandatory | Default value |
|---|---|---|---|
| debug | true to display debug log | No | false |
| host | URL of the ElasticSearch instance, without the port | Yes | |
| port | The port to connect to the ElasticSearch instance | Yes | |
| username | The username to connect to the ElasticSearch instance, or AWS Access Key | No | |
| password | The password to connect to the ElasticSearch instance in standalone mode only, or AWS Secret Key | No | |
| configAssetId | The ID of the asset containing the YAML mappings | Yes | |
| prefixIndexNamesWithContextId | true or false to indicate whether or not to prefix the index names with the context IDs | Yes | |
| deleteElementsNotMatchingFilters | true or false to indicate if elements not matching filters should be deleted from the database | Yes | |
| enableSsl | true enables TLS/SSL connection. | No | false |
| compatibility | ELASTICSEARCH or OPENSEARCH | No | ELASTICSEARCH |
| authenticationMode | NONE, PASSWORD, AWS_SECRET_KEY or OAUTH2_CLIENT_CREDENTIALS | No | NONE |
| batchSize | The maximum number of elements to send in a single query | Yes | |
| oAuth2TokenEndpoint | The endpoint to retrieve the OAuth2 token | No | |
| cacheConfig | The ID of the asset containing the JCS configuration | No | |
| oAuth2Scope | The OAuth2 token scope | No | |
| pathPrefix | The URL prefix before the API URI | No |
Configuration example
extensions.[0].pluginId=fr.cantor.c4i.ElasticSearchDelivery
extensions.[0].host=localhost
extensions.[0].port=92000
extensions.[0].username=c4i
extensions.[0].configAssetId=C4I-Configuration
extensions.[0].prefixIndexNamesWithContextId=true
extensions.[0].deleteElementsNotMatchingFilters=true
extensions.[0].enableSsl=false
extensions.[0].compatibility=ELASTICSEARCH
extensions.[0].authenticationMode=OAUTH2_CLIENT_CREDENTIALS
extensions.[0].oAuth2TokenEndpoint=https://my-oauth2-endpoint.com/auth/realms/myrealm/protocol/openid-connect/token
extensions.[0].batchSize=100
extensions.[0].oAuth2Scope=my-custom-scope
extensions.[0].pathPrefix=v1
pluginId=fr.cantor.c4i.ElasticSearchDelivery
host=localhost
port=9200
username=c4i
password=secure_password
configAssetId=/Path/to/C4I/Configuration.yml
prefixIndexNamesWithContextId=true
deleteElementsNotMatchingFilters=true
licenseAssetId=/Path/to/C4I/License.cat
enableSsl=false
compatibility=ELASTICSEARCH
authenticationMode=OAUTH2_CLIENT_CREDENTIALS
oAuth2TokenEndpoint=https://my-oauth2-endpoint.com/auth/realms/myrealm/protocol/openid-connect/token
batchSize=100
cacheConfig=/Path/to/JCS/Config.ccf
oAuth2Scope=my-custom-scope
pathPrefix=v1
pluginId=fr.cantor.c4i.ElasticSearchDelivery
host=mydomain-opensearch-tdfvjn2xk7vewapaigbkadzo6y.us-east-1.es.amazonaws.com
port=442
username=AKIAZRH4PHFLLQB4CMO6
password=secure_access_key
configAssetId=/Path/to/C4I/Configuration.yml
prefixIndexNamesWithContextId=true
deleteElementsNotMatchingFilters=true
licenseAssetId=/Path/to/C4I/License.cat
enableSsl=true
compatibility=OPENSEARCH
authenticationMode=AWS_SECRET_KEY
batchSize=100
cacheConfig=/Path/to/JCS/Config.ccf
oAuth2Scope=my-custom-scope
pathPrefix=v1