Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update Operate OpenSearch configuration to include awsEnabled #4234

Merged
merged 1 commit into from
Sep 4, 2024
Merged

Update Operate OpenSearch configuration to include awsEnabled #4234

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 13 additions & 10 deletions docs/self-managed/operate-deployment/operate-configuration.md
View file
Open in desktop
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
Open in desktop
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
Loading