jeffersonlab/dtm repository overview

⁠dtm

A Jakarta EE 10⁠ web application for managing downtime at Jefferson Lab built with the Smoothness⁠ web template.

• Overview⁠
• User Guide⁠
• 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.

See the User Guide⁠ for how to use it.

⁠Quick Start with Compose

1. Grab project

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

1. Launch Compose⁠

docker compose up

1. Navigate to page

http://localhost:8080/dtm

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

⁠Ports

The containers publish these ports on the host, listening only on its local address (127.0.0.1), so other computers can't reach the demo database, accounts, and management consoles. To use them from another computer, forward them over SSH, such as ssh -N -L 8443:localhost:8443 -L 8081:localhost:8081 <host> for the app and Keycloak. If another project already uses some of them, or you run a second copy of the demo, set other ports in a .env file next to compose.yaml, which Compose reads, or in the environment:

The app and Keycloak are set up for the ports you choose, so log in at https://localhost:<DTM_HTTPS_PORT>/dtm.

Compose names the containers, network, and images after the project's directory, such as dtm-oracle-1, so a copy in another directory, such as a git worktree, gets its own.

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 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:

There are some Settings⁠ in the database as well that can be edited on the Setup tab by admins.

⁠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/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⁠

⁠User Guide website

The user guide⁠ is Markdown, readable on GitHub, and also built into a website with Zensical⁠ (zensical.toml⁠). With uv⁠ installed:

uv run --locked zensical build --strict

builds it into site/, as CI does; --strict fails on a link to a missing page or heading. uv run --locked zensical serve previews it at http://localhost:8000⁠.

CI builds it and each release publishes it with the user guide workflows⁠ of general-workflows.

⁠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. These are the default ports⁠; use yours if you set others.

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.
   • The Publish user guide⁠ GitHub Action to publish the User Guide⁠ to GitHub Pages, in a folder for the release and in latest/.

⁠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 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 dtm v1.2.3

JLab Internal Docs: RHEL9 Wildfly⁠

⁠See Also

• System Downtime Management at 12 GeV CEBAF⁠, presented at Accelerator Reliability Workshop 2015⁠
• JLab ACE management-app list⁠