abhi808shek / horreum

Benchmark results repository service

Horreum

Horreum is a service for storing performance data and regression analysis.

Project website: https://horreum.hyperfoil.io

Prerequisites

• Java 11
• Apache Maven 3.8
• Keycloak
• Grafana
• PostgreSQL 12+

Docker

We have prepared a docker-compose script to setup Keycloak, PostgreSQL and Grafana using

docker-compose -p horreum -f infra/docker-compose.yml up -d

and after a few moments everything should be up and ready. The script will create some example users.

podman

We have prepared a podman-compose script to setup Keycloak, PostgreSQL and Grafana using

./infra/podman-compose.sh

and after a few moments everything should be up and ready. The script will create some example users.

Install:

dnf install -y podman podman-plugins podman-compose podman-docker

In order to run the test suite please enable socket environment:

systemctl --user enable --now podman.socket
export DOCKER_HOST=unix:///run/user/${UID}/podman/podman.sock
export TESTCONTAINERS_RYUK_DISABLED=true

Shutdown:

podman-compose -p horreum -f infra/docker-compose.yml down

Example configuration

You can preload Horreum with some example data with

infra/example-configuration.sh

OpenSSL

Horreum currently depends on the OpenSSL 1.1.x API so you will need to enable legacy mode if you are using an OpenSSL 3 platform.

To do this edit the configuration file /etc/ssl/openssl.cnf to uncomment this section

[provider_sect]
default = default_sect
legacy = legacy_sect

[default_sect]
activate = 1

[legacy_sect]
activate = 1

and set the following environment variable

export NODE_OPTIONS=--openssl-legacy-provider

Credentials

Horreum

Horreum is running on localhost:8080

Role	Name	Password
User	user	secret

Keycloak

Keycloak is running on localhost:8180

Role	Name	Password	Realm
Admin	admin	secret
User	user	secret	horreum

Getting Started

mvn package
mvn quarkus:dev

To run without test cases do

mvn -DskipTests=true package
mvn -Dquarkus.test.continuous-testing=disabled quarkus:dev

Access

• localhost:3000 for the create-react-app live code server
• localhost:8080 for the Quarkus development server

Troubleshooting development infrastructure

If PostgreSQL container fails to start try removing the volume using:

podman volume rm horreum_horreum_pg12

If you are having problems with Grafana login after restarting the infrastructure wipe out old environment files using:

rm horreum-backend/.env .grafana

Operator

The Horreum operator can help to setup a production environment.

Contributing

Contributions to Horreum are managed on GitHub.com

• Ask a question
• Raise an issue
• Feature request
• Code submission

Contributions are most welcome !

Please, consult our Code of Conduct policies for interacting in our community.

Consider giving the project a star on GitHub if you find it useful.

License

Apache-2.0 license