calendar

A Java EE 8 web application for visualizing schedules and aiding work coordination at Jefferson Lab.

Overview

The accelerator task list calendar provides a visualization of schedules to aid with work coordination of ATLis tasks. The calender is most often used during Scheduled Accelerator Down (SAD) periods so is often referred to as the SAD Calendar.

Quick Start with Compose

Grab project

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

Launch Compose
```
docker compose up
```
Navigate to page
```
http://localhost:8080/calendar
```

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).

Install service dependencies
Download Wildfly 26.1.3
Configure Wildfly and start it
Download calendar.war and deploy it to Wildfly
Navigate your web browser to localhost:8080/calendar

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

Database

The application requires an Oracle 18+ 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 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/calendar
cd calendar
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

Bump the version number in the VERSION file and commit and push to GitHub (using Semantic Versioning).
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/calendar and internally at acctest.acc.jlab.org/calendar. However, those servers are proxies for wildfly6.acc.jlab.org and wildflytest6.acc.jlab.org respectively. A deploy script is provided to automate wget and deploy. Example:

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

JLab Internal Docs: InstallGuideWildflyRHEL9

JeffersonLab / calendar

readme