Merge pull request #80 from TIBCOSoftware/pre-release-8.1.0

Merging 8.1.0 changes to main

Author: hguntupa-tibco

jaspersoft-containers/Docker/jrs/.env

@@ -1,9 +1,9 @@
 INSTALL_CHROMIUM=false
 JASPERREPORTS_SERVER_APP_IMAGE_NAME=jasperserver-webapp
 JASPERREPORTS_SERVER_BUILDOMATIC_IMAGE_NAME=jasperserver-buildomatic
-JASPERREPORTS_SERVER_VERSION=8.0.2
-JASPERREPORTS_SERVER_APP_IMAGE_TAG=8.0.2
-JASPERREPORTS_SERVER_BUILDOMATIC_IMAGE_TAG=8.0.2
+JASPERREPORTS_SERVER_VERSION=8.1.0
+JASPERREPORTS_SERVER_APP_IMAGE_TAG=8.1.0
+JASPERREPORTS_SERVER_BUILDOMATIC_IMAGE_TAG=8.1.0
 TOMCAT_BASE_IMAGE=tomcat:9.0.54-jdk11-openjdk
 JDK_BASE_IMAGE=openjdk:11-jdk
 RELEASE_DATE=May 13,2022

jaspersoft-containers/Docker/jrs/Dockerfile

@@ -5,7 +5,7 @@
 #ARG TOMCAT_BASE_IMAGE=tomcat:9.0.54-jdk11-corretto
 ARG TOMCAT_BASE_IMAGE=tomcat:9.0.54-jdk11-openjdk
 ARG INSTALL_CHROMIUM=false
-ARG JASPERREPORTS_SERVER_VERSION=8.0.2
+ARG JASPERREPORTS_SERVER_VERSION=8.1.0
 
 FROM ${TOMCAT_BASE_IMAGE} as deployment
 
@@ -16,7 +16,7 @@ ARG JRS_DISTRO=jasperreports-server-pro-${JASPERREPORTS_SERVER_VERSION}-bin
 
 
 ENV INSTALL_CHROMIUM ${INSTALl_CHROMIUM:-false}
-ENV JASPERREPORTS_SERVER_VERSION ${JASPERREPORTS_SERVER_VERSION:-8.0.2}
+ENV JASPERREPORTS_SERVER_VERSION ${JASPERREPORTS_SERVER_VERSION:-8.1.0}
 ENV JRS_HOME /usr/src/jasperreports-server
 ENV BUILDOMATIC_MODE non-interactive
 

jaspersoft-containers/Docker/jrs/Dockerfile.buildomatic

@@ -6,11 +6,11 @@
 ARG JDK_BASE_IMAGE=openjdk:11-jdk
 FROM ${JDK_BASE_IMAGE}
 
-ARG JASPERREPORTS_SERVER_VERSION=8.0.2
+ARG JASPERREPORTS_SERVER_VERSION=8.1.0
 ARG CONTAINER_DISTRO=jaspersoft-containers/Docker/jrs
 ARG JRS_DISTRO=jasperreports-server-pro-${JASPERREPORTS_SERVER_VERSION}-bin
 
-ENV JASPERREPORTS_SERVER_VERSION ${JASPERREPORTS_SERVER_VERSION:-8.0.2}
+ENV JASPERREPORTS_SERVER_VERSION ${JASPERREPORTS_SERVER_VERSION:-8.1.0}
 ENV JRS_HOME /usr/src/jasperreports-server
 ENV BUILDOMATIC_MODE non-interactive
 ENV RELEASE_DATE ${RELEASE_DATE:- 13-05-2022}

jaspersoft-containers/Docker/jrs/README.md

@@ -7,7 +7,7 @@
 - [Repository Structure](#repository-structure)
 - [Installer Setup](#installer-setup)
 - [Docker Build and Run Time Environment Variables](#docker-build-and-run-time-environment-variables)
-- [Building the Images ](#building-the-images )
+- [Building the Images ](#building-the-images)
   - [Using Docker Compose](#using-docker-compose)
   - [Using Docker Build](#using-docker-build)
 - [Keystore Generation](#keystore-generation)
@@ -17,6 +17,7 @@
   - [Using Docker Compose](#using-docker-compose-1)
   - [Using Docker Run](#using-docker-run-1)
 - [Deploying the TIBCO JasperReports® Server Application](#deploying-the-tibco-jasperreports-server-application)
+  - [Install JasperReports® Server license](#install-jasperreports-server-license)
   - [Using Docker Compose](#using-docker-compose-2)
   - [Using Docker Run](#using-docker-run-2)
 - [Deploying the Application in Cluster Mode](#deploying-the-application-in-cluster-mode)
@@ -35,6 +36,8 @@ This distribution includes Dockerfile and supporting files for building, configu
 1. Git 
 1. TIBCO JasperReports® Server
 
+# Step-by-step Guide to deploy TIBCO JasperReports® Server on Docker
+To deploy TIBCO JasperReports® Server Cluster from scratch using **docker compose**, you can follow instructions at [Deploying JasperReports Server and Scalable Query Engine](#deploying-jasperreports-server-and-scalable-query-engine)
 
 # Repository Structure
 
@@ -53,10 +56,9 @@ This distribution includes Dockerfile and supporting files for building, configu
 # Installer Setup
 
 1. Run `cd <YOUR_SYSTEM_DIR>`.
-1. Clone the js-docker repository to the current directory.
-      `[email protected]:TIBCOSoftware/js-docker.git`   
-1. `cd <CONTAINER_PATH>` and Download a commercial edition of TIBCO JasperReports® Server WAR File installer zip into the current directory.
-1. Run `cd <CONTAINER_PATH>/jaspersoft-containers/Docker/jrs/scripts` and then run `./unpackWARInstaller.sh`.
+2. Clone the js-docker repository to the current directory:<br/>`git clone [email protected]:TIBCOSoftware/js-docker.git`
+3. `cd <CONTAINER_PATH>` and Download a commercial edition of TIBCO JasperReports® Server WAR File installer zip into the current directory.
+4. Run `cd <CONTAINER_PATH>/jaspersoft-containers/Docker/jrs/scripts` and then run `./unpackWARInstaller.sh`.
 
 **Note:**  **CONTAINER_PATH=<YOUR_SYSTEM_DIR>/js-docker**
 
@@ -69,13 +71,13 @@ These variables are passed to the command line with `--build-arg` for docker bui
 |INSTALL_CHROMIUM| Whether Chromium installed. **Note: TIBCO Software Inc. is not liable for license violation of chromium.**| false|
 |JASPERREPORTS_SERVER_APP_IMAGE_NAME| Name of the TIBCO JasperReports® Server image | jasperserver-webapp|
 |JASPERREPORTS_SERVER_BUILDOMATIC_IMAGE_NAME| Name of the TIBCO JasperReports® Server buildomatic image | jasperserver-buildomatic|
-|JASPERREPORTS_SERVER_VERSION|Version number of TIBCO JasperReports® Server|8.0.2|
-|JASPERREPORTS_SERVER_APP_IMAGE_TAG|Image tag of the TIBCO JasperReports® Server web app |8.0.2|
-|JASPERREPORTS_SERVER_BUILDOMATIC_IMAGE_TAG|Image tag of the TIBCO JasperReports® Server buildomatic |8.0.2|
+|JASPERREPORTS_SERVER_VERSION|Version number of TIBCO JasperReports® Server|8.1.0|
+|JASPERREPORTS_SERVER_APP_IMAGE_TAG|Image tag of the TIBCO JasperReports® Server web app |8.1.0|
+|JASPERREPORTS_SERVER_BUILDOMATIC_IMAGE_TAG|Image tag of the TIBCO JasperReports® Server buildomatic |8.1.0|
 |TOMCAT_BASE_IMAGE|Tomcat Docker image certified for the version of TIBCO JasperReports® Server being deployed based on Debian and Amazon Linux 2. It is of two types "tomcat:9.0.54-jdk11-openjdk" for Debian and "tomcat:9.0.54-jdk11-corretto" for Amazon Linux 2 |tomcat:9.0.54-jdk11-openjdk|
 |JDK_BASE_IMAGE|Java Docker image certified for the version of TIBCO JasperReports® Server being deployed based on Debian and Amazon Linux 2. It is of two types openjdk:11-jdk and  amazoncorretto:11|openjdk:11-jdk|
 RELEASE_DATE|Release date of TIBCO JasperReports® Server | May 13, 2022 |
-|JS_INSTALL_TARGETS| Used for repository setup, import, and export. Provides all the lists of ANT targets to perform any buildomatic action in TIBCO JasperReports® Server. See the TIBCO JasperReports® Server documentation for more information. |gen-config pre-install-test-pro prepare-all-pro-dbs-normal|
+|JS_INSTALL_TARGETS| Used for repository setup, import, and export. Provides all the lists of ANT targets to perform any buildomatic action in TIBCO JasperReports® Server. For more information, see the TIBCO JasperReports® Server documentation . |gen-config pre-install-test-pro prepare-all-pro-dbs-normal|
 
 # Building the Images 
 `cd <CONTAINER_PATH>/jaspersoft-containers/Docker/jrs` and update the `.env` file and `./resources/default-properties/default_master.properties`
@@ -87,6 +89,7 @@ In case if an external repository database already exists and loaded, then updat
 
 If you plan to use repository database in the container, then **dbHost** can be set to:
 - host.docker.internal - in case of using docker desktop
+- repository - in case of using docker compose (host should be the same as service name in docker-compose.yml)
 - repository-postgresql.default.svc.cluster.local - when PostgreSQL is installed in k8s cluster
 
 ### Chromium Configuration 
@@ -113,11 +116,18 @@ If you see the Chromium issue in TIBCO JasperReports® Server using Docker deplo
 
     echo 'net.sf.jasperreports.chrome.argument.no-sandbox=true' >>$CATALINA_HOME/webapps/jasperserver-pro/WEB-INF/classes/jasperreports.properties` 
 
-
+### JasperReports® Server and Buildomatic customization
+If you plan to work with **default** JasperReports® Server and buildomatic setup, you can skip this step. In case if you want to apply certain configurations or customizations, for example, changing some settings in `jasperserver-pro/WEB-INF/classes/jasperreports.properties` or some `jasperserver-pro/WEB-INF/applicationContext-*` files, refer to:
+- [jasperserver customization guide ](resources/jasperserver-customization/README.md)
+- [buildomatic customization guide ](resources/buildomatic-customization/README.md)
 
 ## Using Docker Compose
+**Note:** Following tasks can be performed using either docker run or docker-compose. Pick the one which is suitable for your use case.
+
 **It is recommended to use Docker Compose.**
 
+**If you perform installation using docker-compose, then you can skip all docker run commands.**
+
 `cd <CONTAINER_PATH>/jaspersoft-containers/Docker/jrs`
 
     docker-compose build
@@ -133,12 +143,12 @@ If you see the Chromium issue in TIBCO JasperReports® Server using Docker deplo
 1. Go to `cd <CONTAINER_PATH>/jasperreports-server-pro-<JRS_VERSION>-bin/buildomatic`.
 1. Copy the `sample_conf/postgresql_master.properties` to `default_master.properties`.
 1. Add `appServerType=skipAppServerCheck` to `default_master.properties` and comment out `appServerType = tomcat`.
-1. Run `./js-ant gen-config` and keystore will generate in USER_HOME dir with **.jrsks and .jrsksp** name.
+1. Run `./js-ant gen-config`, as the result keystore and keystore-properties files will be generated in `USER_HOME` dir with **.jrsks and .jrsksp** name.
 1. Copy the keystore to `<CONTAINER_PATH>/jaspersoft-containers/Docker/jrs/resources/keystore`. 
-1. To change the permissions to 644, run `chmod -R 644 .jrs*`.
+1. Change the permissions to 644 for keystore files, run `chmod -R 644 .jrs*`.
 
 ## Using Docker Run
-- Buildomatic image must be created before going on to the next steps.
+- Buildomatic image must be created before going to the next steps.
 
 **Note:** This will run with root user.
 
@@ -150,13 +160,14 @@ If you see the Chromium issue in TIBCO JasperReports® Server using Docker deplo
 
 - To change the keystore permission to 644, run `chmod -R 644 .jrs*`.
 
- See the TIBCO JasperReports® Server Security Guide at [Jasperserver Official Docs](https://community.jaspersoft.com/documentation) for more information.
+ For more information, see the TIBCO JasperReports® Server Security Guide at [Jasperserver Official Docs](https://community.jaspersoft.com/documentation).
 
 # Repository Setup
 
 **It is recommended to use Docker Compose.**
 
 ## Using Docker Compose
+`cd <CONTAINER_PATH>/jaspersoft-containers/Docker/jrs`
 
     docker-compose run jasperserver-buildomatic (you can use the same command for the external DB Host and Docker container as DB host)   
 
@@ -188,11 +199,15 @@ If you see the Chromium issue in TIBCO JasperReports® Server using Docker deplo
 
 # Deploying the TIBCO JasperReports® Server Application
 
-**It is recommended to use Docker Compose.**
+## Install JasperReports® Server license
+1. To install JasperReports® Server license, copy obtained license file into `<CONTAINER_PATH>/jaspersoft-containers/Docker/jrs/resources/license`.
+2. Set the permissions to 644 for license file `chmod 644 <CONTAINER_PATH>/jaspersoft-containers/Docker/jrs/resources/license/jasperserver.license`.
+
 
 ## Using Docker Compose
+**It is recommended to use Docker Compose.**
 
-   `docker-compose up -d jasperserver-webapp`  (Same command for the external DB Host and Docker container as DB host )
+   `docker-compose up -d jasperserver-webapp` (Same command for the external DB Host and Docker container as DB host )
 
 - Access the application by using host-name:8080/jasperserver-pro
 
@@ -221,24 +236,41 @@ If you see the Chromium issue in TIBCO JasperReports® Server using Docker deplo
 
 - Wait for the application to start and access the application by using `host-name/jasperserver-pro` (port is not needed, haproxy is running on port 80).
 
- **Note:** Although an external repository DB is used, a PostgreSQL container is created, and it does not impact TIBCO JasperReports® Server. If you don't want to create a PostgreSQL container, then remove repository dependency from jasperserver-webapp-1 and jasperserver-webapp-2 services in cluster-docker-compose.yaml
+ **Note:** Although an external repository DB is used, a PostgreSQL container is created, and it does not impact TIBCO JasperReports® Server. If you don't want to create a PostgreSQL container, then remove repository dependency from jasperserver-webapp-1 and jasperserver-webapp-2 services in cluster-docker-compose.yaml.
 
 
 # Deploying JasperReports Server and Scalable Query Engine
 
-1. Set  `scalableQueryEngine.enabled to true` in [default_master.properties](./resources/default-properties/default_master.properties)
-1. Update the **SCALABLE_QUERY_ENGINE_URL** with the Hostname or Fqdn in the `.env` file.
-1. Update the **jrs.server.host**  with the Host Name or Fqdn  in the following directory. `<CONTAINER_PATH>/Docker/scalableQueryEngine/resources/properties/application.properties `
-1. Build the docker images for JasperReports Server and Scalable Query Engine.   
-1. Start the JasperReports Server application (see the instructions in [Deploying the TIBCO JasperReports® Server Application](#deploying-the-tibco-jasperreports-server-application) section).
-1. Start the Scalable Query Engine by running the below commands: 
-   
-   
-      `cd ../scalableQueryEngine`
-      `docker-compose up -d scalable-query-engine`
-
-1. Check the Scalable Query Engine status by using `HOST_NAME:8081/actuator/health`.
-1. Access the JasperReports Server application by using `HOST_NAME:8080/jasperserver-pro`.
-1. Run any dashboard in JasperReports Server which uses Ad Hoc view (for example, Performance Summary Dashboard) and see the logs in Scalable Query Engine container.
-1. To see the logs, run `docker logs <container_name/id>`.
-1. To enable the worker logging, add `com.jaspersoft.ji.war.AdhocWorkerForwardingFilter` to the log.
+1. Setup Docker and JasperReports® Server, see the instructions at the [Installer Setup](#installer-setup) section.
+2. Configure `default_master.properties`, see the instructions at the [Building the Images ](#building-the-images) section.
+3. Set  `scalableQueryEngine.enabled to true` in [default_master.properties](./resources/default-properties/default_master.properties).
+4. Edit `<CONTAINER_PATH>/Docker/jrs/.env` by setting the **SCALABLE_QUERY_ENGINE_URL** to use the Hostname or Fqdn:
+   - for docker desktop on Windows, use the hostname `host.docker.internal`
+   - for docker on Linux, use machine Hostname or Fqdn
+5. Update the **jrs.server.host**  with the Hostname or Fqdn in the following directory:              `<CONTAINER_PATH>/Docker/scalableQueryEngine/resources/properties/application.properties `
+6. Build the docker images for JasperReports® Server by using following commands:
+   1. `cd <CONTAINER_PATH>/Docker/jrs`
+   2. Run `docker-compose build`
+7. Build the docker image for Scalable Query Engine by using following commands:
+   1. `cd <CONTAINER_PATH>/Docker/scalableQueryEngine`
+   2. Run `docker-compose build`
+8. If keystore files (jrsks, jrsksp) do not exist, generate them. You can find information about generating keystore files at the [Using TIBCO JasperReports® Server Installer](#using-tibco-jasperreports-server-installer) section.
+9. Copy jrsks, jrsksp into jrs and scalableQueryEngine folders, then keystore files location can be mapped as volume:
+   1. copy .jrsks, .jrsksp into `<CONTAINER_PATH>/Docker/jrs/resources/keystore`
+   2. copy .jrsks, .jrsksp  into `<CONTAINER_PATH>/Docker/scalableQueryEngine/resources/keystore`
+   3. Set the permissions for each keystore file under `<CONTAINER_PATH>/Docker/jrs/resources/keystore` and `<CONTAINER_PATH>/Docker/scalableQueryEngine/resources/keystore`:  `chmod -R 644 .jrs*`.
+10. Copy JasperReports® Server license to `<CONTAINER_PATH>/jaspersoft-containers/Docker/jrs/resources/license`, for more information, see the [Install JasperReports® Server license](#install-jasperreports-server-license) section.
+11. Set up and load repository database by using following commands:
+    1. `cd <CONTAINER_PATH>/Docker/jrs`
+    2. Run `docker-compose run jasperserver-buildomatic`
+12. Start the JasperReports® Server application, for more information, see [Deploying the TIBCO JasperReports® Server Application](#deploying-the-tibco-jasperreports-server-application) section.
+    1. `cd <CONTAINER_PATH>/Docker/jrs`
+    2. Run `docker-compose up -d jasperserver-webapp`
+13. Start the Scalable Query Engine by using following commands:
+    1. `cd <CONTAINER_PATH>/Docker/scalableQueryEngine`
+    2. Run `docker-compose up -d scalable-query-engine`
+14. Access the JasperReports® Server application by using `HOST_NAME:8080/jasperserver-pro`. 
+15. Check the Scalable Query Engine status by using `HOST_NAME:8081/actuator/health`.
+16. Run any dashboard in JasperReports® Server which uses an Ad Hoc view (for example, Performance Summary Dashboard) and see the logs in Scalable Query Engine container.
+17. To see the logs, run `docker logs <container_name/id>`.
+18. To enable the worker logging, login to JasperReports® Server, go to Log Settings and add `com.jaspersoft.ji.war.AdhocWorkerForwardingFilter` to the `DEBUG`.

jaspersoft-containers/Docker/scalableQueryEngine/.env

@@ -1,8 +1,8 @@
-JASPERREPORTS_SERVER_VERSION=8.0.2
+JASPERREPORTS_SERVER_VERSION=8.1.0
 SCALABLE_QUERY_ENGINE_IMAGE_NAME=scalable-query-engine
 SCALABLE_QUERY_ENGINE_DRIVER_IMAGE_NAME=scalable-query-engine-drivers
-SCALABLE_QUERY_ENGINE_DRIVER_IMAGE_TAG=8.0.2
-SCALABLE_QUERY_ENGINE_IMAGE_TAG=8.0.2
+SCALABLE_QUERY_ENGINE_DRIVER_IMAGE_TAG=8.1.0
+SCALABLE_QUERY_ENGINE_IMAGE_TAG=8.1.0
 JDK_BASE_IMAGE=openjdk:11-jdk
 ks=/etc/secrets/keystore
 ksp=/etc/secrets/keystore

jaspersoft-containers/Docker/scalableQueryEngine/Dockerfile

@@ -4,13 +4,13 @@
 
 #ARG JDK_BASE_IMAGE=amazoncorretto:11
 ARG JDK_BASE_IMAGE=openjdk:11-jdk
-ARG JASPERREPORTS_SERVER_VERSION=8.0.2
+ARG JASPERREPORTS_SERVER_VERSION=8.1.0
 
 FROM ${JDK_BASE_IMAGE} AS worker
 
 ARG JASPERREPORTS_SERVER_VERSION
 ARG CONTAINER_DISTRO=jaspersoft-containers/Docker/scalableQueryEngine
-ENV JASPERREPORTS_SERVER_VERSION ${JASPERREPORTS_SERVER_VERSION:-8.0.2}
+ENV JASPERREPORTS_SERVER_VERSION ${JASPERREPORTS_SERVER_VERSION:-8.1.0}
 ARG JRS_DISTRO=jasperreports-server-pro-${JASPERREPORTS_SERVER_VERSION}-bin
 
 ENV WORKER_HOME /usr/local/scalable-query-engine

jaspersoft-containers/Docker/scalableQueryEngine/Dockerfile.drivers

@@ -3,12 +3,12 @@
 # in the license file that is distributed with this file
 #ARG JDK_BASE_IMAGE=amazoncorretto:11
 ARG JDK_BASE_IMAGE=openjdk:11-jdk
-ARG JASPERREPORTS_SERVER_VERSION=8.0.2
+ARG JASPERREPORTS_SERVER_VERSION=8.1.0
 
 FROM ${JDK_BASE_IMAGE} as driver
 
 ARG JASPERREPORTS_SERVER_VERSION
-ENV JASPERREPORTS_SERVER_VERSION ${JASPERREPORTS_SERVER_VERSION:-8.0.2}
+ENV JASPERREPORTS_SERVER_VERSION ${JASPERREPORTS_SERVER_VERSION:-8.1.0}
 ARG JRS_DISTRO=jasperreports-server-pro-${JASPERREPORTS_SERVER_VERSION}-bin
 ARG CONTAINER_DISTRO=jaspersoft-containers/Docker/scalableQueryEngine
 ENV JRS_HOME /usr/local/jasperreports-server
@@ -26,7 +26,7 @@ FROM ${JDK_BASE_IMAGE}
 ARG CONTAINER_DISTRO=jaspersoft-containers/Docker/scalableQueryEngine
 ENV WAR_JARS=/usr/local/jasperreports-server/buildomatic/conf_source/iePro/lib
 ENV WAR_LIB_JARS=/usr/local/jasperreports-server/jasperserver-pro/WEB-INF/lib
-ENV JASPERREPORTS_SERVER_VERSION ${JASPERREPORTS_SERVER_VERSION:-8.0.2}
+ENV JASPERREPORTS_SERVER_VERSION ${JASPERREPORTS_SERVER_VERSION:-8.1.0}
 ENV RELEASE_DATE ${RELEASE_DATE:- 13-05-2022}
 
 LABEL "org.jasperosft.name"="Jasper Reports Server Scalable Query Engine" \