Skip to content

Latest commit

 

History

History
32 lines (27 loc) · 1.2 KB

CONTRIBUTING.md

File metadata and controls

32 lines (27 loc) · 1.2 KB

repository organization

├── docs
├── infrastructure
│   ├── grafana
│   ├── inventory
│   ├── local
│   └── playbooks
├── runner
├── scripts
└── tests

docs

Documentation and images for usage of this repository

infrastructure

  • grafana: Any Grafana configurations for dashboards and such.
  • inventory: Defines the hosts this project is targeting for production
  • local: Any infrastructure parts needed to run this in a local system. Requires docker-compose to be installed. It will run containers for Grafana and InfluxDB. See below for more details.
  • playbooks: Ansible playbooks run by the runner to provision the target benchmark system.

runner

Houses the runner code and configuration. npm install should be run in this folder. Use npm run tests to execute tests (TBD)

scripts

Various convenience scripts to make running things a bit easier

tests

Houses the code for the benchmarks. npm install should be run in this folder. Use npm run tests to execute tests