• 0: Tools Required
  • To Build/Run Waltz
  • To Develop
• 1: Create Database
  • PostgreSQL, MariaDB or MS SQL Server
• 2: Build Waltz
  • Step 1: Setup Maven Profiles
  • Step 2: Trigger Build
• 3: Run Waltz
  • Step 1: Create Waltz Properties File
  • Step 2: Create Waltz Logback Config File
  • Step 3: Deploy
    • Standard Deployment (.war on Tomcat)
    • Docker Deployment

• Docker
• Git, to clone this repo. You can also download a zip, but cloning is recommended to easily pull in future updates/fixes
• Optional: A Postgres (recommended), MariaDB or MSSQL database server (if a standalone database server is required instead of one running in a Docker container)
  • jOOQ Pro to build Waltz from source if using MSSQL
• Optional: A servlet app server like Tomcat (if a standalone server is required instead of one running in a Docker container)
• Recommended: Cygwin or a similar tool if using Windows

WIP

If using an existing database server, create a new empty database, if you don't already have a Waltz database.

Waltz database schema is created/updated as part of the build process

Alternatively, to run a containerised database server, see instructions here:

• Containerised Waltz Postgres DB (also includes instructions for loading sample data)
• Containerised Waltz MariaDB
• Containerised Waltz MSSQL DB

Create a settings.xml file under config/maven/ (you can copy from config/maven/settings.xml.sample)
Create Waltz database maven profiles under config/maven/settings.xml

If your database runs inside a container on the same host, you'll need to set the IP address of the container in your JDBC URL.
By default, localhost will not work, even if you have set up port forwarding.
If port forwarding is set up for your database container, you may be be able to use a special DNS name host.docker.internal or IP 172.0.17.1 in your JDBC URL to connect to your database from within the build/run containers.

See Network Settings and Connecting to a service on the host for more details.

See instructions for Waltz Postgres DB, Waltz MariaDB, or Waltz MSSQL DB on how to find database container IP addresses.

The file can also be used for other custom maven settings.

The build process downloads latest code from finos/Waltz master branch by default.
This can be overriden by passing a different git url or branch/tag name.
See details of all available build arguments here.

All commands must be run from the waltz-docker root directory

Tip: Pass --build-arg force_build_timestamp=$(date +%s) to the docker build command to force maven build to re-run (otherwise docker will use cached images if no code has changed in the git repo)

Template docker command:

# specify maven profiles as an argument (mandatory)
# waltz rolls out database ddl changes are part of the build process (via liquibase), so it is important to 
# build against your correct target database.
# eg: You need to run builds against your Dev/UAT/Prod databases separately, unless you are manually
#     deploying liquibase changes to these databases

[user@machine:waltz-docker]$ docker build \
--tag waltz-build:<image_tag> \
--build-arg maven_profiles=<profiles> \
-f build/build.Dockerfile .

This will take several minutes to run, especially the first time, as required dependencies are downloaded.
Once complete, you can either extract the deployable artifacts to deploy them onto an external app server, or spin up a docker container to run Waltz, see below for instructions on both methods.

Examples:

# postgres using 'local-postgres' maven profile defined in config/maven/settings.xml
[user@machine:waltz-docker]$ docker build \
--tag waltz-build:latest \
--build-arg maven_profiles=waltz-postgres,local-postgres \
-f build/build.Dockerfile .

# mariadb using 'local-mariadb' maven profile defined in config/maven/settings.xml
[user@machine:waltz-docker]$ docker build \
--tag waltz-build:latest \
--build-arg maven_profiles=waltz-mariadb,local-mariadb \
-f build/build.Dockerfile .

To build Waltz for MSSQL from source, a jOOQ Pro licence is required.
jOOQ Pro maven dependencies need to be dowloaded and installed locally in maven repository.

jOOQ provides a 30-day trial for jOOQ Pro, which may be used to build Waltz.

Download jOOQ Pro
Download jOOQ Pro zip file (jOOQ-<version>.zip) from jOOQ website and copy the file to config/maven directory.
Ensure that the version matches the one specified in Waltz code waltz-schema/pom.xml (see jooq.version property). If this is not possible (eg: when using jOOQ Pro trial, an additional property will need to be set under your MSSQL maven profiles, see below).

The build process will use this zip file to install jOOQ dependencies in the build container's maven repository.

Additional Maven Profile Properties
The following additional properties may need to be specified for MSSQL profiles in your config/maven/settings.xml file:

• jooq.group: Set this to org.jooq.trial-java-8 if using jOOQ trial version
• jooq.version: If your version of jOOQ doesn't match the one in waltz-schema/pom.xml. This can happen if using jOOQ trial, as that is only available for the latest jOOQ release.
• jooq.dialect: Set this so that it matches your version of MSSQL. See jOOQ Documentation for details

Additional Build Argument
An additional jooq_pro_version mandatory build argument needs to be passed for MSSQL builds, which should match the version in jOOQ Pro zip file (jOOQ-<version>.zip) under config/maven directory.
The build process uses this argument to find the correct zip file to automatically install jOOQ dependencies inside the build container's maven repo.

Examples

# template
[user@machine:waltz-docker]$ docker build \
--tag waltz-build:<image_tag> \
--build-arg maven_profiles=<profiles> \
--build-arg jooq_pro_version=<jooq-version> \
-f build/build.Dockerfile .

# mssql using 'local-mssql' maven profile defined in config/maven/settings.xml
# and jOOQ version 3.13.1

[user@machine:waltz-docker]$ docker build \
--tag waltz-build:latest \
--build-arg maven_profiles=waltz-mssql-alt,local-mssql \
--build-arg jooq_pro_version=3.13.1 \
-f build/build.Dockerfile .

You need the following to run Waltz:

• Waltz runtime properties file: waltz.properties
• Waltz logback config file: waltz-logback.xml
• Waltz war file: waltz-web.war

Create environment specific property files (waltz-<env>.properties) under config/waltz (you can copy from config/waltz/waltz.properties.sample)

The default environment is local, so at minimum, create waltz-local.properties

You can also create files for other environments like waltz-dev.properties, waltz-uat.properties, waltz-prod.properties, depending on how many environments you have.

Create environment specific logback config files (waltz-logback-<env>.xml) under config/waltz (you can copy from config/waltz/waltz-logback.xml.sample)

The default environment is local, so at minimum, create waltz-logback-local.xml

You can also create files for other environments like waltz-logback-dev.xml, waltz-logback-uat.xml, waltz-logback-prod.xml, depending on how many environments you have.

If you already have an app server like Tomcat set up, you can extract the required artificats from the docker build image waltz-build and deploy them in your server:

All commands must be run from the waltz-docker root directory

The following environment variables can be passed to the docker run command using -e <var_name>=<var_value docker syntax :

Template docker command:

# specify target environment and db
[user@machine:waltz-docker]$ docker run --rm \
-v "$PWD"/build/output:/waltz-build-output \
-v "$PWD"/config/waltz:/waltz-bin/config \
-e WALTZ_ENV=<env> \
-e WALTZ_TARGET_DB=<target-db> \
waltz-build:<image_tag>

Examples:

# local env and postgres db
[user@machine:waltz-docker]$ docker run --rm \
-v "$PWD"/build/output:/waltz-build-output \
-v "$PWD"/config/waltz:/waltz-bin/config \
-e WALTZ_ENV=local \
-e WALTZ_TARGET_DB=postgres \
waltz-build:latest

# dev env and mariadb
[user@machine:waltz-docker]$ docker run --rm \
-v "$PWD"/build/output:/waltz-build-output \
-v "$PWD"/config/waltz:/waltz-bin/config \
-e WALTZ_ENV=dev \
-e WALTZ_TARGET_DB=mariadb \
waltz-build:latest

# prod environment and mssql db
[user@machine:waltz-docker]$ docker run --rm \
-v "$PWD"/build/output:/waltz-build-output \
-v "$PWD"/config/waltz:/waltz-bin/config \
-e WALTZ_ENV=prod \
-e WALTZ_TARGET_DB=mssql \
waltz-build:latest

The above command will copy the deployment artifacts to build/output/${WALTZ_ENV} directory.

Depending on how your server is configured, the artifacts may be deployed on Tomcat like so:
The .war file can be placed under Tomcat's webapps directory.
The waltz.properties and waltz-logback.xml files need to be on the classpath, so they can be dropped into the server's lib folder.

Once the waltz-build docker image is created by the build step, you can easily build and run a docker container to deploy Waltz.

Dockerfile: run/run.Dockerfile

All commands must be run from the waltz-docker root directory

This step creates a waltz-run docker image by extracting deployable waltz-web.war file from the waltz-build image and copying it into Tomcat's webapps directory inside the waltz-run image.
This also copies the correct waltz-<env>.properties and waltz-logback-<env>.xml files from config/waltz directory into Tomcat's lib directory.

You can also override Tomcat server's config (eg: server.xml etc) by placing these files under config/tomcat directory.

The following arguments can be passed to the docker build command when building Waltz, using --build-arg <arg_name>=<arg_value> docker syntax:

Template Command

[user@machine:waltz-docker]$ docker build \
--tag waltz-run:<tag> \
--build-arg waltz_build_tag=<waltz_build_tag> \
--build-arg waltz_env=<waltz_env> \
--build-arg context_path=<context_path> \
-f run/run.Dockerfile .

Example

[user@machine:waltz-docker]$ docker build \
--tag waltz-run:latest \
--build-arg waltz_build_tag=latest \
--build-arg waltz_env=local \
--build-arg context_path=waltz \
-f run/run.Dockerfile .

This will create a container from the waltz-run image and start a Tomcat server with Waltz deployed.

You can then access Waltz using this URL:

http://<host_ip>:<host_port>/${context_path}/

Default user account created: admin, password: password

Template Command

[user@machine:waltz-docker]$ docker run --rm -it \
--name <container_name> \
-p <host_port>:8080 \
waltz-run:<waltz_run_tag>

Example

# port 8888 on the host machine will point to port 8080 in the container
# waltz url will be: http://localhost:8888/waltz

[user@machine:waltz-docker]$ docker run --rm -it \
--name waltz-run \
-p 8888:8080 \
waltz-run:latest

Once you've completed the one-off steps of Creating Database(s), Maven Profiles, Waltz Properties and Logback Configuration files, the repeatable process of rebuilding Waltz and extracting or deploying artifacts can be scripted, or you can store your frequently used commands to access them later.

These can be stored under the custom-scripts directory.
Click the link to view an example script.