rukundob451 / Horreum

Benchmark results repository service

Home Page:https://horreum.hyperfoil.io/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Horreum

Website GitHub issues GitHub forks GitHub stars GitHub license


What is Horreum?

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

Please, visit our project website:

https://horreum.hyperfoil.io

for more information.

Horreum is a Quarkus based application which uses Quinoa as its nodejs engine.

Prerequisites

Local development in Windows

We have prepared a seperate docker compose script to setup Keycloak and PostgreSQL in the Windows platform, check the guide πŸ‘‰ Local development in Windows

Local development with Docker Compose

We have prepared a docker compose script to setup Keycloak and PostgreSQL using following command.

 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.

Local development with Podman

We have prepared a podman-compose script to setup Keycloak and PostgreSQL using following command.

./infra/podman-compose.sh

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

Install of the podman packages:

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

In one terminal do

podman system service -t 0

And then run the test suite with a socket environment as

export DOCKER_HOST=unix:///run/user/${UID}/podman/podman.sock
export TESTCONTAINERS_RYUK_DISABLED=true
mvn clean package

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

once Horreum is running.

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 with development server

To run with test cases do

mvn package
mvn quarkus:dev

To run without test cases do

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

Get Access

Troubleshooting development infrastructure

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

podman volume rm horreum_horreum_pg13

Tested platforms

  • Linux (Fedora, RHEL)
  • Windows/WSL2 (Windows 10 and Windows 11)

Operator

The Horreum operator can help to setup a production environment.

πŸ§‘β€πŸ’» Contributing

Contributions to Horreum Please check our CONTRIBUTING.md

If you have any idea or doubt πŸ‘‡

Contribution is the best way to support and get involved in community !

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

Thanks to all the Contributors ❀️

About

Benchmark results repository service

https://horreum.hyperfoil.io/

License:Apache License 2.0


Languages

Language:Java 46.4%Language:TypeScript 40.5%Language:JavaScript 11.6%Language:Shell 1.2%Language:HTML 0.2%Language:CSS 0.1%