Browse Source

Update Bonita doc for 7.9 (#1505)

* update Bonita and migration tool versions
* updates links
* update content for 7.9
JeremJR 6 years ago
parent
commit
cb12e86739
1 changed files with 48 additions and 22 deletions
  1. 48 22
      bonita/content.md

+ 48 - 22
bonita/content.md

@@ -14,7 +14,7 @@ Bonita (called Bonita BPM till 7.5) is an open-source business process managemen
 $ docker run --name bonita -d -p 8080:8080 %%IMAGE%%
 ```
 
-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.
+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.
 
 You can access the Bonita Portal on http://localhost:8080/bonita and login using the default credentials: install / install
 
@@ -24,7 +24,7 @@ You can access the Bonita Portal on http://localhost:8080/bonita and login using
 
 PostgreSQL is the recommanded database.
 
-[Set max_prepared_transactions to 100](https://documentation.bonitasoft.com/bonita/7.8/database-configuration#toc5):
+[Set max_prepared_transactions to 100](https://documentation.bonitasoft.com/bonita/7.9/database-configuration#toc5):
 
 ```console
 $ mkdir -p custom_postgres
@@ -49,7 +49,7 @@ $ docker run --name bonita_postgres --link mydbpostgres:postgres -d -p 8080:8080
 
 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.
 
-[Increase the packet size](https://documentation.bonitasoft.com/bonita/7.8/database-configuration#toc5) which is set by default to 1M:
+[Increase the packet size](https://documentation.bonitasoft.com/bonita/7.9/database-configuration#toc5) which is set by default to 1M:
 
 ```console
 $ mkdir -p custom_mysql
@@ -85,7 +85,7 @@ Run `docker stack deploy -c stack.yml %%REPO%%` (or `docker-compose -f stack.yml
 
 ## Where to store data
 
-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.
+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.
 
 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:
 
@@ -167,9 +167,9 @@ The `-v /my/own/datadir:/opt/bonita` part of the command mounts the `/my/own/dat
 
 		```console
 		cd bonita_migration
-		wget https://release.ow2.org/bonita/bonita-migration-distrib-2.40.0.zip
+		wget https://release.ow2.org/bonita/bonita-migration-distrib-2.41.0.zip
 		wget https://download.forge.ow2.org/bonita/BonitaBPMCommunity-7.2.4-Tomcat-7.0.67.zip
-		unzip bonita-migration-distrib-2.40.0.zip
+		unzip bonita-migration-distrib-2.41.0.zip
 		unzip BonitaBPMCommunity-7.2.4-Tomcat-7.0.67.zip
 		```
 
@@ -184,14 +184,14 @@ The `-v /my/own/datadir:/opt/bonita` part of the command mounts the `/my/own/dat
 
 		```console
 		cd bonita_migration
-		wget https://release.ow2.org/bonita/bonita-migration-distrib-2.40.0.zip
-		unzip bonita-migration-distrib-2.40.0.zip
+		wget https://release.ow2.org/bonita/bonita-migration-distrib-2.41.0.zip
+		unzip bonita-migration-distrib-2.41.0.zip
 		```
 
 -	Configure the migration tool
 
 	```console
-	$ cd bonita-migration-distrib-2.40.0
+	$ cd bonita-migration-distrib-2.41.0
 	```
 
 	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
 	-	If >= 7.3.0
 
 	```console
-	$ 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
+	$ 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
 	```
 
 -	Reapply specific configuration if needed, for example with a version >= 7.3.0 :
 
 	```console
-	$ docker exec -ti bonita_7.8.4_postgres /bin/bash
+	$ docker exec -ti bonita_7.9.0_postgres /bin/bash
 	```
 
 	```console
-	$ cd /opt/bonita/BonitaCommunity-7.8.4-Tomcat-8.5.34/setup
+	$ cd /opt/bonita/BonitaCommunity-7.9.0-tomcat/setup
 	$ ./setup.sh pull
 	$ TENANT_LOGIN=tech_user
 	$ TENANT_PASSWORD=secret
@@ -258,10 +258,14 @@ The `-v /my/own/datadir:/opt/bonita` part of the command mounts the `/my/own/dat
 	```
 
 	```console
-	$ docker restart bonita_7.8.4_postgres
+	$ docker restart bonita_7.9.0_postgres
 	```
 
-For more details regarding Bonita migration, see the [documentation](https://documentation.bonitasoft.com/bonita/7.8/migrate-from-an-earlier-version-of-bonita-bpm).
+-	Specific consideration regarding migration to Java 11 in Bonita 7.9
+
+	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.
+
+For more details regarding Bonita migration, see the [documentation](https://documentation.bonitasoft.com/bonita/7.9/migrate-from-an-earlier-version-of-bonita-bpm).
 
 ## Security
 
@@ -269,11 +273,11 @@ This Docker image activates both static and dynamic authorization checks by defa
 
 -	REST API authorization
 
-	-	[Static authorization checking](https://documentation.bonitasoft.com/bonita/7.8/rest-api-authorization#toc1)
+	-	[Static authorization checking](https://documentation.bonitasoft.com/bonita/7.9/rest-api-authorization#toc1)
 
-	-	[Dynamic authorization checking](https://documentation.bonitasoft.com/bonita/7.8/rest-api-authorization#toc2)
+	-	[Dynamic authorization checking](https://documentation.bonitasoft.com/bonita/7.9/rest-api-authorization#toc2)
 
--	[HTTP API](https://documentation.bonitasoft.com/bonita/7.8/rest-api-authorization#toc10)
+-	[HTTP API](https://documentation.bonitasoft.com/bonita/7.9/rest-api-authorization#toc10)
 
 For specific needs you can override this behavior by setting HTTP_API to true and REST_API_DYN_AUTH_CHECKS to false:
 
@@ -287,7 +291,7 @@ When you start the `bonita` image, you can adjust the configuration of the Bonit
 
 ### `PLATFORM_PASSWORD`
 
-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.
+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.
 
 ### `PLATFORM_LOGIN`
 
@@ -295,7 +299,7 @@ This optional environment variable is used in conjunction with `PLATFORM_PASSWOR
 
 ### `TENANT_PASSWORD`
 
-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.
+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.
 
 ### `TENANT_LOGIN`
 
@@ -303,7 +307,7 @@ This optional environment variable is used in conjunction with `TENANT_PASSWORD`
 
 ### `REST_API_DYN_AUTH_CHECKS`
 
-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.
+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.
 
 ### `HTTP_API`
 
@@ -337,7 +341,7 @@ These variables are used in conjunction to create a new user, set that user's pa
 
 ### `BIZ_DB_NAME`, `BIZ_DB_USER`, `BIZ_DB_PASS`
 
-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).
+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).
 
 `BIZ_DB_NAME` default value is `businessdb`.
 
@@ -361,6 +365,14 @@ These variables are optional, and used in conjunction to create users and databa
 
 `BIZ_DB_DROP_EXISTING` default value is `N`.
 
+### `BONITA_SERVER_LOGGING_FILE`, `BONITA_SETUP_LOGGING_FILE`
+
+Since Bonita 7.9 `BONITA_SERVER_LOGGING_FILE` and `BONITA_SETUP_LOGGING_FILE` can be used to update logging configuration.
+
+`BONITA_SERVER_LOGGING_FILE` default value is `/opt/bonita/BonitaSubscription-${BONITA_VERSION}-tomcat/server/conf/logging.properties`.
+
+`BONITA_SETUP_LOGGING_FILE` default value is `/opt/bonita/BonitaSubscription-${BONITA_VERSION}-tomcat/setup/logback.xml`.
+
 # How to extend this image
 
 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
 $ docker run --name bonita_custom -v "$PWD"/custom_bonita/:/opt/custom-init.d -d -p 8080:8080 %%IMAGE%%
 ```
 
-Note: There are several ways to check the `bonita` logs. One of them is
+Since Bonita 7.9 you can also apply a custom `logging.properties` file like this :
+
+```console
+docker run --name bonita \
+  -v /path/to/logging.properties:/etc/logging.properties -e BONITA_SERVER_LOGGING_FILE=/etc/logging.properties \
+  -d -p 8080:8080 %%IMAGE%%
+```
+
+Note: There are several ways to check the `bonita` logs. Till Bonita 7.8, one of them is
 
 ```console
 $ docker exec -ti bonita_custom /bin/bash
 tail -f /opt/bonita/BonitaCommunity-7.8.4-Tomcat-8.5.34/server/logs/bonita.`date +%Y-%m-%d`.log
 ```
+
+Since Bonita 7.9 bonita logs are redirected towards standard output and directly accessible using
+
+```console
+$ docker logs -f bonita
+```