diff --git a/theodolite-quarkus/README.md b/theodolite-quarkus/README.md index d42d00c976e8720e2953ab41b6fcfb68c69979d0..1b651d91e82caaadd2af0a9dc8032e30f8642ccd 100644 --- a/theodolite-quarkus/README.md +++ b/theodolite-quarkus/README.md @@ -7,6 +7,7 @@ If you want to learn more about Quarkus, please visit its website: https://quark ## Running the application in dev mode You can run your application in dev mode using: + ```shell script ./gradlew quarkusDev ``` @@ -14,13 +15,16 @@ You can run your application in dev mode using: ## Packaging and running the application The application can be packaged using: + ```shell script ./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. + +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: + ```shell script ./gradlew build -Dquarkus.package.type=uber-jar ``` @@ -30,11 +34,13 @@ The application is now runnable using `java -jar build/theodolite-quarkus-1.0.0- ## Creating a native executable You can create a native executable using: + ```shell script ./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: + ```shell script ./gradlew build -Dquarkus.package.type=native -Dquarkus.native.container-build=true ``` @@ -47,52 +53,58 @@ If you want to learn more about building native executables, please consult http ## Build docker images For the jvm version use: + ```shell script ./gradlew build docker build -f src/main/docker/Dockerfile.jvm -t theodolite-quarkus-jvm . ``` For the native image version use: + ```shell script ./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: + ```shell script docker run -i --rm theodolite-quarkus-jvm ``` Native image version: + ```shell script docker run -i --rm theodolite-quarkus-native ``` ## Environment variables -**Production:** +**Production:** (Docker-Container) | Variables name | Default value |Usage | | -----------------------------|:----------------------------------:| ------------:| -| `NAMESPACE` | `default` |Determines the namesspace of the KubernetesClient. Used in the KubernetesBenchmark| +| `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 ressources for the subexperiments are found. Used in the KubernetesBenchmark| +| `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:** +**Development:** (local) | Variables name | Default value |Usage | | -----------------------------|:----------------------------------:| ------------:| -| `NAMESPACE` | `default` |Determines the namesspace of the KubernetesClient. Used in the KubernetesBenchmark| +| `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 ressources for the subexperiments are found. Used in the KubernetesBenchmark| +| `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`| -For Development gradle.run configuration: +For the development gradle run configuration in intelij: ``` NAMESPACE=default;THEODOLITE_BENCHMARK=./../../../../config/BenchmarkType.yaml;THEODOLITE_APP_RESOURCES=./../../../../config;THEODOLITE_EXECUTION=./../../../../config/BenchmarkExecution.yaml;MODE=operator @@ -112,7 +124,6 @@ export MODE=operator #### Install Detekt Code analysis Plugin - Install https://plugins.jetbrains.com/plugin/10761-detekt - Install the plugin @@ -120,11 +131,10 @@ Install https://plugins.jetbrains.com/plugin/10761-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 +to build.gradle detekt task