diff --git a/poc/README.md b/poc/README.md new file mode 100644 index 0000000..da45cae --- /dev/null +++ b/poc/README.md @@ -0,0 +1,17 @@ +# CDEvents Visualisation Reference Implementation + +The CDEvents Proof of Concept is demonstrated by CDEvents contributors to show the interactions between different CI/CD tools Tekton, Keptn and Spinnaker. In the PoC Tekton executes the Pipeline to build the artifact, Keptn handles the business decision and Spinnaker running the Pipeline to deploy the artifact. More information about the PoC can be found on the [PoC GitHub page](https://github.com/cdfoundation/sig-events/tree/main/poc). + +CDEvents Visualisation reference implementation helps to visualise the end-end workflow of the CDEvents Proof of Concept with different types of visualisations. + +### CDEvents aware tool +CDEvents aware tool knows what exactly is CDEvent and it creates sequences and aggregation graph of the events produced by PoC. + + +## Generic tool (Prometheus/Grafana) +Generic tool like Prometheus/Grafana can consume a specific event format which is translated from CDEvents to show the tracking and monitoring of an end-end workflow of CDEvents PoC. + +## Visualisation Reference Architecture + + +![Reference Architecture](visualisation_reference_architecture.jpg "Reference Architecture") diff --git a/poc/cdevents-visualiser/.gitignore b/poc/cdevents-visualiser/.gitignore new file mode 100644 index 0000000..549e00a --- /dev/null +++ b/poc/cdevents-visualiser/.gitignore @@ -0,0 +1,33 @@ +HELP.md +target/ +!.mvn/wrapper/maven-wrapper.jar +!**/src/main/**/target/ +!**/src/test/**/target/ + +### STS ### +.apt_generated +.classpath +.factorypath +.project +.settings +.springBeans +.sts4-cache + +### IntelliJ IDEA ### +.idea +*.iws +*.iml +*.ipr + +### NetBeans ### +/nbproject/private/ +/nbbuild/ +/dist/ +/nbdist/ +/.nb-gradle/ +build/ +!**/src/main/**/build/ +!**/src/test/**/build/ + +### VS Code ### +.vscode/ diff --git a/poc/cdevents-visualiser/.mvn/wrapper/maven-wrapper.jar b/poc/cdevents-visualiser/.mvn/wrapper/maven-wrapper.jar new file mode 100644 index 0000000..bf82ff0 Binary files /dev/null and b/poc/cdevents-visualiser/.mvn/wrapper/maven-wrapper.jar differ diff --git a/poc/cdevents-visualiser/.mvn/wrapper/maven-wrapper.properties b/poc/cdevents-visualiser/.mvn/wrapper/maven-wrapper.properties new file mode 100644 index 0000000..ca5ab4b --- /dev/null +++ b/poc/cdevents-visualiser/.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 +# +# https://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.8.7/apache-maven-3.8.7-bin.zip +wrapperUrl=https://repo.maven.apache.org/maven2/org/apache/maven/wrapper/maven-wrapper/3.1.1/maven-wrapper-3.1.1.jar diff --git a/poc/cdevents-visualiser/deploy_visualiser.sh b/poc/cdevents-visualiser/deploy_visualiser.sh new file mode 100755 index 0000000..81c864f --- /dev/null +++ b/poc/cdevents-visualiser/deploy_visualiser.sh @@ -0,0 +1,23 @@ +#!/bin/sh + +./mvnw spring-boot:build-image +docker tag visualiser:0.0.1-SNAPSHOT localhost:5000/cdevents/visualiser +docker push localhost:5000/cdevents/visualiser:latest + +kubectl delete -f visualiser-deployment.yaml +kubectl apply -f visualiser-deployment.yaml + +kubectl delete trigger cdevents-visualiser-receiver || true + +kubectl create -f - < \(.*\)$'` + if expr "$link" : '/.*' > /dev/null; then + PRG="$link" + else + PRG="`dirname "$PRG"`/$link" + fi + done + + saveddir=`pwd` + + M2_HOME=`dirname "$PRG"`/.. + + # make it fully qualified + M2_HOME=`cd "$M2_HOME" && pwd` + + cd "$saveddir" + # echo Using m2 at $M2_HOME +fi + +# For Cygwin, ensure paths are in UNIX format before anything is touched +if $cygwin ; then + [ -n "$M2_HOME" ] && + M2_HOME=`cygpath --unix "$M2_HOME"` + [ -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 "$M2_HOME" ] && + M2_HOME="`(cd "$M2_HOME"; pwd)`" + [ -n "$JAVA_HOME" ] && + JAVA_HOME="`(cd "$JAVA_HOME"; 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; \\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 + +CLASSWORLDS_LAUNCHER=org.codehaus.plexus.classworlds.launcher.Launcher + +# 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/.."; pwd` + fi + # end of workaround + done + echo "${basedir}" +} + +# concatenates all lines of a file +concat_lines() { + if [ -f "$1" ]; then + echo "$(tr -s '\n' ' ' < "$1")" + fi +} + +BASE_DIR=`find_maven_basedir "$(pwd)"` +if [ -z "$BASE_DIR" ]; then + exit 1; +fi + +########################################################################################## +# 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. +########################################################################################## +if [ -r "$BASE_DIR/.mvn/wrapper/maven-wrapper.jar" ]; then + if [ "$MVNW_VERBOSE" = true ]; then + echo "Found .mvn/wrapper/maven-wrapper.jar" + fi +else + if [ "$MVNW_VERBOSE" = true ]; then + echo "Couldn't find .mvn/wrapper/maven-wrapper.jar, downloading it ..." + fi + if [ -n "$MVNW_REPOURL" ]; then + jarUrl="$MVNW_REPOURL/org/apache/maven/wrapper/maven-wrapper/3.1.0/maven-wrapper-3.1.0.jar" + else + jarUrl="https://repo.maven.apache.org/maven2/org/apache/maven/wrapper/maven-wrapper/3.1.0/maven-wrapper-3.1.0.jar" + fi + while IFS="=" read key value; do + case "$key" in (wrapperUrl) jarUrl="$value"; break ;; + esac + done < "$BASE_DIR/.mvn/wrapper/maven-wrapper.properties" + if [ "$MVNW_VERBOSE" = true ]; then + echo "Downloading from: $jarUrl" + fi + wrapperJarPath="$BASE_DIR/.mvn/wrapper/maven-wrapper.jar" + if $cygwin; then + wrapperJarPath=`cygpath --path --windows "$wrapperJarPath"` + fi + + if command -v wget > /dev/null; then + if [ "$MVNW_VERBOSE" = true ]; then + echo "Found wget ... using wget" + fi + if [ -z "$MVNW_USERNAME" ] || [ -z "$MVNW_PASSWORD" ]; then + wget "$jarUrl" -O "$wrapperJarPath" || rm -f "$wrapperJarPath" + else + wget --http-user=$MVNW_USERNAME --http-password=$MVNW_PASSWORD "$jarUrl" -O "$wrapperJarPath" || rm -f "$wrapperJarPath" + fi + elif command -v curl > /dev/null; then + if [ "$MVNW_VERBOSE" = true ]; then + echo "Found curl ... using curl" + fi + if [ -z "$MVNW_USERNAME" ] || [ -z "$MVNW_PASSWORD" ]; then + curl -o "$wrapperJarPath" "$jarUrl" -f + else + curl --user $MVNW_USERNAME:$MVNW_PASSWORD -o "$wrapperJarPath" "$jarUrl" -f + fi + + else + if [ "$MVNW_VERBOSE" = true ]; then + echo "Falling back to using Java to download" + fi + javaClass="$BASE_DIR/.mvn/wrapper/MavenWrapperDownloader.java" + # For Cygwin, switch paths to Windows format before running javac + if $cygwin; then + javaClass=`cygpath --path --windows "$javaClass"` + fi + if [ -e "$javaClass" ]; then + if [ ! -e "$BASE_DIR/.mvn/wrapper/MavenWrapperDownloader.class" ]; then + if [ "$MVNW_VERBOSE" = true ]; then + echo " - Compiling MavenWrapperDownloader.java ..." + fi + # Compiling the Java class + ("$JAVA_HOME/bin/javac" "$javaClass") + fi + if [ -e "$BASE_DIR/.mvn/wrapper/MavenWrapperDownloader.class" ]; then + # Running the downloader + if [ "$MVNW_VERBOSE" = true ]; then + echo " - Running MavenWrapperDownloader.java ..." + fi + ("$JAVA_HOME/bin/java" -cp .mvn/wrapper MavenWrapperDownloader "$MAVEN_PROJECTBASEDIR") + fi + fi + fi +fi +########################################################################################## +# End of extension +########################################################################################## + +export MAVEN_PROJECTBASEDIR=${MAVEN_BASEDIR:-"$BASE_DIR"} +if [ "$MVNW_VERBOSE" = true ]; then + echo $MAVEN_PROJECTBASEDIR +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 "$M2_HOME" ] && + M2_HOME=`cygpath --path --windows "$M2_HOME"` + [ -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 + +exec "$JAVACMD" \ + $MAVEN_OPTS \ + $MAVEN_DEBUG_OPTS \ + -classpath "$MAVEN_PROJECTBASEDIR/.mvn/wrapper/maven-wrapper.jar" \ + "-Dmaven.home=${M2_HOME}" \ + "-Dmaven.multiModuleProjectDirectory=${MAVEN_PROJECTBASEDIR}" \ + ${WRAPPER_LAUNCHER} $MAVEN_CONFIG "$@" diff --git a/poc/cdevents-visualiser/mvnw.cmd b/poc/cdevents-visualiser/mvnw.cmd new file mode 100644 index 0000000..1d8ab01 --- /dev/null +++ b/poc/cdevents-visualiser/mvnw.cmd @@ -0,0 +1,188 @@ +@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 https://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 Maven Start Up Batch script +@REM +@REM Required ENV vars: +@REM JAVA_HOME - location of a JDK home dir +@REM +@REM Optional ENV vars +@REM M2_HOME - location of maven2's installed home dir +@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 DOWNLOAD_URL="https://repo.maven.apache.org/maven2/org/apache/maven/wrapper/maven-wrapper/3.1.0/maven-wrapper-3.1.0.jar" + +FOR /F "usebackq tokens=1,2 delims==" %%A IN ("%MAVEN_PROJECTBASEDIR%\.mvn\wrapper\maven-wrapper.properties") DO ( + IF "%%A"=="wrapperUrl" SET DOWNLOAD_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 DOWNLOAD_URL="%MVNW_REPOURL%/org/apache/maven/wrapper/maven-wrapper/3.1.0/maven-wrapper-3.1.0.jar" + ) + if "%MVNW_VERBOSE%" == "true" ( + echo Couldn't find %WRAPPER_JAR%, downloading it ... + echo Downloading from: %DOWNLOAD_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('%DOWNLOAD_URL%', '%WRAPPER_JAR%')"^ + "}" + if "%MVNW_VERBOSE%" == "true" ( + echo Finished downloading %WRAPPER_JAR% + ) +) +@REM End of extension + +@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/poc/cdevents-visualiser/pom.xml b/poc/cdevents-visualiser/pom.xml new file mode 100644 index 0000000..060630b --- /dev/null +++ b/poc/cdevents-visualiser/pom.xml @@ -0,0 +1,62 @@ + + + 4.0.0 + + org.springframework.boot + spring-boot-starter-parent + 2.7.13 + + + dev.cdevents + visualiser + 0.0.1-SNAPSHOT + visualiser + PoC project for CDEvents visualiser + + 11 + 2.5.0 + + + + org.springframework.boot + spring-boot-starter + + + org.springframework.boot + spring-boot-starter-web + + + + org.springframework.boot + spring-boot-starter-test + test + + + io.cloudevents + cloudevents-spring + ${cloudevents.version} + + + + io.cloudevents + cloudevents-http-basic + ${cloudevents.version} + + + io.cloudevents + cloudevents-json-jackson + ${cloudevents.version} + + + + + + + org.springframework.boot + spring-boot-maven-plugin + + + + + diff --git a/poc/cdevents-visualiser/src/main/java/dev/cdevents/visualiser/VisualisationApplication.java b/poc/cdevents-visualiser/src/main/java/dev/cdevents/visualiser/VisualisationApplication.java new file mode 100644 index 0000000..8ee9391 --- /dev/null +++ b/poc/cdevents-visualiser/src/main/java/dev/cdevents/visualiser/VisualisationApplication.java @@ -0,0 +1,22 @@ +package dev.cdevents.visualiser; + +import io.cloudevents.spring.mvc.CloudEventHttpMessageConverter; +import org.springframework.boot.SpringApplication; +import org.springframework.boot.autoconfigure.SpringBootApplication; +import org.springframework.context.annotation.Bean; +import org.springframework.web.client.RestTemplate; + +@SpringBootApplication +public class VisualisationApplication { + + public static void main(String[] args) { + SpringApplication.run(VisualisationApplication.class, args); + } + + @Bean + public RestTemplate restTemplate() { + RestTemplate restTemplate = new RestTemplate(); + restTemplate.getMessageConverters().add(0, new CloudEventHttpMessageConverter()); + return restTemplate; + } +} diff --git a/poc/cdevents-visualiser/src/main/java/dev/cdevents/visualiser/config/CloudEventHandlerConfiguration.java b/poc/cdevents-visualiser/src/main/java/dev/cdevents/visualiser/config/CloudEventHandlerConfiguration.java new file mode 100644 index 0000000..c400046 --- /dev/null +++ b/poc/cdevents-visualiser/src/main/java/dev/cdevents/visualiser/config/CloudEventHandlerConfiguration.java @@ -0,0 +1,23 @@ +package dev.cdevents.visualiser.config; + +import io.cloudevents.spring.mvc.CloudEventHttpMessageConverter; +import org.springframework.context.annotation.Bean; +import org.springframework.context.annotation.Configuration; +import org.springframework.http.converter.HttpMessageConverter; +import org.springframework.web.servlet.config.annotation.WebMvcConfigurer; + +import java.util.List; + +@Configuration +public class CloudEventHandlerConfiguration implements WebMvcConfigurer { + + @Override + public void configureMessageConverters(List> converters) { + converters.add(0, cloudEventHttpMessageConverter()); + } + + @Bean + public CloudEventHttpMessageConverter cloudEventHttpMessageConverter() { + return new CloudEventHttpMessageConverter(); + } +} diff --git a/poc/cdevents-visualiser/src/main/java/dev/cdevents/visualiser/controller/MonitorCDEventsController.java b/poc/cdevents-visualiser/src/main/java/dev/cdevents/visualiser/controller/MonitorCDEventsController.java new file mode 100644 index 0000000..3dba5e3 --- /dev/null +++ b/poc/cdevents-visualiser/src/main/java/dev/cdevents/visualiser/controller/MonitorCDEventsController.java @@ -0,0 +1,49 @@ +package dev.cdevents.visualiser.controller; + +import com.fasterxml.jackson.core.JsonProcessingException; +import com.fasterxml.jackson.databind.ObjectMapper; +import dev.cdevents.visualiser.service.MonitorCDEvents; +import io.cloudevents.CloudEvent; +import io.cloudevents.core.provider.EventFormatProvider; +import io.cloudevents.jackson.JsonFormat; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.http.ResponseEntity; +import org.springframework.web.bind.annotation.RequestBody; +import org.springframework.web.bind.annotation.RequestMapping; +import org.springframework.web.bind.annotation.RequestMethod; +import org.springframework.web.bind.annotation.RestController; + +import java.util.List; + +import static com.fasterxml.jackson.databind.SerializationFeature.FAIL_ON_EMPTY_BEANS; + +@RestController +@RequestMapping(value = "/cdevents") +public class MonitorCDEventsController { + + private List monitorImplementations; + + @Autowired + public MonitorCDEventsController(List monitorImplementations) { + this.monitorImplementations = monitorImplementations; + } + + + @RequestMapping(value = "/visualiser", method = RequestMethod.POST) + public ResponseEntity receiveCDEvent(@RequestBody CloudEvent cdEvent){ + ObjectMapper objectMapper = new ObjectMapper(); + EventFormatProvider.getInstance().registerFormat(new JsonFormat()); + objectMapper.registerModule(JsonFormat.getCloudEventJacksonModule()); + objectMapper.disable(FAIL_ON_EMPTY_BEANS); + + try { + System.out.println("Received CDEvent " + objectMapper.writeValueAsString(cdEvent)); + } catch (JsonProcessingException e) { + throw new RuntimeException(e); + } + for (MonitorCDEvents monitorCDEvents : monitorImplementations) { + monitorCDEvents.processCDEvent(cdEvent); + } + return ResponseEntity.ok().build(); + } +} diff --git a/poc/cdevents-visualiser/src/main/java/dev/cdevents/visualiser/service/CDEventsDBService.java b/poc/cdevents-visualiser/src/main/java/dev/cdevents/visualiser/service/CDEventsDBService.java new file mode 100644 index 0000000..d87ebfd --- /dev/null +++ b/poc/cdevents-visualiser/src/main/java/dev/cdevents/visualiser/service/CDEventsDBService.java @@ -0,0 +1,40 @@ +package dev.cdevents.visualiser.service; + +import io.cloudevents.CloudEvent; +import io.cloudevents.spring.mvc.CloudEventHttpMessageConverter; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.beans.factory.annotation.Value; +import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty; +import org.springframework.http.HttpEntity; +import org.springframework.http.HttpHeaders; +import org.springframework.http.MediaType; +import org.springframework.http.ResponseEntity; +import org.springframework.stereotype.Service; +import org.springframework.web.client.RestTemplate; + +@ConditionalOnProperty("visualisation.dbstore.enabled") +@Service +public class CDEventsDBService implements MonitorCDEvents { + + @Autowired + RestTemplate restTemplate; + + @Value("${visualisation.grafanavisi.arangodb.endpoint}") + private String arangoDBEndPoint; + + @Override + public void processCDEvent(CloudEvent cdEvent) { + System.out.println("IN CDEventsDBService received CDEvent"); + + HttpHeaders headers = new HttpHeaders(); + headers.set("Ce-Id", cdEvent.getId()); + headers.set("Ce-Specversion", cdEvent.getSpecVersion().name()); + headers.set("Ce-Source", cdEvent.getSource().toString()); + headers.set("Ce-Type", cdEvent.getType()); + headers.setContentType(MediaType.APPLICATION_JSON); + + ResponseEntity response = restTemplate.postForEntity(arangoDBEndPoint, cdEvent, String.class, headers); + System.out.println("Response Status Code from Arango DB endpoint: " + response.getStatusCode()); + } + +} diff --git a/poc/cdevents-visualiser/src/main/java/dev/cdevents/visualiser/service/CDEventsVisiService.java b/poc/cdevents-visualiser/src/main/java/dev/cdevents/visualiser/service/CDEventsVisiService.java new file mode 100644 index 0000000..828ea30 --- /dev/null +++ b/poc/cdevents-visualiser/src/main/java/dev/cdevents/visualiser/service/CDEventsVisiService.java @@ -0,0 +1,44 @@ +package dev.cdevents.visualiser.service; + +import com.fasterxml.jackson.databind.ObjectMapper; +import com.fasterxml.jackson.databind.SerializationFeature; +import io.cloudevents.CloudEvent; +import io.cloudevents.spring.mvc.CloudEventHttpMessageConverter; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.beans.factory.annotation.Value; +import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty; +import org.springframework.http.HttpEntity; +import org.springframework.http.HttpHeaders; +import org.springframework.http.MediaType; +import org.springframework.http.ResponseEntity; +import org.springframework.http.converter.json.MappingJackson2HttpMessageConverter; +import org.springframework.stereotype.Service; +import org.springframework.web.client.RestTemplate; + +import java.net.URI; + +@ConditionalOnProperty("visualisation.cdeventsvisi.enabled") +@Service +public class CDEventsVisiService implements MonitorCDEvents { + + @Autowired + RestTemplate restTemplate; + @Value("${visualisation.cdeventsvisi.endpoint}") + private String cdEventsVisiEndPoint; + + @Override + public void processCDEvent(CloudEvent cdEvent) { + System.out.println("IN CDEventsVisiService received CDEvent and posted to " + cdEventsVisiEndPoint); + HttpHeaders headers = new HttpHeaders(); + headers.set("Ce-Id", cdEvent.getId()); + headers.set("Ce-Specversion", cdEvent.getSpecVersion().name()); + headers.set("Ce-Source", cdEvent.getSource().toString()); + headers.set("Ce-Type", cdEvent.getType()); + headers.setContentType(MediaType.APPLICATION_JSON); + + ResponseEntity response = restTemplate.postForEntity(cdEventsVisiEndPoint, cdEvent, String.class, headers); + + System.out.println("Response Status Code from CDEvents Visi endpoint: " + response.getStatusCode()); + } + +} diff --git a/poc/cdevents-visualiser/src/main/java/dev/cdevents/visualiser/service/GrafanaVisiService.java b/poc/cdevents-visualiser/src/main/java/dev/cdevents/visualiser/service/GrafanaVisiService.java new file mode 100644 index 0000000..8f19de0 --- /dev/null +++ b/poc/cdevents-visualiser/src/main/java/dev/cdevents/visualiser/service/GrafanaVisiService.java @@ -0,0 +1,39 @@ +package dev.cdevents.visualiser.service; + +import io.cloudevents.CloudEvent; +import io.cloudevents.spring.mvc.CloudEventHttpMessageConverter; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.beans.factory.annotation.Value; +import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty; +import org.springframework.http.HttpEntity; +import org.springframework.http.HttpHeaders; +import org.springframework.http.MediaType; +import org.springframework.http.ResponseEntity; +import org.springframework.stereotype.Service; +import org.springframework.web.client.RestTemplate; + +@ConditionalOnProperty("visualisation.grafanavisi.enabled") +@Service +public class GrafanaVisiService implements MonitorCDEvents { + + @Autowired + RestTemplate restTemplate; + @Value("${visualisation.grafanavisi.endpoint}") + private String grafanaVisiEndPoint; + + @Override + public void processCDEvent(CloudEvent cdEvent) { + System.out.println("IN GrafanaVisiService received CDEvent"); + + HttpHeaders headers = new HttpHeaders(); + headers.set("Ce-Id", cdEvent.getId()); + headers.set("Ce-Specversion", cdEvent.getSpecVersion().name()); + headers.set("Ce-Source", cdEvent.getSource().toString()); + headers.set("Ce-Type", cdEvent.getType()); + headers.setContentType(MediaType.APPLICATION_JSON); + + ResponseEntity response = restTemplate.postForEntity(grafanaVisiEndPoint, cdEvent, String.class, headers); + System.out.println("Response Status Code from Grafana endpoint: " + response.getStatusCode()); + + } +} diff --git a/poc/cdevents-visualiser/src/main/java/dev/cdevents/visualiser/service/MonitorCDEvents.java b/poc/cdevents-visualiser/src/main/java/dev/cdevents/visualiser/service/MonitorCDEvents.java new file mode 100644 index 0000000..9b8c085 --- /dev/null +++ b/poc/cdevents-visualiser/src/main/java/dev/cdevents/visualiser/service/MonitorCDEvents.java @@ -0,0 +1,9 @@ +package dev.cdevents.visualiser.service; + +import io.cloudevents.CloudEvent; + +public interface MonitorCDEvents { + + public void processCDEvent(CloudEvent cdEvent); + +} diff --git a/poc/cdevents-visualiser/src/main/resources/application.properties b/poc/cdevents-visualiser/src/main/resources/application.properties new file mode 100644 index 0000000..1240367 --- /dev/null +++ b/poc/cdevents-visualiser/src/main/resources/application.properties @@ -0,0 +1,7 @@ +visualisation.cdeventsvisi.enabled=true +visualisation.cdeventsvisi.endpoint=http://cdevents-visi.default:8080/cdevents/visi +visualisation.grafanavisi.enabled=true +visualisation.grafanavisi.endpoint=http://cdeventreciever-python.default.svc.cluster.local +visualisation.grafanavisi.arangodb.endpoint=http://cdevent-storage.default.svc.cluster.local +visualisation.dbstore.enabled=true +server.port=8099 diff --git a/poc/cdevents-visualiser/src/test/java/dev/cdevents/visualiser/VisualisationApplicationTests.java b/poc/cdevents-visualiser/src/test/java/dev/cdevents/visualiser/VisualisationApplicationTests.java new file mode 100644 index 0000000..9e7067b --- /dev/null +++ b/poc/cdevents-visualiser/src/test/java/dev/cdevents/visualiser/VisualisationApplicationTests.java @@ -0,0 +1,13 @@ +package dev.cdevents.visualiser; + +import org.junit.jupiter.api.Test; +import org.springframework.boot.test.context.SpringBootTest; + +@SpringBootTest +class VisualisationApplicationTests { + + @Test + void contextLoads() { + } + +} diff --git a/poc/cdevents-visualiser/visualiser-deployment.yaml b/poc/cdevents-visualiser/visualiser-deployment.yaml new file mode 100644 index 0000000..c7bba3b --- /dev/null +++ b/poc/cdevents-visualiser/visualiser-deployment.yaml @@ -0,0 +1,43 @@ +apiVersion: apps/v1 +kind: Deployment +metadata: + creationTimestamp: null + labels: + app: cdevents-visualiser + name: cdevents-visualiser +spec: + replicas: 1 + selector: + matchLabels: + app: cdevents-visualiser + strategy: {} + template: + metadata: + creationTimestamp: null + labels: + app: cdevents-visualiser + spec: + containers: + - image: localhost:5000/cdevents/visualiser:latest + name: visualiser + resources: {} +status: {} +--- +apiVersion: v1 +kind: Service +metadata: + creationTimestamp: null + labels: + app: cdevents-visualiser + name: cdevents-visualiser-service +spec: + ports: + - name: 8099-8099 + port: 8099 + protocol: TCP + targetPort: 8099 + selector: + app: cdevents-visualiser + type: ClusterIP +status: + loadBalancer: {} diff --git a/poc/visualisation_reference_architecture.jpg b/poc/visualisation_reference_architecture.jpg new file mode 100644 index 0000000..976f41c Binary files /dev/null and b/poc/visualisation_reference_architecture.jpg differ