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

feat: Adding some clarifications for Optimize usage with OpenSearch #4430

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
+11 −25
Draft

feat: Adding some clarifications for Optimize usage with OpenSearch #4430

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
10 changes: 0 additions & 10 deletions docs/self-managed/setup/guides/using-existing-opensearch.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,12 +18,6 @@ Otherwise, if it is intended to connect to Amazon OpenSearch Service with basic

## Values file

:::caution

The migration step within Optimize is currently not supported with OpenSearch. Disable the migration as shown in the example below.

:::

The following values can be configured in the Camunda 8 Self-Managed Helm chart in order to use Amazon OpenSearch Service:

### Connecting to Amazon OpenSearch Service with basic auth
Expand All @@ -42,10 +36,6 @@ global:
host: opensearch.example.com
port: 443

optimize:
migration:
enabled: false

elasticsearch:
enabled: false
```
Expand Down
6 changes: 3 additions & 3 deletions docs/self-managed/setup/install.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,11 +41,11 @@ The existing Helm charts use the Elasticsearch configurations by default. The He

**Zeebe**: Configure the [OpenSearch exporter](/self-managed/zeebe-deployment/exporters/opensearch-exporter.md).

**Operate** & **Tasklist**: These components use the same parameters for both Elasticsearch and OpenSearch. Replace the `elasticsearch` part of the relevant configuration key with `opensearch`, together with its appropriate value.
**Operate**, **Tasklist** and **Optimize**: These components use the same parameters for both Elasticsearch and OpenSearch. Replace the `elasticsearch` part of the relevant configuration key with `opensearch`, together with its appropriate value.

For example, `CAMUNDA_OPERATE_ELASTICSEARCH_URL` becomes `CAMUNDA_OPERATE_OPENSEARCH_URL`.
For example, `CAMUNDA_OPERATE_ELASTICSEARCH_URL` becomes `CAMUNDA_OPERATE_OPENSEARCH_URL`. In the case of Optimize, please make sure all variables have the proper `CAMUNDA_OPTIMIZE` prefix, i.e. `OPTIMIZE_ELASTICSEARCH_HTTP_PORT` becomes `CAMUNDA_OPTIMIZE_OPENSEARCH_HTTP_PORT`.

Refer to the [Operate](/self-managed/operate-deployment/operate-configuration.md#settings-for-opensearch) and [Tasklist](/self-managed/tasklist-deployment/tasklist-configuration.md#elasticsearch-or-opensearch) configuration documentation for additional component configuration parameters to update.
Refer to the [Operate](/self-managed/operate-deployment/operate-configuration.md#settings-for-opensearch), [Tasklist](/self-managed/tasklist-deployment/tasklist-configuration.md#elasticsearch-or-opensearch) and [Optimize](optimize/self-managed/optimize-deployment/configuration/system-configuration/#opensearch) configuration documentation for additional component configuration parameters to update.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This Optimize link doesnt work (it resolves to
https://preview.docs.camunda.cloud/pr-4430/docs/next/self-managed/setup/install/optimize/self-managed/optimize-deployment/configuration/system-configuration/#opensearch)

Copy link
Member

@akeller akeller Oct 9, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

https://github.com/camunda/camunda-docs/blob/main/howtos/documentation-guidelines.md#internal-links

If the source is in docs and the target is in optimize, use the $optimize$ token to prefix the URL.

:::

![Camunda 8 Self-Managed Architecture Diagram](../assets/camunda-platform-8-self-managed-architecture-diagram-combined-ingress.png)
Expand Down
4 changes: 3 additions & 1 deletion versioned_docs/version-8.6/reference/supported-environments.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,10 +92,12 @@ Requirements for the components can be seen below:
| Operate | OpenJDK 21+ | Elasticsearch 8.13+<br/>Amazon OpenSearch 2.9+ |
| Tasklist | OpenJDK 21+ | Elasticsearch 8.13+<br/>Amazon OpenSearch 2.9+ |
| Identity | OpenJDK 17+ | Keycloak 24.x, 25.x<br/>PostgreSQL 14.x, 15.x or Amazon Aurora PostgreSQL 13.x, 14.x, 15.x (required for [certain features](/self-managed/identity/deployment/configuration-variables.md#database-configuration)) |
| Optimize | OpenJDK 21+ | Elasticsearch 8.13+<br/>Amazon OpenSearch 2.9+ |
| Optimize | OpenJDK 21+ | Elasticsearch 8.13+<br/>Amazon OpenSearch 2.9+\* |
| Connectors | OpenJDK 21+ | |
| Web Modeler | - | PostgreSQL 13.x, 14.x, 15.x, 16.x or Amazon Aurora PostgreSQL 13.x, 14.x, 15.x, 16.x |

- Not all Optimize features are supported when using OpenSearch as a database. For a full list of the features that are currently supported, please refer to the [Camunda 8](https://github.com/camunda/issues/issues/635) OpenSearch features.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this supposed to be referring to the asterisk in the table? If so lets add another *


When running Elasticsearch, you must have the [appropriate Elasticsearch privileges](/self-managed/concepts/elasticsearch-privileges.md).

When running Amazon OpenSearch 2.11 or higher, we do not support [OR1 instances](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/or1.html)
Expand Down
10 changes: 2 additions & 8 deletions versioned_docs/version-8.6/self-managed/setup/guides/using-existing-opensearch.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,8 @@ Otherwise, if it is intended to connect to Amazon OpenSearch Service with basic

## Values file

:::caution

The migration step within Optimize is currently not supported with OpenSearch. Disable the migration as shown in the example below.

:::note
Not all Optimize features are supported when using OpenSearch as a database. For a full list of the features that are currently supported, please refer to the [Camunda 8](https://github.com/camunda/issues/issues/635) OpenSearch features.
:::

The following values can be configured in the Camunda 8 Self-Managed Helm chart in order to use Amazon OpenSearch Service:
Expand All @@ -42,10 +40,6 @@ global:
host: opensearch.example.com
port: 443

optimize:
migration:
enabled: false

elasticsearch:
enabled: false
```
Expand Down
6 changes: 3 additions & 3 deletions versioned_docs/version-8.6/self-managed/setup/install.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,11 +41,11 @@ The existing Helm charts use the Elasticsearch configurations by default. The He

**Zeebe**: Configure the [OpenSearch exporter](/self-managed/zeebe-deployment/exporters/opensearch-exporter.md).

**Operate** & **Tasklist**: These components use the same parameters for both Elasticsearch and OpenSearch. Replace the `elasticsearch` part of the relevant configuration key with `opensearch`, together with its appropriate value.
**Operate**, **Tasklist** and **Optimize**: These components use the same parameters for both Elasticsearch and OpenSearch. Replace the `elasticsearch` part of the relevant configuration key with `opensearch`, together with its appropriate value.

For example, `CAMUNDA_OPERATE_ELASTICSEARCH_URL` becomes `CAMUNDA_OPERATE_OPENSEARCH_URL`.
For example, `CAMUNDA_OPERATE_ELASTICSEARCH_URL` becomes `CAMUNDA_OPERATE_OPENSEARCH_URL`. In the case of Optimize, please make sure all variables have the proper `CAMUNDA_OPTIMIZE` prefix, i.e. `OPTIMIZE_ELASTICSEARCH_HTTP_PORT` becomes `CAMUNDA_OPTIMIZE_OPENSEARCH_HTTP_PORT`.

Refer to the [Operate](/self-managed/operate-deployment/operate-configuration.md#settings-for-opensearch) and [Tasklist](/self-managed/tasklist-deployment/tasklist-configuration.md#elasticsearch-or-opensearch) configuration documentation for additional component configuration parameters to update.
Refer to the [Operate](/self-managed/operate-deployment/operate-configuration.md#settings-for-opensearch), [Tasklist](/self-managed/tasklist-deployment/tasklist-configuration.md#elasticsearch-or-opensearch) and [Optimize](optimize/self-managed/optimize-deployment/configuration/system-configuration/#opensearch) configuration documentation for additional component configuration parameters to update.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The Optimize link doesnt work (it resolves to
https://preview.docs.camunda.cloud/pr-4430/docs/next/self-managed/setup/install/optimize/self-managed/optimize-deployment/configuration/system-configuration/#opensearch)

:::

![Camunda 8 Self-Managed Architecture Diagram](../assets/camunda-platform-8-self-managed-architecture-diagram-combined-ingress.png)
Expand Down
Loading