Skip to content

Commit

Permalink
feat: add awsEnabled explanation on tasklist opensearch configuration
Browse files Browse the repository at this point in the history
  • Loading branch information
@nathansandi
nathansandi committed Sep 2, 2024
1 parent c507ef8 commit 110f912
Show file tree
Hide file tree
Showing 3 changed files with 33 additions and 30 deletions.
21 changes: 11 additions & 10 deletions docs/self-managed/tasklist-deployment/tasklist-configuration.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -90,16 +90,17 @@ You may need to import the certificate into JVM runtime.

For OpenSearch we also have similar configurations:

| Name | Description | Default value |
| ----------------------------------------------- | -------------------------------------- | --------------------- |
| camunda.tasklist.opensearch.indexPrefix | Prefix for index names | tasklist |
| camunda.tasklist.opensearch.clusterName | Clustername of OpenSearch | opensearch |
| camunda.tasklist.opensearch.url | URL of OpenSearch REST API | http://localhost:9200 |
| camunda.tasklist.opensearch.username | Username to access OpenSearch REST API | - |
| camunda.tasklist.opensearch.password | Password to access OpenSearch REST API | - |
| camunda.tasklist.opensearch.ssl.certificatePath | Path to certificate used by OpenSearch | - |
| camunda.tasklist.opensearch.ssl.selfSigned | Certificate was self-signed | false |
| camunda.tasklist.opensearch.ssl.verifyHostname | Should the hostname be validated | false |
| Name | Description | Default value |
| ----------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------- |
| camunda.tasklist.opensearch.indexPrefix | Prefix for index names | tasklist |
| camunda.tasklist.opensearch.clusterName | Clustername of OpenSearch | opensearch |
| camunda.tasklist.opensearch.url | URL of OpenSearch REST API | http://localhost:9200 |
| camunda.tasklist.opensearch.username | Username to access OpenSearch REST API | - |
| camunda.tasklist.opensearch.password | Password to access OpenSearch REST API | - |
| camunda.tasklist.opensearch.awsEnabled | When set to false, Basic authentication will be used to authenticate with OpenSearch, adhering to the global configuration settings for AWS OpenSearch. | false |
| camunda.tasklist.opensearch.ssl.certificatePath | Path to certificate used by OpenSearch | - |
| camunda.tasklist.opensearch.ssl.selfSigned | Certificate was self-signed | false |
| camunda.tasklist.opensearch.ssl.verifyHostname | Should the hostname be validated | false |

It's important to mention that by default Tasklist is always going to try to connect to Elasticsearch. To define what database is going to be used, the configuration below is mandatory (if this configuration is missed, Elasticsearch is the selected database):

Expand Down
21 changes: 11 additions & 10 deletions ...ned_docs/version-8.4/self-managed/tasklist-deployment/tasklist-configuration.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -84,16 +84,17 @@ You may need to import the certificate into JVM runtime.

For OpenSearch we also have similar configurations:

| Name | Description | Default value |
| ----------------------------------------------- | -------------------------------------- | --------------------- |
| camunda.tasklist.opensearch.indexPrefix | Prefix for index names | tasklist |
| camunda.tasklist.opensearch.clusterName | Clustername of OpenSearch | opensearch |
| camunda.tasklist.opensearch.url | URL of OpenSearch REST API | http://localhost:9200 |
| camunda.tasklist.opensearch.username | Username to access OpenSearch REST API | - |
| camunda.tasklist.opensearch.password | Password to access OpenSearch REST API | - |
| camunda.tasklist.opensearch.ssl.certificatePath | Path to certificate used by OpenSearch | - |
| camunda.tasklist.opensearch.ssl.selfSigned | Certificate was self-signed | false |
| camunda.tasklist.opensearch.ssl.verifyHostname | Should the hostname be validated | false |
| Name | Description | Default value |
| ----------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------- |
| camunda.tasklist.opensearch.indexPrefix | Prefix for index names | tasklist |
| camunda.tasklist.opensearch.clusterName | Clustername of OpenSearch | opensearch |
| camunda.tasklist.opensearch.url | URL of OpenSearch REST API | http://localhost:9200 |
| camunda.tasklist.opensearch.username | Username to access OpenSearch REST API | - |
| camunda.tasklist.opensearch.password | Password to access OpenSearch REST API | - |
| camunda.tasklist.opensearch.awsEnabled | When set to false, Basic authentication will be used to authenticate with OpenSearch, adhering to the global configuration settings for AWS OpenSearch. | false |
| camunda.tasklist.opensearch.ssl.certificatePath | Path to certificate used by OpenSearch | - |
| camunda.tasklist.opensearch.ssl.selfSigned | Certificate was self-signed | false |
| camunda.tasklist.opensearch.ssl.verifyHostname | Should the hostname be validated | false |

It's important to mention that by default Tasklist is always going to try to connect to Elasticsearch. To define what database is going to be used, the configuration below is mandatory (if this configuration is missed, Elasticsearch is the selected database):

Expand Down
21 changes: 11 additions & 10 deletions ...ned_docs/version-8.5/self-managed/tasklist-deployment/tasklist-configuration.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -84,16 +84,17 @@ You may need to import the certificate into JVM runtime.

For OpenSearch we also have similar configurations:

| Name | Description | Default value |
| ----------------------------------------------- | -------------------------------------- | --------------------- |
| camunda.tasklist.opensearch.indexPrefix | Prefix for index names | tasklist |
| camunda.tasklist.opensearch.clusterName | Clustername of OpenSearch | opensearch |
| camunda.tasklist.opensearch.url | URL of OpenSearch REST API | http://localhost:9200 |
| camunda.tasklist.opensearch.username | Username to access OpenSearch REST API | - |
| camunda.tasklist.opensearch.password | Password to access OpenSearch REST API | - |
| camunda.tasklist.opensearch.ssl.certificatePath | Path to certificate used by OpenSearch | - |
| camunda.tasklist.opensearch.ssl.selfSigned | Certificate was self-signed | false |
| camunda.tasklist.opensearch.ssl.verifyHostname | Should the hostname be validated | false |
| Name | Description | Default value |
| ----------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------- |
| camunda.tasklist.opensearch.indexPrefix | Prefix for index names | tasklist |
| camunda.tasklist.opensearch.clusterName | Clustername of OpenSearch | opensearch |
| camunda.tasklist.opensearch.url | URL of OpenSearch REST API | http://localhost:9200 |
| camunda.tasklist.opensearch.username | Username to access OpenSearch REST API | - |
| camunda.tasklist.opensearch.password | Password to access OpenSearch REST API | - |
| camunda.tasklist.opensearch.awsEnabled | When set to false, Basic authentication will be used to authenticate with OpenSearch, adhering to the global configuration settings for AWS OpenSearch. | false |
| camunda.tasklist.opensearch.ssl.certificatePath | Path to certificate used by OpenSearch | - |
| camunda.tasklist.opensearch.ssl.selfSigned | Certificate was self-signed | false |
| camunda.tasklist.opensearch.ssl.verifyHostname | Should the hostname be validated | false |

It's important to mention that by default Tasklist is always going to try to connect to Elasticsearch. To define what database is going to be used, the configuration below is mandatory (if this configuration is missed, Elasticsearch is the selected database):

Expand Down

0 comments on commit 110f912

Please sign in to comment.