Skip to content

Commit cb12e86

Browse files
JeremJRyosifkit
authored andcommitted
Update Bonita doc for 7.9 (#1505)
* update Bonita and migration tool versions * updates links * update content for 7.9
1 parent 7ff08eb commit cb12e86

File tree

1 file changed

+48
-22
lines changed

1 file changed

+48
-22
lines changed

bonita/content.md

Lines changed: 48 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Bonita (called Bonita BPM till 7.5) is an open-source business process managemen
1414
$ docker run --name bonita -d -p 8080:8080 %%IMAGE%%
1515
```
1616

17-
This will start a container running the [Tomcat Bundle](https://documentation.bonitasoft.com/bonita/7.8/tomcat-bundle) with Bonita Engine + Bonita Portal. With no environment variables specified, it's as like if you have launched the bundle on your host using startup.{sh|bat} (with security hardening on REST and HTTP APIs, cf Security part). Bonita uses a H2 database here.
17+
This will start a container running the [Tomcat Bundle](https://documentation.bonitasoft.com/bonita/7.9/tomcat-bundle) with Bonita Engine + Bonita Portal. With no environment variables specified, it's as like if you have launched the bundle on your host using startup.{sh|bat} (with security hardening on REST and HTTP APIs, cf Security part). Bonita uses a H2 database here.
1818

1919
You can access the Bonita Portal on http://localhost:8080/bonita and login using the default credentials: install / install
2020

@@ -24,7 +24,7 @@ You can access the Bonita Portal on http://localhost:8080/bonita and login using
2424

2525
PostgreSQL is the recommanded database.
2626

27-
[Set max_prepared_transactions to 100](https://documentation.bonitasoft.com/bonita/7.8/database-configuration#toc5):
27+
[Set max_prepared_transactions to 100](https://documentation.bonitasoft.com/bonita/7.9/database-configuration#toc5):
2828

2929
```console
3030
$ mkdir -p custom_postgres
@@ -49,7 +49,7 @@ $ docker run --name bonita_postgres --link mydbpostgres:postgres -d -p 8080:8080
4949

5050
There are known issues with the management of XA transactions by MySQL engine and driver: see MySQL bugs [17343](http://bugs.mysql.com/bug.php?id=17343) and [12161](http://bugs.mysql.com/bug.php?id=12161) for more details. Thus, using MySQL database in a production environment is not recommended.
5151

52-
[Increase the packet size](https://documentation.bonitasoft.com/bonita/7.8/database-configuration#toc5) which is set by default to 1M:
52+
[Increase the packet size](https://documentation.bonitasoft.com/bonita/7.9/database-configuration#toc5) which is set by default to 1M:
5353

5454
```console
5555
$ mkdir -p custom_mysql
@@ -85,7 +85,7 @@ Run `docker stack deploy -c stack.yml %%REPO%%` (or `docker-compose -f stack.yml
8585

8686
## Where to store data
8787

88-
Most of the data are stored in a database and can be stored outside the Bonita container as described above using the PostgreSQL or MySQL container. However, some data remains inside the Bonita bundle. Bonita Home is a folder, called `bonita`, which contains configuration, working, and temporary folders and files. There are also log files inside the `logs` folder.
88+
Most of the data are stored in a database and can be stored outside the Bonita container as described above using the PostgreSQL or MySQL container. However, some data remains inside the Bonita bundle. Bonita Home is a folder, called `bonita`, which contains configuration, working, and temporary folders and files. There are also log files inside the `logs` folder till Bonita 7.8.
8989

9090
Important note: There are several ways to store data used by applications that run in Docker containers. We encourage users of the `%%REPO%%` images to familiarize themselves with the options available, including:
9191

@@ -167,9 +167,9 @@ The `-v /my/own/datadir:/opt/bonita` part of the command mounts the `/my/own/dat
167167

168168
```console
169169
cd bonita_migration
170-
wget https://release.ow2.org/bonita/bonita-migration-distrib-2.40.0.zip
170+
wget https://release.ow2.org/bonita/bonita-migration-distrib-2.41.0.zip
171171
wget https://download.forge.ow2.org/bonita/BonitaBPMCommunity-7.2.4-Tomcat-7.0.67.zip
172-
unzip bonita-migration-distrib-2.40.0.zip
172+
unzip bonita-migration-distrib-2.41.0.zip
173173
unzip BonitaBPMCommunity-7.2.4-Tomcat-7.0.67.zip
174174
```
175175

@@ -184,14 +184,14 @@ The `-v /my/own/datadir:/opt/bonita` part of the command mounts the `/my/own/dat
184184

185185
```console
186186
cd bonita_migration
187-
wget https://release.ow2.org/bonita/bonita-migration-distrib-2.40.0.zip
188-
unzip bonita-migration-distrib-2.40.0.zip
187+
wget https://release.ow2.org/bonita/bonita-migration-distrib-2.41.0.zip
188+
unzip bonita-migration-distrib-2.41.0.zip
189189
```
190190

191191
- Configure the migration tool
192192

193193
```console
194-
$ cd bonita-migration-distrib-2.40.0
194+
$ cd bonita-migration-distrib-2.41.0
195195
```
196196

197197
edit the migration tool config to point towards the copy of bonita home and db
@@ -228,17 +228,17 @@ The `-v /my/own/datadir:/opt/bonita` part of the command mounts the `/my/own/dat
228228
- If >= 7.3.0
229229

230230
```console
231-
$ docker run --name=bonita_7.8.4_postgres --link mydbpostgres:postgres -e "DB_NAME=newbonitadb" -e "DB_USER=newbonitauser" -e "DB_PASS=newbonitapass" -d -p 8081:8080 %%IMAGE%%:7.8.4
231+
$ docker run --name=bonita_7.9.0_postgres --link mydbpostgres:postgres -e "DB_NAME=newbonitadb" -e "DB_USER=newbonitauser" -e "DB_PASS=newbonitapass" -d -p 8081:8080 %%IMAGE%%:7.9.0
232232
```
233233

234234
- Reapply specific configuration if needed, for example with a version >= 7.3.0 :
235235

236236
```console
237-
$ docker exec -ti bonita_7.8.4_postgres /bin/bash
237+
$ docker exec -ti bonita_7.9.0_postgres /bin/bash
238238
```
239239

240240
```console
241-
$ cd /opt/bonita/BonitaCommunity-7.8.4-Tomcat-8.5.34/setup
241+
$ cd /opt/bonita/BonitaCommunity-7.9.0-tomcat/setup
242242
$ ./setup.sh pull
243243
$ TENANT_LOGIN=tech_user
244244
$ TENANT_PASSWORD=secret
@@ -258,22 +258,26 @@ The `-v /my/own/datadir:/opt/bonita` part of the command mounts the `/my/own/dat
258258
```
259259

260260
```console
261-
$ docker restart bonita_7.8.4_postgres
261+
$ docker restart bonita_7.9.0_postgres
262262
```
263263

264-
For more details regarding Bonita migration, see the [documentation](https://documentation.bonitasoft.com/bonita/7.8/migrate-from-an-earlier-version-of-bonita-bpm).
264+
- Specific consideration regarding migration to Java 11 in Bonita 7.9
265+
266+
Bonita 7.9 docker image runs with Java 11. If you are migrating from an earlier version which runs Java 8, you should validate on a test environment that your custom code is compatible. Aside from just code incompatibility, special attention has to be given to the dependencies of the custom code, as they might not work in Java 11.
267+
268+
For more details regarding Bonita migration, see the [documentation](https://documentation.bonitasoft.com/bonita/7.9/migrate-from-an-earlier-version-of-bonita-bpm).
265269

266270
## Security
267271

268272
This Docker image activates both static and dynamic authorization checks by default on REST API. To be consistent, it also deactivates the HTTP API.
269273

270274
- REST API authorization
271275

272-
- [Static authorization checking](https://documentation.bonitasoft.com/bonita/7.8/rest-api-authorization#toc1)
276+
- [Static authorization checking](https://documentation.bonitasoft.com/bonita/7.9/rest-api-authorization#toc1)
273277

274-
- [Dynamic authorization checking](https://documentation.bonitasoft.com/bonita/7.8/rest-api-authorization#toc2)
278+
- [Dynamic authorization checking](https://documentation.bonitasoft.com/bonita/7.9/rest-api-authorization#toc2)
275279

276-
- [HTTP API](https://documentation.bonitasoft.com/bonita/7.8/rest-api-authorization#toc10)
280+
- [HTTP API](https://documentation.bonitasoft.com/bonita/7.9/rest-api-authorization#toc10)
277281

278282
For specific needs you can override this behavior by setting HTTP_API to true and REST_API_DYN_AUTH_CHECKS to false:
279283

@@ -287,23 +291,23 @@ When you start the `bonita` image, you can adjust the configuration of the Bonit
287291

288292
### `PLATFORM_PASSWORD`
289293

290-
This environment variable [is recommended](https://documentation.bonitasoft.com/bonita/7.8/tomcat-bundle#toc3) for you to use the Bonita image. It sets the platform administrator password for Bonita. If it is not specified, the default password `platform` will be used.
294+
This environment variable [is recommended](https://documentation.bonitasoft.com/bonita/7.9/tomcat-bundle#toc3) for you to use the Bonita image. It sets the platform administrator password for Bonita. If it is not specified, the default password `platform` will be used.
291295

292296
### `PLATFORM_LOGIN`
293297

294298
This optional environment variable is used in conjunction with `PLATFORM_PASSWORD` to define the username for the platform administrator. If it is not specified, the default user `platformAdmin` will be used.
295299

296300
### `TENANT_PASSWORD`
297301

298-
This environment variable [is recommended](https://documentation.bonitasoft.com/bonita/7.8/tomcat-bundle#toc3) for you to use the Bonita image. It sets the tenant administrator password for Bonita. If it is not specified, the default password `install` will be used.
302+
This environment variable [is recommended](https://documentation.bonitasoft.com/bonita/7.9/tomcat-bundle#toc3) for you to use the Bonita image. It sets the tenant administrator password for Bonita. If it is not specified, the default password `install` will be used.
299303

300304
### `TENANT_LOGIN`
301305

302306
This optional environment variable is used in conjunction with `TENANT_PASSWORD` to define the username for the tenant administrator. If it is not specified, the default user of `install` will be used.
303307

304308
### `REST_API_DYN_AUTH_CHECKS`
305309

306-
This optional environment variable is used to enable/disable [dynamic authorization checking](https://documentation.bonitasoft.com/bonita/7.8/rest-api-authorization#toc2) on Bonita REST API. The default value is `true`, which will activate dynamic authorization checking.
310+
This optional environment variable is used to enable/disable [dynamic authorization checking](https://documentation.bonitasoft.com/bonita/7.9/rest-api-authorization#toc2) on Bonita REST API. The default value is `true`, which will activate dynamic authorization checking.
307311

308312
### `HTTP_API`
309313

@@ -337,7 +341,7 @@ These variables are used in conjunction to create a new user, set that user's pa
337341

338342
### `BIZ_DB_NAME`, `BIZ_DB_USER`, `BIZ_DB_PASS`
339343

340-
These variables are used in conjunction to create a new user, set that user's password and create the `bonita` [business database](https://documentation.bonitasoft.com/bonita/7.8/define-and-deploy-the-bdm#toc1).
344+
These variables are used in conjunction to create a new user, set that user's password and create the `bonita` [business database](https://documentation.bonitasoft.com/bonita/7.9/define-and-deploy-the-bdm#toc1).
341345

342346
`BIZ_DB_NAME` default value is `businessdb`.
343347

@@ -361,6 +365,14 @@ These variables are optional, and used in conjunction to create users and databa
361365

362366
`BIZ_DB_DROP_EXISTING` default value is `N`.
363367

368+
### `BONITA_SERVER_LOGGING_FILE`, `BONITA_SETUP_LOGGING_FILE`
369+
370+
Since Bonita 7.9 `BONITA_SERVER_LOGGING_FILE` and `BONITA_SETUP_LOGGING_FILE` can be used to update logging configuration.
371+
372+
`BONITA_SERVER_LOGGING_FILE` default value is `/opt/bonita/BonitaSubscription-${BONITA_VERSION}-tomcat/server/conf/logging.properties`.
373+
374+
`BONITA_SETUP_LOGGING_FILE` default value is `/opt/bonita/BonitaSubscription-${BONITA_VERSION}-tomcat/setup/logback.xml`.
375+
364376
# How to extend this image
365377

366378
If you would like to do additional initialization, you can add a `*.sh` script under `/opt/custom-init.d`. The `startup.sh` file will source any `*.sh` script found in this directory to do further initialization before starting the service.
@@ -376,9 +388,23 @@ $ chmod +x custom_bonita/bonita.sh
376388
$ docker run --name bonita_custom -v "$PWD"/custom_bonita/:/opt/custom-init.d -d -p 8080:8080 %%IMAGE%%
377389
```
378390

379-
Note: There are several ways to check the `bonita` logs. One of them is
391+
Since Bonita 7.9 you can also apply a custom `logging.properties` file like this :
392+
393+
```console
394+
docker run --name bonita \
395+
-v /path/to/logging.properties:/etc/logging.properties -e BONITA_SERVER_LOGGING_FILE=/etc/logging.properties \
396+
-d -p 8080:8080 %%IMAGE%%
397+
```
398+
399+
Note: There are several ways to check the `bonita` logs. Till Bonita 7.8, one of them is
380400

381401
```console
382402
$ docker exec -ti bonita_custom /bin/bash
383403
tail -f /opt/bonita/BonitaCommunity-7.8.4-Tomcat-8.5.34/server/logs/bonita.`date +%Y-%m-%d`.log
384404
```
405+
406+
Since Bonita 7.9 bonita logs are redirected towards standard output and directly accessible using
407+
408+
```console
409+
$ docker logs -f bonita
410+
```

0 commit comments

Comments
 (0)