jeffersonlab/calendar

calendar https://github.com/JeffersonLab/calendar/actions/workflows/ci.yaml/badge.svg](https://github.com/JeffersonLab/calendar/actions/workflows/ci.yaml) https://img.shields.io/docker/v/jeffersonlab/calendar?sort=semver&label=DockerHub](https://hub.docker.com/r/jeffersonlab/calendar)

A Jakarta EE 10 web application for visualizing schedules and aiding work coordination at Jefferson Lab.

!https://github.com/JeffersonLab/calendar/raw/main/Screenshot.png?raw=true "Screenshot"

• https://github.com/JeffersonLab/calendar#overview
• https://github.com/JeffersonLab/calendar#quick-start-with-compose
• https://github.com/JeffersonLab/calendar#install
• https://github.com/JeffersonLab/calendar#configure
• https://github.com/JeffersonLab/calendar#build
• https://github.com/JeffersonLab/calendar#develop
• https://github.com/JeffersonLab/calendar#release
• https://github.com/JeffersonLab/calendar#deploy
• https://github.com/JeffersonLab/calendar#see-also

Overview

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

Quick Start with Compose

1. Grab project

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

2. Launch https://github.com/docker/compose

docker compose up

3. Navigate to page

http://localhost:8080/calendar

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

See: https://gist.github.com/slominskir/a7da801e8259f5974c978f9c3091d52c

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 https://github.com/JeffersonLab/calendar/blob/main/deps.yaml
2. Download https://www.wildfly.org/downloads/
3. https://github.com/JeffersonLab/calendar#configure Wildfly and start it
4. Download https://github.com/JeffersonLab/calendar/releases and deploy it to Wildfly
5. Navigate your web browser to http://localhost:8080/calendar

Configure

Configtime

Wildfly must be pre-configured before the first deployment of the app. The https://github.com/JeffersonLab/wildfly#configure can be used to accomplish this. See the https://github.com/JeffersonLab/calendar/blob/main/Dockerfile for an example.

Runtime

Uses a subset of the https://github.com/JeffersonLab/smoothness#global-runtime including:

• BACKEND_SERVER_URL
• FRONTEND_SERVER_URL
• PUPPET_SHOW_SERVER_URL

Database

The application requires an Oracle 19+ database with the following https://github.com/JeffersonLab/calendar/tree/main/docker/oracle/setup 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 https://gradle.org/ 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 https://gist.github.com/slominskir/92c25a033db93a90184a5994e71d0b78

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 https://github.com/JeffersonLab/calendar#configure 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 https://github.com/JeffersonLab/wildfly/blob/main/scripts/server-setup.sh and https://github.com/JeffersonLab/wildfly/blob/main/scripts/app-setup.sh 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 https://semver.org/).
2. The https://github.com/JeffersonLab/calendar/blob/main/.github/workflows/cd.yaml GitHub Action should run automatically invoking:
   • The https://github.com/JeffersonLab/java-workflows/blob/main/.github/workflows/gh-release.yaml 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 https://github.com/JeffersonLab/container-workflows/blob/main/.github/workflows/docker-publish.yaml GitHub Action to create a new demo Docker image.
   • The https://github.com/JeffersonLab/general-workflows/blob/main/.github/workflows/jlab-deploy-app.yaml 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 wildfly5.acc.jlab.org and wildflytest5.acc.jlab.org respectively. A https://github.com/JeffersonLab/wildfly/blob/main/scripts/deploy.sh is provided to automate wget and deploy. Example:

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

JLab Internal Docs: RHEL9 Wildfly

See Also

• https://github.com/search?q=org%3Ajeffersonlab+topic%3Aace+topic%3Amanagement-app&type=repositories