diff --git a/docs/self-managed/components/management-identity/miscellaneous/configuration-variables.md b/docs/self-managed/components/management-identity/miscellaneous/configuration-variables.md index 0b3cd6254a2..660c75d039b 100644 --- a/docs/self-managed/components/management-identity/miscellaneous/configuration-variables.md +++ b/docs/self-managed/components/management-identity/miscellaneous/configuration-variables.md @@ -101,7 +101,7 @@ Identity requires a database to store information about resource authorization a :::note There are no default values for the variables above. See [supported environments](/reference/supported-environments.md#camunda-platform-8-self-managed) for a list of -supported databases. +supported databases. You may also review the [RDBMS support policy](/self-managed/concepts/rdbms-support-policy.md). ::: ### Running Identity on Amazon Aurora PostgreSQL diff --git a/docs/self-managed/components/orchestration-cluster/core-settings/concepts/schema-and-migration.md b/docs/self-managed/components/orchestration-cluster/core-settings/concepts/schema-and-migration.md index c52e01611a9..f65c2b13591 100644 --- a/docs/self-managed/components/orchestration-cluster/core-settings/concepts/schema-and-migration.md +++ b/docs/self-managed/components/orchestration-cluster/core-settings/concepts/schema-and-migration.md @@ -1,7 +1,7 @@ --- id: schema-and-migration title: Schema and data migration -description: "The orchestration cluster stores data in Elasticsearch and provides tools to manage schema and migrations." +description: "The orchestration cluster stores data with secondary storage and provides tools to manage schema and migrations." --- The orchestration cluster persists runtime and task data in Elasticsearch. On first startup, all required indices and templates are automatically created. diff --git a/docs/self-managed/concepts/secondary-storage/configuring-secondary-storage.md b/docs/self-managed/concepts/secondary-storage/configuring-secondary-storage.md index 23d33379b0b..a486dbc9f33 100644 --- a/docs/self-managed/concepts/secondary-storage/configuring-secondary-storage.md +++ b/docs/self-managed/concepts/secondary-storage/configuring-secondary-storage.md @@ -16,6 +16,11 @@ You can configure secondary storage using Helm charts, Docker Compose, or manual Camunda uses the `data.secondary-storage` configuration to define which database backend supports advanced web applications and APIs. +:::note +For the latest list of supported relational databases and versions, see the +[RDBMS version support policy](/self-managed/concepts/rdbms-support-policy.md). +::: + + If you’re using Docker Compose, configure your environment variables within the relevant service definition: @@ -72,8 +78,8 @@ For Elasticsearch: ```yaml environment: - - CAMUNDA_DATA_SECONDSTORAGE_TYPE=elasticsearch - - CAMUNDA_DATA_SECONDSTORAGE_ELASTICSEARCH_URL=http://elasticsearch:9200 + - CAMUNDA_DATA_SECONDARYSTORAGE_TYPE=elasticsearch + - CAMUNDA_DATA_SECONDARYSTORAGE_ELASTICSEARCH_URL=http://elasticsearch:9200 ``` To disable secondary storage: @@ -84,6 +90,7 @@ environment: ``` + In Self-Managed or Camunda 8 Run deployments, you can also configure storage directly in the `application.yaml` file: @@ -109,19 +116,21 @@ data: ``` + ## Choosing a storage backend -| Scenario | Recommended backend | Reason | -| :---------------------------------------- | :---------------------------------------------- | :------------------------------------------------------------ | -| Local testing or Camunda 8 Run quickstart | H2 | Fast, lightweight, and runs entirely in memory or file-based. | -| Production workloads | Elasticsearch or supported RDBMS | Scalable and persistent; designed for concurrent queries. | -| Debugging and troubleshooting | H2 or PostgreSQL (for debugging and inspection) | Easier to inspect and visualize data. | +| Scenario | Recommended backend | Reason | +| :---------------------------------------- | :--------------------------------- | :------------------------------------------------------------ | +| Local testing or Camunda 8 Run quickstart | H2 | Fast, lightweight, and runs entirely in memory or file-based. | +| Production workloads | Elasticsearch or a supported RDBMS | Scalable and persistent; designed for concurrent queries. | +| Debugging and troubleshooting | H2 or PostgreSQL | Easier to inspect and visualize data. | :::note H2 is suitable for testing and local development only. -For production use, Operate and Tasklist require a persistent secondary storage backend such as an RDBMS or Elasticsearch. +For production use, Operate and Tasklist require a persistent secondary storage backend such as a supported RDBMS or Elasticsearch. +Consult the [RDBMS version support policy](/self-managed/concepts/rdbms-support-policy.md) when choosing a relational database. ::: ## Run without secondary storage @@ -134,4 +143,4 @@ In this mode: - The Zeebe engine and primary storage remain active for process execution. - This configuration is best suited for local development or minimal-resource environments. -See [Run without secondary storage](./no-secondary-storage.md) for configuration examples and limitations. +See [run without secondary storage](./no-secondary-storage.md) for configuration examples and limitations. diff --git a/docs/self-managed/concepts/secondary-storage/index.md b/docs/self-managed/concepts/secondary-storage/index.md index 61fad422300..ad5dcbd3a0b 100644 --- a/docs/self-managed/concepts/secondary-storage/index.md +++ b/docs/self-managed/concepts/secondary-storage/index.md @@ -23,12 +23,14 @@ Secondary storage is not a duplicate of primary data. It represents the historic ### Supported storage options -Camunda supports the following secondary storage backends, depending on the version and use case: - -| Database type | Availability | Use case | -| :------------------------------ | :------------------- | :------------------------------------------------------------------- | -| Elasticsearch/OpenSearch | General availability | Default for most production installations. | -| RDBMS (H2, PostgreSQL, MariaDB) | 8.9-alpha1+ | Lightweight local testing (H2) or future enterprise-grade RDBMS use. | +Camunda supports multiple secondary storage backends. +For the latest list of supported database versions, see the +[RDBMS version support policy](/self-managed/concepts/rdbms-support-policy.md). + +| Database type | Availability | Use case | +| :----------------------- | :------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Elasticsearch/OpenSearch | General availability | Default for most production installations. | +| RDBMS | 8.9-alpha1+ | Supports relational databases for secondary storage. See the [RDBMS support policy](/self-managed/concepts/rdbms-support-policy.md) for supported vendors and versions. | :::info OpenSearch support Camunda 8 supports both [Amazon OpenSearch](https://aws.amazon.com/opensearch-service) and the open-source [OpenSearch](https://opensearch.org/) distribution. diff --git a/docs/self-managed/deployment/helm/configure/database/using-existing-postgres.md b/docs/self-managed/deployment/helm/configure/database/using-existing-postgres.md index a3fc682131b..7bd8c214b61 100644 --- a/docs/self-managed/deployment/helm/configure/database/using-existing-postgres.md +++ b/docs/self-managed/deployment/helm/configure/database/using-existing-postgres.md @@ -19,7 +19,7 @@ username: `postgres` password: `examplePassword` ``` -- **Supported versions:**: Check the [supported environments](/reference/supported-environments.md) page to confirm which PostgreSQL versions are supported. +- **Supported versions:**: Check the [supported environments](/reference/supported-environments.md) and [RDBMS support policy](/self-managed/concepts/rdbms-support-policy.md) pages to confirm which PostgreSQL versions are supported. - **Database setup:** Ensure the required databases exist in your PostgreSQL instance. For this guide, create the following databases: ```SQL diff --git a/docs/self-managed/deployment/helm/configure/registry-and-images/air-gapped-installation.md b/docs/self-managed/deployment/helm/configure/registry-and-images/air-gapped-installation.md index 442b08e738e..2ff619dfb7e 100644 --- a/docs/self-managed/deployment/helm/configure/registry-and-images/air-gapped-installation.md +++ b/docs/self-managed/deployment/helm/configure/registry-and-images/air-gapped-installation.md @@ -175,7 +175,7 @@ Install the Helm chart by either making it available in a [private repository](h helm install camunda --version $HELM_CHART_VERSION ./camunda-platform-11.1.0.tgz ``` -For supported versions, see [supported environments](/reference/supported-environments.md#camunda-8-self-managed). +For supported versions, see [supported environments](/reference/supported-environments.md#camunda-8-self-managed) and the [RDBMS support policy](/self-managed/concepts/rdbms-support-policy.md). ### Dependency overview diff --git a/docs/self-managed/deployment/manual/cloud-providers/amazon/aws-ec2.md b/docs/self-managed/deployment/manual/cloud-providers/amazon/aws-ec2.md index 34519202d69..7e1587cf6d6 100644 --- a/docs/self-managed/deployment/manual/cloud-providers/amazon/aws-ec2.md +++ b/docs/self-managed/deployment/manual/cloud-providers/amazon/aws-ec2.md @@ -89,7 +89,7 @@ With the reference architecture in place, you can proceed with the remaining ste ### Terraform prerequisites -To manage Camunda 8 infrastructure on AWS using Terraform, you need to configure Terraform's backend to store the state file remotely in an S3 bucket. This provides secure, persistent state storage for your infrastructure. +To manage Camunda 8 infrastructure on AWS using Terraform, you need to configure Terraform's backend to store the state file remotely in an S3 bucket. This provides secure, persistent primary storage for your infrastructure. :::note Advanced users may choose to configure a different backend. The setup described here is a recommended starting point for new users. diff --git a/docs/self-managed/quickstart/developer-quickstart/c8run.md b/docs/self-managed/quickstart/developer-quickstart/c8run.md index 9893ccabd08..f3867588957 100644 --- a/docs/self-managed/quickstart/developer-quickstart/c8run.md +++ b/docs/self-managed/quickstart/developer-quickstart/c8run.md @@ -21,6 +21,11 @@ Camunda 8 Run includes the following: Camunda 8 Run also supports document storage and management with [document handling](/self-managed/concepts/document-handling/overview.md). +:::note +For the latest list of supported relational databases and versions, see the +[RDBMS version support policy](/self-managed/concepts/rdbms-support-policy.md). +::: + ## Prerequisites - **OpenJDK 21–23**: Required for running Camunda 8 as a Java application. @@ -279,11 +284,11 @@ For more information, see the [metrics](/self-managed/operational-guides/monitor ### Configure or switch secondary storage (Elasticsearch or H2) Camunda 8 Run supports multiple secondary-storage options. -By default, it uses **Elasticsearch**, but you can switch to **H2** for lightweight local development or testing. +By default, it uses **Elasticsearch**, but you can switch to an RDBMS backend such as **H2** for lightweight local development or testing. #### Default: Elasticsearch -In version 8.9-alpha1 and later, Camunda 8 Run starts with **Elasticsearch** as the default secondary storage. +Camunda 8 Run starts with **Elasticsearch** as the default secondary storage. ```yaml data: @@ -404,10 +409,10 @@ Camunda 8 uses two layers of storage: For more details on how these layers interact, see [secondary storage architecture](/self-managed/concepts/secondary-storage/index.md). Camunda 8 Run uses v2 APIs by default, so no additional configuration is required when H2 becomes the default in a future release. -### Known limitations (8.9-alpha1) +### Known limitations -- Operate and Tasklist are **not yet supported** when using H2. -- H2 is intended for **testing only** in this alpha release. +- Tasklist can use H2 through the v2 APIs. Operate support for H2 is under active development and may have limitations in current alpha versions. +- H2 is intended for testing and local development only. - Data stored in H2 is ephemeral unless configured as file-based. - Performance and memory use may vary depending on local environment.