From 6db11435dd2b402261b51d90a55cfd15618b9b3d Mon Sep 17 00:00:00 2001 From: Annel Ketcha Date: Fri, 15 Mar 2024 10:31:30 -0400 Subject: [PATCH 1/7] aap job launch workflow --- aap-job/.dockerignore | 5 + aap-job/.gitignore | 43 +++ aap-job/.mvn/wrapper/.gitignore | 1 + .../.mvn/wrapper/MavenWrapperDownloader.java | 98 ++++++ aap-job/.mvn/wrapper/maven-wrapper.properties | 18 + aap-job/README.md | 49 +++ aap-job/mvnw | 308 ++++++++++++++++++ aap-job/mvnw.cmd | 205 ++++++++++++ aap-job/pom.xml | 165 ++++++++++ aap-job/src/main/docker/Dockerfile.jvm | 98 ++++++ aap-job/src/main/docker/Dockerfile.legacy-jar | 94 ++++++ aap-job/src/main/docker/Dockerfile.native | 27 ++ .../src/main/docker/Dockerfile.native-micro | 30 ++ aap-job/src/main/resources/aap-job.sw.yaml | 94 ++++++ .../src/main/resources/application.properties | 8 + .../schemas/app-job-input-schema.json | 13 + .../src/main/resources/specs/aap-openapi.yaml | 88 +++++ 17 files changed, 1344 insertions(+) create mode 100644 aap-job/.dockerignore create mode 100644 aap-job/.gitignore create mode 100644 aap-job/.mvn/wrapper/.gitignore create mode 100644 aap-job/.mvn/wrapper/MavenWrapperDownloader.java create mode 100644 aap-job/.mvn/wrapper/maven-wrapper.properties create mode 100644 aap-job/README.md create mode 100755 aap-job/mvnw create mode 100644 aap-job/mvnw.cmd create mode 100644 aap-job/pom.xml create mode 100644 aap-job/src/main/docker/Dockerfile.jvm create mode 100644 aap-job/src/main/docker/Dockerfile.legacy-jar create mode 100644 aap-job/src/main/docker/Dockerfile.native create mode 100644 aap-job/src/main/docker/Dockerfile.native-micro create mode 100644 aap-job/src/main/resources/aap-job.sw.yaml create mode 100644 aap-job/src/main/resources/application.properties create mode 100644 aap-job/src/main/resources/schemas/app-job-input-schema.json create mode 100644 aap-job/src/main/resources/specs/aap-openapi.yaml diff --git a/aap-job/.dockerignore b/aap-job/.dockerignore new file mode 100644 index 0000000..94810d0 --- /dev/null +++ b/aap-job/.dockerignore @@ -0,0 +1,5 @@ +* +!target/*-runner +!target/*-runner.jar +!target/lib/* +!target/quarkus-app/* \ No newline at end of file diff --git a/aap-job/.gitignore b/aap-job/.gitignore new file mode 100644 index 0000000..8c7863e --- /dev/null +++ b/aap-job/.gitignore @@ -0,0 +1,43 @@ +#Maven +target/ +pom.xml.tag +pom.xml.releaseBackup +pom.xml.versionsBackup +release.properties +.flattened-pom.xml + +# Eclipse +.project +.classpath +.settings/ +bin/ + +# IntelliJ +.idea +*.ipr +*.iml +*.iws + +# NetBeans +nb-configuration.xml + +# Visual Studio Code +.vscode +.factorypath + +# OSX +.DS_Store + +# Vim +*.swp +*.swo + +# patch +*.orig +*.rej + +# Local environment +.env + +# Plugin directory +/.quarkus/cli/plugins/ diff --git a/aap-job/.mvn/wrapper/.gitignore b/aap-job/.mvn/wrapper/.gitignore new file mode 100644 index 0000000..e72f5e8 --- /dev/null +++ b/aap-job/.mvn/wrapper/.gitignore @@ -0,0 +1 @@ +maven-wrapper.jar diff --git a/aap-job/.mvn/wrapper/MavenWrapperDownloader.java b/aap-job/.mvn/wrapper/MavenWrapperDownloader.java new file mode 100644 index 0000000..84d1e60 --- /dev/null +++ b/aap-job/.mvn/wrapper/MavenWrapperDownloader.java @@ -0,0 +1,98 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +import java.io.IOException; +import java.io.InputStream; +import java.net.Authenticator; +import java.net.PasswordAuthentication; +import java.net.URL; +import java.nio.file.Files; +import java.nio.file.Path; +import java.nio.file.Paths; +import java.nio.file.StandardCopyOption; + +public final class MavenWrapperDownloader +{ + private static final String WRAPPER_VERSION = "3.2.0"; + + private static final boolean VERBOSE = Boolean.parseBoolean( System.getenv( "MVNW_VERBOSE" ) ); + + public static void main( String[] args ) + { + log( "Apache Maven Wrapper Downloader " + WRAPPER_VERSION ); + + if ( args.length != 2 ) + { + System.err.println( " - ERROR wrapperUrl or wrapperJarPath parameter missing" ); + System.exit( 1 ); + } + + try + { + log( " - Downloader started" ); + final URL wrapperUrl = new URL( args[0] ); + final String jarPath = args[1].replace( "..", "" ); // Sanitize path + final Path wrapperJarPath = Paths.get( jarPath ).toAbsolutePath().normalize(); + downloadFileFromURL( wrapperUrl, wrapperJarPath ); + log( "Done" ); + } + catch ( IOException e ) + { + System.err.println( "- Error downloading: " + e.getMessage() ); + if ( VERBOSE ) + { + e.printStackTrace(); + } + System.exit( 1 ); + } + } + + private static void downloadFileFromURL( URL wrapperUrl, Path wrapperJarPath ) + throws IOException + { + log( " - Downloading to: " + wrapperJarPath ); + if ( System.getenv( "MVNW_USERNAME" ) != null && System.getenv( "MVNW_PASSWORD" ) != null ) + { + final String username = System.getenv( "MVNW_USERNAME" ); + final char[] password = System.getenv( "MVNW_PASSWORD" ).toCharArray(); + Authenticator.setDefault( new Authenticator() + { + @Override + protected PasswordAuthentication getPasswordAuthentication() + { + return new PasswordAuthentication( username, password ); + } + } ); + } + try ( InputStream inStream = wrapperUrl.openStream() ) + { + Files.copy( inStream, wrapperJarPath, StandardCopyOption.REPLACE_EXISTING ); + } + log( " - Downloader complete" ); + } + + private static void log( String msg ) + { + if ( VERBOSE ) + { + System.out.println( msg ); + } + } + +} diff --git a/aap-job/.mvn/wrapper/maven-wrapper.properties b/aap-job/.mvn/wrapper/maven-wrapper.properties new file mode 100644 index 0000000..6d3a566 --- /dev/null +++ b/aap-job/.mvn/wrapper/maven-wrapper.properties @@ -0,0 +1,18 @@ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +distributionUrl=https://repo.maven.apache.org/maven2/org/apache/maven/apache-maven/3.9.3/apache-maven-3.9.3-bin.zip +wrapperUrl=https://repo.maven.apache.org/maven2/org/apache/maven/wrapper/maven-wrapper/3.2.0/maven-wrapper-3.2.0.jar diff --git a/aap-job/README.md b/aap-job/README.md new file mode 100644 index 0000000..c8569e3 --- /dev/null +++ b/aap-job/README.md @@ -0,0 +1,49 @@ +# Ansible automation platform job workflow +This workflow launches an Ansible Automation Platform (AAP) job from a given job template id and send out a notification for success or failure upon completion. + + +## Prerequisite +* A running instance of AAP with admin credentials. +* A running instance of Backstage notification plugin. + +### Requiqued Properties +List of required properties to run the workflow: +- BACKSTAGE_NOTIFICATIONS_URL +- AAP_URL +- AAP_USERNAME +- AAP_PASSWORD + +## How to run + +```bash +mvn clean quarkus:dev +``` + +Example of POST to trigger the workflow: +```bash +curl -XPOST -H "Content-Type: application/json" http://localhost:8080/app-job -d '{"jobTemplateId": _JOB_TEMPLATE_ID_}' +``` + +Response: +``` +{ + "workflowdata": { + "launchedJob": { + "id": 31, + "failed": false, + "status": "pending", + "outputUrl": "https://your-app-platform.io/#/jobs/playbook/31/output" + }, + "jobTemplateId": 7 + } +} +``` + +Subsequently (about 30s delay), the workflow will repeatedly pull job with its status to check if the job is done with success or failure to send out relevant notification. + +For job completion with success, the log outputs look like: +``` +[org.kie.kog.ser.wor.dev.DevModeServerlessWorkflowLogger] (executor-thread-2) Triggered node 'getJob' for process 'aap-job' (3aa93369-5914-4211-b7f3-b218de1630e1) +[org.kie.kog.ser.wor.dev.DevModeServerlessWorkflowLogger] (executor-thread-2) Triggered node 'IsJobDone' for process 'aap-job' (3aa93369-5914-4211-b7f3-b218de1630e1) +[org.kie.kog.ser.wor.dev.DevModeServerlessWorkflowLogger] (executor-thread-2) Triggered node 'SendSuccessNotification' for process 'aap-job' (3aa93369-5914-4211-b7f3-b218de1630e1) +``` diff --git a/aap-job/mvnw b/aap-job/mvnw new file mode 100755 index 0000000..8d937f4 --- /dev/null +++ b/aap-job/mvnw @@ -0,0 +1,308 @@ +#!/bin/sh +# ---------------------------------------------------------------------------- +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +# ---------------------------------------------------------------------------- + +# ---------------------------------------------------------------------------- +# Apache Maven Wrapper startup batch script, version 3.2.0 +# +# Required ENV vars: +# ------------------ +# JAVA_HOME - location of a JDK home dir +# +# Optional ENV vars +# ----------------- +# MAVEN_OPTS - parameters passed to the Java VM when running Maven +# e.g. to debug Maven itself, use +# set MAVEN_OPTS=-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=8000 +# MAVEN_SKIP_RC - flag to disable loading of mavenrc files +# ---------------------------------------------------------------------------- + +if [ -z "$MAVEN_SKIP_RC" ] ; then + + if [ -f /usr/local/etc/mavenrc ] ; then + . /usr/local/etc/mavenrc + fi + + if [ -f /etc/mavenrc ] ; then + . /etc/mavenrc + fi + + if [ -f "$HOME/.mavenrc" ] ; then + . "$HOME/.mavenrc" + fi + +fi + +# OS specific support. $var _must_ be set to either true or false. +cygwin=false; +darwin=false; +mingw=false +case "$(uname)" in + CYGWIN*) cygwin=true ;; + MINGW*) mingw=true;; + Darwin*) darwin=true + # Use /usr/libexec/java_home if available, otherwise fall back to /Library/Java/Home + # See https://developer.apple.com/library/mac/qa/qa1170/_index.html + if [ -z "$JAVA_HOME" ]; then + if [ -x "/usr/libexec/java_home" ]; then + JAVA_HOME="$(/usr/libexec/java_home)"; export JAVA_HOME + else + JAVA_HOME="/Library/Java/Home"; export JAVA_HOME + fi + fi + ;; +esac + +if [ -z "$JAVA_HOME" ] ; then + if [ -r /etc/gentoo-release ] ; then + JAVA_HOME=$(java-config --jre-home) + fi +fi + +# For Cygwin, ensure paths are in UNIX format before anything is touched +if $cygwin ; then + [ -n "$JAVA_HOME" ] && + JAVA_HOME=$(cygpath --unix "$JAVA_HOME") + [ -n "$CLASSPATH" ] && + CLASSPATH=$(cygpath --path --unix "$CLASSPATH") +fi + +# For Mingw, ensure paths are in UNIX format before anything is touched +if $mingw ; then + [ -n "$JAVA_HOME" ] && [ -d "$JAVA_HOME" ] && + JAVA_HOME="$(cd "$JAVA_HOME" || (echo "cannot cd into $JAVA_HOME."; exit 1); pwd)" +fi + +if [ -z "$JAVA_HOME" ]; then + javaExecutable="$(which javac)" + if [ -n "$javaExecutable" ] && ! [ "$(expr "\"$javaExecutable\"" : '\([^ ]*\)')" = "no" ]; then + # readlink(1) is not available as standard on Solaris 10. + readLink=$(which readlink) + if [ ! "$(expr "$readLink" : '\([^ ]*\)')" = "no" ]; then + if $darwin ; then + javaHome="$(dirname "\"$javaExecutable\"")" + javaExecutable="$(cd "\"$javaHome\"" && pwd -P)/javac" + else + javaExecutable="$(readlink -f "\"$javaExecutable\"")" + fi + javaHome="$(dirname "\"$javaExecutable\"")" + javaHome=$(expr "$javaHome" : '\(.*\)/bin') + JAVA_HOME="$javaHome" + export JAVA_HOME + fi + fi +fi + +if [ -z "$JAVACMD" ] ; then + if [ -n "$JAVA_HOME" ] ; then + if [ -x "$JAVA_HOME/jre/sh/java" ] ; then + # IBM's JDK on AIX uses strange locations for the executables + JAVACMD="$JAVA_HOME/jre/sh/java" + else + JAVACMD="$JAVA_HOME/bin/java" + fi + else + JAVACMD="$(\unset -f command 2>/dev/null; \command -v java)" + fi +fi + +if [ ! -x "$JAVACMD" ] ; then + echo "Error: JAVA_HOME is not defined correctly." >&2 + echo " We cannot execute $JAVACMD" >&2 + exit 1 +fi + +if [ -z "$JAVA_HOME" ] ; then + echo "Warning: JAVA_HOME environment variable is not set." +fi + +# traverses directory structure from process work directory to filesystem root +# first directory with .mvn subdirectory is considered project base directory +find_maven_basedir() { + if [ -z "$1" ] + then + echo "Path not specified to find_maven_basedir" + return 1 + fi + + basedir="$1" + wdir="$1" + while [ "$wdir" != '/' ] ; do + if [ -d "$wdir"/.mvn ] ; then + basedir=$wdir + break + fi + # workaround for JBEAP-8937 (on Solaris 10/Sparc) + if [ -d "${wdir}" ]; then + wdir=$(cd "$wdir/.." || exit 1; pwd) + fi + # end of workaround + done + printf '%s' "$(cd "$basedir" || exit 1; pwd)" +} + +# concatenates all lines of a file +concat_lines() { + if [ -f "$1" ]; then + # Remove \r in case we run on Windows within Git Bash + # and check out the repository with auto CRLF management + # enabled. Otherwise, we may read lines that are delimited with + # \r\n and produce $'-Xarg\r' rather than -Xarg due to word + # splitting rules. + tr -s '\r\n' ' ' < "$1" + fi +} + +log() { + if [ "$MVNW_VERBOSE" = true ]; then + printf '%s\n' "$1" + fi +} + +BASE_DIR=$(find_maven_basedir "$(dirname "$0")") +if [ -z "$BASE_DIR" ]; then + exit 1; +fi + +MAVEN_PROJECTBASEDIR=${MAVEN_BASEDIR:-"$BASE_DIR"}; export MAVEN_PROJECTBASEDIR +log "$MAVEN_PROJECTBASEDIR" + +########################################################################################## +# Extension to allow automatically downloading the maven-wrapper.jar from Maven-central +# This allows using the maven wrapper in projects that prohibit checking in binary data. +########################################################################################## +wrapperJarPath="$MAVEN_PROJECTBASEDIR/.mvn/wrapper/maven-wrapper.jar" +if [ -r "$wrapperJarPath" ]; then + log "Found $wrapperJarPath" +else + log "Couldn't find $wrapperJarPath, downloading it ..." + + if [ -n "$MVNW_REPOURL" ]; then + wrapperUrl="$MVNW_REPOURL/org/apache/maven/wrapper/maven-wrapper/3.2.0/maven-wrapper-3.2.0.jar" + else + wrapperUrl="https://repo.maven.apache.org/maven2/org/apache/maven/wrapper/maven-wrapper/3.2.0/maven-wrapper-3.2.0.jar" + fi + while IFS="=" read -r key value; do + # Remove '\r' from value to allow usage on windows as IFS does not consider '\r' as a separator ( considers space, tab, new line ('\n'), and custom '=' ) + safeValue=$(echo "$value" | tr -d '\r') + case "$key" in (wrapperUrl) wrapperUrl="$safeValue"; break ;; + esac + done < "$MAVEN_PROJECTBASEDIR/.mvn/wrapper/maven-wrapper.properties" + log "Downloading from: $wrapperUrl" + + if $cygwin; then + wrapperJarPath=$(cygpath --path --windows "$wrapperJarPath") + fi + + if command -v wget > /dev/null; then + log "Found wget ... using wget" + [ "$MVNW_VERBOSE" = true ] && QUIET="" || QUIET="--quiet" + if [ -z "$MVNW_USERNAME" ] || [ -z "$MVNW_PASSWORD" ]; then + wget $QUIET "$wrapperUrl" -O "$wrapperJarPath" || rm -f "$wrapperJarPath" + else + wget $QUIET --http-user="$MVNW_USERNAME" --http-password="$MVNW_PASSWORD" "$wrapperUrl" -O "$wrapperJarPath" || rm -f "$wrapperJarPath" + fi + elif command -v curl > /dev/null; then + log "Found curl ... using curl" + [ "$MVNW_VERBOSE" = true ] && QUIET="" || QUIET="--silent" + if [ -z "$MVNW_USERNAME" ] || [ -z "$MVNW_PASSWORD" ]; then + curl $QUIET -o "$wrapperJarPath" "$wrapperUrl" -f -L || rm -f "$wrapperJarPath" + else + curl $QUIET --user "$MVNW_USERNAME:$MVNW_PASSWORD" -o "$wrapperJarPath" "$wrapperUrl" -f -L || rm -f "$wrapperJarPath" + fi + else + log "Falling back to using Java to download" + javaSource="$MAVEN_PROJECTBASEDIR/.mvn/wrapper/MavenWrapperDownloader.java" + javaClass="$MAVEN_PROJECTBASEDIR/.mvn/wrapper/MavenWrapperDownloader.class" + # For Cygwin, switch paths to Windows format before running javac + if $cygwin; then + javaSource=$(cygpath --path --windows "$javaSource") + javaClass=$(cygpath --path --windows "$javaClass") + fi + if [ -e "$javaSource" ]; then + if [ ! -e "$javaClass" ]; then + log " - Compiling MavenWrapperDownloader.java ..." + ("$JAVA_HOME/bin/javac" "$javaSource") + fi + if [ -e "$javaClass" ]; then + log " - Running MavenWrapperDownloader.java ..." + ("$JAVA_HOME/bin/java" -cp .mvn/wrapper MavenWrapperDownloader "$wrapperUrl" "$wrapperJarPath") || rm -f "$wrapperJarPath" + fi + fi + fi +fi +########################################################################################## +# End of extension +########################################################################################## + +# If specified, validate the SHA-256 sum of the Maven wrapper jar file +wrapperSha256Sum="" +while IFS="=" read -r key value; do + case "$key" in (wrapperSha256Sum) wrapperSha256Sum=$value; break ;; + esac +done < "$MAVEN_PROJECTBASEDIR/.mvn/wrapper/maven-wrapper.properties" +if [ -n "$wrapperSha256Sum" ]; then + wrapperSha256Result=false + if command -v sha256sum > /dev/null; then + if echo "$wrapperSha256Sum $wrapperJarPath" | sha256sum -c > /dev/null 2>&1; then + wrapperSha256Result=true + fi + elif command -v shasum > /dev/null; then + if echo "$wrapperSha256Sum $wrapperJarPath" | shasum -a 256 -c > /dev/null 2>&1; then + wrapperSha256Result=true + fi + else + echo "Checksum validation was requested but neither 'sha256sum' or 'shasum' are available." + echo "Please install either command, or disable validation by removing 'wrapperSha256Sum' from your maven-wrapper.properties." + exit 1 + fi + if [ $wrapperSha256Result = false ]; then + echo "Error: Failed to validate Maven wrapper SHA-256, your Maven wrapper might be compromised." >&2 + echo "Investigate or delete $wrapperJarPath to attempt a clean download." >&2 + echo "If you updated your Maven version, you need to update the specified wrapperSha256Sum property." >&2 + exit 1 + fi +fi + +MAVEN_OPTS="$(concat_lines "$MAVEN_PROJECTBASEDIR/.mvn/jvm.config") $MAVEN_OPTS" + +# For Cygwin, switch paths to Windows format before running java +if $cygwin; then + [ -n "$JAVA_HOME" ] && + JAVA_HOME=$(cygpath --path --windows "$JAVA_HOME") + [ -n "$CLASSPATH" ] && + CLASSPATH=$(cygpath --path --windows "$CLASSPATH") + [ -n "$MAVEN_PROJECTBASEDIR" ] && + MAVEN_PROJECTBASEDIR=$(cygpath --path --windows "$MAVEN_PROJECTBASEDIR") +fi + +# Provide a "standardized" way to retrieve the CLI args that will +# work with both Windows and non-Windows executions. +MAVEN_CMD_LINE_ARGS="$MAVEN_CONFIG $*" +export MAVEN_CMD_LINE_ARGS + +WRAPPER_LAUNCHER=org.apache.maven.wrapper.MavenWrapperMain + +# shellcheck disable=SC2086 # safe args +exec "$JAVACMD" \ + $MAVEN_OPTS \ + $MAVEN_DEBUG_OPTS \ + -classpath "$MAVEN_PROJECTBASEDIR/.mvn/wrapper/maven-wrapper.jar" \ + "-Dmaven.multiModuleProjectDirectory=${MAVEN_PROJECTBASEDIR}" \ + ${WRAPPER_LAUNCHER} $MAVEN_CONFIG "$@" diff --git a/aap-job/mvnw.cmd b/aap-job/mvnw.cmd new file mode 100644 index 0000000..c4586b5 --- /dev/null +++ b/aap-job/mvnw.cmd @@ -0,0 +1,205 @@ +@REM ---------------------------------------------------------------------------- +@REM Licensed to the Apache Software Foundation (ASF) under one +@REM or more contributor license agreements. See the NOTICE file +@REM distributed with this work for additional information +@REM regarding copyright ownership. The ASF licenses this file +@REM to you under the Apache License, Version 2.0 (the +@REM "License"); you may not use this file except in compliance +@REM with the License. You may obtain a copy of the License at +@REM +@REM http://www.apache.org/licenses/LICENSE-2.0 +@REM +@REM Unless required by applicable law or agreed to in writing, +@REM software distributed under the License is distributed on an +@REM "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +@REM KIND, either express or implied. See the License for the +@REM specific language governing permissions and limitations +@REM under the License. +@REM ---------------------------------------------------------------------------- + +@REM ---------------------------------------------------------------------------- +@REM Apache Maven Wrapper startup batch script, version 3.2.0 +@REM +@REM Required ENV vars: +@REM JAVA_HOME - location of a JDK home dir +@REM +@REM Optional ENV vars +@REM MAVEN_BATCH_ECHO - set to 'on' to enable the echoing of the batch commands +@REM MAVEN_BATCH_PAUSE - set to 'on' to wait for a keystroke before ending +@REM MAVEN_OPTS - parameters passed to the Java VM when running Maven +@REM e.g. to debug Maven itself, use +@REM set MAVEN_OPTS=-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=8000 +@REM MAVEN_SKIP_RC - flag to disable loading of mavenrc files +@REM ---------------------------------------------------------------------------- + +@REM Begin all REM lines with '@' in case MAVEN_BATCH_ECHO is 'on' +@echo off +@REM set title of command window +title %0 +@REM enable echoing by setting MAVEN_BATCH_ECHO to 'on' +@if "%MAVEN_BATCH_ECHO%" == "on" echo %MAVEN_BATCH_ECHO% + +@REM set %HOME% to equivalent of $HOME +if "%HOME%" == "" (set "HOME=%HOMEDRIVE%%HOMEPATH%") + +@REM Execute a user defined script before this one +if not "%MAVEN_SKIP_RC%" == "" goto skipRcPre +@REM check for pre script, once with legacy .bat ending and once with .cmd ending +if exist "%USERPROFILE%\mavenrc_pre.bat" call "%USERPROFILE%\mavenrc_pre.bat" %* +if exist "%USERPROFILE%\mavenrc_pre.cmd" call "%USERPROFILE%\mavenrc_pre.cmd" %* +:skipRcPre + +@setlocal + +set ERROR_CODE=0 + +@REM To isolate internal variables from possible post scripts, we use another setlocal +@setlocal + +@REM ==== START VALIDATION ==== +if not "%JAVA_HOME%" == "" goto OkJHome + +echo. +echo Error: JAVA_HOME not found in your environment. >&2 +echo Please set the JAVA_HOME variable in your environment to match the >&2 +echo location of your Java installation. >&2 +echo. +goto error + +:OkJHome +if exist "%JAVA_HOME%\bin\java.exe" goto init + +echo. +echo Error: JAVA_HOME is set to an invalid directory. >&2 +echo JAVA_HOME = "%JAVA_HOME%" >&2 +echo Please set the JAVA_HOME variable in your environment to match the >&2 +echo location of your Java installation. >&2 +echo. +goto error + +@REM ==== END VALIDATION ==== + +:init + +@REM Find the project base dir, i.e. the directory that contains the folder ".mvn". +@REM Fallback to current working directory if not found. + +set MAVEN_PROJECTBASEDIR=%MAVEN_BASEDIR% +IF NOT "%MAVEN_PROJECTBASEDIR%"=="" goto endDetectBaseDir + +set EXEC_DIR=%CD% +set WDIR=%EXEC_DIR% +:findBaseDir +IF EXIST "%WDIR%"\.mvn goto baseDirFound +cd .. +IF "%WDIR%"=="%CD%" goto baseDirNotFound +set WDIR=%CD% +goto findBaseDir + +:baseDirFound +set MAVEN_PROJECTBASEDIR=%WDIR% +cd "%EXEC_DIR%" +goto endDetectBaseDir + +:baseDirNotFound +set MAVEN_PROJECTBASEDIR=%EXEC_DIR% +cd "%EXEC_DIR%" + +:endDetectBaseDir + +IF NOT EXIST "%MAVEN_PROJECTBASEDIR%\.mvn\jvm.config" goto endReadAdditionalConfig + +@setlocal EnableExtensions EnableDelayedExpansion +for /F "usebackq delims=" %%a in ("%MAVEN_PROJECTBASEDIR%\.mvn\jvm.config") do set JVM_CONFIG_MAVEN_PROPS=!JVM_CONFIG_MAVEN_PROPS! %%a +@endlocal & set JVM_CONFIG_MAVEN_PROPS=%JVM_CONFIG_MAVEN_PROPS% + +:endReadAdditionalConfig + +SET MAVEN_JAVA_EXE="%JAVA_HOME%\bin\java.exe" +set WRAPPER_JAR="%MAVEN_PROJECTBASEDIR%\.mvn\wrapper\maven-wrapper.jar" +set WRAPPER_LAUNCHER=org.apache.maven.wrapper.MavenWrapperMain + +set WRAPPER_URL="https://repo.maven.apache.org/maven2/org/apache/maven/wrapper/maven-wrapper/3.2.0/maven-wrapper-3.2.0.jar" + +FOR /F "usebackq tokens=1,2 delims==" %%A IN ("%MAVEN_PROJECTBASEDIR%\.mvn\wrapper\maven-wrapper.properties") DO ( + IF "%%A"=="wrapperUrl" SET WRAPPER_URL=%%B +) + +@REM Extension to allow automatically downloading the maven-wrapper.jar from Maven-central +@REM This allows using the maven wrapper in projects that prohibit checking in binary data. +if exist %WRAPPER_JAR% ( + if "%MVNW_VERBOSE%" == "true" ( + echo Found %WRAPPER_JAR% + ) +) else ( + if not "%MVNW_REPOURL%" == "" ( + SET WRAPPER_URL="%MVNW_REPOURL%/org/apache/maven/wrapper/maven-wrapper/3.2.0/maven-wrapper-3.2.0.jar" + ) + if "%MVNW_VERBOSE%" == "true" ( + echo Couldn't find %WRAPPER_JAR%, downloading it ... + echo Downloading from: %WRAPPER_URL% + ) + + powershell -Command "&{"^ + "$webclient = new-object System.Net.WebClient;"^ + "if (-not ([string]::IsNullOrEmpty('%MVNW_USERNAME%') -and [string]::IsNullOrEmpty('%MVNW_PASSWORD%'))) {"^ + "$webclient.Credentials = new-object System.Net.NetworkCredential('%MVNW_USERNAME%', '%MVNW_PASSWORD%');"^ + "}"^ + "[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12; $webclient.DownloadFile('%WRAPPER_URL%', '%WRAPPER_JAR%')"^ + "}" + if "%MVNW_VERBOSE%" == "true" ( + echo Finished downloading %WRAPPER_JAR% + ) +) +@REM End of extension + +@REM If specified, validate the SHA-256 sum of the Maven wrapper jar file +SET WRAPPER_SHA_256_SUM="" +FOR /F "usebackq tokens=1,2 delims==" %%A IN ("%MAVEN_PROJECTBASEDIR%\.mvn\wrapper\maven-wrapper.properties") DO ( + IF "%%A"=="wrapperSha256Sum" SET WRAPPER_SHA_256_SUM=%%B +) +IF NOT %WRAPPER_SHA_256_SUM%=="" ( + powershell -Command "&{"^ + "$hash = (Get-FileHash \"%WRAPPER_JAR%\" -Algorithm SHA256).Hash.ToLower();"^ + "If('%WRAPPER_SHA_256_SUM%' -ne $hash){"^ + " Write-Output 'Error: Failed to validate Maven wrapper SHA-256, your Maven wrapper might be compromised.';"^ + " Write-Output 'Investigate or delete %WRAPPER_JAR% to attempt a clean download.';"^ + " Write-Output 'If you updated your Maven version, you need to update the specified wrapperSha256Sum property.';"^ + " exit 1;"^ + "}"^ + "}" + if ERRORLEVEL 1 goto error +) + +@REM Provide a "standardized" way to retrieve the CLI args that will +@REM work with both Windows and non-Windows executions. +set MAVEN_CMD_LINE_ARGS=%* + +%MAVEN_JAVA_EXE% ^ + %JVM_CONFIG_MAVEN_PROPS% ^ + %MAVEN_OPTS% ^ + %MAVEN_DEBUG_OPTS% ^ + -classpath %WRAPPER_JAR% ^ + "-Dmaven.multiModuleProjectDirectory=%MAVEN_PROJECTBASEDIR%" ^ + %WRAPPER_LAUNCHER% %MAVEN_CONFIG% %* +if ERRORLEVEL 1 goto error +goto end + +:error +set ERROR_CODE=1 + +:end +@endlocal & set ERROR_CODE=%ERROR_CODE% + +if not "%MAVEN_SKIP_RC%"=="" goto skipRcPost +@REM check for post script, once with legacy .bat ending and once with .cmd ending +if exist "%USERPROFILE%\mavenrc_post.bat" call "%USERPROFILE%\mavenrc_post.bat" +if exist "%USERPROFILE%\mavenrc_post.cmd" call "%USERPROFILE%\mavenrc_post.cmd" +:skipRcPost + +@REM pause the script if MAVEN_BATCH_PAUSE is set to 'on' +if "%MAVEN_BATCH_PAUSE%"=="on" pause + +if "%MAVEN_TERMINATE_CMD%"=="on" exit %ERROR_CODE% + +cmd /C exit /B %ERROR_CODE% diff --git a/aap-job/pom.xml b/aap-job/pom.xml new file mode 100644 index 0000000..3e80e4a --- /dev/null +++ b/aap-job/pom.xml @@ -0,0 +1,165 @@ + + + 4.0.0 + com.redhat.rhdh.orchestrator + serverless-workflow-aap-job + 1.0.0-SNAPSHOT + + 17 + 3.10.1 + kogito-bom + org.kie.kogito + 2.44.0.Alpha + UTF-8 + UTF-8 + quarkus-bom + io.quarkus.platform + 3.2.9.Final + true + 3.0.0-M7 + + + + + ${quarkus.platform.group-id} + ${quarkus.platform.artifact-id} + ${quarkus.platform.version} + pom + import + + + ${kogito.bom.group-id} + ${kogito.bom.artifact-id} + ${kogito.bom.version} + pom + import + + + + + + org.kie.kogito + kogito-quarkus-serverless-workflow + + + io.quarkus + quarkus-smallrye-health + + + org.kie.kogito + kogito-addons-quarkus-source-files + + + org.kie.kogito + kogito-quarkus-serverless-workflow-devui + + + org.kie.kogito + kogito-addons-quarkus-process-management + + + io.quarkus + quarkus-resteasy-jackson + + + io.quarkus + quarkus-arc + + + org.kie.kogito + kogito-addons-quarkus-data-index-inmemory + + + io.quarkus + quarkus-junit5 + test + + + + + + ${quarkus.platform.group-id} + quarkus-maven-plugin + ${quarkus.platform.version} + true + + + + build + generate-code + generate-code-tests + + + + + + maven-compiler-plugin + ${compiler-plugin.version} + + + -parameters + + + + + maven-surefire-plugin + ${surefire-plugin.version} + + + org.jboss.logmanager.LogManager + ${maven.home} + + + + + maven-failsafe-plugin + ${surefire-plugin.version} + + + + integration-test + verify + + + + ${project.build.directory}/${project.build.finalName}-runner + org.jboss.logmanager.LogManager + ${maven.home} + + + + + + + + + + native + + + native + + + + false + native + + + + + + + apache-repository-snapshots + https://repository.apache.org/content/repositories/snapshots/ + default + + true + + + true + daily + + + + diff --git a/aap-job/src/main/docker/Dockerfile.jvm b/aap-job/src/main/docker/Dockerfile.jvm new file mode 100644 index 0000000..3d330ec --- /dev/null +++ b/aap-job/src/main/docker/Dockerfile.jvm @@ -0,0 +1,98 @@ +#### +# This Dockerfile is used in order to build a container that runs the Quarkus application in JVM mode +# +# Before building the container image run: +# +# ./mvnw package +# +# Then, build the image with: +# +# docker build -f src/main/docker/Dockerfile.jvm -t quarkus/serverless-workflow-assessment-jvm . +# +# Then run the container using: +# +# docker run -i --rm -p 8080:8080 quarkus/serverless-workflow-assessment-jvm +# +# If you want to include the debug port into your docker image +# you will have to expose the debug port (default 5005 being the default) like this : EXPOSE 8080 5005. +# Additionally you will have to set -e JAVA_DEBUG=true and -e JAVA_DEBUG_PORT=*:5005 +# when running the container +# +# Then run the container using : +# +# docker run -i --rm -p 8080:8080 quarkus/serverless-workflow-assessment-jvm +# +# This image uses the `run-java.sh` script to run the application. +# This scripts computes the command line to execute your Java application, and +# includes memory/GC tuning. +# You can configure the behavior using the following environment properties: +# - JAVA_OPTS: JVM options passed to the `java` command (example: "-verbose:class") +# - JAVA_OPTS_APPEND: User specified Java options to be appended to generated options +# in JAVA_OPTS (example: "-Dsome.property=foo") +# - JAVA_MAX_MEM_RATIO: Is used when no `-Xmx` option is given in JAVA_OPTS. This is +# used to calculate a default maximal heap memory based on a containers restriction. +# If used in a container without any memory constraints for the container then this +# option has no effect. If there is a memory constraint then `-Xmx` is set to a ratio +# of the container available memory as set here. The default is `50` which means 50% +# of the available memory is used as an upper boundary. You can skip this mechanism by +# setting this value to `0` in which case no `-Xmx` option is added. +# - JAVA_INITIAL_MEM_RATIO: Is used when no `-Xms` option is given in JAVA_OPTS. This +# is used to calculate a default initial heap memory based on the maximum heap memory. +# If used in a container without any memory constraints for the container then this +# option has no effect. If there is a memory constraint then `-Xms` is set to a ratio +# of the `-Xmx` memory as set here. The default is `25` which means 25% of the `-Xmx` +# is used as the initial heap size. You can skip this mechanism by setting this value +# to `0` in which case no `-Xms` option is added (example: "25") +# - JAVA_MAX_INITIAL_MEM: Is used when no `-Xms` option is given in JAVA_OPTS. +# This is used to calculate the maximum value of the initial heap memory. If used in +# a container without any memory constraints for the container then this option has +# no effect. If there is a memory constraint then `-Xms` is limited to the value set +# here. The default is 4096MB which means the calculated value of `-Xms` never will +# be greater than 4096MB. The value of this variable is expressed in MB (example: "4096") +# - JAVA_DIAGNOSTICS: Set this to get some diagnostics information to standard output +# when things are happening. This option, if set to true, will set +# `-XX:+UnlockDiagnosticVMOptions`. Disabled by default (example: "true"). +# - JAVA_DEBUG: If set remote debugging will be switched on. Disabled by default (example: +# true"). +# - JAVA_DEBUG_PORT: Port used for remote debugging. Defaults to 5005 (example: "8787"). +# - CONTAINER_CORE_LIMIT: A calculated core limit as described in +# https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt. (example: "2") +# - CONTAINER_MAX_MEMORY: Memory limit given to the container (example: "1024"). +# - GC_MIN_HEAP_FREE_RATIO: Minimum percentage of heap free after GC to avoid expansion. +# (example: "20") +# - GC_MAX_HEAP_FREE_RATIO: Maximum percentage of heap free after GC to avoid shrinking. +# (example: "40") +# - GC_TIME_RATIO: Specifies the ratio of the time spent outside the garbage collection. +# (example: "4") +# - GC_ADAPTIVE_SIZE_POLICY_WEIGHT: The weighting given to the current GC time versus +# previous GC times. (example: "90") +# - GC_METASPACE_SIZE: The initial metaspace size. (example: "20") +# - GC_MAX_METASPACE_SIZE: The maximum metaspace size. (example: "100") +# - GC_CONTAINER_OPTIONS: Specify Java GC to use. The value of this variable should +# contain the necessary JRE command-line options to specify the required GC, which +# will override the default of `-XX:+UseParallelGC` (example: -XX:+UseG1GC). +# - HTTPS_PROXY: The location of the https proxy. (example: "myuser@127.0.0.1:8080") +# - HTTP_PROXY: The location of the http proxy. (example: "myuser@127.0.0.1:8080") +# - NO_PROXY: A comma separated lists of hosts, IP addresses or domains that can be +# accessed directly. (example: "foo.example.com,bar.example.com") +# +### +FROM registry.access.redhat.com/ubi8/openjdk-11:1.16 + +ENV LANGUAGE='en_US:en' + + +# We make four distinct layers so if there are application changes the library layers can be re-used +COPY --chown=185 target/quarkus-app/lib/ /deployments/lib/ +COPY --chown=185 target/quarkus-app/*.jar /deployments/ +COPY --chown=185 target/quarkus-app/app/ /deployments/app/ +COPY --chown=185 target/quarkus-app/quarkus/ /deployments/quarkus/ + +EXPOSE 8080 +USER 185 +ENV AB_JOLOKIA_OFF="" +ENV JAVA_OPTS="-Dquarkus.http.host=0.0.0.0 -Djava.util.logging.manager=org.jboss.logmanager.LogManager" +ENV JAVA_APP_JAR="/deployments/quarkus-run.jar" + +ENTRYPOINT [ "/opt/jboss/container/java/run/run-java.sh" ] + diff --git a/aap-job/src/main/docker/Dockerfile.legacy-jar b/aap-job/src/main/docker/Dockerfile.legacy-jar new file mode 100644 index 0000000..7a02661 --- /dev/null +++ b/aap-job/src/main/docker/Dockerfile.legacy-jar @@ -0,0 +1,94 @@ +#### +# This Dockerfile is used in order to build a container that runs the Quarkus application in JVM mode +# +# Before building the container image run: +# +# ./mvnw package -Dquarkus.package.type=legacy-jar +# +# Then, build the image with: +# +# docker build -f src/main/docker/Dockerfile.legacy-jar -t quarkus/serverless-workflow-assessment-legacy-jar . +# +# Then run the container using: +# +# docker run -i --rm -p 8080:8080 quarkus/serverless-workflow-assessment-legacy-jar +# +# If you want to include the debug port into your docker image +# you will have to expose the debug port (default 5005 being the default) like this : EXPOSE 8080 5005. +# Additionally you will have to set -e JAVA_DEBUG=true and -e JAVA_DEBUG_PORT=*:5005 +# when running the container +# +# Then run the container using : +# +# docker run -i --rm -p 8080:8080 quarkus/serverless-workflow-assessment-legacy-jar +# +# This image uses the `run-java.sh` script to run the application. +# This scripts computes the command line to execute your Java application, and +# includes memory/GC tuning. +# You can configure the behavior using the following environment properties: +# - JAVA_OPTS: JVM options passed to the `java` command (example: "-verbose:class") +# - JAVA_OPTS_APPEND: User specified Java options to be appended to generated options +# in JAVA_OPTS (example: "-Dsome.property=foo") +# - JAVA_MAX_MEM_RATIO: Is used when no `-Xmx` option is given in JAVA_OPTS. This is +# used to calculate a default maximal heap memory based on a containers restriction. +# If used in a container without any memory constraints for the container then this +# option has no effect. If there is a memory constraint then `-Xmx` is set to a ratio +# of the container available memory as set here. The default is `50` which means 50% +# of the available memory is used as an upper boundary. You can skip this mechanism by +# setting this value to `0` in which case no `-Xmx` option is added. +# - JAVA_INITIAL_MEM_RATIO: Is used when no `-Xms` option is given in JAVA_OPTS. This +# is used to calculate a default initial heap memory based on the maximum heap memory. +# If used in a container without any memory constraints for the container then this +# option has no effect. If there is a memory constraint then `-Xms` is set to a ratio +# of the `-Xmx` memory as set here. The default is `25` which means 25% of the `-Xmx` +# is used as the initial heap size. You can skip this mechanism by setting this value +# to `0` in which case no `-Xms` option is added (example: "25") +# - JAVA_MAX_INITIAL_MEM: Is used when no `-Xms` option is given in JAVA_OPTS. +# This is used to calculate the maximum value of the initial heap memory. If used in +# a container without any memory constraints for the container then this option has +# no effect. If there is a memory constraint then `-Xms` is limited to the value set +# here. The default is 4096MB which means the calculated value of `-Xms` never will +# be greater than 4096MB. The value of this variable is expressed in MB (example: "4096") +# - JAVA_DIAGNOSTICS: Set this to get some diagnostics information to standard output +# when things are happening. This option, if set to true, will set +# `-XX:+UnlockDiagnosticVMOptions`. Disabled by default (example: "true"). +# - JAVA_DEBUG: If set remote debugging will be switched on. Disabled by default (example: +# true"). +# - JAVA_DEBUG_PORT: Port used for remote debugging. Defaults to 5005 (example: "8787"). +# - CONTAINER_CORE_LIMIT: A calculated core limit as described in +# https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt. (example: "2") +# - CONTAINER_MAX_MEMORY: Memory limit given to the container (example: "1024"). +# - GC_MIN_HEAP_FREE_RATIO: Minimum percentage of heap free after GC to avoid expansion. +# (example: "20") +# - GC_MAX_HEAP_FREE_RATIO: Maximum percentage of heap free after GC to avoid shrinking. +# (example: "40") +# - GC_TIME_RATIO: Specifies the ratio of the time spent outside the garbage collection. +# (example: "4") +# - GC_ADAPTIVE_SIZE_POLICY_WEIGHT: The weighting given to the current GC time versus +# previous GC times. (example: "90") +# - GC_METASPACE_SIZE: The initial metaspace size. (example: "20") +# - GC_MAX_METASPACE_SIZE: The maximum metaspace size. (example: "100") +# - GC_CONTAINER_OPTIONS: Specify Java GC to use. The value of this variable should +# contain the necessary JRE command-line options to specify the required GC, which +# will override the default of `-XX:+UseParallelGC` (example: -XX:+UseG1GC). +# - HTTPS_PROXY: The location of the https proxy. (example: "myuser@127.0.0.1:8080") +# - HTTP_PROXY: The location of the http proxy. (example: "myuser@127.0.0.1:8080") +# - NO_PROXY: A comma separated lists of hosts, IP addresses or domains that can be +# accessed directly. (example: "foo.example.com,bar.example.com") +# +### +FROM registry.access.redhat.com/ubi8/openjdk-11:1.16 + +ENV LANGUAGE='en_US:en' + + +COPY target/lib/* /deployments/lib/ +COPY target/*-runner.jar /deployments/quarkus-run.jar + +EXPOSE 8080 +USER 185 +ENV AB_JOLOKIA_OFF="" +ENV JAVA_OPTS="-Dquarkus.http.host=0.0.0.0 -Djava.util.logging.manager=org.jboss.logmanager.LogManager" +ENV JAVA_APP_JAR="/deployments/quarkus-run.jar" + +ENTRYPOINT [ "/opt/jboss/container/java/run/run-java.sh" ] diff --git a/aap-job/src/main/docker/Dockerfile.native b/aap-job/src/main/docker/Dockerfile.native new file mode 100644 index 0000000..21b5383 --- /dev/null +++ b/aap-job/src/main/docker/Dockerfile.native @@ -0,0 +1,27 @@ +#### +# This Dockerfile is used in order to build a container that runs the Quarkus application in native (no JVM) mode. +# +# Before building the container image run: +# +# ./mvnw package -Dnative +# +# Then, build the image with: +# +# docker build -f src/main/docker/Dockerfile.native -t quarkus/serverless-workflow-assessment . +# +# Then run the container using: +# +# docker run -i --rm -p 8080:8080 quarkus/serverless-workflow-assessment +# +### +FROM registry.access.redhat.com/ubi8/ubi-minimal:8.8 +WORKDIR /work/ +RUN chown 1001 /work \ + && chmod "g+rwX" /work \ + && chown 1001:root /work +COPY --chown=1001:root target/*-runner /work/application + +EXPOSE 8080 +USER 1001 + +ENTRYPOINT ["./application", "-Dquarkus.http.host=0.0.0.0"] diff --git a/aap-job/src/main/docker/Dockerfile.native-micro b/aap-job/src/main/docker/Dockerfile.native-micro new file mode 100644 index 0000000..f70d843 --- /dev/null +++ b/aap-job/src/main/docker/Dockerfile.native-micro @@ -0,0 +1,30 @@ +#### +# This Dockerfile is used in order to build a container that runs the Quarkus application in native (no JVM) mode. +# It uses a micro base image, tuned for Quarkus native executables. +# It reduces the size of the resulting container image. +# Check https://quarkus.io/guides/quarkus-runtime-base-image for further information about this image. +# +# Before building the container image run: +# +# ./mvnw package -Dnative +# +# Then, build the image with: +# +# docker build -f src/main/docker/Dockerfile.native-micro -t quarkus/serverless-workflow-assessment . +# +# Then run the container using: +# +# docker run -i --rm -p 8080:8080 quarkus/serverless-workflow-assessment +# +### +FROM quay.io/quarkus/quarkus-micro-image:2.0 +WORKDIR /work/ +RUN chown 1001 /work \ + && chmod "g+rwX" /work \ + && chown 1001:root /work +COPY --chown=1001:root target/*-runner /work/application + +EXPOSE 8080 +USER 1001 + +ENTRYPOINT ["./application", "-Dquarkus.http.host=0.0.0.0"] diff --git a/aap-job/src/main/resources/aap-job.sw.yaml b/aap-job/src/main/resources/aap-job.sw.yaml new file mode 100644 index 0000000..97be0b3 --- /dev/null +++ b/aap-job/src/main/resources/aap-job.sw.yaml @@ -0,0 +1,94 @@ +specVersion: "0.8" +id: aap-job +name: Aap job +annotations: + - "workflow-type/infrastructure" +version: 0.0.1 +timeouts: + workflowExecTimeout: PT24H +start: LaunchJob +extensions: + - extensionid: workflow-uri-definitions + definitions: + notifications: "https://raw.githubusercontent.com/janus-idp/backstage-plugins/%40janus-idp/plugin-notifications-backend%401.0.3/plugins/notifications-backend/src/openapi.yaml" +dataInputSchema: schemas/app-job-input-schema.json +functions: + - name: launchJob + operation: specs/aap-openapi.yaml#launchJob + - name: getJob + operation: specs/aap-openapi.yaml#getJob + - name: createNotification + operation: notifications#createNotification + - name: logInfo + type: custom + operation: "sysout:INFO" +states: + - name: LaunchJob + type: operation + actions: + - functionRef: + refName: launchJob + arguments: + job_template_id: .jobTemplateId + actionDataFilter: + toStateData: .launchedJob + stateDataFilter: + output: ".launchedJob += { outputUrl: $SECRET.app_url + \"/#/jobs/playbook/\" + (.launchedJob.id|tostring) + \"/output\" }" + transition: GetJob + - name: GetJob + type: operation + actions: + - functionRef: + refName: logInfo + arguments: + message: "\"Sleeping before checking the aap job \\(.launchedJob)\"" + sleep: + after: PT30S + - functionRef: + refName: getJob + arguments: + job_id: .launchedJob.id + actionDataFilter: + toStateData: .readJob + transition: IsJobDone + - name: IsJobDone + type: switch + dataConditions: + - condition: (.readJob.status == "successful") + transition: + nextState: SendSuccessNotification + - condition: (.readJob.failed == true) + transition: + nextState: SendFailureNotification + defaultCondition: + transition: GetJob + - name: SendFailureNotification + type: operation + actions: + - functionRef: + refName: "logInfo" + arguments: + message: '"AAP job workflow id: " + $WORKFLOW.instanceId + " for job template id: " + (.jobTemplateId|tostring) + " failed. Click the link for details: " + .launchedJob.outputUrl' + # - functionRef: + # refName: createNotification + # arguments: + # title: '"AAP Job Workflow " + $WORKFLOW.instanceId + " Failed"' + # message: '"AAP job workflow id: " + $WORKFLOW.instanceId + " for job template id: " + (.jobTemplateId|tostring) + " failed. Click the link for details: " + .launchedJob.outputUrl' + # origin: "AAP Job Workflow" + # topic: "AAP Job Workflow" + end: true + - name: SendSuccessNotification + type: operation + actions: + - functionRef: + refName: "logInfo" + arguments: + message: '"AAP job workflow id: " + $WORKFLOW.instanceId + " for job template id: " + (.jobTemplateId|tostring) + " succeeded. Click the link for details: " + .launchedJob.outputUrl' + # - functionRef: + # refName: createNotification + # arguments: + # title: '"AAP Job Workflow " + $WORKFLOW.instanceId + " Succeeded"' + # message: '"AAP job workflow id: " + $WORKFLOW.instanceId + " for job template id: " + (.jobTemplateId|tostring) + " succeeded. Click the link for details: " + .launchedJob.outputUrl' + # origin: "AAP Job Workflow" + # topic: "AAP Job Workflow" + end: true \ No newline at end of file diff --git a/aap-job/src/main/resources/application.properties b/aap-job/src/main/resources/application.properties new file mode 100644 index 0000000..884b03a --- /dev/null +++ b/aap-job/src/main/resources/application.properties @@ -0,0 +1,8 @@ +# Notifications Settings +quarkus.rest-client.notifications_openapi_yaml.url=${BACKSTAGE_NOTIFICATIONS_URL} + +# Ansible Automation Platform Settings +app_url=${AAP_URL} +quarkus.rest-client.aap_openapi_yaml.url=${app_url} +quarkus.openapi-generator.aap_openapi_yaml.auth.basicAuth.username=${AAP_USERNAME} +quarkus.openapi-generator.aap_openapi_yaml.auth.basicAuth.password=${AAP_PASSWORD} \ No newline at end of file diff --git a/aap-job/src/main/resources/schemas/app-job-input-schema.json b/aap-job/src/main/resources/schemas/app-job-input-schema.json new file mode 100644 index 0000000..8d92484 --- /dev/null +++ b/aap-job/src/main/resources/schemas/app-job-input-schema.json @@ -0,0 +1,13 @@ +{ + "$schema": "http://json-schema.org/draft-07/schema#", + "type": "object", + "properties": { + "jobTemplateId": { + "type": "integer", + "description": "Job template id" + } + }, + "required": [ + "jobTemplateId" + ] +} \ No newline at end of file diff --git a/aap-job/src/main/resources/specs/aap-openapi.yaml b/aap-job/src/main/resources/specs/aap-openapi.yaml new file mode 100644 index 0000000..6d4326d --- /dev/null +++ b/aap-job/src/main/resources/specs/aap-openapi.yaml @@ -0,0 +1,88 @@ +openapi: 3.0.3 +info: + title: The AAP Rest Api + version: v2 +servers: + - url: https://your-app-platform.io/ +paths: + /api/v2/job_templates/{job_template_id}/launch/: + post: + description: Launch a job from a template id + operationId: launchJob + parameters: + - name: job_template_id + in: path + required: true + schema: + type: integer + responses: + "201": + description: Created + content: + application/json: + schema: + $ref: '#/components/schemas/LaunchJobResponse' + "401": + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/UnauthorizedError' + security: + - basicAuth: [] + /api/v2/jobs/{job_id}/: + get: + description: Retrieve a job from a job id + operationId: getJob + parameters: + - name: job_id + in: path + required: true + schema: + type: integer + responses: + "200": + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/GetJobResponse' + "401": + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/UnauthorizedError' + security: + - basicAuth: [] +components: + schemas: + LaunchJobResponse: + type: object + properties: + id: + type: integer + failed: + type: boolean + status: + type: string + additionalProperties: false + GetJobResponse: + type: object + properties: + id: + type: integer + failed: + type: boolean + status: + type: string + additionalProperties: false + UnauthorizedError: + type: object + properties: + detail: + type: string + securitySchemes: + basicAuth: + type: http + scheme: basic \ No newline at end of file From f0ee72bc0e65abf5c9859a240693b7aa7e425ff3 Mon Sep 17 00:00:00 2001 From: Annel Ketcha Date: Fri, 15 Mar 2024 11:08:14 -0400 Subject: [PATCH 2/7] fix review comments --- aap-job/pom.xml | 22 ++++++-------------- aap-job/src/main/resources/aap-job.svg | 1 + aap-job/src/main/resources/aap-job.sw.yaml | 24 ++++++++-------------- 3 files changed, 15 insertions(+), 32 deletions(-) create mode 100644 aap-job/src/main/resources/aap-job.svg diff --git a/aap-job/pom.xml b/aap-job/pom.xml index 3e80e4a..1a48eec 100644 --- a/aap-job/pom.xml +++ b/aap-job/pom.xml @@ -2,23 +2,13 @@ 4.0.0 - com.redhat.rhdh.orchestrator serverless-workflow-aap-job - 1.0.0-SNAPSHOT - - 17 - 3.10.1 - kogito-bom - org.kie.kogito - 2.44.0.Alpha - UTF-8 - UTF-8 - quarkus-bom - io.quarkus.platform - 3.2.9.Final - true - 3.0.0-M7 - + + dev.parodos + swf-parent + 1.0.0-SNAPSHOT + ../swf-parent + diff --git a/aap-job/src/main/resources/aap-job.svg b/aap-job/src/main/resources/aap-job.svg new file mode 100644 index 0000000..5cce765 --- /dev/null +++ b/aap-job/src/main/resources/aap-job.svg @@ -0,0 +1 @@ +StartLaunchJobGetJobIsJobDoneSendFailureNotifica tion EndSendSuccessNotific ation End(.readJob.s... (.readJob.s... (.readJob.fa... (.readJob.fa... \ No newline at end of file diff --git a/aap-job/src/main/resources/aap-job.sw.yaml b/aap-job/src/main/resources/aap-job.sw.yaml index 97be0b3..74e0511 100644 --- a/aap-job/src/main/resources/aap-job.sw.yaml +++ b/aap-job/src/main/resources/aap-job.sw.yaml @@ -66,29 +66,21 @@ states: type: operation actions: - functionRef: - refName: "logInfo" + refName: createNotification arguments: + title: '"AAP Job Workflow " + $WORKFLOW.instanceId + " Failed"' message: '"AAP job workflow id: " + $WORKFLOW.instanceId + " for job template id: " + (.jobTemplateId|tostring) + " failed. Click the link for details: " + .launchedJob.outputUrl' - # - functionRef: - # refName: createNotification - # arguments: - # title: '"AAP Job Workflow " + $WORKFLOW.instanceId + " Failed"' - # message: '"AAP job workflow id: " + $WORKFLOW.instanceId + " for job template id: " + (.jobTemplateId|tostring) + " failed. Click the link for details: " + .launchedJob.outputUrl' - # origin: "AAP Job Workflow" - # topic: "AAP Job Workflow" + origin: "AAP Job Workflow" + topic: "AAP Job Workflow" end: true - name: SendSuccessNotification type: operation actions: - functionRef: - refName: "logInfo" + refName: createNotification arguments: + title: '"AAP Job Workflow " + $WORKFLOW.instanceId + " Succeeded"' message: '"AAP job workflow id: " + $WORKFLOW.instanceId + " for job template id: " + (.jobTemplateId|tostring) + " succeeded. Click the link for details: " + .launchedJob.outputUrl' - # - functionRef: - # refName: createNotification - # arguments: - # title: '"AAP Job Workflow " + $WORKFLOW.instanceId + " Succeeded"' - # message: '"AAP job workflow id: " + $WORKFLOW.instanceId + " for job template id: " + (.jobTemplateId|tostring) + " succeeded. Click the link for details: " + .launchedJob.outputUrl' - # origin: "AAP Job Workflow" - # topic: "AAP Job Workflow" + origin: "AAP Job Workflow" + topic: "AAP Job Workflow" end: true \ No newline at end of file From 996e89799af1fb71aca0f72fe552bf632dcc0b31 Mon Sep 17 00:00:00 2001 From: Annel Ketcha Date: Fri, 15 Mar 2024 11:08:30 -0400 Subject: [PATCH 3/7] update kogito version --- swf-parent/pom.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/swf-parent/pom.xml b/swf-parent/pom.xml index 5aeaaf4..a215794 100644 --- a/swf-parent/pom.xml +++ b/swf-parent/pom.xml @@ -18,7 +18,7 @@ 3.2.9.Final org.kie.kogito kogito-bom - 999-SNAPSHOT + 2.44.0.Alpha true 3.0.0-M7 From b955dfa12c81ccf5fa89bb5fcf44bb3e0a39ef5a Mon Sep 17 00:00:00 2001 From: Annel Ketcha Date: Tue, 19 Mar 2024 16:34:26 -0400 Subject: [PATCH 4/7] update workflow to add additional inputs --- aap-job/README.md | 37 +++++++++---------- aap-job/{src/main/resources => }/aap-job.svg | 2 +- aap-job/src/main/resources/aap-job.sw.yaml | 13 ++++++- .../src/main/resources/application.properties | 2 +- .../schemas/app-job-input-schema.json | 18 ++++++++- .../src/main/resources/specs/aap-openapi.yaml | 16 ++++++++ 6 files changed, 63 insertions(+), 25 deletions(-) rename aap-job/{src/main/resources => }/aap-job.svg (62%) diff --git a/aap-job/README.md b/aap-job/README.md index c8569e3..895b5d2 100644 --- a/aap-job/README.md +++ b/aap-job/README.md @@ -1,6 +1,8 @@ # Ansible automation platform job workflow -This workflow launches an Ansible Automation Platform (AAP) job from a given job template id and send out a notification for success or failure upon completion. - +This workflow launches an Ansible Automation Platform (AAP) job and send out a notification for success or failure upon completion. +The following two (2) inputs are required: +- Job template Id +- Inventory group ## Prerequisite * A running instance of AAP with admin credentials. @@ -21,29 +23,24 @@ mvn clean quarkus:dev Example of POST to trigger the workflow: ```bash -curl -XPOST -H "Content-Type: application/json" http://localhost:8080/app-job -d '{"jobTemplateId": _JOB_TEMPLATE_ID_}' +curl -XPOST -H "Content-Type: application/json" http://localhost:8080/aap-job -d '{"jobTemplateId": _JOB_TEMPLATE_ID_, "inventoryGroup": "_INVENTORY_GROUP_", "limit": "_LIMIT_"}' ``` Response: ``` { - "workflowdata": { - "launchedJob": { - "id": 31, - "failed": false, - "status": "pending", - "outputUrl": "https://your-app-platform.io/#/jobs/playbook/31/output" - }, - "jobTemplateId": 7 - } + "id": "832685aa-0df0-4cf9-9e91-820b013efda6", + "workflowdata": { + "jobTemplateId": 17, + "inventoryGroup": "ALL_rhel", + "limit": "fancy-seal", + "launchedJob": { + "id": 29, + "failed": false, + "status": "pending", + "outputUrl": "https://student1.2df46.example.opentlc.com/#/jobs/playbook/29/output" + } + } } ``` -Subsequently (about 30s delay), the workflow will repeatedly pull job with its status to check if the job is done with success or failure to send out relevant notification. - -For job completion with success, the log outputs look like: -``` -[org.kie.kog.ser.wor.dev.DevModeServerlessWorkflowLogger] (executor-thread-2) Triggered node 'getJob' for process 'aap-job' (3aa93369-5914-4211-b7f3-b218de1630e1) -[org.kie.kog.ser.wor.dev.DevModeServerlessWorkflowLogger] (executor-thread-2) Triggered node 'IsJobDone' for process 'aap-job' (3aa93369-5914-4211-b7f3-b218de1630e1) -[org.kie.kog.ser.wor.dev.DevModeServerlessWorkflowLogger] (executor-thread-2) Triggered node 'SendSuccessNotification' for process 'aap-job' (3aa93369-5914-4211-b7f3-b218de1630e1) -``` diff --git a/aap-job/src/main/resources/aap-job.svg b/aap-job/aap-job.svg similarity index 62% rename from aap-job/src/main/resources/aap-job.svg rename to aap-job/aap-job.svg index 5cce765..2645012 100644 --- a/aap-job/src/main/resources/aap-job.svg +++ b/aap-job/aap-job.svg @@ -1 +1 @@ -StartLaunchJobGetJobIsJobDoneSendFailureNotifica tion EndSendSuccessNotific ation End(.readJob.s... (.readJob.s... (.readJob.fa... (.readJob.fa... \ No newline at end of file +StartLaunchJobGetJobIsJobDoneSendFailureNotifica tion EndSendSuccessNotific ation End(.readJob.s... (.readJob.s... (.readJob.fa... (.readJob.fa... \ No newline at end of file diff --git a/aap-job/src/main/resources/aap-job.sw.yaml b/aap-job/src/main/resources/aap-job.sw.yaml index 74e0511..e9d3ed5 100644 --- a/aap-job/src/main/resources/aap-job.sw.yaml +++ b/aap-job/src/main/resources/aap-job.sw.yaml @@ -30,6 +30,9 @@ states: refName: launchJob arguments: job_template_id: .jobTemplateId + limit: .limit + extra_vars: + rhel_inventory_group: .inventoryGroup actionDataFilter: toStateData: .launchedJob stateDataFilter: @@ -69,9 +72,12 @@ states: refName: createNotification arguments: title: '"AAP Job Workflow " + $WORKFLOW.instanceId + " Failed"' - message: '"AAP job workflow id: " + $WORKFLOW.instanceId + " for job template id: " + (.jobTemplateId|tostring) + " failed. Click the link for details: " + .launchedJob.outputUrl' + message: '"AAP job workflow id: " + $WORKFLOW.instanceId + " for job template id: " + (.jobTemplateId|tostring) + " failed."' origin: "AAP Job Workflow" topic: "AAP Job Workflow" + actions: + - title: "AAP Job Output" + url: .launchedJob.outputUrl end: true - name: SendSuccessNotification type: operation @@ -80,7 +86,10 @@ states: refName: createNotification arguments: title: '"AAP Job Workflow " + $WORKFLOW.instanceId + " Succeeded"' - message: '"AAP job workflow id: " + $WORKFLOW.instanceId + " for job template id: " + (.jobTemplateId|tostring) + " succeeded. Click the link for details: " + .launchedJob.outputUrl' + message: '"AAP job workflow id: " + $WORKFLOW.instanceId + " for job template id: " + (.jobTemplateId|tostring) + " succeeded."' origin: "AAP Job Workflow" topic: "AAP Job Workflow" + actions: + - title: "AAP Job Output" + url: .launchedJob.outputUrl end: true \ No newline at end of file diff --git a/aap-job/src/main/resources/application.properties b/aap-job/src/main/resources/application.properties index 884b03a..3865475 100644 --- a/aap-job/src/main/resources/application.properties +++ b/aap-job/src/main/resources/application.properties @@ -1,5 +1,5 @@ # Notifications Settings -quarkus.rest-client.notifications_openapi_yaml.url=${BACKSTAGE_NOTIFICATIONS_URL} +quarkus.rest-client.notifications_openapi_yaml.url=${BACKSTAGE_NOTIFICATIONS_URL:http://localhost} # Ansible Automation Platform Settings app_url=${AAP_URL} diff --git a/aap-job/src/main/resources/schemas/app-job-input-schema.json b/aap-job/src/main/resources/schemas/app-job-input-schema.json index 8d92484..96fb03b 100644 --- a/aap-job/src/main/resources/schemas/app-job-input-schema.json +++ b/aap-job/src/main/resources/schemas/app-job-input-schema.json @@ -5,9 +5,25 @@ "jobTemplateId": { "type": "integer", "description": "Job template id" + }, + "inventoryGroup": { + "type": "string", + "description": "Inventory group" + }, + "limit": { + "type": "string", + "description": "Exta variables" } }, "required": [ - "jobTemplateId" + "jobTemplateId", + "inventoryGroup" + ], + "examples": [ + { + "jobTemplateId": 17, + "limit": "fancy-seal", + "inventoryGroup": "ALL_rhel" + } ] } \ No newline at end of file diff --git a/aap-job/src/main/resources/specs/aap-openapi.yaml b/aap-job/src/main/resources/specs/aap-openapi.yaml index 6d4326d..ee09dd8 100644 --- a/aap-job/src/main/resources/specs/aap-openapi.yaml +++ b/aap-job/src/main/resources/specs/aap-openapi.yaml @@ -15,6 +15,11 @@ paths: required: true schema: type: integer + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/LaunchJobRequest' responses: "201": description: Created @@ -57,6 +62,17 @@ paths: - basicAuth: [] components: schemas: + LaunchJobRequest: + type: object + properties: + limit: + type: string + extra_vars: + type: object + properties: + rhel_inventory_group: + type: string + additionalProperties: false LaunchJobResponse: type: object properties: From 3d25e4e57f33372cfac1336ee1eb56d0a9b12139 Mon Sep 17 00:00:00 2001 From: Annel Ketcha Date: Tue, 19 Mar 2024 16:37:14 -0400 Subject: [PATCH 5/7] update url --- aap-job/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/aap-job/README.md b/aap-job/README.md index 895b5d2..6b0db4e 100644 --- a/aap-job/README.md +++ b/aap-job/README.md @@ -38,7 +38,7 @@ Response: "id": 29, "failed": false, "status": "pending", - "outputUrl": "https://student1.2df46.example.opentlc.com/#/jobs/playbook/29/output" + "outputUrl": "https://your-app-platform.io/#/jobs/playbook/29/output" } } } From 70daf39e78229dfbdba76d179ac291a3a735e886 Mon Sep 17 00:00:00 2001 From: Annel Ketcha Date: Wed, 20 Mar 2024 10:04:27 -0400 Subject: [PATCH 6/7] update and remove unnecessary files --- aap-job/README.md | 25 +++-- aap-job/src/main/docker/Dockerfile.jvm | 98 ------------------- aap-job/src/main/docker/Dockerfile.legacy-jar | 94 ------------------ aap-job/src/main/docker/Dockerfile.native | 27 ----- .../src/main/docker/Dockerfile.native-micro | 30 ------ aap-job/src/main/resources/aap-job.sw.yaml | 7 +- .../src/main/resources/application.properties | 2 +- 7 files changed, 19 insertions(+), 264 deletions(-) delete mode 100644 aap-job/src/main/docker/Dockerfile.jvm delete mode 100644 aap-job/src/main/docker/Dockerfile.legacy-jar delete mode 100644 aap-job/src/main/docker/Dockerfile.native delete mode 100644 aap-job/src/main/docker/Dockerfile.native-micro diff --git a/aap-job/README.md b/aap-job/README.md index 6b0db4e..b523ec8 100644 --- a/aap-job/README.md +++ b/aap-job/README.md @@ -4,16 +4,21 @@ The following two (2) inputs are required: - Job template Id - Inventory group -## Prerequisite +## Prerequisites * A running instance of AAP with admin credentials. * A running instance of Backstage notification plugin. -### Requiqued Properties -List of required properties to run the workflow: -- BACKSTAGE_NOTIFICATIONS_URL -- AAP_URL -- AAP_USERNAME -- AAP_PASSWORD +## AAP job flow +![SWF VIZ](https://github.com/parodos-dev/serverless-workflow-examples/blob/main/aap-job/aap-job.svg) + +## Workflow application configuration +Application properties can be initialized from environment variables before running the application: + +| Environment variable | Description | Mandatory | +|-----------------------|-------------|-----------| +| `AAP_URL` | The AAP server URL | ✅ | +| `AAP_USERNAME` | The AAP server password | ✅ | +| `AAP_PASSWORD` | The AAP server password | ✅ | ## How to run @@ -31,9 +36,9 @@ Response: { "id": "832685aa-0df0-4cf9-9e91-820b013efda6", "workflowdata": { - "jobTemplateId": 17, - "inventoryGroup": "ALL_rhel", - "limit": "fancy-seal", + "jobTemplateId": _JOB_TEMPLATE_ID_, + "inventoryGroup": "_INVENTORY_GROUP_", + "limit": "_LIMIT_", "launchedJob": { "id": 29, "failed": false, diff --git a/aap-job/src/main/docker/Dockerfile.jvm b/aap-job/src/main/docker/Dockerfile.jvm deleted file mode 100644 index 3d330ec..0000000 --- a/aap-job/src/main/docker/Dockerfile.jvm +++ /dev/null @@ -1,98 +0,0 @@ -#### -# This Dockerfile is used in order to build a container that runs the Quarkus application in JVM mode -# -# Before building the container image run: -# -# ./mvnw package -# -# Then, build the image with: -# -# docker build -f src/main/docker/Dockerfile.jvm -t quarkus/serverless-workflow-assessment-jvm . -# -# Then run the container using: -# -# docker run -i --rm -p 8080:8080 quarkus/serverless-workflow-assessment-jvm -# -# If you want to include the debug port into your docker image -# you will have to expose the debug port (default 5005 being the default) like this : EXPOSE 8080 5005. -# Additionally you will have to set -e JAVA_DEBUG=true and -e JAVA_DEBUG_PORT=*:5005 -# when running the container -# -# Then run the container using : -# -# docker run -i --rm -p 8080:8080 quarkus/serverless-workflow-assessment-jvm -# -# This image uses the `run-java.sh` script to run the application. -# This scripts computes the command line to execute your Java application, and -# includes memory/GC tuning. -# You can configure the behavior using the following environment properties: -# - JAVA_OPTS: JVM options passed to the `java` command (example: "-verbose:class") -# - JAVA_OPTS_APPEND: User specified Java options to be appended to generated options -# in JAVA_OPTS (example: "-Dsome.property=foo") -# - JAVA_MAX_MEM_RATIO: Is used when no `-Xmx` option is given in JAVA_OPTS. This is -# used to calculate a default maximal heap memory based on a containers restriction. -# If used in a container without any memory constraints for the container then this -# option has no effect. If there is a memory constraint then `-Xmx` is set to a ratio -# of the container available memory as set here. The default is `50` which means 50% -# of the available memory is used as an upper boundary. You can skip this mechanism by -# setting this value to `0` in which case no `-Xmx` option is added. -# - JAVA_INITIAL_MEM_RATIO: Is used when no `-Xms` option is given in JAVA_OPTS. This -# is used to calculate a default initial heap memory based on the maximum heap memory. -# If used in a container without any memory constraints for the container then this -# option has no effect. If there is a memory constraint then `-Xms` is set to a ratio -# of the `-Xmx` memory as set here. The default is `25` which means 25% of the `-Xmx` -# is used as the initial heap size. You can skip this mechanism by setting this value -# to `0` in which case no `-Xms` option is added (example: "25") -# - JAVA_MAX_INITIAL_MEM: Is used when no `-Xms` option is given in JAVA_OPTS. -# This is used to calculate the maximum value of the initial heap memory. If used in -# a container without any memory constraints for the container then this option has -# no effect. If there is a memory constraint then `-Xms` is limited to the value set -# here. The default is 4096MB which means the calculated value of `-Xms` never will -# be greater than 4096MB. The value of this variable is expressed in MB (example: "4096") -# - JAVA_DIAGNOSTICS: Set this to get some diagnostics information to standard output -# when things are happening. This option, if set to true, will set -# `-XX:+UnlockDiagnosticVMOptions`. Disabled by default (example: "true"). -# - JAVA_DEBUG: If set remote debugging will be switched on. Disabled by default (example: -# true"). -# - JAVA_DEBUG_PORT: Port used for remote debugging. Defaults to 5005 (example: "8787"). -# - CONTAINER_CORE_LIMIT: A calculated core limit as described in -# https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt. (example: "2") -# - CONTAINER_MAX_MEMORY: Memory limit given to the container (example: "1024"). -# - GC_MIN_HEAP_FREE_RATIO: Minimum percentage of heap free after GC to avoid expansion. -# (example: "20") -# - GC_MAX_HEAP_FREE_RATIO: Maximum percentage of heap free after GC to avoid shrinking. -# (example: "40") -# - GC_TIME_RATIO: Specifies the ratio of the time spent outside the garbage collection. -# (example: "4") -# - GC_ADAPTIVE_SIZE_POLICY_WEIGHT: The weighting given to the current GC time versus -# previous GC times. (example: "90") -# - GC_METASPACE_SIZE: The initial metaspace size. (example: "20") -# - GC_MAX_METASPACE_SIZE: The maximum metaspace size. (example: "100") -# - GC_CONTAINER_OPTIONS: Specify Java GC to use. The value of this variable should -# contain the necessary JRE command-line options to specify the required GC, which -# will override the default of `-XX:+UseParallelGC` (example: -XX:+UseG1GC). -# - HTTPS_PROXY: The location of the https proxy. (example: "myuser@127.0.0.1:8080") -# - HTTP_PROXY: The location of the http proxy. (example: "myuser@127.0.0.1:8080") -# - NO_PROXY: A comma separated lists of hosts, IP addresses or domains that can be -# accessed directly. (example: "foo.example.com,bar.example.com") -# -### -FROM registry.access.redhat.com/ubi8/openjdk-11:1.16 - -ENV LANGUAGE='en_US:en' - - -# We make four distinct layers so if there are application changes the library layers can be re-used -COPY --chown=185 target/quarkus-app/lib/ /deployments/lib/ -COPY --chown=185 target/quarkus-app/*.jar /deployments/ -COPY --chown=185 target/quarkus-app/app/ /deployments/app/ -COPY --chown=185 target/quarkus-app/quarkus/ /deployments/quarkus/ - -EXPOSE 8080 -USER 185 -ENV AB_JOLOKIA_OFF="" -ENV JAVA_OPTS="-Dquarkus.http.host=0.0.0.0 -Djava.util.logging.manager=org.jboss.logmanager.LogManager" -ENV JAVA_APP_JAR="/deployments/quarkus-run.jar" - -ENTRYPOINT [ "/opt/jboss/container/java/run/run-java.sh" ] - diff --git a/aap-job/src/main/docker/Dockerfile.legacy-jar b/aap-job/src/main/docker/Dockerfile.legacy-jar deleted file mode 100644 index 7a02661..0000000 --- a/aap-job/src/main/docker/Dockerfile.legacy-jar +++ /dev/null @@ -1,94 +0,0 @@ -#### -# This Dockerfile is used in order to build a container that runs the Quarkus application in JVM mode -# -# Before building the container image run: -# -# ./mvnw package -Dquarkus.package.type=legacy-jar -# -# Then, build the image with: -# -# docker build -f src/main/docker/Dockerfile.legacy-jar -t quarkus/serverless-workflow-assessment-legacy-jar . -# -# Then run the container using: -# -# docker run -i --rm -p 8080:8080 quarkus/serverless-workflow-assessment-legacy-jar -# -# If you want to include the debug port into your docker image -# you will have to expose the debug port (default 5005 being the default) like this : EXPOSE 8080 5005. -# Additionally you will have to set -e JAVA_DEBUG=true and -e JAVA_DEBUG_PORT=*:5005 -# when running the container -# -# Then run the container using : -# -# docker run -i --rm -p 8080:8080 quarkus/serverless-workflow-assessment-legacy-jar -# -# This image uses the `run-java.sh` script to run the application. -# This scripts computes the command line to execute your Java application, and -# includes memory/GC tuning. -# You can configure the behavior using the following environment properties: -# - JAVA_OPTS: JVM options passed to the `java` command (example: "-verbose:class") -# - JAVA_OPTS_APPEND: User specified Java options to be appended to generated options -# in JAVA_OPTS (example: "-Dsome.property=foo") -# - JAVA_MAX_MEM_RATIO: Is used when no `-Xmx` option is given in JAVA_OPTS. This is -# used to calculate a default maximal heap memory based on a containers restriction. -# If used in a container without any memory constraints for the container then this -# option has no effect. If there is a memory constraint then `-Xmx` is set to a ratio -# of the container available memory as set here. The default is `50` which means 50% -# of the available memory is used as an upper boundary. You can skip this mechanism by -# setting this value to `0` in which case no `-Xmx` option is added. -# - JAVA_INITIAL_MEM_RATIO: Is used when no `-Xms` option is given in JAVA_OPTS. This -# is used to calculate a default initial heap memory based on the maximum heap memory. -# If used in a container without any memory constraints for the container then this -# option has no effect. If there is a memory constraint then `-Xms` is set to a ratio -# of the `-Xmx` memory as set here. The default is `25` which means 25% of the `-Xmx` -# is used as the initial heap size. You can skip this mechanism by setting this value -# to `0` in which case no `-Xms` option is added (example: "25") -# - JAVA_MAX_INITIAL_MEM: Is used when no `-Xms` option is given in JAVA_OPTS. -# This is used to calculate the maximum value of the initial heap memory. If used in -# a container without any memory constraints for the container then this option has -# no effect. If there is a memory constraint then `-Xms` is limited to the value set -# here. The default is 4096MB which means the calculated value of `-Xms` never will -# be greater than 4096MB. The value of this variable is expressed in MB (example: "4096") -# - JAVA_DIAGNOSTICS: Set this to get some diagnostics information to standard output -# when things are happening. This option, if set to true, will set -# `-XX:+UnlockDiagnosticVMOptions`. Disabled by default (example: "true"). -# - JAVA_DEBUG: If set remote debugging will be switched on. Disabled by default (example: -# true"). -# - JAVA_DEBUG_PORT: Port used for remote debugging. Defaults to 5005 (example: "8787"). -# - CONTAINER_CORE_LIMIT: A calculated core limit as described in -# https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt. (example: "2") -# - CONTAINER_MAX_MEMORY: Memory limit given to the container (example: "1024"). -# - GC_MIN_HEAP_FREE_RATIO: Minimum percentage of heap free after GC to avoid expansion. -# (example: "20") -# - GC_MAX_HEAP_FREE_RATIO: Maximum percentage of heap free after GC to avoid shrinking. -# (example: "40") -# - GC_TIME_RATIO: Specifies the ratio of the time spent outside the garbage collection. -# (example: "4") -# - GC_ADAPTIVE_SIZE_POLICY_WEIGHT: The weighting given to the current GC time versus -# previous GC times. (example: "90") -# - GC_METASPACE_SIZE: The initial metaspace size. (example: "20") -# - GC_MAX_METASPACE_SIZE: The maximum metaspace size. (example: "100") -# - GC_CONTAINER_OPTIONS: Specify Java GC to use. The value of this variable should -# contain the necessary JRE command-line options to specify the required GC, which -# will override the default of `-XX:+UseParallelGC` (example: -XX:+UseG1GC). -# - HTTPS_PROXY: The location of the https proxy. (example: "myuser@127.0.0.1:8080") -# - HTTP_PROXY: The location of the http proxy. (example: "myuser@127.0.0.1:8080") -# - NO_PROXY: A comma separated lists of hosts, IP addresses or domains that can be -# accessed directly. (example: "foo.example.com,bar.example.com") -# -### -FROM registry.access.redhat.com/ubi8/openjdk-11:1.16 - -ENV LANGUAGE='en_US:en' - - -COPY target/lib/* /deployments/lib/ -COPY target/*-runner.jar /deployments/quarkus-run.jar - -EXPOSE 8080 -USER 185 -ENV AB_JOLOKIA_OFF="" -ENV JAVA_OPTS="-Dquarkus.http.host=0.0.0.0 -Djava.util.logging.manager=org.jboss.logmanager.LogManager" -ENV JAVA_APP_JAR="/deployments/quarkus-run.jar" - -ENTRYPOINT [ "/opt/jboss/container/java/run/run-java.sh" ] diff --git a/aap-job/src/main/docker/Dockerfile.native b/aap-job/src/main/docker/Dockerfile.native deleted file mode 100644 index 21b5383..0000000 --- a/aap-job/src/main/docker/Dockerfile.native +++ /dev/null @@ -1,27 +0,0 @@ -#### -# This Dockerfile is used in order to build a container that runs the Quarkus application in native (no JVM) mode. -# -# Before building the container image run: -# -# ./mvnw package -Dnative -# -# Then, build the image with: -# -# docker build -f src/main/docker/Dockerfile.native -t quarkus/serverless-workflow-assessment . -# -# Then run the container using: -# -# docker run -i --rm -p 8080:8080 quarkus/serverless-workflow-assessment -# -### -FROM registry.access.redhat.com/ubi8/ubi-minimal:8.8 -WORKDIR /work/ -RUN chown 1001 /work \ - && chmod "g+rwX" /work \ - && chown 1001:root /work -COPY --chown=1001:root target/*-runner /work/application - -EXPOSE 8080 -USER 1001 - -ENTRYPOINT ["./application", "-Dquarkus.http.host=0.0.0.0"] diff --git a/aap-job/src/main/docker/Dockerfile.native-micro b/aap-job/src/main/docker/Dockerfile.native-micro deleted file mode 100644 index f70d843..0000000 --- a/aap-job/src/main/docker/Dockerfile.native-micro +++ /dev/null @@ -1,30 +0,0 @@ -#### -# This Dockerfile is used in order to build a container that runs the Quarkus application in native (no JVM) mode. -# It uses a micro base image, tuned for Quarkus native executables. -# It reduces the size of the resulting container image. -# Check https://quarkus.io/guides/quarkus-runtime-base-image for further information about this image. -# -# Before building the container image run: -# -# ./mvnw package -Dnative -# -# Then, build the image with: -# -# docker build -f src/main/docker/Dockerfile.native-micro -t quarkus/serverless-workflow-assessment . -# -# Then run the container using: -# -# docker run -i --rm -p 8080:8080 quarkus/serverless-workflow-assessment -# -### -FROM quay.io/quarkus/quarkus-micro-image:2.0 -WORKDIR /work/ -RUN chown 1001 /work \ - && chmod "g+rwX" /work \ - && chown 1001:root /work -COPY --chown=1001:root target/*-runner /work/application - -EXPOSE 8080 -USER 1001 - -ENTRYPOINT ["./application", "-Dquarkus.http.host=0.0.0.0"] diff --git a/aap-job/src/main/resources/aap-job.sw.yaml b/aap-job/src/main/resources/aap-job.sw.yaml index e9d3ed5..dcdbce0 100644 --- a/aap-job/src/main/resources/aap-job.sw.yaml +++ b/aap-job/src/main/resources/aap-job.sw.yaml @@ -1,17 +1,16 @@ specVersion: "0.8" id: aap-job +version: 0.0.1 name: Aap job +description: Workflow to launch a AAP job annotations: - "workflow-type/infrastructure" -version: 0.0.1 -timeouts: - workflowExecTimeout: PT24H +dataInputSchema: schemas/app-job-input-schema.json start: LaunchJob extensions: - extensionid: workflow-uri-definitions definitions: notifications: "https://raw.githubusercontent.com/janus-idp/backstage-plugins/%40janus-idp/plugin-notifications-backend%401.0.3/plugins/notifications-backend/src/openapi.yaml" -dataInputSchema: schemas/app-job-input-schema.json functions: - name: launchJob operation: specs/aap-openapi.yaml#launchJob diff --git a/aap-job/src/main/resources/application.properties b/aap-job/src/main/resources/application.properties index 3865475..18d394d 100644 --- a/aap-job/src/main/resources/application.properties +++ b/aap-job/src/main/resources/application.properties @@ -1,5 +1,5 @@ # Notifications Settings -quarkus.rest-client.notifications_openapi_yaml.url=${BACKSTAGE_NOTIFICATIONS_URL:http://localhost} +quarkus.rest-client.notifications_openapi_yaml.url=${BACKSTAGE_NOTIFICATIONS_URL:http://localhost:7007/api/notifications} # Ansible Automation Platform Settings app_url=${AAP_URL} From 0cd2b740d8d57f984329d2f56f5c8e857796c921 Mon Sep 17 00:00:00 2001 From: Annel Ketcha Date: Wed, 20 Mar 2024 10:25:24 -0400 Subject: [PATCH 7/7] clean and add dev prop --- aap-job/.dockerignore | 5 ----- aap-job/src/main/resources/aap-job.sw.yaml | 6 ++++++ aap-job/src/main/resources/application-dev.properties | 7 +++++++ 3 files changed, 13 insertions(+), 5 deletions(-) delete mode 100644 aap-job/.dockerignore create mode 100644 aap-job/src/main/resources/application-dev.properties diff --git a/aap-job/.dockerignore b/aap-job/.dockerignore deleted file mode 100644 index 94810d0..0000000 --- a/aap-job/.dockerignore +++ /dev/null @@ -1,5 +0,0 @@ -* -!target/*-runner -!target/*-runner.jar -!target/lib/* -!target/quarkus-app/* \ No newline at end of file diff --git a/aap-job/src/main/resources/aap-job.sw.yaml b/aap-job/src/main/resources/aap-job.sw.yaml index dcdbce0..066c1c3 100644 --- a/aap-job/src/main/resources/aap-job.sw.yaml +++ b/aap-job/src/main/resources/aap-job.sw.yaml @@ -74,6 +74,9 @@ states: message: '"AAP job workflow id: " + $WORKFLOW.instanceId + " for job template id: " + (.jobTemplateId|tostring) + " failed."' origin: "AAP Job Workflow" topic: "AAP Job Workflow" + targetUsers: + - "default/guest" + targetGroups: [] actions: - title: "AAP Job Output" url: .launchedJob.outputUrl @@ -88,6 +91,9 @@ states: message: '"AAP job workflow id: " + $WORKFLOW.instanceId + " for job template id: " + (.jobTemplateId|tostring) + " succeeded."' origin: "AAP Job Workflow" topic: "AAP Job Workflow" + targetUsers: + - "default/guest" + targetGroups: [] actions: - title: "AAP Job Output" url: .launchedJob.outputUrl diff --git a/aap-job/src/main/resources/application-dev.properties b/aap-job/src/main/resources/application-dev.properties new file mode 100644 index 0000000..bf057e5 --- /dev/null +++ b/aap-job/src/main/resources/application-dev.properties @@ -0,0 +1,7 @@ +#Quarkus +quarkus.http.host=0.0.0.0 +# This is to enable debugging of HTTP request +quarkus.log.category.\"org.apache.http\".level=DEBUG + +# Added +quarkus.http.port=8080 \ No newline at end of file