Skip to content

Commit 68bf0df

Browse files
authored
chore(content): Add Tomcat 10 to Documentation
Co-authored-by: danielkelemen Co-authored-by: tasso94 Co-authored-by: petros.savvidis Related-to: camunda/camunda-bpm-platform#4390 Parent-ticket: camunda/camunda-bpm-platform#2471
1 parent 8d2ccd4 commit 68bf0df

File tree

5 files changed

+78
-5
lines changed

5 files changed

+78
-5
lines changed

content/installation/full/tomcat/manual.md

+6-2
Original file line numberDiff line numberDiff line change
@@ -143,7 +143,8 @@ You have to add the file `bpm-platform.xml` to the folder `$TOMCAT_HOME/conf` or
143143
## Secure Tomcat
144144

145145
Follow the Tomcat Security Howto of your Tomcat version:
146-
[9.0](https://tomcat.apache.org/tomcat-9.0-doc/security-howto.html).
146+
[9.0](https://tomcat.apache.org/tomcat-9.0-doc/security-howto.html),
147+
[10.1](https://tomcat.apache.org/tomcat-10.1-doc/security-howto.html).
147148

148149
In particular, go to `${TOMCAT_HOME}/webapps/` and remove the directories
149150
`ROOT`, `docs`, `examples`, `manager` and `host-manager`.
@@ -160,7 +161,8 @@ The following steps are required to deploy the applications:
160161

161162
1. Download the Camunda 7 web application that contains both applications from our [Artifact Repository](https://artifacts.camunda.com/artifactory/camunda-bpm/org/camunda/bpm/webapp/camunda-webapp-tomcat/).
162163
Or switch to the private repository for the enterprise version (User and password from license required).
163-
Choose the correct version named `$PLATFORM_VERSION/camunda-webapp-tomcat-$PLATFORM_VERSION.war`.
164+
* For [Tomcat 10](https://artifacts.camunda.com/ui/native/camunda-bpm/org/camunda/bpm/webapp/camunda-webapp-tomcat-jakarta/), the name of the artifact is `$PLATFORM_VERSION/camunda-webapp-tomcat-jakarta-$PLATFORM_VERSION.war`.
165+
* For [Tomcat 9](https://artifacts.camunda.com/ui/native/camunda-bpm/org/camunda/bpm/webapp/camunda-webapp-tomcat/), the name of the artifact is `$PLATFORM_VERSION/camunda-webapp-tomcat-$PLATFORM_VERSION.war`.
164166
2. Copy the war file to `$TOMCAT_HOME/webapps/camunda.war`.
165167
Optionally you may name it differently or extract it to a folder to deploy it to a different context path.
166168
3. Startup Tomcat.
@@ -174,6 +176,8 @@ The following steps are required to deploy the REST API:
174176
1. Download the REST API web application archive from our [Artifact Repository](https://artifacts.camunda.com/artifactory/camunda-bpm/org/camunda/bpm/camunda-engine-rest/).
175177
Or switch to the private repository for the enterprise version (User and password from license required).
176178
Choose the correct version named `$PLATFORM_VERSION/camunda-engine-rest-$PLATFORM_VERSION-tomcat.war`.
179+
* For [Tomcat 10](https://artifacts.camunda.com/artifactory/public/org/camunda/bpm/camunda-engine-rest-jakarta/), the name of the artifact is `$PLATFORM_VERSION/camunda-engine-rest-jakarta-$PLATFORM_VERSION-tomcat.war`.
180+
* For [Tomcat 9](https://artifacts.camunda.com/artifactory/public/org/camunda/bpm/camunda-engine-rest/), the name of the artifact is `$PLATFORM_VERSION/camunda-engine-rest-$PLATFORM_VERSION-tomcat.war`.
177181
2. Copy the war file to `$TOMCAT_HOME/webapps`.
178182
Optionally you may rename it or extract it to a folder to deploy it to a specific context like `/engine-rest`.
179183
3. Startup Tomcat.

content/introduction/supported-environments.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ Run Camunda in every Java-runnable environment. Camunda is supported with our QA
3232

3333
## Container-Managed Process Engine and Camunda Cockpit, Tasklist, Admin
3434

35-
* Apache Tomcat 9.0
35+
* Apache Tomcat 9.0 / 10.1
3636
* JBoss EAP 7.4 / 8.0
3737
* WildFly Application Server 23.0 / 26.0 / 31.0
3838
* IBM WebSphere Liberty 22 with Java EE 8 features ([Enterprise Edition only](http://camunda.com/enterprise/),

content/update/minor/721-to-722/_index.md

+54
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ This document guides you through the update from Camunda `7.21.x` to `7.22.0` an
2222
1. For developers: [Camunda Template Engines FreeMarker](#camunda-template-engines-freemarker)
2323
1. For developers: [Camunda Connect](#camunda-connect)
2424
1. For administrators and developers: [Update to JBoss EAP 8.0](#update-to-jboss-eap-8)
25+
1. For administrators and developers: [Update to Tomcat 10 Server](#update-to-tomcat-10-server)
2526

2627
This guide covers mandatory migration steps and optional considerations for the initial configuration of new functionality included in Camunda 7.22.
2728

@@ -99,3 +100,56 @@ Replace the artifact `camunda-webapp-jboss-$PLATFORM_VERSION.war` with `camunda-
99100
### Replace REST API deployment
100101

101102
Replace the artifact `camunda-engine-rest-$PLATFORM_VERSION-wildfly.war` with `camunda-engine-rest-jakarta-$PLATFORM_VERSION-wildfly.war` under `$JBOSS_HOME/standalone/deployments`.
103+
104+
# Update to Tomcat 10 Server
105+
106+
This version brings support for `Tomcat 10.1`. A few reasons to upgrade are:
107+
108+
* Namespace Change: Switch from `javax.*` to `jakarta.*` for future compatibility.
109+
* Enhanced Security: Improved security features and fixes.
110+
* Modern Features: Supports `Servlet 6.0`, `JSP 3.1`, and `WebSocket 2.1`.
111+
* Performance Improvements: Faster response times and better resource efficiency.
112+
* Simplified Migration: Tools and documentation for easier transition from earlier versions.
113+
* Better Integration: Enhanced compatibility with `Jakarta EE` components and third-party libraries.
114+
115+
From now on, our pre-packaged Tomcat distribution is built with `Tomcat 10.1`.
116+
Additionally, the Tomcat Docker image will, from now on, utilize `Tomcat 10.1`.
117+
118+
If you prefer to stay on `Tomcat 9`, you can still download the `Java EE` compliant [web application][tomcat9-webapp], and [REST API][tomcat9-rest-api].
119+
120+
To work with `Tomcat 10`, consider the following when migrating your process applications and replacing artifacts on the application server:
121+
122+
[tomcat9-webapp]: https://artifacts.camunda.com/ui/native/camunda-bpm/org/camunda/bpm/webapp/camunda-webapp-tomcat/
123+
[tomcat9-rest-api]: https://artifacts.camunda.com/artifactory/public/org/camunda/bpm/camunda-engine-rest/
124+
125+
### Migrate process applications
126+
127+
* Replace Java EE class references (`javax.*`) with Jakarta class references (`jakarta.*`)
128+
* You might have a look at [`org.eclipse.transformer:transformer-maven-plugin`](https://github.com/eclipse/transformer)
129+
* Replace Camunda class references:
130+
* `org.camunda.bpm.application.impl.EjbProcessApplication``org.camunda.bpm.application.impl.JakartaEjbProcessApplication`
131+
* `org.camunda.bpm.application.impl.ServletProcessApplicationDeployer``org.camunda.bpm.application.impl.JakartaServletProcessApplicationDeployer`
132+
* `org.camunda.bpm.application.impl.ServletProcessApplication``org.camunda.bpm.application.impl.JakartaServletProcessApplication`
133+
* `org.camunda.bpm.engine.impl.cfg.jta.JtaTransactionContext``org.camunda.bpm.engine.impl.cfg.jta.JakartaTransactionContext`
134+
* `org.camunda.bpm.engine.impl.cfg.jta.JtaTransactionContextFactory``org.camunda.bpm.engine.impl.cfg.jta.JakartaTransactionContextFactory`
135+
* `org.camunda.bpm.engine.impl.cfg.JtaProcessEngineConfiguration``org.camunda.bpm.engine.impl.cfg.JakartaTransactionProcessEngineConfiguration`
136+
* `org.camunda.bpm.engine.impl.interceptor.JtaTransactionInterceptor``org.camunda.bpm.engine.impl.interceptor.JakartaTransactionInterceptor`
137+
* Replace Camunda Maven dependencies:
138+
* `org.camunda.bpm.javaee:camunda-ejb-client``org.camunda.bpm.javaee:camunda-ejb-client-jakarta`
139+
* `org.camunda.bpm:camunda-engine-cdi``org.camunda.bpm:camunda-engine-cdi-jakarta`
140+
141+
### Migrate Java webapp plugins
142+
143+
Replace Java EE class references (`javax.*`) with Jakarta class references (`jakarta.*`)
144+
145+
### Replace web application (Cockpit, Admin, Tasklist, Welcome) deployment
146+
147+
Replace the artifact `camunda-webapp-tomcat-$PLATFORM_VERSION.war` with `camunda-webapp-tomcat-jakarta-$PLATFORM_VERSION.war` under `$CATALINA_HOME/webapps`.
148+
149+
### Replace REST API deployment
150+
151+
Replace the artifact `camunda-engine-rest-$PLATFORM_VERSION-tomcat.war` with `camunda-engine-rest-jakarta-$PLATFORM_VERSION-tomcat.war` under `$CATALINA_HOME/webapps`.
152+
153+
### Migrating to the Tomcat 10 Docker Image
154+
155+
If your application uses a Docker image based on `Tomcat 9`, you need to perform the above migration steps yourself before your application is compatible with the `jakarta` namespace changes the new Tomcat version introduces.

content/update/patch-level.md

+15
Original file line numberDiff line numberDiff line change
@@ -486,6 +486,21 @@ This will allow a better experience when looking for process definitions.
486486
The change also affects the API that provides the data for the search component.
487487
This API is an internal API, which means it's **not** part of the public [REST API]({{< ref "/reference/rest" >}}), so the change should not affect any customers.
488488

489+
## 7.21.3 to 7.21.4
490+
491+
### Added Support for Tomcat 10
492+
493+
This version supports all the necessary building-block modules for our users to use `camunda-bpm-platform` community and enterprise editions in conjunction with `Tomcat 10.1`.
494+
495+
{{< note title="Heads-up!" class="warning" >}}
496+
`Tomcat 10` is compatible with the `jakarta` namespace.
497+
If you wish to use it, the `jakarta` modules needs to be used (`camunda-webapp-tomcat-jakarta`, `camunda-engine-rest-jakarta`).
498+
499+
The `javax` modules won't work with `Tomcat 10`.
500+
501+
For detailed steps of manual installation, follow the [Tomcat Manual Installation Guide]({{< ref "/installation/full/tomcat/manual.md" >}})
502+
{{< /note >}}
503+
489504
# Full Distribution
490505

491506
This section is applicable if you installed the [Full Distribution]({{< ref "/introduction/downloading-camunda.md#full-distribution" >}}) with a **shared process engine**. In this case you need to update the libraries and applications installed inside the application server.

content/user-guide/runtime-container-integration/tomcat.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ menu:
1414

1515
# JNDI Bindings
1616

17-
To use the JNDI Bindings for Camunda 7 Services on Apache Tomcat you have to add the file `META-INF/context.xml` to your process application and add the following [ResourceLinks](http://tomcat.apache.org/tomcat-9.0-doc/config/context.html#Resource_Links):
17+
To use the JNDI Bindings for Camunda 7 Services on Apache Tomcat you have to add the file `META-INF/context.xml` to your process application and add the following ResourceLinks ([Tomcat 9](http://tomcat.apache.org/tomcat-9.0-doc/config/context.html#Resource_Links), [Tomcat 10.1](https://tomcat.apache.org/tomcat-10.1-doc/config/context.html#Resource_Links)):
1818

1919
```xml
2020
<Context>
@@ -64,7 +64,7 @@ If you have declared other resource link names than we proposed, you have to use
6464

6565
## Tomcat Default Job Executor
6666

67-
Camunda 7 on Apache Tomcat 9.x uses the default job executor. The default [job executor]({{< ref "/user-guide/process-engine/the-job-executor.md" >}}) uses a ThreadPoolExecutor which manages a thread
67+
Camunda 7 on Apache Tomcat 10.x uses the default job executor. The default [job executor]({{< ref "/user-guide/process-engine/the-job-executor.md" >}}) uses a ThreadPoolExecutor which manages a thread
6868
pool and a job queue.
6969

7070
The core pool size, queue size, maximum pool size and keep-alive-time can be configured in the `bpm-platform.xml`.

0 commit comments

Comments
 (0)