jeffersonlab/workmap repository overview

⁠workmap

A Jakarta EE 10⁠ web application for geographical work coordination at Jefferson Lab.

• Overview⁠
• Quick Start with Compose⁠
• Install⁠
• Configure⁠
• Build⁠
• Develop⁠
• Release⁠
• Deploy⁠
• See Also⁠

⁠Overview

The accelerator task list work map provides geographical context to the accelerator task list calendar and ATLis⁠.

⁠Quick Start with Compose

1. Grab project

git clone https://github.com/JeffersonLab/workmap
cd workmap

1. Launch Compose⁠

docker compose up

1. Navigate to page

http://localhost:8080/workmap

Note: Login with demo username "jdoe" and password "password".

See: Docker Compose Strategy⁠

⁠Install

This application requires a Java 17+ JVM and standard library to run, plus a Jakarta EE 10 application server (developed with Wildfly).

1. Install service dependencies⁠
2. Download Wildfly 37.0.1⁠
3. Configure⁠ Wildfly and start it
4. Download workmap.war⁠ and deploy it to Wildfly
5. Navigate your web browser to localhost:8080/workmap⁠

⁠Configure

⁠Configtime

Wildfly must be pre-configured before the first deployment of the app. The wildfly bash scripts⁠ can be used to accomplish this. See the Dockerfile⁠ for an example.

⁠Runtime

Uses a subset of the Smoothness Environment Variables⁠ including:

• BACKEND_SERVER_URL
• FRONTEND_SERVER_URL
• PUPPET_SHOW_SERVER_URL

The following application specific envs are also used:

⁠Database

The application requires an Oracle 19+ database with the following schema⁠ installed. The application server hosting the app must also be configured with a JNDI datasource.

⁠Build

This project is built with Java 21⁠ (compiled to Java 17 bytecode), and uses the Gradle 9⁠ build tool to automatically download dependencies and build the project from source:

git clone https://github.com/JeffersonLab/workmap
cd workmap
gradlew build

Note: If you do not already have Gradle installed, it will be installed automatically by the wrapper script included in the source

Note for JLab On-Site Users: Jefferson Lab has an intercepting proxy⁠

⁠Develop

In order to iterate rapidly when making changes it's often useful to run the app directly on the local workstation, perhaps leveraging an IDE. In this scenario run the service dependencies with:

docker compose -f deps.yaml up

Note: The local install of Wildfly should be configured⁠ to proxy connections to services via localhost and therefore the environment variables should contain:

KEYCLOAK_BACKEND_SERVER_URL=http://localhost:8081
FRONTEND_SERVER_URL=https://localhost:8443

Further, the local DataSource must also leverage localhost port forwarding so the standalone.xml connection-url field should be: jdbc:oracle:thin:@//localhost:1521/xepdb1.

The server⁠ and app⁠ setup scripts can be used to setup a local instance of Wildfly.

⁠Release

1. Bump the version number in the VERSION file and commit and push to GitHub (using Semantic Versioning⁠).
2. The CD⁠ GitHub Action should run automatically invoking:
   • The Create release⁠ GitHub Action to tag the source and create release notes summarizing any pull requests. Edit the release notes to add any missing details. A war file artifact is attached to the release.
   • The Publish docker image⁠ GitHub Action to create a new demo Docker image.
   • The Deploy to JLab⁠ GitHub Action to deploy to the JLab test environment.

⁠Deploy

The deploy to JLab's acctest is handled automatically via the release workflow.

At JLab this app is found at ace.jlab.org/workmap⁠ and internally at acctest.acc.jlab.org/workmap⁠. However, those servers are proxies for wildfly5.acc.jlab.org and wildflytest5.acc.jlab.org respectively. A deploy script⁠ is provided to automate wget and deploy. Example:

/opt/wildfly/cd/deploy.sh workmap v1.2.3

JLab Internal Docs: RHEL9 Wildfly⁠

⁠See Also

• JLab ACE management-app list⁠