dtm

A Java EE 8 web application for managing downtime at Jefferson Lab built with the Smoothness web template.

---

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

---

Overview

The Downtime application allows Operators to log machine downtime events. Downtime events are caused by one or more incidents, and incidents may occur concurrently. The machine requires time to recover after all incidents are resolved, and this time is also part of an event. Short temporary "trips" caused by Fast Shutdown System (FSD) faults, are also recorded. A trip that lasts longer than five minutes is considered eligible to be a downtime event. Most downtime events start off as trips.

Quick Start with Compose

1. Grab project

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

2. Launch Compose

docker compose up

3. Navigate to page

http://localhost:8080/dtm

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

See: Docker Compose Strategy

Install

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

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

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:

Name	Description
DTM_BOOKS_CSV	Comma Separated Logbooks to post CREATED/DELETED entries to. Defaults to TLOG. Generally should be set to ELOG in production.
RAR_DIR	Directory path to store Repair Assessment Reports
SRM_URL	Scheme, host, and port to System Readiness Manager (for Downgrade link; formally named HCO)
PAC_SCHEDULE_SERVER_URL	Scheme, host, and port to Program Advisory Committee Schedule (for Joule Report)

There are some Settings in the database as well.

Build

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

git clone https://github.com/JeffersonLab/dtm
cd dtm
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, and bump the compose.override.yaml to use the new 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/dtm and internally at acctest.acc.jlab.org/dtm. However, those servers are proxies for wildfly5.acc.jlab.org and wildflytest5.acc.jlab.org respectively. A deploy script is provided on each server to automate wget and deploy. Example:

/root/setup/deploy.sh dtm v1.2.3

JLab Internal Docs: InstallGuideWildflyRHEL9

See Also

• JLab ACE management-app list