Skip to content

Commit

Permalink
Merge branch 'master' into t153-add-backport-action
Browse files Browse the repository at this point in the history
  • Loading branch information
yanavasileva committed Jun 29, 2024
2 parents 7b5d761 + a0260de commit 78d8ae7
Show file tree
Hide file tree
Showing 71 changed files with 226 additions and 186 deletions.
14 changes: 14 additions & 0 deletions .github/workflows/close-stale-issues.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# This workflow warns and then closes issues and PRs that have had no activity for a specified amount of time.
#
# You can adjust the behavior by modifying this file.
# For more information, see:
# https://github.com/actions/stale
name: 'Close stale issues and PRs'
on:
schedule:
- cron: '0 3 * * 2-6'
workflow_dispatch: # can be used to trigger the workflow manually

jobs:
call-reusable-flow:
uses: camunda/automation-platform-github-actions/.github/workflows/close-stale-issues.yml@main
1 change: 0 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -181,6 +181,5 @@ _Note: For screenshot of the enterprise webapps, you can use the automatic scree
[Hugo]: http://gohugo.io/
[Hugo v0.54]: https://github.com/gohugoio/hugo/releases/tag/v0.54.0
[Hugo Installation]: https://gohugo.io/getting-started/installing/#install-hugo-from-tarball
[Camunda Nexus]: https://artifacts.camunda.com/artifactory/thirdparty/hugo/
[OpenOffice]: https://www.openoffice.org/download/index.html
[OpenSans]: https://www.google.com/fonts#UsePlace:use/Collection:Open+Sans
12 changes: 6 additions & 6 deletions content/installation/database-schema.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ The [update](#update) paragraph provides more details on this topic.

Camunda 7 comes with a maintained changelog file that Liquibase can consume.
This changelog defines which SQL statements to execute on a database.
You can find the changelog and its referenced resources on our [Nexus].
You can find the changelog and its referenced resources on our [Artifact Repository].
Select the respective version (`$PLATFORM_VERSION`) and download the resources as a `zip` or `tar.gz` file.
Open the `camunda-sql-scripts-$PLATFORM_VERSION/liquibase` folder to find the changelog.
In case you are using a [pre-packaged distribution], the Liquibase resources already reside in the `sql/liquibase` folder of the distribution.
Expand Down Expand Up @@ -76,7 +76,7 @@ Furthermore, if you have defined a specific prefix for the entities of your data
## Manual installation

To install the database schema required for Camunda 7, we provide a set of scripts with prepared DDL statements.
Those scripts create all required tables and default indices. You can find the provided SQL scripts on our [Nexus].
Those scripts create all required tables and default indices. You can find the provided SQL scripts on our [Artifact Repository].
Select the respective version (`$PLATFORM_VERSION`) and download the scripts as a `zip` or `tar.gz` file.
Open the `camunda-sql-scripts-$PLATFORM_VERSION/create` folder to find all available scripts.
In case you are using a [pre-packaged distribution], the SQL scripts already reside in the `sql/create` folder of the distribution.
Expand Down Expand Up @@ -117,7 +117,7 @@ Based on that changelog and the tracking tables, Liquibase determines which chan

Perform the following steps to update the database schema on your database instance:

1. Select the respective version you want to update to (`$Y`) on our [Nexus] and download the resources as a `zip` or `tar.gz` file.
1. Select the respective version you want to update to (`$Y`) on our [Artifact Repository] and download the resources as a `zip` or `tar.gz` file.
Open the `camunda-sql-scripts-$Y/liquibase` folder to find the changelog file.
In case you are using a [pre-packaged distribution], the Liquibase resources already reside in the `sql/liquibase` folder of the distribution with version `$Y`.
1. Run Liquibase's [update command](https://docs.liquibase.com/commands/community/update.html) referencing the new `camunda-changelog.xml` of version `$Y`.
Expand Down Expand Up @@ -159,7 +159,7 @@ Updating from your current minor version (`$X`) to its follow-up version (`$Y`)
Follow the outlined procedure to perform this update:

1. Check for [available database patch scripts](#patch-level-update") for your database that are within the bounds of your update path.
You can find the scripts on our [Nexus].
You can find the scripts on our [Artifact Repository].
Select the respective version you want to update to (`$Y`) and download the scripts as a `zip` or `tar.gz` file.
Open the `camunda-sql-scripts-$Y/upgrade` folder to find all available scripts.
In case you are using a [pre-packaged distribution], the SQL scripts already reside in the `sql/upgrade` folder of the distribution with version `$Y`.
Expand Down Expand Up @@ -623,7 +623,7 @@ Therefore, the procedure for patch-level updates is equivalent to that for [mino

### Manual patch level update

You can find the necessary scripts on our [Nexus].
You can find the necessary scripts on our [Artifact Repository].
Select the respective patch version you want to update to (`$Y`) and download the scripts as a `zip` or `tar.gz` file.
Open the `camunda-sql-scripts-$Y/upgrade` folder to find all available patch scripts.
In case you are using a [pre-packaged distribution], the SQL scripts reside in the `sql/upgrade` folder of the distribution you want to update to.
Expand All @@ -633,5 +633,5 @@ If you do choose to apply a database patch, then you must apply all patch script

<strong>Note:</strong> Some patches are provided for multiple versions. It is not required to execute them more than once. See the description of the [patch version list](#patch-level-update) for information on duplicate fixes.

[Nexus]: https://artifacts.camunda.com/artifactory/camunda-bpm/org/camunda/bpm/distro/camunda-sql-scripts/
[Artifact Repository]: https://artifacts.camunda.com/artifactory/camunda-bpm/org/camunda/bpm/distro/camunda-sql-scripts/
[pre-packaged distribution]: {{< ref "/introduction/downloading-camunda.md#full-distribution" >}}
8 changes: 4 additions & 4 deletions content/installation/full/jboss/_index.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
---

title: "Install the Full Distribution for JBoss EAP/Wildfly"
title: "Install the Full Distribution for JBoss EAP/WildFly"
weight: 20

menu:
main:
name: "JBoss EAP/Wildfly"
name: "JBoss EAP/WildFly"
identifier: "installation-guide-full-jboss"
parent: "installation-guide-full"
pre: "Install the Full Distribution for JBoss EAP or Wildfly Application Servers."
pre: "Install the Full Distribution for JBoss EAP or WildFly Application Servers."

---

This document describes the installation of the [Full Distribution]({{< ref "/introduction/downloading-camunda.md#full-distribution" >}}) for [Wildfly Application Server / JBoss EAP 7](http://www.wildfly.org).
This document describes the installation of the [Full Distribution]({{< ref "/introduction/downloading-camunda.md#full-distribution" >}}) for [WildFly Application Server / JBoss EAP](http://www.wildfly.org).

There are different options for installing the Full Distribution:
10 changes: 5 additions & 5 deletions content/installation/full/jboss/configuration.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---

title: 'Configure the Full Distribution for JBoss EAP/Wildfly'
title: 'Configure the Full Distribution for JBoss EAP/WildFly'
weight: 30

menu:
Expand All @@ -13,17 +13,17 @@ menu:
---


This page explains how to configure the full distribution for the JBoss EAP/Wildfly application server.
This page explains how to configure the full distribution for the JBoss EAP/WildFly application server.


## LDAP

In order to setup LDAP for the JBoss EAP/Wildfly Application Server distribution, you have to perform the following steps:
In order to setup LDAP for the JBoss EAP/WildFly Application Server distribution, you have to perform the following steps:


### Adjust the Process Engine Configuration

Edit the file `standalone.xml` (or `domain.xml`) provided by the JBoss EAP/Wildfly Application Server and add the [LDAP Identity Provider Plugin]({{< ref "/user-guide/process-engine/identity-service.md#the-ldap-identity-service" >}}) and the [Administrator Authorization Plugin]({{< ref "/user-guide/process-engine/authorization-service.md#the-administrator-authorization-plugin" >}}).
Edit the file `standalone.xml` (or `domain.xml`) provided by the JBoss EAP/WildFly Application Server and add the [LDAP Identity Provider Plugin]({{< ref "/user-guide/process-engine/identity-service.md#the-ldap-identity-service" >}}) and the [Administrator Authorization Plugin]({{< ref "/user-guide/process-engine/authorization-service.md#the-administrator-authorization-plugin" >}}).

```xml
<subsystem xmlns="urn:org.camunda.bpm.jboss:1.1">
Expand Down Expand Up @@ -134,7 +134,7 @@ configuration to the `web.xml` file of the Camunda 7 web application
</module>
```

The `module.xml` file is included in the Camunda 7 distribution. If you install Camunda 7 on a vanilla Wildfly container, this file needs to be created manually.
The `module.xml` file is included in the Camunda 7 distribution. If you install Camunda 7 on a vanilla WildFly container, this file needs to be created manually.
3. [Configure the process engine plugin]({{< ref "/user-guide/runtime-container-integration/jboss.md#extend-a-process-engine-using-process-engine-plugins" >}}) in the standalone.xml/domain.xml configuration file

## Session Cookie in Webapps
Expand Down
24 changes: 14 additions & 10 deletions content/installation/full/jboss/manual.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ menu:
---


This document describes the installation of Camunda 7 and its components on a vanilla [WildFly Application Server](http://www.wildfly.org) or JBoss EAP 7.
This document describes the installation of Camunda 7 and its components on a vanilla [WildFly Application Server](http://www.wildfly.org) or JBoss EAP 7 / 8.

{{< note title="Reading this Guide" class="info" >}}
This guide uses a number of variables to denote common path names and constants:
Expand All @@ -26,15 +26,15 @@ This guide uses a number of variables to denote common path names and constants:

## Setup

* For WildFly 27 and above, download the [Camunda 7 WildFly distribution](https://downloads.camunda.cloud/release/camunda-bpm/wildfly/).
* For WildFly 27 / JBoss EAP 8, download the [Camunda 7 WildFly distribution](https://downloads.camunda.cloud/release/camunda-bpm/wildfly/).
* For WildFly ≤26 / JBoss EAP 7, download the [`camunda-wildfly26-modules`](https://artifacts.camunda.com/artifactory/camunda-bpm/org/camunda/bpm/wildfly/camunda-wildfly26-modules/).

### Copy Modules

Copy the modules from the `modules/` folder of the Camunda 7 distribution, or extract the `camunda-wildfly-modules` archive, to the `$WILDFLY_HOME/modules/` of your WildFly application server.

{{< note title="Replace H2 Database" >}}
The WildFly distribution ships a different version of the H2 database than the one that is shipped with Wildfly itself.
The WildFly distribution ships a different version of the H2 database than the one that is shipped with WildFly itself.
The version shipped with Camunda 7 is the version that the process engine is tested on and it is strongly recommended to use Camunda's version.
To do so, **make sure to delete the folder**

Expand Down Expand Up @@ -133,10 +133,12 @@ typically `bin`.
pool-name="ProcessEngine">
<connection-url>jdbc:h2:./camunda-h2-dbs/process-engine;DB_CLOSE_DELAY=-1;DB_CLOSE_ON_EXIT=FALSE</connection-url>
<driver>h2</driver>
<security user-name="sa" password="sa"/> <!-- for WildFly ≥27 / JBoss EAP 8 -->
<!-- for WildFly ≤26 / JBoss EAP 7
<security>
<user-name>sa</user-name>
<password>sa</password>
</security>
</security> -->
</datasource>
```
Using H2 as a database is ideal for development purposes but is not recommended for usage in a productive environment.
Expand All @@ -147,7 +149,7 @@ These links point you to resources for other databases:

## Optional Components

This section describes how to install optional dependencies. None of these are required to work with the core platform. Before continuing, make sure that Camunda 7 is already installed according to [this step]({{< relref "#setup" >}}) for WildFly / JBoss EAP 7.
This section describes how to install optional dependencies. None of these are required to work with the core platform. Before continuing, make sure that Camunda 7 is already installed according to [this step]({{< relref "#setup" >}}) for WildFly / JBoss EAP.


### Cockpit, Tasklist, and Admin
Expand All @@ -156,7 +158,7 @@ The following steps are required to deploy the web application:

1. Download the Camunda web application that contains the web applications from our Maven Artifactory.
Alternatively, switch to the private repository for the enterprise version (credentials from license required).
* For [WildFly 27+](https://artifacts.camunda.com/artifactory/camunda-bpm/org/camunda/bpm/webapp/camunda-webapp-wildfly/), the name of the artifact is `$PLATFORM_VERSION/camunda-webapp-wildfly-$PLATFORM_VERSION.war`.
* For [WildFly ≥27 / JBoss EAP 8](https://artifacts.camunda.com/artifactory/camunda-bpm/org/camunda/bpm/webapp/camunda-webapp-wildfly/), the name of the artifact is `$PLATFORM_VERSION/camunda-webapp-wildfly-$PLATFORM_VERSION.war`.
* For [WildFly ≤26 / JBoss EAP 7](https://artifacts.camunda.com/artifactory/camunda-bpm/org/camunda/bpm/webapp/camunda-webapp-jboss/), the name of the artifact is `$PLATFORM_VERSION/camunda-webapp-jboss-$PLATFORM_VERSION.war`.
2. Optionally, you may change the context path to which the application will be deployed (default is `/camunda`).
Edit the file `WEB-INF/jboss-web.xml` in the war file and update the `context-root` element accordingly.
Expand All @@ -171,7 +173,7 @@ The following steps are required to deploy the REST API:

1. Download the REST API web application archive from our Maven Artifactory.
Alternatively, switch to the private repository for the enterprise version (credentials from license required).
* For [WildFly 27+](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-wildfly.war`.
* For [WildFly ≥27 / JBoss EAP 8](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-wildfly.war`.
* For [WildFly ≤26 / JBoss EAP 7](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-wildfly.war`.
2. Optionally, you may change the context path to which the REST API will be deployed (default is `/engine-rest`).
Edit the file `WEB-INF/jboss-web.xml` in the war file and update the `context-root` element accordingly.
Expand Down Expand Up @@ -222,9 +224,9 @@ Add the following modules (if not existing) from the folder `$WILDFLY_DISTRIBUTI
* `org/camunda/spin/camunda-spin-core`
* `org/camunda/spin/camunda-spin-dataformat-json-jackson`
* `org/camunda/spin/camunda-spin-dataformat-xml-dom-jakarta`
* **Heads-up:** add this module only for Wildfly 27+.
* **Heads-up:** add this module only for WildFly ≥27 / JBoss EAP 8.
* `org/camunda/spin/camunda-spin-dataformat-xml-dom`
* **Heads-up:** add this module only for Wildfly ≤26 / JBoss EAP 7.
* **Heads-up:** add this module only for WildFly ≤26 / JBoss EAP 7.
* `org/camunda/bpm/camunda-engine-plugin-spin`
* `org/camunda/commons/camunda-commons-utils`
* `com/fasterxml/jackson/core/jackson-core`
Expand Down Expand Up @@ -275,7 +277,7 @@ See this [Forum Post](https://forum.camunda.org/t/camunda-json-marshalling-and-j

#### Problem With Deployments Using the REST API

Camunda Spin is not available in scripts if a process definition is deployed via REST API. Because Wildfly handles dependencies using its module system and Camunda engine module has no module dependency on the spin module.
Camunda Spin is not available in scripts if a process definition is deployed via REST API. Because WildFly handles dependencies using its module system and Camunda engine module has no module dependency on the spin module.

### Groovy Scripting

Expand Down Expand Up @@ -303,3 +305,5 @@ Add the following modules (if not existing) from the folder `$WILDFLY_DISTRIBUTI
* `org/graalvm/sdk/graal-sdk`
* `org/graalvm/truffle/truffle-api`
* `com/ibm/icu/icu4j`


15 changes: 2 additions & 13 deletions content/installation/full/jboss/pre-packaged.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,24 +8,13 @@ menu:
name: "Pre-Packaged Distribution"
identifier: "installation-guide-full-jboss-install-pre-built"
parent: "installation-guide-full-jboss"
pre: "Download and install Wildfly Application Server with the Full Distribution pre-deployed and pre-configured."
pre: "Download and install WildFly Application Server with the Full Distribution pre-deployed and pre-configured."

---

# Installation Procedure

1. Download the pre-packaged distribution for [Wildfly](https://downloads.camunda.cloud/release/camunda-bpm/wildfly/)
1. Download the pre-packaged distribution for [WildFly](https://downloads.camunda.cloud/release/camunda-bpm/wildfly/).
2. Unpack the distro to a directory.
3. Adjust the datasource according to your needs (see [Manual Installation]({{<ref "/installation/full/jboss/manual.md" >}})).
4. Startup the server by running `camunda-welcome.bat` or by using the `$WILDFLY_HOME/bin/standalone.{bat/sh}` script.


# Accessing the H2 console

In Wildfly you can easily access the H2 console to inspect your local H2 database (used in demo/evaluation scenarios):

1. Go to http://localhost:8080/h2/h2
2. Login with the following data:
* jdbc:h2:./camunda-h2-dbs/process-engine
* User: sa
* Password: sa
4 changes: 2 additions & 2 deletions content/installation/full/tomcat/manual.md
Original file line number Diff line number Diff line change
Expand Up @@ -158,7 +158,7 @@ This section describes how to install optional Camunda 7 dependencies onto a Tom

The following steps are required to deploy the applications:

1. Download the Camunda 7 web application that contains both applications from our [Maven Nexus Server](https://artifacts.camunda.com/artifactory/camunda-bpm/org/camunda/bpm/webapp/camunda-webapp-tomcat/).
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/).
Or switch to the private repository for the enterprise version (User and password from license required).
Choose the correct version named `$PLATFORM_VERSION/camunda-webapp-tomcat-$PLATFORM_VERSION.war`.
2. Copy the war file to `$TOMCAT_HOME/webapps/camunda.war`.
Expand All @@ -171,7 +171,7 @@ The following steps are required to deploy the applications:

The following steps are required to deploy the REST API:

1. Download the REST API web application archive from our [Maven Nexus Server](https://artifacts.camunda.com/artifactory/camunda-bpm/org/camunda/bpm/camunda-engine-rest/).
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/).
Or switch to the private repository for the enterprise version (User and password from license required).
Choose the correct version named `$PLATFORM_VERSION/camunda-engine-rest-$PLATFORM_VERSION-tomcat.war`.
2. Copy the war file to `$TOMCAT_HOME/webapps`.
Expand Down
11 changes: 0 additions & 11 deletions content/installation/full/tomcat/pre-packaged.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,14 +18,3 @@ menu:
2. Unpack the distro to a directory.
3. Adjust the datasource according to your needs (see [Manual Installation]({{<ref "/installation/full/tomcat/manual.md" >}})).
4. Startup the server by running `camunda-welcome.bat` or by using the `$TOMCAT_HOME/bin/startup.{bat/sh}` script.


# Accessing the H2 console

You can easily access the H2 console to inspect your local H2 database (used in demo/evaluation scenarios):

1. Go to http://localhost:8080/h2/h2
2. Login with the following data:
* jdbc:h2:./camunda-h2-dbs/process-engine
* User: sa
* Password: sa
2 changes: 1 addition & 1 deletion content/introduction/supported-environments.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ Run Camunda in every Java-runnable environment. Camunda is supported with our QA
## Container-Managed Process Engine and Camunda Cockpit, Tasklist, Admin

* Apache Tomcat 9.0
* JBoss EAP 7.4
* JBoss EAP 7.4 / 8.0
* WildFly Application Server 23.0 / 26.0 / 31.0
* IBM WebSphere Liberty 22 with Java EE 8 features ([Enterprise Edition only](http://camunda.com/enterprise/),
see [Installation guide]({{< ref "/installation/full/was/manual-liberty.md" >}}))
Expand Down
Loading

0 comments on commit 78d8ae7

Please sign in to comment.