README
¶
Nomi
Nomi is a benchmarking tool that tests a fleet cluster. With Nomi, you can deploy benchmark units that employ Docker, rkt containers, or just raw systemd units. Nomi is able to collect some metrics and generate some plots from those. To make use of Nomi, you just need to define your own benchmark using a YAML file. Nomi parses this file and runs the benchmark according to the instructions defined in it. Additionally, Nomi provides the possibility to define instructions in one line using the parameter raw-instructions.
Requirements
Nomi requires to be installed on a fleet cluster-node to run properly.
Dependencies:
- fleet and systemd running on the host machine.
- In case you want to run Docker or rkt containers, the respective tool needs to be running on the host machines, too.
- Optional: To generate gnu plots, support for gnuplot is required on the host machine. Alternatively, you can run Nomi as a Docker container, which comes with gnuplot installed, as shown below.
Getting Nomi
Download the latest tarball from here: https://downloads.giantswarm.io/nomi/latest/nomi.tar.gz
Clone the latest git repository from here: https://github.com/giantswarm/nomi.git
Get the latest docker image from here: https://hub.docker.com/r/giantswarm/nomi/
Running Nomi:
nomi help
Run Nomi from source:
make
./nomi help
More information on how to run Nomi and its required parameters in: docs
Further Steps
Check more detailed documentation: docs
Check code documentation: godoc
Future Development
- Future directions/vision
Contact
- Mailing list: giantswarm
- IRC: #giantswarm on freenode.org
- Bugs: issues
Contributing & Reporting Bugs
See CONTRIBUTING for details on submitting patches, the contribution workflow as well as reporting bugs.
License
Nomi is under the Apache 2.0 license. See the LICENSE file for details.
Origin of the Name
nomi (のみ[蚤]) is Japanese for flea.
Documentation
¶
There is no documentation for this package.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
This definition package implements the transformation of a YAML definition to a nomi benchmark
|
This definition package implements the transformation of a YAML definition to a nomi benchmark |
|
This fleet package implements all the operation to communicate with a fleet cluster
|
This fleet package implements all the operation to communicate with a fleet cluster |
|
This output package contains all the operations to render the metrics collected during the benchmark
|
This output package contains all the operations to render the metrics collected during the benchmark |
|
gnuplot
This file has been modified by @Giant Swarm Gmbh
|
This file has been modified by @Giant Swarm Gmbh |
|
This unit package generates all the require unit files This unit package implements the logic of the benchmark execution, as well as it process the defined instructions in the appropiate order
|
This unit package generates all the require unit files This unit package implements the logic of the benchmark execution, as well as it process the defined instructions in the appropiate order |