Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,10 @@ description: "Configure Camunda 8 Self-Managed to use an external Elasticsearch

Configure Camunda 8 Self-Managed to connect to an external Elasticsearch instance as a secondary storage backend. Elasticsearch is used for indexing and querying operational data consumed by multiple Camunda components. For a canonical definition, see [Elasticsearch/OpenSearch](/reference/glossary.md#elasticsearchopensearch).

By default, the [Helm chart deployment](/self-managed/deployment/helm/install/quick-install.md) provisions an Elasticsearch instance using the bundled Elasticsearch subchart. You can instead connect Camunda to an existing external Elasticsearch instance, either running inside the same Kubernetes cluster or outside it.

Secondary storage is configurable. For supported components, you can use an RDBMS-based secondary store instead. See [RDBMS configuration](/self-managed/concepts/databases/relational-db/configuration.md) and the glossary entry [RDBMS](/reference/glossary.md#rdbms) for configuration details and limitations.

For production deployments, Camunda recommends managing Elasticsearch externally and disabling the Elasticsearch subchart. This gives more flexibility for scaling, backups, and upgrades without affecting the rest of the Camunda installation.
Starting with Camunda 8.9, the Helm chart no longer provisions Elasticsearch by default. To use Elasticsearch as secondary storage, you must explicitly enable it in your Helm values (`global.elasticsearch.enabled: true`). You can either deploy Elasticsearch using the [ECK operator](/self-managed/deployment/helm/configure/operator-based-infrastructure.md#elasticsearch-deployment) (recommended) or connect Camunda to an existing external Elasticsearch instance, either running inside the same Kubernetes cluster or outside it.

:::note
In 8.9-alpha3, H2 is the default secondary storage for lightweight Camunda 8 Run and quick-install scenarios. Elasticsearch is still bundled with the distribution and fully supported as an optional alternative. Use this guide when you want to run or connect to an external Elasticsearch cluster instead of the default H2 store.
The bundled Elasticsearch Bitnami subchart (`elasticsearch.enabled: true`) is deprecated and will be removed in a future release. For production deployments, use the [ECK (Elastic Cloud on Kubernetes) operator](/self-managed/deployment/helm/configure/operator-based-infrastructure.md#elasticsearch-deployment) or a managed Elasticsearch service instead. See [deploy infrastructure with Kubernetes operators](/self-managed/deployment/helm/configure/operator-based-infrastructure.md) for details.
:::

## Prerequisites
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,9 @@ description: Learn how to connect a Camunda 8 Self-Managed Helm chart deployment

Configure Camunda 8 Self-Managed to use Amazon OpenSearch Service as a secondary storage backend when deploying with the Helm chart. OpenSearch is used for indexing and querying operational data consumed by multiple Camunda components. For a canonical definition, see [Elasticsearch/OpenSearch](/reference/glossary.md#elasticsearchopensearch).

By default, the [Helm chart deployment](/self-managed/setup/overview.md) provisions an Elasticsearch instance. You can instead configure the Helm chart to connect to an external Amazon OpenSearch Service instance.
Starting with Camunda 8.9, the Helm chart no longer provisions Elasticsearch by default. You can configure the Helm chart to connect to an external Amazon OpenSearch Service instance as an alternative secondary storage backend.

Secondary storage is configurable. For supported components, you can use an RDBMS-based secondary store instead. See [RDBMS configuration](/self-managed/concepts/databases/relational-db/configuration.md) or the glossary entry [RDBMS](/reference/glossary.md#rdbms).

:::note
In 8.9-alpha3, H2 is the default secondary storage for lightweight Camunda 8 Run and quick-install scenarios. Elasticsearch remains bundled and supported as an optional alternative; OpenSearch is supported for Self‑Managed deployments but is not bundled in Camunda 8 Run. Use this guide when you want to run or connect to an external OpenSearch cluster instead of the default H2 store.
:::
Secondary storage is configurable. For supported components, you can use an RDBMS-based secondary store instead. See [RDBMS configuration](/self-managed/concepts/databases/relational-db/configuration.md) or the glossary entry [RDBMS](/reference/glossary.md#rdbms). For the [quick-install](/self-managed/deployment/helm/install/quick-install.md) scenario, RDBMS with embedded H2 is used instead.

:::info OpenSearch support
Camunda 8 supports both the open-source [OpenSearch](https://opensearch.org/) distribution and [Amazon OpenSearch Service](https://aws.amazon.com/opensearch-service).
Expand Down
12 changes: 11 additions & 1 deletion docs/self-managed/deployment/helm/install/quick-install.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,12 +57,19 @@ In production, Camunda 8 is typically deployed together with additional componen
```bash
helm install camunda camunda/camunda-platform \
--set orchestration.exporters.rdbms.enabled=true \
--set orchestration.clusterSize=1 \
--set orchestration.partitionCount=1 \
--set orchestration.replicationFactor=1 \
--set-string 'orchestration.env[0].name=CAMUNDA_PERSISTENT_SESSIONS_ENABLED' \
--set-string 'orchestration.env[0].value=false' \
-n orchestration
```

This enables the RDBMS exporter with embedded H2 as secondary storage. Starting with Camunda 8.9, the chart no longer includes a default secondary storage; you must explicitly choose one (`rdbms`, `elasticsearch`, or `opensearch`).
This enables the RDBMS exporter with embedded H2 as secondary storage. The cluster is configured with a single broker, a single partition, and a replication factor of 1. The replication factor must be less than or equal to the cluster size. For a single-broker cluster, the only valid replication factor is 1.

The embedded H2 database is local to each broker. Running multiple brokers would result in separate, independent databases and incomplete query results.

Starting with Camunda 8.9, the Helm chart no longer provisions Elasticsearch by default. You must explicitly enable a secondary storage backend (RDBMS, Elasticsearch, or OpenSearch) in your Helm values.

<!-- TODO before 8.9 GA:
The install command below includes a temporary workaround:
Expand All @@ -84,6 +91,9 @@ In production, Camunda 8 is typically deployed together with additional componen
```
helm install camunda camunda/camunda-platform \
--set orchestration.exporters.rdbms.enabled=true \
--set orchestration.clusterSize=1 \
--set orchestration.partitionCount=1 \
--set orchestration.replicationFactor=1 \
-n orchestration
```
- Confirm the Connectors service port in the chart NOTES matches the actual port (currently NOTES say 8086, service is 8080)
Expand Down
Loading