diff --git a/scaffolder-templates/build/.gitlab-ci.yml b/scaffolder-templates/build/.gitlab-ci.yml new file mode 100644 index 0000000..2233834 --- /dev/null +++ b/scaffolder-templates/build/.gitlab-ci.yml @@ -0,0 +1,25 @@ +stages: + - update + +update_pipelinerun: + tags: + - shared-podman # Change to whatever tag your Gitlab runner is set to + stage: update + image: ubuntu:latest + script: | + apt-get update && apt-get install -y git + apt-get install apt-transport-https ca-certificates -y + update-ca-certificates + git config --global http.sslVerify "false" + COMMIT_AUTHOR_EMAIL=$(git log -1 --pretty=format:'%ae') + COMMIT_AUTHOR_NAME=$(git log -1 --pretty=format:'%an') + COMMIT_ID=$(git rev-parse --short HEAD) + git config --global user.email "$COMMIT_AUTHOR_EMAIL" + git config --global user.name "$COMMIT_AUTHOR_NAME" + git remote set-url origin https://token:$PROJECT_ACCESS_TOKEN@$CI_SERVER_HOST/$CI_PROJECT_PATH.git + + cd argocd + sed "s/__COMMIT_ID__/$COMMIT_ID/g" pipelinerun.template > pipelinerun.yaml + git add pipelinerun.yaml + git commit -m "Updated PipelineRun with commit id $COMMIT_ID" + git push origin HEAD:main -o ci.skip diff --git a/scaffolder-templates/gitlab-workflow/skeleton/.mvn/wrapper/.gitignore b/scaffolder-templates/gitlab-workflow/skeleton/.mvn/wrapper/.gitignore new file mode 100644 index 0000000..e72f5e8 --- /dev/null +++ b/scaffolder-templates/gitlab-workflow/skeleton/.mvn/wrapper/.gitignore @@ -0,0 +1 @@ +maven-wrapper.jar diff --git a/scaffolder-templates/gitlab-workflow/skeleton/.mvn/wrapper/MavenWrapperDownloader.java b/scaffolder-templates/gitlab-workflow/skeleton/.mvn/wrapper/MavenWrapperDownloader.java new file mode 100644 index 0000000..84d1e60 --- /dev/null +++ b/scaffolder-templates/gitlab-workflow/skeleton/.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/scaffolder-templates/gitlab-workflow/skeleton/.mvn/wrapper/maven-wrapper.properties b/scaffolder-templates/gitlab-workflow/skeleton/.mvn/wrapper/maven-wrapper.properties new file mode 100644 index 0000000..eacdc9e --- /dev/null +++ b/scaffolder-templates/gitlab-workflow/skeleton/.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.5/apache-maven-3.9.5-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/scaffolder-templates/gitlab-workflow/skeleton/LICENSE b/scaffolder-templates/gitlab-workflow/skeleton/LICENSE new file mode 100644 index 0000000..7dc91c9 --- /dev/null +++ b/scaffolder-templates/gitlab-workflow/skeleton/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright 2024 [name of copyright owner] + + Licensed 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. diff --git a/scaffolder-templates/gitlab-workflow/skeleton/README.md b/scaffolder-templates/gitlab-workflow/skeleton/README.md new file mode 100644 index 0000000..55bbce7 --- /dev/null +++ b/scaffolder-templates/gitlab-workflow/skeleton/README.md @@ -0,0 +1,50 @@ +# ${{ values.artifactId }} + +${{ values.description }} + +## Prerequisites +* Java 11+ is installed. +* Apache Maven 3.8.6 or later is installed. +* [Quarkus CLI](https://quarkus.io/guides/cli-tooling) or [Knative Workflow CLI](https://kiegroup.github.io/kogito-docs/serverlessworkflow/latest/testing-and-troubleshooting/kn-plugin-workflow-overview.html) 0.21.3 or later is installed. +* (Optional) Docker is installed. +* (Optional) Podman is installed. +* (Optional) Kubernetes CLI is installed. +* Visual Studio Code with [Red Hat Java Extension](https://marketplace.visualstudio.com/items?itemName=redhat.java) and +[Red Hat Serverless Workflow Editor](https://marketplace.visualstudio.com/items?itemName=redhat.vscode-extension-serverless-workflow-editor) +are installed to edit your workflows. + +## References +* [About OpenShift Serverless Logic](https://openshift-knative.github.io/docs/docs/latest/serverless-logic/about.html) +* [SonataFlow Guides](https://kiegroup.github.io/kogito-docs/serverlessworkflow/latest/index.html) + +## Running ${{ values.artifactId }} in Quarkus dev mode +You can run your application in dev mode that enables live coding using: + +```shell script +mvn compile quarkus:dev +``` + +## Testing with curl +First, validate the workflows exposed by the application: +```shell script +curl -v -H "Content-Type: application/json" http://localhost:8080/management/processes +``` +(${{ values.workflowId }} should be included in the returned array) + +Then, assuming that you stored in [input.json](./input.json) the input parameters (if any) following the input schema specifications at +[${{ values.artifactId }}-schema.json](./src/main/resources/schemas/${{ values.artifactId }}-schema.json ), run the following to create an +instance of the ${{ values.workflowId }} workflow: +```shell script +curl -v -X POST -H "Content-Type: application/json" http://localhost:8080/${{ values.workflowId }} -d@input.json +``` + +# Dev UI Tools +Use the `Serverless Workflow Tools` to manage and monitor the published workflows: +``` +http://localhost:8080/q/dev-v1/org.apache.kie.sonataflow.sonataflow-quarkus-devui/workflowInstances +``` + +Use the `Data Index GraphQL UI` to query the state of the [Data Index service](https://sonataflow.org/serverlessworkflow/main/data-index/data-index-core-concepts.html): +``` +http://localhost:8080/q/dev-v1/org.kie.kogito-addons-quarkus-data-index-inmemory/dataindex +``` diff --git a/scaffolder-templates/gitlab-workflow/skeleton/catalog-info.yaml b/scaffolder-templates/gitlab-workflow/skeleton/catalog-info.yaml new file mode 100644 index 0000000..d9533b9 --- /dev/null +++ b/scaffolder-templates/gitlab-workflow/skeleton/catalog-info.yaml @@ -0,0 +1,16 @@ +apiVersion: backstage.io/v1alpha1 +kind: Component +metadata: + name: ${{ values.workflowId }} + description: ${{ values.description }} + annotations: + argocd/app-selector: rht-gitops.com/janus-argocd=${{ values.workflowId }} + backstage.io/kubernetes-namespace: ${{ values.argocdNamespace }} + backstage.io/kubernetes-id: ${{ values.workflowId }}-ci + janus-idp.io/tekton: ${{ values.workflowId }} + gitlab.com/project-slug: ${{ values.orgName }}/${{ values.repoName }} +spec: + type: ${{ values.applicationType }} + system: ${{ values.system }} + lifecycle: ${{ values.lifecycle }} + owner: ${{ values.owner }} diff --git a/scaffolder-templates/gitlab-workflow/skeleton/input.json b/scaffolder-templates/gitlab-workflow/skeleton/input.json new file mode 100644 index 0000000..dfe49bc --- /dev/null +++ b/scaffolder-templates/gitlab-workflow/skeleton/input.json @@ -0,0 +1,3 @@ +{ + "sampleText": "Sample text" +} diff --git a/scaffolder-templates/gitlab-workflow/skeleton/mvnw b/scaffolder-templates/gitlab-workflow/skeleton/mvnw new file mode 100755 index 0000000..8d937f4 --- /dev/null +++ b/scaffolder-templates/gitlab-workflow/skeleton/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/scaffolder-templates/gitlab-workflow/skeleton/mvnw.cmd b/scaffolder-templates/gitlab-workflow/skeleton/mvnw.cmd new file mode 100644 index 0000000..c4586b5 --- /dev/null +++ b/scaffolder-templates/gitlab-workflow/skeleton/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/scaffolder-templates/gitlab-workflow/skeleton/pom.xml b/scaffolder-templates/gitlab-workflow/skeleton/pom.xml new file mode 100644 index 0000000..2f34739 --- /dev/null +++ b/scaffolder-templates/gitlab-workflow/skeleton/pom.xml @@ -0,0 +1,192 @@ + + + 4.0.0 + ${{ values.groupId }} + ${{ values.artifactId }} + ${{ values.version }} + ${{ values.description }} + + 17 + 3.10.1 + kogito-bom + org.kie.kogito + 9.101.0.redhat-00007 + sonataflow-quarkus-devui-bom + org.apache.kie.sonataflow + 9.101.0.redhat-00007 + UTF-8 + UTF-8 + quarkus-bom + io.quarkus + 3.8.6.redhat-00004 + 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 + + + ${sonataflow-quarkus-devui.bom.group-id} + ${sonataflow-quarkus-devui.bom.artifact-id} + ${sonataflow-quarkus-devui.bom.version} + pom + import + + + + + + org.apache.kie.sonataflow + sonataflow-quarkus + + + io.quarkus + quarkus-smallrye-health + + + org.kie + kie-addons-quarkus-source-files + + + org.apache.kie.sonataflow + sonataflow-quarkus-devui + + + org.kie + kie-addons-quarkus-process-management + + + io.quarkus + quarkus-resteasy-jackson + + + io.quarkus + quarkus-arc + + + org.kie + 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 + + + + + + + redhat-mvn-ga + https://maven.repository.redhat.com/ga + default + + true + + + true + daily + + + + + + + true + + + true + daily + + redhat-mvn-ga + Red Hat Maven Plugin Repository + https://maven.repository.redhat.com/ga + + + \ No newline at end of file diff --git a/scaffolder-templates/gitlab-workflow/skeleton/src/main/docker/Dockerfile.jvm b/scaffolder-templates/gitlab-workflow/skeleton/src/main/docker/Dockerfile.jvm new file mode 100644 index 0000000..d55300a --- /dev/null +++ b/scaffolder-templates/gitlab-workflow/skeleton/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/${{ values.artifactId }}-jvm . +# +# Then run the container using: +# +# docker run -i --rm -p 8080:8080 quarkus/${{ values.artifactId }}-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/${{ values.artifactId }}-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.17 + +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_APPEND="-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/scaffolder-templates/gitlab-workflow/skeleton/src/main/docker/Dockerfile.legacy-jar b/scaffolder-templates/gitlab-workflow/skeleton/src/main/docker/Dockerfile.legacy-jar new file mode 100644 index 0000000..f3a32c9 --- /dev/null +++ b/scaffolder-templates/gitlab-workflow/skeleton/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/${{ values.artifactId }}-legacy-jar . +# +# Then run the container using: +# +# docker run -i --rm -p 8080:8080 quarkus/${{ values.artifactId }}-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/${{ values.artifactId }}-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.17 + +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_APPEND="-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/scaffolder-templates/gitlab-workflow/skeleton/src/main/docker/Dockerfile.native b/scaffolder-templates/gitlab-workflow/skeleton/src/main/docker/Dockerfile.native new file mode 100644 index 0000000..4aa49f5 --- /dev/null +++ b/scaffolder-templates/gitlab-workflow/skeleton/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/${{ values.artifactId }} . +# +# Then run the container using: +# +# docker run -i --rm -p 8080:8080 quarkus/${{ values.artifactId }} +# +### +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/scaffolder-templates/gitlab-workflow/skeleton/src/main/docker/Dockerfile.native-micro b/scaffolder-templates/gitlab-workflow/skeleton/src/main/docker/Dockerfile.native-micro new file mode 100644 index 0000000..aa36848 --- /dev/null +++ b/scaffolder-templates/gitlab-workflow/skeleton/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/${{ values.artifactId }} . +# +# Then run the container using: +# +# docker run -i --rm -p 8080:8080 quarkus/${{ values.artifactId }} +# +### +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/scaffolder-templates/gitlab-workflow/skeleton/src/main/resources/application-dev.properties b/scaffolder-templates/gitlab-workflow/skeleton/src/main/resources/application-dev.properties new file mode 100644 index 0000000..c859d88 --- /dev/null +++ b/scaffolder-templates/gitlab-workflow/skeleton/src/main/resources/application-dev.properties @@ -0,0 +1,2 @@ +quarkus.profile=dev +quarkus.http.host=localhost \ No newline at end of file diff --git a/scaffolder-templates/gitlab-workflow/skeleton/src/main/resources/application.properties b/scaffolder-templates/gitlab-workflow/skeleton/src/main/resources/application.properties new file mode 100644 index 0000000..08010b0 --- /dev/null +++ b/scaffolder-templates/gitlab-workflow/skeleton/src/main/resources/application.properties @@ -0,0 +1,8 @@ +# This property is used to select the log level, which controls the amount +# of information logged on HTTP requests based on the severity of the events. +# Possible values: OFF, FATAL, ERROR, WARN, INFO, DEBUG, ALL. +# and see https://quarkus.io/guides/logging for documentation +quarkus.log.category."org.apache.http".level=INFO +quarkus.log.level=INFO + +quarkus.flyway.migrate-at-start=true diff --git a/scaffolder-templates/gitlab-workflow/skeleton/src/main/resources/assessment-template.sw.yaml b/scaffolder-templates/gitlab-workflow/skeleton/src/main/resources/assessment-template.sw.yaml new file mode 100644 index 0000000..ade6002 --- /dev/null +++ b/scaffolder-templates/gitlab-workflow/skeleton/src/main/resources/assessment-template.sw.yaml @@ -0,0 +1,64 @@ +id: ${{ values.workflowId }} +version: "${{ values.version}}" +specVersion: "0.8" +name: "${{ values.workflowId }}" +description: "${{ values.description }}" +annotations: + - "workflow-type/assessment" +dataInputSchema: + schema: schemas/${{ values.artifactId }}-input-schema.json + failOnValidationErrors: true +extensions: + - extensionid: workflow-output-schema + outputSchema: + schema: schemas/${{ values.artifactId }}-workflow-result-schema.json + failOnValidationErrors: true +functions: + - name: assessmentResult + type: expression + operation: '{ + result: { + "completedWith":"success", + "message": "The workflow ${{ values.workflowId }} completed successfully", + "outputs":[], + "nextWorkflows":[ + { + "id":"${{ values.infrastructureWorkflowId }}", + "name":"${{ values.infrastructureWorkflowId }}" + } + ] + } + }' + - name: emptyAssessmentResult + type: expression + operation: '{ + result: { + "completedWith":"success", + "message": "The workflow ${{ values.workflowId }} completed without sampleText", + "outputs":[], + "nextWorkflows":[] + } + }' +start: StartState +states: + - name: StartState + type: switch + dataConditions: + - condition: ${ .sampleText | length != 0 } + transition: GetSampleWorkflowOptions + defaultCondition: + transition: GetEmptyWorkflowOptions + - name: GetSampleWorkflowOptions + type: operation + actions: + - name: GetSampleWorkflowOptions + functionRef: + refName: assessmentResult + end: true + - name: GetEmptyWorkflowOptions + type: operation + actions: + - name: GetEmptyWorkflowOptions + functionRef: + refName: emptyAssessmentResult + end: true \ No newline at end of file diff --git a/scaffolder-templates/gitlab-workflow/skeleton/src/main/resources/infrastructure-template.sw.yaml b/scaffolder-templates/gitlab-workflow/skeleton/src/main/resources/infrastructure-template.sw.yaml new file mode 100644 index 0000000..1fb1c06 --- /dev/null +++ b/scaffolder-templates/gitlab-workflow/skeleton/src/main/resources/infrastructure-template.sw.yaml @@ -0,0 +1,25 @@ +id: ${{ values.workflowId }} +version: "${{ values.version}}" +specVersion: "0.8" +name: "${{ values.workflowId }}" +description: "${{ values.description }}" +annotations: + - "workflow-type/infrastructure" +dataInputSchema: + failOnValidationErrors: true + schema: schemas/${{ values.artifactId }}-input-schema.json +functions: + - name: logInfo + type: custom + operation: "sysout:INFO" +start: "StartState" +states: + - name: "StartState" + type: "operation" + actions: + - name: logInput + functionRef: + refName: logInfo + arguments: + message: '"You entered " + .sampleText' + end: true diff --git a/scaffolder-templates/gitlab-workflow/skeleton/src/main/resources/schemas/${{values.artifactId}}-input-schema.json b/scaffolder-templates/gitlab-workflow/skeleton/src/main/resources/schemas/${{values.artifactId}}-input-schema.json new file mode 100644 index 0000000..b127c44 --- /dev/null +++ b/scaffolder-templates/gitlab-workflow/skeleton/src/main/resources/schemas/${{values.artifactId}}-input-schema.json @@ -0,0 +1,13 @@ +{ + "$id": "classpath:/schemas/${{ values.artifactId }}-schema.json", + "title": "Data Input Schema", + "$schema": "http://json-schema.org/draft-07/schema#", + "type": "object", + "properties": { + "sampleText": { + "title": "A sample text", + "type": "string", + "description": "Sample text data" + } + } +} diff --git a/scaffolder-templates/gitlab-workflow/skeleton/src/main/resources/schemas/${{values.artifactId}}-workflow-result-schema.json b/scaffolder-templates/gitlab-workflow/skeleton/src/main/resources/schemas/${{values.artifactId}}-workflow-result-schema.json new file mode 100644 index 0000000..cd38b2a --- /dev/null +++ b/scaffolder-templates/gitlab-workflow/skeleton/src/main/resources/schemas/${{values.artifactId}}-workflow-result-schema.json @@ -0,0 +1,77 @@ +{ + "$schema": "http://json-schema.org/draft-07/schema#", + "title": "WorkflowResult", + "description": "Result of a workflow execution", + "type": "object", + "properties": { + "completedWith": { + "description": "The state of workflow completion.", + "type": "string", + "enum": [ + "error", + "success" + ] + }, + "message": { + "description": "High-level summary of the current status, free-form text, human readable.", + "type": "string" + }, + "nextWorkflows": { + "description": "List of workflows suggested to run next. Items at lower indexes are of higher priority.", + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "description": "Workflow identifier", + "type": "string" + }, + "name": { + "description": "Human readable title describing the workflow.", + "type": "string" + } + }, + "required": [ + "id", + "name" + ] + } + }, + "outputs": { + "description": "Additional structured output of workflow processing. This can contain identifiers of created resources, links to resources, logs or other output.", + "type": "array", + "items": { + "type": "object", + "properties": { + "key": { + "description": "Unique identifier of the option. Preferably human-readable.", + "type": "string" + }, + "value": { + "description": "Free form value of the option.", + "anyOf": [ + { + "type": "string" + }, + { + "type": "number" + } + ] + }, + "format": { + "description": "More detailed type of the 'value' property. Defaults to 'text'.", + "enum": [ + "text", + "number", + "link" + ] + } + }, + "required": [ + "key", + "value" + ] + } + } + } +} \ No newline at end of file diff --git a/scaffolder-templates/gitlab-workflow/template.yaml b/scaffolder-templates/gitlab-workflow/template.yaml new file mode 100644 index 0000000..4865c87 --- /dev/null +++ b/scaffolder-templates/gitlab-workflow/template.yaml @@ -0,0 +1,451 @@ +apiVersion: scaffolder.backstage.io/v1beta3 +kind: Template +metadata: + name: gitlab-workflow-bootstrap + title: Gitlab workflow bootstrap project + description: Bootstrap project for basic serverless workflow with gitlab + tags: + - orchestrator + - built-in + links: + - url: https://openshift-knative.github.io/docs/docs/latest/serverless-logic/about.html + title: About OpenShift Serverless Logic + icon: techdocs + - url: https://kiegroup.github.io/kogito-docs/serverlessworkflow/latest/index.html + title: SonataFlow Guides + icon: techdocs + - url: https://www.parodos.dev/docs/core-concepts/workflow-types/ + title: Workflow Types + icon: techdocs +spec: + owner: janus-orchestrator + type: gitlab-workflow + parameters: + - title: Workflow Software Project + description: Configure the gitlab repository where the Maven software project is located + required: + - orgName + - repoName + - workflowId + - description + - owner + - system + properties: + orgName: + title: Group Name + type: string + ui:autofocus: true + description: Gitlab Group Name + repoName: + title: Repository Name + type: string + description: Gitlab Project name + default: onboarding + description: + title: Description + type: string + description: Description added to the README file + default: A workflow for onboarding applications to OCP cluster + workflowId: + title: Workflow ID + type: string + pattern: "^([a-zA-Z][a-zA-Z0-9]*)([.]?[a-zA-Z0-9]+)*$" # hypens '-' are not allowed to not mess with java package + description: Unique identifier of the workflow in SonataFlow + default: onboarding + owner: + title: Owner + type: string + ui:field: EntityPicker + ui:options: + catalogFilter: + kind: + - Group + - User + default: user:guest + system: + title: System + type: string + ui:field: EntityPicker + ui:options: + catalogFilter: + kind: + - System + - title: Workflow Type + description: Select the workflow type. For an assessment, provide an infrastructure workflow option, which should already be set up in your environment + required: + - workflowType + properties: + workflowType: + title: Workflow Type + type: string + description: Annotation to be added to the workflow in SonataFlow to specify its type + ui:widget: radio + enum: + - infrastructure + - assessment + enumNames: + - Infrastructure + - Assessment + default: infrastructure + dependencies: + workflowType: + oneOf: + - properties: + workflowType: + const: infrastructure + - properties: + workflowType: + const: assessment + infrastructureWorkflowId: + title: Infrastructure Workflow ID + type: string + pattern: "^([a-zA-Z][a-zA-Z0-9]*)([.]?[a-zA-Z0-9]+)*$" # hypens '-' are not allowed to not mess with java package + description: Workflow ID, the unique identifier of the infrastructure worklow available in the environment + required: + - infrastructureWorkflowId + - title: Build Environment + required: + - CI + properties: + CI: + title: Select a CI/CD method + type: string + description: This action will create a CI pipeline for your application based on chosen method + default: tekton_argocd + enum: + - none + - tekton_argocd + enumNames: + - None + - Tekton with ArgoCD + # See: https://github.com/redhat-developer/red-hat-developer-hub-software-templates/blob/3019e781b988e0548eb987eed3e522854ed8c52f/templates/github/quarkus-backend/template.yaml#L101 + dependencies: + CI: + oneOf: + - properties: + CI: + const: none + - properties: + CI: + const: tekton_argocd + namespace: + title: Workflow Namespace + type: string + default: sonataflow-infra + description: Deployment namespace for workflow applications + argocdNamespace: + title: GitOps Namespace + type: string + default: orchestrator-gitops + description: Deployment namespace for ArgoCD and Tekton resources + gitlabHost: + title: Gitlab Instance Name + type: string + default: gitlab.cee.redhat.com + description: The name or host of your gitlab instance + persistencePSQLSecretName: + title: PostgreSQL Secret Name + type: string + default: sonataflow-psql-postgresql + description: Name of the secret in which the PostgreSQL secrets are stored. Shall be in the same namespace as the workflow + persistencePSQLUserKey: + title: PostgreSQL User key from secret + type: string + description: The key name in which the PostgreSQL user is stored + default: postgres-username + persistencePSQLPasswordKey: + title: PostgreSQL Password key from secret + type: string + description: The key name in which the PostgreSQL password is stored + default: postgres-password + persistencePSQLServiceName: + title: PostgreSQL K8s Service Name + type: string + default: sonataflow-psql-postgresql + description: Name of the service running the PostgreSQL instance + persistencePSQLServiceNamespace: + title: PostgreSQL K8s Service Namespace + type: string + default: sonataflow-infra + description: Namespace of the service running the PostgreSQL instance + persistencePSQLServicePort: + title: PostgreSQL Port + type: integer + default: 5432 + description: Port on which the PostgreSQL instance is running + persistencePSQLDatabaseName: + title: PostgreSQL Database Name + type: string + description: Name of the database to use for persistence + default: sonataflow + quayConfig: + title: Quay Configuration + description: Choose between creating a new Quay repository or using an existing one + type: string + default: "Use Existing Repository" + enum: + - "Use Existing Repository" + - "Create New Repository" + ui:widget: radio + dependencies: + quayConfig: + oneOf: + - properties: + quayConfig: + const: "Use Existing Repository" + quayOrgName: + title: Quay Organization Name + type: string + description: The Quay organization name of the published workflow + quayRepoName: + title: Quay Repository Name + type: string + description: The Quay repository name of the published workflow. The repository must exist before deploying the gitops + required: + - quayOrgName + - quayRepoName + - properties: + quayConfig: + const: "Create New Repository" + quayOrgName: + title: Quay Organization Name + type: string + description: The Quay Organization Name of the published workflow + quayRepoName: + title: Quay Repository Name + type: string + description: A name to create a new Quay Repository of the published workflow + token: + title: Quay AuthToken + type: string + description: Quay organization bearer token used for authorization + ui:widget: password + visibility: + title: Quay Repository Visiblity + type: string + description: Visibility setting for the created repository, either public or private + ui:widget: select + enum: ["public", "private"] + default: public + repoKind: + title: Quay Repository Kind + type: string + description: The created Quay repository kind, either image or application + ui:widget: select + enum: ["image", "application"] + default: image + newRepoDescription: + title: Quay Repository Description + type: string + description: The Quay repository description + baseUrl: + title: Quay Base URL + type: string + description: URL of your Quay instance + default: "https://quay.io" + quayNamespace: + title: Quay Namespace + type: string + description: The Quay namespace of the published workflow + required: + - visibility + - newRepoDescription + - quayNamespace + - token + - quayOrgName + - quayRepoName + required: + - namespace + - argocdNamespace + - persistencePSQLSecretName + - persistencePSQLUserKey + - persistencePSQLPasswordKey + - persistencePSQLServiceName + - persistencePSQLServiceNamespace + - persistencePSQLServicePort + - persistencePSQLDatabaseName + steps: + - id: createQuayRepository + name: Create Quay Repository + action: quay:create-repository + if: ${{ parameters.quayConfig == 'Create New Repository' }} + input: + baseUrl: ${{ parameters.baseUrl }} + token: ${{ parameters.token }} + name: ${{ parameters.quayRepoName }} + visibility: ${{ parameters.visibility }} + description: ${{ parameters.newRepoDescription }} + repoKind: ${{ parameters.repoKind }} + namespace: ${{ parameters.quayNamespace }} + + - id: workflowCodeTemplate + name: Generating the Workflow Source Code and Catalog Info Component + action: fetch:template + input: + # "Relative path is not allowed to refer to a directory outside its parent" + url: ./skeleton + values: + namespace: ${{ parameters.namespace }} + argocdNamespace: ${{ parameters.argocdNamespace }} + orgName: ${{ parameters.orgName }} + repoName: ${{ parameters.repoName }} + owner: ${{ parameters.owner }} + system: ${{ parameters.system }} + description: ${{ parameters.description }} + groupId: io.janus.workflow + artifactId: ${{ parameters.workflowId }} + version: 1.0.0-SNAPSHOT + workflowId: ${{ parameters.workflowId }} + workflowType: ${{ parameters.workflowType }} + infrastructureWorkflowId: ${{ parameters.infrastructureWorkflowId }} + sourceControl: gitlab.com + applicationType: workflow-project + lifecycle: development + quayOrgName: ${{ parameters.quayOrgName }} + quayRepoName: ${{ parameters.quayRepoName }} + targetPath: workflow + - id: renameFiles + action: fs:rename + name: Rename files + input: + files: + - from: workflow/src/main/resources/${{ parameters.workflowType }}-template.sw.yaml + to: workflow/src/main/resources/${{ parameters.workflowId }}.sw.yaml + overwrite: false + - id: deleteFiles + action: fs:delete + name: Delete files + input: + files: + - workflow/src/main/resources/assessment-template.sw.yaml + - workflow/src/main/resources/infrastructure-template.sw.yaml + - id: buildCodeTemplate + name: Generating the Build Code for the Workflow + action: fetch:template + if: ${{ parameters.CI == 'tekton_argocd' }} + input: + url: ../build + copyWithoutTemplating: + - .gitlab-ci.yml + values: + namespace: ${{ parameters.namespace }} + argocdNamespace: ${{ parameters.argocdNamespace }} + orgName: ${{ parameters.orgName }} + workflowId: ${{ parameters.workflowId }} + gitUrl: git@${{ parameters.gitlabHost }}:${{ parameters.orgName }}/${{ parameters.repoName }}.git + gitOpsUrl: git@${{ parameters.gitlabHost }}:${{ parameters.orgName }}/${{ parameters.repoName }}-gitops.git + quayOrgName: ${{ parameters.quayOrgName }} + quayRepoName: ${{ parameters.quayRepoName }} + convertToFlat: true + targetPath: workflow + - id: publishWorkflow + name: Publishing to the Workflow Repository + action: publish:gitlab + input: + allowedHosts: ["${{ parameters.gitlabHost }}"] + description: ${{ parameters.description }} + repoUrl: ${{ parameters.gitlabHost }}?owner=${{ parameters.orgName }}&repo=${{ parameters.repoName }} + defaultBranch: main + sourcePath: workflow + + - id: createProjectAccessToken + name: Create a Project Access Token to the workflow Repository + action: gitlab:projectAccessToken:create + input: + projectId: ${{ parameters.orgName }}/${{ parameters.repoName }} + repoUrl: ${{ parameters.gitlabHost }}?owner=${{ parameters.orgName }}&repo=${{ parameters.repoName }} + name: PROJECT_ACCESS_TOKEN + scopes: + [api, read_api, create_runner, read_repository, write_repository] + + - id: createAccessTokenVariable + name: Create a Project Variable to hold the Token + action: gitlab:projectVariable:create + input: + repoUrl: ${{ parameters.gitlabHost }}?owner=${{ parameters.orgName }}&repo=${{ parameters.repoName }} + projectId: ${{ parameters.orgName }}/${{ parameters.repoName }} + key: PROJECT_ACCESS_TOKEN + value: ${{ steps.createProjectAccessToken.output.access_token }} + variableType: env_var + raw: false + masked: true + + - id: register + name: Registering the Catalog Info Component + action: catalog:register + input: + repoContentsUrl: ${{ steps.publishWorkflow.output.repoContentsUrl }} + catalogInfoPath: /catalog-info.yaml + - id: gitopsCodeTemplate + name: Generating the GitOps Component and Catalog Info Component + action: fetch:template + if: ${{ parameters.CI == 'tekton_argocd' }} + input: + url: ../gitops + values: + workflowId: ${{ parameters.workflowId }} + namespace: ${{ parameters.namespace }} + argocdNamespace: ${{ parameters.argocdNamespace }} + orgName: ${{ parameters.orgName }} + repoName: ${{ parameters.repoName }}-gitops + owner: ${{ parameters.owner }} + system: ${{ parameters.system }} + applicationType: workflow-project + description: ${{ parameters.description }} + sourceControl: gitlab.com # CHECK if not cee redhat + lifecycle: development + gitUrl: git@${{ parameters.gitlabHost }}:${{ parameters.orgName }}/${{ parameters.repoName }}.git + gitOpsUrl: git@${{ parameters.gitlabHost }}:${{ parameters.orgName }}/${{ parameters.repoName }}-gitops.git + persistencePSQLSecretName: ${{ parameters.persistencePSQLSecretName }} + persistencePSQLUserKey: ${{ parameters.persistencePSQLUserKey }} + persistencePSQLPasswordKey: ${{ parameters.persistencePSQLPasswordKey }} + persistencePSQLServiceName: ${{ parameters.persistencePSQLServiceName }} + persistencePSQLServiceNamespace: ${{ parameters.persistencePSQLServiceNamespace }} + persistencePSQLServicePort: ${{ parameters.persistencePSQLServicePort }} + persistencePSQLDatabaseName: ${{ parameters.persistencePSQLDatabaseName }} + persistencePSQLDatabaseSchema: ${{ parameters.workflowId }} + quayOrgName: ${{ parameters.quayOrgName }} + quayRepoName: ${{ parameters.quayRepoName }} + targetPath: gitops + - id: renameFilesForPersistence + if: ${{ parameters.CI == 'tekton_argocd' }} + action: fs:rename + name: Rename files for persistence + input: + files: + - from: gitops/kustomize/base/sonataflow-patch-persistence.yaml + to: gitops/kustomize/base/sonataflow-patch.yaml + overwrite: true + - id: publishGitOps + if: ${{ parameters.CI == 'tekton_argocd' }} + name: Publishing to the GitOps Code Repository + action: publish:gitlab + input: + allowedHosts: ["${{ parameters.gitlabHost }}"] + description: Configuration repository for ${{ parameters.orgName }}/${{ parameters.repoName }} + repoUrl: ${{ parameters.gitlabHost }}?owner=${{ parameters.orgName }}&repo=${{ parameters.repoName }}-gitops + defaultBranch: main + sourcePath: gitops + - id: registerGitOps + if: ${{ parameters.CI == 'tekton_argocd' }} + name: Registering the GitOps Catalog Info Component + action: catalog:register + input: + repoContentsUrl: ${{ steps.publishGitOps.output.repoContentsUrl }} + catalogInfoPath: /catalog-info.yaml + output: + links: + - title: Bootstrap the GitOps Resources + icon: github + url: ${{ parameters.gitlabHost }}/${{ parameters.orgName }}/${{ parameters.repoName }}-gitops/tree/main/bootstrap + - title: Open the Source Code Repository + icon: github + url: ${{ steps.publishWorkflow.output.remoteUrl }} + - title: Open the Catalog Info Component + icon: catalog + entityRef: ${{ steps.register.output.entityRef }} + # If quayConfig is not populated, the Quay URL link will not appear. + - title: Quay Repository + icon: dashboard + url: ${{ steps['createQuayRepository'].output.repositoryUrl }} + - title: Project Token diff --git a/scaffolder-templates/gitops/catalog-info.yaml b/scaffolder-templates/gitops/catalog-info.yaml index dcc35f8..5eebb02 100644 --- a/scaffolder-templates/gitops/catalog-info.yaml +++ b/scaffolder-templates/gitops/catalog-info.yaml @@ -9,6 +9,7 @@ metadata: backstage.io/kubernetes-namespace: ${{ values.namespace }} backstage.io/kubernetes-id: ${{ values.workflowId }} github.com/project-slug: ${{ values.orgName }}/${{ values.repoName }} + gitlab.com/project-slug: ${{ values.orgName }}/${{ values.repoName }} spec: type: ${{ values.applicationType }} system: ${{ values.system }}