jeffersonlab/jam repository overview

⁠jam

A Jakarta EE 10⁠ web application for both beam and RF operations authorization at Jefferson Lab built with the Smoothness⁠ web template.

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

⁠Overview

The authorization application allows the Director of Operations (or a delegate) to clearly communicate and document authorization for various facilities at JLab to either generate beam or engage in RF operations. For beam generation the maximum current and beam mode ("permissions") that are authorized are provided for a given beam destination. This information is stored in a database and presented via the web for easy access. There are three beam generating facilities, each with their own set of beam destinations and beam modes: CEBAF, LERF, UITF. There are seven facilities which generate RF: CEBAF Injector, CEBAF North Linac, CEBAF South Linac, LERF, CMTF, and VTA. In addition to director authorization, the app also tracks Credited Controls and their verification. Each beam destination is assigned a set of controls and each control is assigned to a particular responsible verification team. A beam desintation is ready for beam only if all the controls assigned are verified by their responsible verification team. Both team verifications and director permissions have expirations. Emails and Jefferson Lab logbook entires are created to aid communication of new director permissions, responsible team verifications (upgrades and downgrades), and verification and permissions expirations.

⁠Roles

• Authorizer / Operations Director - Responsible for authorizing beam
• Operability / Admin - Responsible for process administration and continuous improvement
• Operator - Must honor permissions set by the Director when operating facilities
• Verification Team - Responsible for verifying Credited Control readiness and assigning expiration dates for when new checks are required

⁠JLab Internal Docs

• CEBAF-LERF ASE⁠
• UITF ASE⁠
• SAD⁠

⁠Quick Start with Compose

1. Grab project

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

1. Launch Compose⁠

docker compose up

1. Navigate to page

http://localhost:8080/jam

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 jam.war⁠ and deploy it to Wildfly
5. Navigate your web browser to localhost:8080/jam⁠

⁠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 the Smoothness Environment Variables⁠ plus the following application specific Settings:

⁠Database

This application requires an Oracle 19+ database with the following schema⁠ installed. The application server hosting this 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/jam
cd jam
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⁠

See: Docker Development Quick Reference⁠

⁠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/jam⁠ and internally at acctest.acc.jlab.org/jam⁠. However, those servers are proxies for wildfly3.acc.jlab.org and wildflytest3.acc.jlab.org respectively. A deploy script⁠ is provided on each server to automate wget and deploy. Example:

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

JLab Internal Docs: RHEL9 Wildfly⁠

⁠See Also

• JLab ACE management-app list⁠