Skip to content

Commit

Permalink
Update Operate OpenSearch configuration to include awsEnabled
Browse files Browse the repository at this point in the history 
-related to camunda/camunda#21481
and
camunda/camunda#21488
-fixed "Elasticsearch" being written in descriptions instead of "OpenSearch"
  • Loading branch information
@kristinkomschow
kristinkomschow committed Sep 2, 2024
1 parent 85cdf36 commit a38c6b5
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 20 deletions.
23 changes: 13 additions & 10 deletions docs/self-managed/operate-deployment/operate-configuration.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -159,6 +159,8 @@ camunda.operate:
To connect to a secured (https) OpenSearch instance, you normally need to only set the URL protocol
part to `https` instead of `http`. A secured OpenSearch instance also needs `username` and `password`.

To use AWS Credentials instead of basic auth when connecting to Amazon OpenSearch Services `awsEnabled` has to be set.

The other SSL settings should only be used in case of connection problems; for example, in disabling host verification.

:::note
Expand All @@ -167,16 +169,17 @@ You may need to import the certificate into JVM runtime.

Either set `host` and `port` (deprecated), or `url` (recommended).

| Name | Description | Default value |
| ---------------------------------------------- | ----------------------------------------- | --------------------- |
| camunda.operate.opensearch.indexPrefix | Prefix for index names | operate |
| camunda.operate.opensearch.clusterName | Cluster name of OpenSearch | opensearch |
| camunda.operate.opensearch.url | URL of Elasticsearch REST API | http://localhost:9200 |
| camunda.operate.opensearch.username | Username to access Elasticsearch REST API | - |
| camunda.operate.opensearch.password | Password to access Elasticsearch REST API | - |
| camunda.operate.opensearch.ssl.certificatePath | Path to certificate used by Elasticsearch | - |
| camunda.operate.opensearch.ssl.selfSigned | Certificate was self-signed | false |
| camunda.operate.opensearch.ssl.verifyHostname | Should the hostname be validated | false |
| Name | Description | Default value |
| ---------------------------------------------- | -------------------------------------- | --------------------- |
| camunda.operate.opensearch.indexPrefix | Prefix for index names | operate |
| camunda.operate.opensearch.clusterName | Cluster name of OpenSearch | opensearch |
| camunda.operate.opensearch.url | URL of OpenSearch REST API | http://localhost:9200 |
| camunda.operate.opensearch.username | Username to access OpenSearch REST API | - |
| camunda.operate.opensearch.password | Password to access OpenSearch REST API | - |
| camunda.operate.opensearch.ssl.certificatePath | Path to certificate used by OpenSearch | - |
| camunda.operate.opensearch.ssl.selfSigned | Certificate was self-signed | false |
| camunda.operate.opensearch.ssl.verifyHostname | Should the hostname be validated | false |
| camunda.operate.opensearch.awsEnabled | Should AWS Credentials be used | false |

#### Settings for shards and replicas

Expand Down
23 changes: 13 additions & 10 deletions ...ioned_docs/version-8.5/self-managed/operate-deployment/operate-configuration.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -152,6 +152,8 @@ camunda.operate:
To connect to a secured (https) OpenSearch instance, you normally need to only set the URL protocol
part to `https` instead of `http`. A secured OpenSearch instance also needs `username` and `password`.

To use AWS Credentials instead of basic auth when connecting to Amazon OpenSearch Services `awsEnabled` has to be set.

The other SSL settings should only be used in case of connection problems; for example, in disabling host verification.

:::note
Expand All @@ -160,16 +162,17 @@ You may need to import the certificate into JVM runtime.

Either set `host` and `port` (deprecated), or `url` (recommended).

| Name | Description | Default value |
| ---------------------------------------------- | ----------------------------------------- | --------------------- |
| camunda.operate.opensearch.indexPrefix | Prefix for index names | operate |
| camunda.operate.opensearch.clusterName | Cluster name of OpenSearch | opensearch |
| camunda.operate.opensearch.url | URL of Elasticsearch REST API | http://localhost:9200 |
| camunda.operate.opensearch.username | Username to access Elasticsearch REST API | - |
| camunda.operate.opensearch.password | Password to access Elasticsearch REST API | - |
| camunda.operate.opensearch.ssl.certificatePath | Path to certificate used by Elasticsearch | - |
| camunda.operate.opensearch.ssl.selfSigned | Certificate was self-signed | false |
| camunda.operate.opensearch.ssl.verifyHostname | Should the hostname be validated | false |
| Name | Description | Default value |
| ---------------------------------------------- | -------------------------------------- | --------------------- |
| camunda.operate.opensearch.indexPrefix | Prefix for index names | operate |
| camunda.operate.opensearch.clusterName | Cluster name of OpenSearch | opensearch |
| camunda.operate.opensearch.url | URL of OpenSearch REST API | http://localhost:9200 |
| camunda.operate.opensearch.username | Username to access OpenSearch REST API | - |
| camunda.operate.opensearch.password | Password to access OpenSearch REST API | - |
| camunda.operate.opensearch.ssl.certificatePath | Path to certificate used by OpenSearch | - |
| camunda.operate.opensearch.ssl.selfSigned | Certificate was self-signed | false |
| camunda.operate.opensearch.ssl.verifyHostname | Should the hostname be validated | false |
| camunda.operate.opensearch.awsEnabled | Should AWS Credentials be used | false |

#### Settings for shards and replicas

Expand Down

0 comments on commit a38c6b5

Please sign in to comment.