Feuerwerk is a tool designed to run load tests in Docker containers using Google Kubernetes Engine. It is a command-line tool, so be sure to read up on how to run commands from your terminal.

Feuerwerk creates a Kubernetes deployment, launches it and then monitors your containerized tests, tearing down the deployment once the tests have finished running.

Feuerwerk was created and tested using macos, iterm2 and zsh. Please consult the documentation for your operating system, terminal emulator and shell if any of the command-line instructions provided here do not work for you.

To use this project you will need the following tools installed:

• pipenv to create a virtual environment and install the required Python dependencies
• kubectl to manage your Kubernetes deployments
• Google's Cloud SDK to configure Google Kubernetes Engine for use

You also will need to have a Docker image containing a load test that can be run. You can find an example of creating a Dockerized load test here.

Once you checked out this repo, create the virtual environment and activate it using the following commands:

• pipenv install
• pipenv shell

If you haven't already created one, use the Google Cloud Platform Console to create one and note the value Google returns to you for the name of the project.

For the sake of examples, the project ID is 'yetanothertest-219614'

Next we need to configure our environment to use this project using this CLI command:

gcloud config set project yetanothertest-219614

followed by setting which region and zone you wish to run your tests in. In this example we are using the US West zone. Choose a zone that provides you with the computing resources you will need to run your tests.

gcloud config set compute/zone us-west1a

Create a user who has permissions to access the resources you will be deploying up to GKE. In this example we're using the same project as above and creating a user named 'feuerwerk'

gcloud iam service-accounts create feuerwerk

Then we need to give that user permission to access your project

gcloud projects add-iam-policy-binding yetanothertest-219614 --member "serviceAccount:[email protected]" --role "roles/owner"

With the user configured, we need to obtain the access keys and other credentials associated with the user we created. These will be written to a file on your local filesystem.

gcloud iam service-accounts keys create loadtest.json --iam-account [email protected]

Next, we need to assign a value representing the fully qualified of path of the file to an environment variable so the Kubernetes python client libraries can find. For bash or zsh, you can use the following command:

export GOOGLE_APPLICATION_CREDENTIALS=/Users/chartjes/mozilla-services/feuerwerk/loadtest.json

You can optionally add the following line to your .env file so it is accessible the next time you exit the virtual environment and re-enter it.

GOOGLE_APPLICATION_CREDENTIALS=/Users/chartjes/mozilla-services/feuerwerk/loadtest.json

You will also need to set up a cluster for your load test containers to run in. Please follow the instructions on configuring cluster access for kubectl.

To run your load test, run the following command:

python runner.py

You will be prompted to enter:

• a name for the deployment
• how many copies of your container to run at once
• the name of the image (ie gcr.io/yetanothertest-219614/kintowe-loadtests)

You should see output similar to the following:

Loading our k8s config
Creating API instance object for GCP
How many copies of the container do you want running? 3
What Docker image are you using? (ie chartjes/kinto-loadtests) chartjes/kinto-loadtest
Checking to see if image exists locally...
Could not find the image locally
Checking if image exists at Docker Hub...
Could not find the requested Docker image
What Docker image are you using? (ie chartjes/kinto-loadtests) chartjes/kinto-loadtests
Checking to see if image exists locally...
Could not find the image locally
Checking if image exists at Docker Hub...
Found the image on Docker hub
Creating our deployment fw-d1f678bb4a8b4580b674739c589b31f8
Running load test using 3 instance(s) of chartjes/kinto-loadtests image                            #                                                                  | 0 Elapsed Time: 0:04:25 
Load test completed
GCP reported no containers could be found
Deployment deleted