diff options
Diffstat (limited to 'microservices/03-resource-server/linux/deb')
13 files changed, 251 insertions, 0 deletions
diff --git a/microservices/03-resource-server/linux/deb/.gitignore b/microservices/03-resource-server/linux/deb/.gitignore new file mode 100644 index 0000000..c00df13 --- /dev/null +++ b/microservices/03-resource-server/linux/deb/.gitignore @@ -0,0 +1 @@ +*.deb diff --git a/microservices/03-resource-server/linux/deb/README b/microservices/03-resource-server/linux/deb/README new file mode 100644 index 0000000..cc66dd8 --- /dev/null +++ b/microservices/03-resource-server/linux/deb/README @@ -0,0 +1,59 @@ +This directory contains everything to build a deb package that bundles a Spring Boot app that starts a web server. + +#### + +Executable scripts: + + create-new-project.sh - This script can be used to create a new deb package project similar to this project that uses a different name (than ceit-fs-resource-server). Output will be placed inside 'out' directory. + + build.sh - This script builds the deb package. If the above script is used, go to the corresponding directory inside out directory to find a copy of this build.sh script. + +#### + +To create a new deb package project that uses 'mycompany-myapp' as the name, run the following command: + + ./create-new-project.sh mycompany mycompany-myapp + + The newly generated project files will be found inside the out directory. + +#### + +To build, run the following command: + + ./build.sh + + Note that the Spring Boot application has not been bundled with this. You need to build it seperately and put it in the correct directory (run build.sh for further details). + +#### + +To install the build deb package run the following commands replacing the package.deb with the correct name of the deb file. + + cp package.deb /tmp + cd /tmp + apt install ./package.deb + +The above "apt install" will download dependencies if needed. Otherwise, dpkg command can just be used to install or upgrade the package: + + dpkg -i package.deb + +After installing the package, update the configuration file /etc/ceit-fs-resource-server/application.yaml . + +Enable service to start at boot time: + + systemctl enable ceit-fs-resource-server + +Start service: + + systemctl start ceit-fs-resource-server + +View service log: + + journalctl -u ceit-fs-resource-server -f + + (Press CTRL+C to terminate log viewing) + +Access the service: + + http://server-ip-or-hostname:8085/ + + (Instead of 8085, use the port configured in application.yaml file) diff --git a/microservices/03-resource-server/linux/deb/build.sh b/microservices/03-resource-server/linux/deb/build.sh new file mode 100755 index 0000000..a121d2e --- /dev/null +++ b/microservices/03-resource-server/linux/deb/build.sh @@ -0,0 +1,36 @@ +#!/bin/bash + +# Define a function that sends messages to stderr. +errcho() { + echo "$@" 1>&2; +} + +# Check if fakeroot command is available +if ! command -v fakeroot > /dev/null 2>&1; then + errcho "[ERROR] fakeroot command not found. Install the fakeroot package."; + exit 1 +fi + +# Check if dpkg-deb command is available +if ! command -v dpkg-deb > /dev/null 2>&1; then + errcho "[ERROR] dpkg-deb command not found. dpkg package contains it. Are you not running this script on a Debian based system?"; + exit 1 +fi + +# Get the directory of this script +DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )" + +# Check if the spring boot jar is in the correct location +if [ ! -f $DIR/package/opt/ceit/ceit-fs-resource-server/app/ceit-fs-resource-server.jar ]; then + errcho "[ERROR] Jar file missing: package/opt/ceit/ceit-fs-resource-server/app/ceit-fs-resource-server.jar" + errcho "[ERROR] Run this build script only after placing the jar file in that location." + exit 1 +fi + +# Remove the deb files found inside DIR. Don't prompt the user before deleting. +if ls $DIR/*.deb 1> /dev/null 2>&1; then + rm $DIR/*.deb +fi + +# Build the deb package +fakeroot dpkg-deb --build $DIR/package $DIR diff --git a/microservices/03-resource-server/linux/deb/package/DEBIAN/conffiles b/microservices/03-resource-server/linux/deb/package/DEBIAN/conffiles new file mode 100644 index 0000000..a7f5a82 --- /dev/null +++ b/microservices/03-resource-server/linux/deb/package/DEBIAN/conffiles @@ -0,0 +1,2 @@ +/etc/ceit-fs-resource-server/application.yaml +/etc/ceit-fs-resource-server/environment.env diff --git a/microservices/03-resource-server/linux/deb/package/DEBIAN/control b/microservices/03-resource-server/linux/deb/package/DEBIAN/control new file mode 100644 index 0000000..e3d6afe --- /dev/null +++ b/microservices/03-resource-server/linux/deb/package/DEBIAN/control @@ -0,0 +1,8 @@ +Package: ceit-fs-resource-server +Version: 1.0.0-1 +Section: httpd +Priority: optional +Architecture: all +Depends: openjdk-25-jre | temurin-25-jre | openjdk-25-jdk | temurin-25-jdk +Maintainer: Kamal Wickramanayake <info@software.lk> +Description: A demo Debian package that bundles a Spring Boot application. diff --git a/microservices/03-resource-server/linux/deb/package/DEBIAN/postinst b/microservices/03-resource-server/linux/deb/package/DEBIAN/postinst new file mode 100755 index 0000000..247d430 --- /dev/null +++ b/microservices/03-resource-server/linux/deb/package/DEBIAN/postinst @@ -0,0 +1,59 @@ +#!/bin/bash + +# Stop on error +set -e + +if [ "$1" == "configure" ] && [ -z "$2" ]; then + # Code here executes only during package install (but not during upgrade) + + # Create a system user + # -r: System user + # -s /sbin/nologin: Prevent the user from logging into the system interactively + # -d /var/lib/ceit-fs-resource-server: Set home directory of user + # ceit-fs-resource-server: Username + useradd -r -s /sbin/nologin -d /var/lib/ceit-fs-resource-server ceit-fs-resource-server || true + +fi + +# Set directory ownership and permissions - Application jar file not to be read by other system users +chown -R root:ceit-fs-resource-server /opt/ceit/ceit-fs-resource-server +chmod 755 /opt/ceit +chmod 750 /opt/ceit/ceit-fs-resource-server +chmod 750 /opt/ceit/ceit-fs-resource-server/app +chmod 640 /opt/ceit/ceit-fs-resource-server/app/ceit-fs-resource-server.jar + +# Set directory ownership and permissions - Config files not to be read by other system users +chown -R root:ceit-fs-resource-server /etc/ceit-fs-resource-server +chmod 750 /etc/ceit-fs-resource-server +chmod 640 /etc/ceit-fs-resource-server/application.yaml +chmod 640 /etc/ceit-fs-resource-server/environment.env + +if [ "$1" = "configure" ] || [ "$1" = "abort-upgrade" ] || [ "$1" = "abort-deconfigure" ] || [ "$1" = "abort-remove" ] ; then + if [ -d /run/systemd/system ]; then + # Reload systemd service configurations + systemctl daemon-reload > /dev/null || true + + if [ -n "$2" ]; then + # Upgrade + # Restart service + if systemctl is-enabled ceit-fs-resource-server > /dev/null; then + systemctl start ceit-fs-resource-server + fi + else + # First install (not upgrade) + # Enable service to start at boot time + systemctl enable ceit-fs-resource-server + # Start service + systemctl start ceit-fs-resource-server + fi + fi +fi + +if [ "$1" == "configure" ] && [ -z "$2" ]; then + # Code here executes only during package install (but not during upgrade) + echo "[INFO] ceit-fs-resource-server service installed." + echo "[INFO] Update /etc/ceit-fs-resource-server/application.yaml to update the configuration." + echo "[INFO] By default, TCP port 8085 is used by the installed server." + echo "[INFO] To allow access from remote systems, you may have to enable firewall for example by running:" + echo "[INFO] ufw allow 8085/tcp" +fi diff --git a/microservices/03-resource-server/linux/deb/package/DEBIAN/postrm b/microservices/03-resource-server/linux/deb/package/DEBIAN/postrm new file mode 100755 index 0000000..1883418 --- /dev/null +++ b/microservices/03-resource-server/linux/deb/package/DEBIAN/postrm @@ -0,0 +1,14 @@ +#!/bin/bash +set -e + +# Check if the package is being purged (erased entirely including configs) +if [ -z "$DPKG_ROOT" ] && [ "$1" = "purge" ] ; then + update-rc.d ceit-fs-resource-server remove >/dev/null + deluser --quiet ceit-fs-resource-server || true +fi + +# Reload systemd service configuration files. +systemctl daemon-reload + +# postrm script must exit with 0 +exit 0 diff --git a/microservices/03-resource-server/linux/deb/package/DEBIAN/preinst b/microservices/03-resource-server/linux/deb/package/DEBIAN/preinst new file mode 100755 index 0000000..61c2587 --- /dev/null +++ b/microservices/03-resource-server/linux/deb/package/DEBIAN/preinst @@ -0,0 +1,8 @@ +#!/bin/bash + +set -e + +# Put commands that should execute before the pckage is installed. + +# Example: Just print a message +echo "preinst script running..." diff --git a/microservices/03-resource-server/linux/deb/package/DEBIAN/prerm b/microservices/03-resource-server/linux/deb/package/DEBIAN/prerm new file mode 100755 index 0000000..e662818 --- /dev/null +++ b/microservices/03-resource-server/linux/deb/package/DEBIAN/prerm @@ -0,0 +1,9 @@ +#!/bin/bash +set -e + +# Stop service before files are removed +systemctl stop ceit-fs-resource-server || true + +# prerm script must exit with 0 +exit 0 + diff --git a/microservices/03-resource-server/linux/deb/package/etc/ceit-fs-resource-server/application.yaml b/microservices/03-resource-server/linux/deb/package/etc/ceit-fs-resource-server/application.yaml new file mode 100644 index 0000000..5a1c9df --- /dev/null +++ b/microservices/03-resource-server/linux/deb/package/etc/ceit-fs-resource-server/application.yaml @@ -0,0 +1,40 @@ +server: + port: 8052 + address: 127.0.0.1 + servlet: + context-path: /myservices + +# logging: +# level: +# org.springframework.security: trace + +spring: + application: + name: resource-server + + security: + oauth2: + resourceserver: + jwt: + issuer-uri: https://fs-auth-server.dev.ceit.pdn.ac.lk + + datasource: + url: jdbc:h2:mem:testdb + driver-class-name: org.h2.Driver + username: sa + password: password + h2: + console: + enabled: false + path: /h2-console # H2 Console: http://localhost:8052/myservices/h2-console + jpa: + # database-platform: org.hibernate.dialect.H2Dialect + hibernate: + ddl-auto: update + show-sql: false + defer-datasource-initialization: true # schema.sql and data.sql are executed after Hibernate/JPA auto-creates database tables. + + # Always execute initialization scripts (resources/schema.sql, resources/data.sql) on startup + sql: + init: + mode: always diff --git a/microservices/03-resource-server/linux/deb/package/etc/ceit-fs-resource-server/environment.env b/microservices/03-resource-server/linux/deb/package/etc/ceit-fs-resource-server/environment.env new file mode 100644 index 0000000..5423533 --- /dev/null +++ b/microservices/03-resource-server/linux/deb/package/etc/ceit-fs-resource-server/environment.env @@ -0,0 +1,2 @@ +# Which Spring profile should be active? +#SPRING_PROFILES_ACTIVE=prod diff --git a/microservices/03-resource-server/linux/deb/package/etc/systemd/system/ceit-fs-resource-server.service b/microservices/03-resource-server/linux/deb/package/etc/systemd/system/ceit-fs-resource-server.service new file mode 100644 index 0000000..0bb7388 --- /dev/null +++ b/microservices/03-resource-server/linux/deb/package/etc/systemd/system/ceit-fs-resource-server.service @@ -0,0 +1,12 @@ +[Unit] +Description=ceit-fs-resource-server + +[Service] +User=ceit-fs-resource-server +EnvironmentFile=/etc/ceit-fs-resource-server/environment.env +ExecStart=/usr/bin/java -Dspring.config.import=optional:file:/etc/ceit-fs-resource-server/application.yaml -jar /opt/ceit/ceit-fs-resource-server/app/ceit-fs-resource-server.jar +Restart=always +RestartSec=30 + +[Install] +WantedBy=multi-user.target diff --git a/microservices/03-resource-server/linux/deb/package/opt/ceit/ceit-fs-resource-server/app/.gitignore b/microservices/03-resource-server/linux/deb/package/opt/ceit/ceit-fs-resource-server/app/.gitignore new file mode 100644 index 0000000..d392f0e --- /dev/null +++ b/microservices/03-resource-server/linux/deb/package/opt/ceit/ceit-fs-resource-server/app/.gitignore @@ -0,0 +1 @@ +*.jar |