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.

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

Lift more info to Supported environments page #3310

Merged
merged 29 commits into from
Mar 15, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
29 commits
Select commit Hold shift + click to select a range
9d1b00f
initial info gathering
akeller Feb 9, 2024
83ac624
fix links
akeller Feb 9, 2024
4027998
add minimum section, small adjustments
akeller Feb 13, 2024
e0b8022
add review recommendations
akeller Feb 15, 2024
fb78ba4
resolved merge conflicts
akeller Feb 15, 2024
5293705
small tweaks
akeller Feb 15, 2024
afdd4c7
add nfs warning
akeller Feb 16, 2024
5a5dd70
refactor page
akeller Feb 16, 2024
6baf277
merge conflicts
akeller Feb 16, 2024
0cd6da0
merge conflicts
akeller Feb 16, 2024
1199afa
Update docs/reference/supported-environments.md
akeller Feb 20, 2024
4a156a3
add spacing to break up text wall
akeller Feb 20, 2024
5ef31cd
backport to 8.4
akeller Feb 20, 2024
99b376d
add back 16.x
akeller Feb 20, 2024
2d01a83
backport 8.3
akeller Feb 20, 2024
2048281
fix merge conflicts
akeller Feb 20, 2024
0c24108
Update docs/reference/supported-environments.md
akeller Feb 21, 2024
cc7cac4
backport change to first sentence
akeller Feb 21, 2024
09d94dc
add helm chart compatibility admonition
akeller Feb 21, 2024
0e17aa2
reword first sentence in component version matrix section
akeller Feb 21, 2024
e9a6d5f
rework deployment options section
akeller Feb 21, 2024
dc97845
add link to certified kubernetes
akeller Feb 21, 2024
a63c241
style(formatting): technical review
christinaausley Feb 22, 2024
4425c6e
Add other network storage types (review suggestion)
akeller Mar 4, 2024
4170fd8
merge conflicts
akeller Mar 5, 2024
124c1be
merge conflicts
akeller Mar 5, 2024
40b998e
Update docs/reference/supported-environments.md
akeller Mar 15, 2024
dee10c1
ensure changes are backported appropriately
akeller Mar 15, 2024
95a31f5
Merge branch 'main' into lift-kube-reqs-to-supported-env
akeller Mar 15, 2024
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
116 changes: 84 additions & 32 deletions docs/reference/supported-environments.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,15 @@ title: "Supported environments"
description: "Find out where to run Camunda 8 components for SaaS and Self-Managed, including Optimize for both Camunda 8 and Camunda 7."
---

:::note
The supported environments page lists browsers, operating systems, clients, deployment options, and component requirements, which are tested and supported for compatibility with Camunda 8.

**If the particular technology is not listed, we cannot resolve issues caused by the usage of that unlisted technology.**

You may [raise a feature request](/contact) that will be evaluated by our product teams to provide official support from Camunda, or you can make a [help request](/contact) to work with Consulting services.

Recommendations are denoted with [recommended], however, other listed options are supported as well.

:::note Minimum versions
The versions listed on this page are the minimum version required if appended with a `+`.

Pay attention to where the `+` falls, as most of our dependencies follow [semantic versioning](https://semver.org/) (semver), where `x.y.z` correspond to MAJOR.MINOR.PATCH. Higher or more recent versions will be compatible with Camunda, with respect to semver.
Expand Down Expand Up @@ -33,53 +41,97 @@ For example, 1.2+ means support for the minor version 2, and any higher minors (

## Camunda 8 Self-Managed

We highly recommend running Camunda 8 Self-Managed in a Kubernetes environment. We provide officially supported [Helm Charts](/self-managed/platform-deployment/helm-kubernetes/overview.md) for this. Please follow the [Installation Guide](/self-managed/platform-deployment/overview.md) to learn more about installation possibilities.
### Deployment options

Requirements for the components can be seen below:
With the right configuration, Camunda 8 Self-Managed can be deployed on any [Certified Kubernetes](https://www.cncf.io/training/certification/software-conformance/#benefits) distribution (cloud or on-premise). However, we officially test and support a specific list of platforms.

| Component | Java version | Other requirements |
| ----------- | ------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Zeebe | OpenJDK 21+ | Elasticsearch 8.9+<br/>Amazon OpenSearch 2.5.x (requires use of [OpenSearch exporter](../self-managed/zeebe-deployment/exporters/opensearch-exporter.md)) |
| Operate | OpenJDK 17+ | Elasticsearch 8.9+<br/>Amazon OpenSearch 2.5.x |
| Tasklist | OpenJDK 17+ | Elasticsearch 8.9+<br/>Amazon OpenSearch 2.5.x |
| Identity | OpenJDK 17+ | Keycloak 22.x, 23.x<br/>PostgreSQL 14.x, 15.x, Amazon Aurora PostgreSQL 13.x, 14.x, 15.x (required for [certain features](/self-managed/identity/deployment/configuration-variables.md#database-configuration)) |
| Optimize | OpenJDK 17+ | Elasticsearch 8.9+ |
| Web Modeler | - | PostgreSQL 13.x, 14.x, 15.x, 16.x, Amazon Aurora PostgreSQL 13.x, 14.x, 15.x, 16.x (other database systems are currently not supported) |
The following are tested and supported deployment options for Kubernetes, Docker, and manual installation:

:::note Elasticsearch support
Camunda 8 works with the [default distribution](https://www.elastic.co/downloads/elasticsearch) of Elasticsearch, which is available under the [Free or Gold+ Elastic license](https://www.elastic.co/pricing/faq/licensing#summary).
- [Stock Kubernetes](/self-managed/platform-deployment/helm-kubernetes/overview.md)
- [Cloud service providers](/self-managed/platform-deployment/helm-kubernetes/platforms/platforms.md) [recommended]
- [Amazon EKS](/self-managed/platform-deployment/helm-kubernetes/platforms/amazon-eks/amazon-eks.md)
- [Microsoft AKS](/self-managed/platform-deployment/helm-kubernetes/platforms/microsoft-aks.md)
- [Google GKE](/self-managed/platform-deployment/helm-kubernetes/platforms/google-gke.md)
- [Red Hat OpenShift](/self-managed/platform-deployment/helm-kubernetes/platforms/redhat-openshift.md) (4.11+)
- [Docker](/self-managed/platform-deployment/docker.md)
- [Manual](/self-managed/platform-deployment/manual.md)

:::note Helm chart compatibility
Ensure the Camunda component versions are compatible with the Helm chart version as defined in the [matrix](https://helm.camunda.io/camunda-platform/version-matrix/).
:::

### Helm chart version matrix
### Sizing

The [sizing of a Camunda 8 installation](/components/best-practices/architecture/sizing-your-environment.md) depends on various influencing factors. Ensure to [determine these factors](../components/best-practices/architecture/sizing-your-environment.md#understanding-influencing-factors), and conduct [benchmarking](../components/best-practices/architecture/sizing-your-environment.md#running-experiments-and-benchmarks) to validate an appropriate environment size for your test, integration, or production environments.

#### Volume performance

The core Camunda components have a unified fixed release schedule following the [release policy](./release-policy.md). However, some of the applications have their own schedule. The following compatibility matrix gives an overview of the different versions with respect to the Helm chart versions.
As a minimum requirement the cluster nodes should use volumes with an absolute minimum of 1,000 IOPS. **NFS or other types of network storage volumes are not supported.**

Since the 8.4 release (January 2024), the Camunda Helm chart version is decoupled from the version of the application (e.g., the chart version is 9.0.0 and the application version is 8.4.x).
To ensure an appropriate sizing, [determine your influencing factors](../components/best-practices/architecture/sizing-your-environment.md#understanding-influencing-factors) (e.g., throughput), and conduct [benchmarking to validate an appropriate environment sizing](../components/best-practices/architecture/sizing-your-environment.md#running-experiments-and-benchmarks).

For more details about the applications version included in the Helm chart, review the [full version matrix](https://helm.camunda.io/camunda-platform/version-matrix/).
For details on typical volume type usage, refer to the following examples specific to cloud service providers:

### Applications version matrix
- [Amazon EKS](../self-managed/platform-deployment/helm-kubernetes/platforms/amazon-eks/amazon-eks.md#volume-performance)
- [Microsoft AKS](../self-managed/platform-deployment/helm-kubernetes/platforms/microsoft-aks.md#volume-performance)
- [Google GKE](../self-managed/platform-deployment/helm-kubernetes/platforms/google-gke.md#volume-performance)

This overview shows which Zeebe version works with which Modeler, Operate, Tasklist and Optimize:
## Component requirements

| Design | Automate | | Improve | form-js |
| --------------------- | ----------- | ------------------------------------------------------------- | --------------- | ------- |
| Desktop Modeler 4.7+ | Zeebe 1.0.x | Operate 1.0.x Tasklist 1.0.x | - | 0.0.1 |
| Desktop Modeler 4.9+ | Zeebe 1.1.x | Operate 1.1.x Tasklist 1.1.x | - | 0.1.x |
| Desktop Modeler 4.11+ | Zeebe 1.2.x | Operate 1.2.x Tasklist 1.2.x IAM 1.2.x | - | 0.1.x |
| Desktop Modeler 4.12+ | Zeebe 1.3.x | Operate 1.3.x Tasklist 1.3.x IAM 1.3.x | Optimize 3.7.x | 0.1.x |
| Desktop Modeler 5.0+ | Zeebe 8.0.x | Operate 8.0.x Tasklist 8.0.x Identity 8.0.x | Optimize 3.8.x | 0.2.x |
| Desktop Modeler 5.4+ | Zeebe 8.1.x | Operate 8.1.x Tasklist 8.1.x Identity 8.1.x Connectors 0.23.0 | Optimize 3.9.x | 0.8.x |
| Desktop Modeler 5.10+ | Zeebe 8.2.x | Operate 8.2.x Tasklist 8.2.x Identity 8.2.x Connectors 0.23.2 | Optimize 3.10.x | 0.14.x |
| Web Modeler 8.2.x | Zeebe 8.2.x | Operate 8.2.x Tasklist 8.2.x Identity 8.2.x Connectors 0.23.2 | Optimize 3.10.x | 0.14.x |
| Web Modeler 8.3.x | Zeebe 8.3.x | Operate 8.3.x Tasklist 8.3.x Identity 8.3.x Connectors 8.3.x | Optimize 8.3.x | 1.3.x |
| Web Modeler 8.4.x | Zeebe 8.4.x | Operate 8.4.x Tasklist 8.4.x Identity 8.4.x Connectors 8.4.x | Optimize 8.4.x | 1.6.x |
| Web Modeler 8.5.x | Zeebe 8.5.x | Operate 8.5.x Tasklist 8.5.x Identity 8.5.x Connectors 8.5.x | Optimize 8.5.x | 1.7.x |
Requirements for the components can be seen below:

| Component | Java version | Other requirements |
| ----------- | ------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Zeebe | OpenJDK 21+ | Elasticsearch 8.9+<br/>Amazon OpenSearch 2.5.x (requires use of [OpenSearch exporter](../self-managed/zeebe-deployment/exporters/opensearch-exporter.md)) |
| Operate | OpenJDK 17+ | Elasticsearch 8.9+<br/>Amazon OpenSearch 2.5.x |
| Tasklist | OpenJDK 17+ | Elasticsearch 8.9+<br/>Amazon OpenSearch 2.5.x |
| Identity | OpenJDK 17+ | Keycloak 22.x, 23.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 17+ | Elasticsearch 8.9+ |
| Web Modeler | - | PostgreSQL 13.x, 14.x, 15.x, 16.x or Amazon Aurora PostgreSQL 13.x, 14.x, 15.x, 16.x |

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

:::note Elasticsearch support
Camunda 8 works with the [default distribution](https://www.elastic.co/downloads/elasticsearch) of Elasticsearch, which is available under the [Free or Gold+ Elastic license](https://www.elastic.co/pricing/faq/licensing#summary).
:::

### Component version matrix

This matrix shows which component versions work together:

| Design | Automate | | Improve |
| --------------------- | ----------- | ------------------------------------------------------------- | --------------- |
| Desktop Modeler 4.12+ | Zeebe 1.3.x | Operate 1.3.x Tasklist 1.3.x IAM 1.3.x | Optimize 3.7.x |
| Desktop Modeler 5.0+ | Zeebe 8.0.x | Operate 8.0.x Tasklist 8.0.x Identity 8.0.x | Optimize 3.8.x |
| Desktop Modeler 5.4+ | Zeebe 8.1.x | Operate 8.1.x Tasklist 8.1.x Identity 8.1.x Connectors 0.23.0 | Optimize 3.9.x |
| Desktop Modeler 5.10+ | Zeebe 8.2.x | Operate 8.2.x Tasklist 8.2.x Identity 8.2.x Connectors 0.23.2 | Optimize 3.10.x |
| Desktop Modeler 5.16+ | Zeebe 8.3.x | Operate 8.3.x Tasklist 8.3.x Identity 8.3.x Connectors 8.3.x | Optimize 8.3.x |
| Desktop Modeler 5.19+ | Zeebe 8.4.x | Operate 8.4.x Tasklist 8.4.x Identity 8.4.x Connectors 8.4.x | Optimize 8.4.x |
| Web Modeler 8.2.x | Zeebe 8.2.x | Operate 8.2.x Tasklist 8.2.x Identity 8.2.x Connectors 0.23.2 | Optimize 3.10.x |
| Web Modeler 8.3.x | Zeebe 8.3.x | Operate 8.3.x Tasklist 8.3.x Identity 8.3.x Connectors 8.3.x | Optimize 8.3.x |
| Web Modeler 8.4.x | Zeebe 8.4.x | Operate 8.4.x Tasklist 8.4.x Identity 8.4.x Connectors 8.4.x | Optimize 8.4.x |
| Web Modeler 8.5.x | Zeebe 8.5.x | Operate 8.5.x Tasklist 8.5.x Identity 8.5.x Connectors 8.5.x | Optimize 8.5.x |

:::note
You can also use newer versions of Desktop and Web Modeler with older Zeebe versions.
:::

## form-js version matrix

| Design | form-js |
| --------------------- | ------- |
| Desktop Modeler 4.7+ | 0.0.1 |
| Desktop Modeler 4.9+ | 0.1.x |
| Desktop Modeler 4.11+ | 0.1.x |
| Desktop Modeler 4.12+ | 0.1.x |
| Desktop Modeler 5.0+ | 0.2.x |
| Desktop Modeler 5.4+ | 0.8.x |
| Desktop Modeler 5.10+ | 0.14.x |
| Web Modeler 8.2.x | 0.14.x |
| Web Modeler 8.3.x | 1.3.x |
| Web Modeler 8.4.x | 1.6.x |
| Web Modeler 8.5.x | 1.7.x |

## Camunda 7 & Optimize version matrix

See https://docs.camunda.org/enterprise/download/#camunda-optimize.
Loading
Loading