diff --git a/docs/quickstart.md b/docs/quickstart.md index aa85fe7d9250f53f655fb0ccca02a444012ea066..858966ca7dcc16099e0217ee423de42ed714e36b 100644 --- a/docs/quickstart.md +++ b/docs/quickstart.md @@ -12,63 +12,63 @@ All you need to get started is access to a Kubernetes cluster plus kubectl and H 1. To install Theodolite with all its dependencies run: - ```sh - helm repo add theodolite https://cau-se.github.io/theodolite - helm repo update - helm install theodolite theodolite/theodolite -f https://raw.githubusercontent.com/cau-se/theodolite/main/helm/preconfigs/minimal.yaml - ``` + ```sh + helm repo add theodolite https://cau-se.github.io/theodolite + helm repo update + helm install theodolite theodolite/theodolite -f https://raw.githubusercontent.com/cau-se/theodolite/main/helm/preconfigs/minimal.yaml + ``` 1. Get the Theodolite examples from the [Theodolite repository](https://github.com/cau-se/theodolite) and `cd` into its example directory: - ```sh - git clone https://github.com/cau-se/theodolite.git - cd theodolite/theodolite/examples/operator/ - ``` + ```sh + git clone https://github.com/cau-se/theodolite.git + cd theodolite/theodolite/examples/operator/ + ``` 1. Deploy the example Benchmark and package its associated Kubernetes resources in a ConfigMap: - ```sh - kubectl apply -f example-benchmark.yaml - kubectl apply -f example-configmap.yaml - ``` + ```sh + kubectl apply -f example-benchmark.yaml + kubectl apply -f example-configmap.yaml + ``` 1. Verify that the Benchmark has been deployed successfully: - ```sh - kubectl get benchmarks - ``` + ```sh + kubectl get benchmarks + ``` - The output is similar to this: + The output is similar to this: - ``` - NAME AGE STATUS - example-benchmark 81s Ready - ``` + ``` + NAME AGE STATUS + example-benchmark 81s Ready + ``` 1. Run the Benchmark by deploying an Execution: - ```sh - kubectl apply -f example-execution.yaml - ``` + ```sh + kubectl apply -f example-execution.yaml + ``` 1. Verify that the Executions is running: - ```sh - kubectl get executions - ``` + ```sh + kubectl get executions + ``` - The output is similar to this: + The output is similar to this: - ``` - NAME STATUS DURATION AGE - theodolite-example-execution Running 13s 14s - ``` + ``` + NAME STATUS DURATION AGE + theodolite-example-execution Running 13s 14s + ``` - Theodolite provides additional information on the current status of an Execution by producing Kubernetes events. To see them: + Theodolite provides additional information on the current status of an Execution by producing Kubernetes events. To see them: - ```sh - kubectl describe execution theodolite-example-execution - ``` + ```sh + kubectl describe execution theodolite-example-execution + ``` ## Next Steps