grimoirelab/full repository overview

Container based on grimoirelab/installed, which therefore includes GrimoireLab, but also all the services needed to produce a GrimoireLab dashboard: Elasticsearch, MariaDB, and Kibana. As is, it will produce a dashboard for the GrimoireLab project.

To try it, you can just run it as follows:

$ docker run -p 127.0.0.1:5601:5601 \
    -v $(pwd)/credentials.cfg:/override.cfg \
    -t grimoirelab/full

credentials.cfg should have a GitHub API token, in a mordred.cfg format:

[github]
api-token = XXX

This will pull the grimoirelab/full Docker container image from DockerHub (if it is not already in the local host), and will run it.

Upon running it, the container will launch Elasticsearch, MariaDB, and Kibana, so they will be ready when the container launches Mordred to produce a complete GrimoireLab dashboard. With the default configuration, a dashboard for the GrimoireLab project will be produced. Once produced, you can just point your browser to http://localhost:5601⁠ and voila.

The docker run command line above exposed port 5601 in the container to be reachable from the host, as localhost:5601. If you omit "127.0.0.1:", it will be reachable to any other machine reaching your host, so be careful: by default there is no access control in the Kibiter used by this container.

The docker run command line above exposed port 5601 in the container to be reachable from the host, as localhost:5601. If you omit "127.0.0.1:", it will be reachable to any other machine reaching your host, so be careful: by default there is no access control in the Kibiter used by this container.

The command above uses the /override.cfg file for the configuration for Mordred. In fact, this is the fourth configuration file in a chain of configuration files for Mordred. The other three, which capture specifics parts of the configuration, can be substituted when launching the container. The first one, /infra.cfg has the configuration for finding the infrastructure needed to run (Elasticsearch, Kibiter, MariaDB, etc.), and is likely that you don't need to change it except if you want to use some external service instead of those provided by the container. Then, /dashboard.cfg, has the general configuration for producing a dashboard, with some tweeks that seem apprpriate for a demo dashboard. It can be adapted to produce the dashboard in on other ways. The third one, /project.cfg, has the configuration specific for the project to analyze (GrimoireLab itself, in this case).

A slightly different command line is as follows:

$ docker run -p 127.0.0.1:9200:9200 -p 127.0.0.1:5601:5601 \
-v $(pwd)/logs:/logs \
-v $(pwd)/credentials.cfg:/override.cfg \
-t grimoirelab/full

This one will expose also port 9200, which corresponds to Elasticsearch. This allows direct queries to the indexes stored in it. In addition, it also mounts a local directory (logs) so that the container writes Mordred logs in it.

More info⁠.