diff --git a/docs/installation.md b/docs/installation.md index 3cc0907e2d0a0ffa1aa8879511ad088019f0b21e..a97e5ea499657cdc3c40f3c03a13c974b5a39bab 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -32,10 +32,11 @@ For this purpose the [default values file](https://github.com/cau-se/theodolite/ For Kubernetes clusters with limited resources such as on local developer installations, we provide a [minimal values file](https://github.com/cau-se/theodolite/blob/master/helm/preconfigs/minimal.yaml). -### Persisting Results +### Persisting results To store the results of benchmark executions in a [PersistentVolume](https://kubernetes.io/docs/concepts/storage/persistent-volumes), `operator.resultsVolume.persistent.enabled` has to be set to `true`. This requires that either a statically provisioned PersistentVolume is available or a dynamic provisioner exists (which is the case for many Kubernetes installations). If required, you can select a storage class with `operator.resultsVolume.persistent.storageClassName`. You can also use an existing PersistentVolumeClaim by setting `operator.resultsVolume.persistent.existingClaim`. +If persistence is not enabled, all results will be gone upon pod termination. ### Standalone mode diff --git a/docs/running-benchmarks.md b/docs/running-benchmarks.md index 309915fa4dfcd5362e7901e197e07c1d532977db..8f8ee87cf151736c9addfd4e5c3586a0e2846b5d 100644 --- a/docs/running-benchmarks.md +++ b/docs/running-benchmarks.md @@ -10,7 +10,8 @@ Running scalability benchmarks with Theodolite involves the following steps: 1. [Deploying a benchmark to Kubernetes](#deploying-a-benchmark) 1. [Creating an execution](#creating-an-execution), which describes the experimental setup for running the benchmark -<!-- TODO analyzing results--> +1. [Accessing Benchmark Results](#accessing-benchmark-results) + ## Deploying a Benchmark @@ -117,3 +118,18 @@ Theodolite provides additional information on the current status of an Execution ```sh kubectl describe execution <execution-name> ``` + + +## Accessing Benchmark Results + +<!-- TODO more specific --> + +Theodolite stores the results of benchmark executions in CSV files, whose names are starting with `exp<id>_...`. These files can be read and analyzed by Theodolite's analysis notebooks. + +If [persisting results](installation#persisting-results) is enabled in Theodolite's installation, the result files are stored in a PersistentVolume. Depending on the cluster setup or Theodolite's configuration, the content of these volumes can usually be mounted into your host system in some way or accessed via your cloud provider. + +For installations without persistence, but also as an alternative for installations with persistence, we provide a second option to access results: Theodolite comes with a *results access sidecar*. It allows to copy all benchmark results from the Theodolite pod to your current working directory on your host machine with the following command: + +```sh +kubectl cp $(kubectl get pod -l app=theodolite -o jsonpath="{.items[0].metadata.name}"):/results . -c results-access +```