Downloading the Software

The scalable query engine is contained in scalable-query-engine-8.2.0.jar in the WAR (web archive) file distribution of JasperReports Server. There are also additional files for Docker and Kubernetes in a github that you can clone. You do not need an account on github.com, but you do need the git software locally on the host where you download and install JasperReports Server.

Prerequisites

This deployment is based on a licensed installation of the JasperReports Server WAR file distribution, enterprise edition 8.2.0 or later. The scalable query engine is not supported with the JasperReports Server binary installer, any evaluation version, nor the Community Project. You must complete the installation and configuration of the server, in particular the keystore (either generated new or imported from a previous version) before deploying the scalable query engine. See the rest of this JasperReports Server Installation Guide or the JasperReports Server Upgrade Guide to complete your server installation before continuing.

You will also need the following third-party software for this deployment:

• git
• Docker engine (19.x+) including Docker Compose V2 (3.9+)
• Kubernetes (1.19+) including kubectl
• Helm 3.5

This manual assumes this software is installed and available in your path. You should be proficient with the concepts and commands for these tools.

Downloading From Git

After installing the JasperReports Server WAR file distribution, you need to download the github project that contains folders for Docker and Kubernetes.

1. Go to the base folder of the unzipped WAR file distribution, referred to as <js-install> in this manual. The content of the github repository must be placed in this folder:

cd jasperreports-server-pro-8.2.0-bin

2. Run the following command to dowload the project from github: 
git clone git@github.com:tibco/jaspersoft-containers.git

The jaspersoft-containers project in git includes the following top-level folders:

Folder Description

Docker/scalableQueryEngine

Docker components for the Scalable Query Engine, described in Docker Configuration.

Docker/jrs

Docker components for a containerized version of JasperReports Server, which is beyond the scope of this document.

K8s/scalableQueryEngine

Kubernetes components for the Scalable Query Engine, described in Deploying with Kubernetes

K8s/jrs

Kubernetes components for the containerized version of JasperReports Server, which is beyond the scope of this document.