nmzswarm

Namazu Swarm: CI Job Parallelizer built on Docker and Kubernetes

Namazu Swarm executes multiple CI jobs in parallel across a Docker cluster

Namazu Swarm is a part of Namazu, a programmable fuzzy scheduler for testing distributed systems. Namazu (鯰) means a catfish 🐟 in Japanese.

Blog: http://osrg.github.io/namazu/

Twitter: @NamazuFuzzTest

Motivation

• Faster test execution
• Reproduction of flaky test by repeating the test many times simultaneously
• git bisect

Many code were copy-pasted from our contribution to accelerate CI of Docker/Moby x20 faster (on 10 nodes).

Talks

• OSS/ContainerCon Japan (May 31-June 2, 2017, Tokyo)

Quick Start

Installation

$ ./make.bash
$ cp ./bin/* /usr/local/bin/

Execute on Docker Swarm (single-host)

Initialize the Swarm cluster:

$ docker swarm init

Build the example image:

$ docker build -t dummy ./example/dummy

Execute in 10 concurrent containers:

$ nmzswarm -source dummy -replicas 10

Execute on Docker Swarm (multi-host)

Set -push and target explicitly, so that nmzswarm can push the image to the shared registry.

$ nmzswarm -source dummy -replicas 10 -target your-docker-registry.example.com/foo/bar:baz

Spec

Please refer to example/dummy for an example.

A Docker/OCI image used for Namazu Swarm is supported to have the following image labels:

• net.osrg.namazu-swarm.v0.master.script: shell command that writes the line-separated list of workload identifiers to the stdout.
• net.osrg.namazu-swarm.v0.worker.script: shell command that executes the workload of which identifiers are passed via the stdin.

e.g.

FROM busybox
# tests.txt contains line-separated list of raw shell commands
ADD tests.txt /
LABEL net.osrg.namazu-swarm.v0.master.script="cat /tests.txt" \
      net.osrg.namazu-swarm.v0.worker.script="sh -e -x"

Workload identifiers can be raw shell command strings, but not generally intended to be so.

Implemented and planned features

Orchestrator:

• Kubernetes (was default in v0.0.1, removed atm)
• Docker Swarm-mode (Docker 1.13 or later)

CI:

• Any! (that supports storing credentials for accessing the orchestrator. Example: TravisCI)

Target program:

• Any!

Job progress UI:

• Text
• curses
• Static HTML

Report:

• stdio
• Static HTML

Scheduling

• Chunking & shuffling techniques presented at the OSS/ContainerCon talk
• Makespan optimization using the past job execution history on a DB

How to Contribute

We welcome your contribution to Namazu Swarm. Please feel free to send your pull requests on github!

Copyright

Copyright (C) 2017 Nippon Telegraph and Telephone Corporation.

Released under Apache License 2.0.

Information about the previous release v0.0.1 (based on Kubernetes)

Experimental Result

Note that the first iteration can take a few extra minutes due to pushing the Docker image to the registry.