Child pages
  • tutorial - set up and run Kafka system tests with ducktape

Versions Compared


  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents

This tutorial will show you how to set up a test cluster and run Kafka system tests on your local machine. I'll assume here that you have a clone of Kafka trunk.

This is broken down into a series of short-ish videos. A summary of the commands run is below each video clip, so you can skip any video clip if you want to.



Ensure Vagrant and Virtualbox are installed

We'll need both Vagrant and Virtualbox to create a test cluster


To install Virtualbox, go here



Bootstrap Vagrant for system testing 

Code Block
$ # This does things like installing necessary Vagrant plugins, creating a Vagrantfile.local, and creating a reusable Vagrant base box
$ tests/


Code Block
$ # If you skipped the previous step, make sure you have a Vagrantfile.local in your Kafka directory
$ cp vagrant/system-test-Vagrantfile.local Vagrantfile.local
$ # Update Vagrantfile.local, and set num_workers = 10
$ # If you packaged a box,        set base_box = "kafkatest-worker"
$ vagrant up # This will bring up your cluster
$ # Other useful vagrant commands
$ vagrant status 		# See how many vms you have, whether they're running, etc.	
$ vagrant ssh <vm_name> # ssh into a vm
$ vagrant hostmanager   # update /etc/hosts on each vm
$ vagrant halt 			# shut down without destroying
$ vagrant destroy -f 	# destroy the vms



Run the tests

Here I'll install ducktape, introduce a few useful ducktape commands, show how to actually run the tests, and give an overview of test output.