README.md

Theodolite-quarkus project

This project uses Quarkus, the Supersonic Subatomic Java Framework.

If you want to learn more about Quarkus, please visit its website: https://quarkus.io/ .

Running the application in dev mode

You can run your application in dev mode using:

./gradlew quarkusDev

Packaging and running the application

The application can be packaged using:

./gradlew build

It produces the theodolite-quarkus-1.0.0-SNAPSHOT-runner.jar file in the /build directory. Be aware that it’s not an über-jar as the dependencies are copied into the build/lib directory.

If you want to build an über-jar, execute the following command:

./gradlew build -Dquarkus.package.type=uber-jar

The application is now runnable using java -jar build/theodolite-quarkus-1.0.0-SNAPSHOT-runner.jar.

Creating a native executable

You can create a native executable using:

./gradlew build -Dquarkus.package.type=native

Or, if you don't have GraalVM installed, you can run the native executable build in a container using:

./gradlew build -Dquarkus.package.type=native -Dquarkus.native.container-build=true

You can then execute your native executable with: ./build/theodolite-quarkus-1.0.0-SNAPSHOT-runner

If you want to learn more about building native executables, please consult https://quarkus.io/guides/gradle-tooling.

Build docker images

For the jvm version use:

./gradlew build
docker build -f src/main/docker/Dockerfile.jvm -t theodolite-quarkus-jvm .

For the native image version use:

./gradlew build -Dquarkus.package.type=native
docker build -f src/main/docker/Dockerfile.native -t theodolite-quarkus-native .

Execute docker images:

Remember to set the environment variables first.

Jvm version:

docker run -i --rm theodolite-quarkus-jvm

Native image version:

docker run -i --rm theodolite-quarkus-native

Environment variables

Production: (Docker-Container)

Variables name	Default value	Usage
NAMESPACE	default	Determines the namespace of the Theodolite will be executed in. Used in the KubernetesBenchmark
THEODOLITE_EXECUTION	./config/BenchmarkExecution.yaml	The complete path to the benchmarkExecution file. Used in the TheodoliteYamlExecutor.
THEODOLITE_BENCHMARK_TYPE	./config/BenchmarkType.yaml	The complete path to the benchmarkType file. Used in the TheodoliteYamlExecutor.
THEODOLITE_APP_RESOURCES	./config	The path under which the yamls for the resources for the subexperiments are found. Used in the KubernetesBenchmark
MODE	yaml-executor	Defines the mode of operation: either yaml-executor or operator

Development: (local via Intellij)

When running Theodolite from within IntelliJ via Run Configurations, set the * Environment variables* field to:

NAMESPACE=default;THEODOLITE_BENCHMARK=./../../../../config/BenchmarkType.yaml;THEODOLITE_APP_RESOURCES=./../../../../config;THEODOLITE_EXECUTION=./../../../../config/BenchmarkExecution.yaml;MODE=operator

Alternative:

export NAMESPACE=default
export THEODOLITE_BENCHMARK=./../../../../config/BenchmarkType.yaml
export THEODOLITE_APP_RESOURCES=./../../../../config
export THEODOLITE_EXECUTION=./../../../../config/BenchmarkExecution.yaml
export MODE=operator
./gradlew quarkusDev

Install Detekt Code analysis Plugin

Install https://plugins.jetbrains.com/plugin/10761-detekt

• Install the plugin
• Navigate to Settings/Preferences -> Tools -> Detekt
• Check Enable Detekt
• Specify your detekt configuration and baseline file (optional)

-> detekt issues will be annotated on-the-fly while coding

ingore Failures in build: add

ignoreFailures = true

to build.gradle detekt task