Skip to content

Your First Experiment

Run your first Iter8 experiment by load testing a Kubernetes HTTP service and validating its service-level objectives (SLOs). This is a single-loop Kubernetes experiment.

Before you begin
  1. Ensure that you have a Kubernetes cluster and the kubectl CLI. You can create a local Kubernetes cluster using tools like Kind or Minikube.
  2. Deploy the sample HTTP service in the Kubernetes cluster.
    kubectl create deploy httpbin --image=kennethreitz/httpbin --port=80
    kubectl expose deploy httpbin --port=80
    

Install Iter8 CLI

Install the latest stable release of the Iter8 CLI using brew as follows.

brew tap iter8-tools/iter8
brew install iter8@0.11

Install the latest stable release of the Iter8 CLI using a compressed binary tarball.

wget https://github.com/iter8-tools/iter8/releases/latest/download/iter8-darwin-amd64.tar.gz
tar -xvf iter8-darwin-amd64.tar.gz
Move darwin-amd64/iter8 to any directory in your PATH.

wget https://github.com/iter8-tools/iter8/releases/latest/download/iter8-linux-amd64.tar.gz
tar -xvf iter8-linux-amd64.tar.gz
Move linux-amd64/iter8 to any directory in your PATH.

wget https://github.com/iter8-tools/iter8/releases/latest/download/iter8-linux-386.tar.gz
tar -xvf iter8-linux-386.tar.gz
Move linux-386/iter8 to any directory in your PATH.

wget https://github.com/iter8-tools/iter8/releases/latest/download/iter8-windows-amd64.tar.gz
tar -xvf iter8-windows-amd64.tar.gz
Move windows-amd64/iter8.exe to any directory in your PATH.


Launch experiment

Launch the Iter8 experiment inside the Kubernetes cluster.

iter8 k launch \
--set "tasks={ready,http,assess}" \
--set ready.deploy=httpbin \
--set ready.service=httpbin \
--set ready.timeout=60s \
--set http.url=http://httpbin.default/get \
--set assess.SLOs.upper.http/latency-mean=50 \
--set assess.SLOs.upper.http/error-count=0 \
--set runner=job
About this experiment

This experiment consists of three tasks, namely, ready, http, and assess.

The ready task checks if the httpbin deployment exists and is available, and the httpbin service exists.

The http task sends requests to the cluster-local HTTP service whose URL is http://httpbin.default/get, and collects Iter8's built-in HTTP load test metrics.

The assess task verifies if the app satisfies the specified SLOs: i) the mean latency of the service does not exceed 50 msec, and ii) there are no errors (4xx or 5xx response codes) in the responses.

This is a single-loop Kubernetes experiment where all the previously mentioned tasks will run once and the experiment will finish. Hence, its runner value is set to job.

Some variations and extensions of this experiment
  1. The http task can be configured with load related parameters such as the number of requests, queries per second, or number of parallel connections.
  2. The http task can be configured to send various types of content as payload.
  3. The assess task can be configured with SLOs for any of Iter8's built-in HTTP load test metrics.
  4. This experiment can also be run in your local environment or run within a GitHub Actions pipeline.

Assert experiment outcomes

Assert that the experiment completed without failures, and all SLOs are satisfied. The timeout flag below specifies a period of 120 sec for assert conditions to be satisfied.

iter8 k assert -c completed -c nofailure -c slos --timeout 120s

If the assert conditions are satisfied, the above command exits with code 0; else, it exits with code 1. Assertions are especially useful inside CI/CD/GitOps pipelines. Depending on the exit code of the assert command, your pipeline can branch into different actions.


View experiment report

iter8 k report
The text report looks like this
Experiment summary:
*******************

  Experiment completed: true
  No task failures: true
  Total number of tasks: 1
  Number of completed tasks: 1

Latest observed values for metrics:
***********************************

  Metric                              |value
  -------                             |-----
  built-in/http-error-count           |0.00
  built-in/http-error-rate            |0.00
  built-in/http-latency-max (msec)    |203.78
  built-in/http-latency-mean (msec)   |17.00
  built-in/http-latency-min (msec)    |4.20
  built-in/http-latency-p50 (msec)    |10.67
  built-in/http-latency-p75 (msec)    |12.33
  built-in/http-latency-p90 (msec)    |14.00
  built-in/http-latency-p95 (msec)    |15.67
  built-in/http-latency-p99 (msec)    |202.84
  built-in/http-latency-p99.9 (msec)  |203.69
  built-in/http-latency-stddev (msec) |37.94
  built-in/http-request-count         |100.00
iter8 k report -o html > report.html # view in a browser
The HTML report looks like this

HTML report


View experiment logs

Logs are useful when debugging an experiment.

iter8 k log
Sample experiment logs
INFO[2022-06-27 11:50:39] inited Helm config                           
INFO[2022-06-27 11:50:39] experiment logs from Kubernetes cluster       indented-trace=below ... 
  time=2022-06-27 15:48:59 level=info msg=task 1: ready : started
  time=2022-06-27 15:48:59 level=info msg=task 1: ready : completed
  time=2022-06-27 15:48:59 level=info msg=task 2: ready : started
  time=2022-06-27 15:48:59 level=info msg=task 2: ready : completed
  time=2022-06-27 15:48:59 level=info msg=task 3: http : started
  time=2022-06-27 15:49:11 level=info msg=task 3: http : completed
  time=2022-06-27 15:49:11 level=info msg=task 4: assess : started
  time=2022-06-27 15:49:11 level=info msg=task 4: assess : completed

Cleanup

Remove the Kubernetes objects created by the iter8 k launch command.

iter8 k delete


Congratulations! 🎉 You completed your first Iter8 experiment.

Back to top