Skip to content

Latest commit

 

History

History
115 lines (89 loc) · 7.11 KB

README.md

File metadata and controls

115 lines (89 loc) · 7.11 KB
Raw

adm CI Docker

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

Screenshot

Overview

The application deployment manager app aids automated app deployment by providing an HTTP endpoint for executing curated remote deployment commands securely.

Quick Start with Compose

  1. Grab project
git clone https://github.com/JeffersonLab/adm
cd adm
  1. Launch Compose
docker compose up
  1. Navigate to page
http://localhost:8080/adm

Note: Login with demo username "tbrown" and password "password". Use env "local-demo", app "testapp", ver "1.0.0".

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

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

The deployment commands rely on ssh and therefore the user running Wildlfy needs to have ssh configured such that remote connections can be made non-interactively (programmatically) without password prompt. This generally means creating a public and private key pair for the Wildfly user via ssh-keygen and then add the public key to the authorized_keys file of each remote user account needed for deployments. It's also possible to use Kerberos and keytabs instead.

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/adm
cd adm
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.

The user you use to run Wildfly needs to have an SSH public/private key pair (ssh-keygen) in the default location (~/.ssh). The public key needs to be added to the authorized_keys file of user testuser in the container named "sshd". This can be done by creating a file named .env in the root of the project containing the env name "TEST_USER_AUTHORIZED_KEY" with value being Wildfly user's public key. This env will then be passed in via deps.yaml environment setting.

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

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

JLab Internal Docs: InstallGuideWildflyRHEL9

See Also