Skip to content

Latest commit

 

History

History
81 lines (58 loc) · 4.02 KB

Setup-TRSS.md

File metadata and controls

81 lines (58 loc) · 4.02 KB
Raw

TRSS Setup

This page documents the setup of the production-ready Test Result Summary Service (TRSS) running at trss.adoptium.net. For instructions to run TRSS for development purposes, refer to the local deployment instructions in the aqa-test-tools repository.

Setup

Prerequisites:

Pre setup recommendations:

  • Dedicate a separate disk for /var/lib/docker (>30G) and one for the directory in which you kick off the TRSS service (>60G), the latter will be where TRSS stores its data.
  • Run the service with a non-root user.

Before running the service:

Connecting to Jenkins

  • Before you start the service, create a file named trssConf.json. This file will be stored in aqa-test-tools/TestResultSummaryService/ once you clone the aqa-test-tools repository.
  • This file will contain the credentials needed by the TRSS service to connect to your Jenkins instance. It should look like this:
{
	"https://yourjenkinsserver.com": {
		"user" : "[email protected]",
		"password" : "123"   <=== the value can be token
	}
}

Nginx config

The TRSS setup includes 2 layers of nginx. One running on the host system and one in a docker container (the docker container is created later when you run the TRSS service for the first time). The host system layer is responsible for receiving all inbound traffic which will direct to the nginx docker container. The docker container layer redirects this traffic to the appropriate TRSS service.

The host system layer nginx.conf at /etc/nginx/nginx.conf should include

include /etc/nginx/sites-enabled/*;

which should include a symlink to /etc/nginx/sites-enabled/defaults.

The file /etc/nginx/sites-enabled/defaults should contain a code block which passes all inbound traffic to http://localhost:4000. It should look something like this:

    location / {
                proxy_pass http://localhost:4000;
    }

http://localhost:4000 will be where the docker nginx layer will listen for incoming traffic.

Installing Certbot (requires root access)

To enable https install certbot. Follow the instructions here or those below:

  1. Install snapd, may already be installed on Ubuntu

  2. Install certbot with snap

snap install --classic certbot
  1. Prepare certbot
ln -s /snap/bin/certbot /usr/bin/certbot
  1. Install certificates
certbot --nginx

Steps to run the service

  1. On the filesystem created for TRSS (see this step), clone the aqa-test-tools repository and cd into it.

  2. Move the trssConf.json file you created earlier into aqa-test-tools/TestResultSummaryService/

  3. From the top level directory of the repository run npm run docker &. FYI the directory $PWD/aqa-test-tools/mongo/data is mapped to /data/db inside the aqa-test-tools-mongo docker container, this directory will be where mongo stores its data. See the docker-compose.yml for more details.

  4. If your nginx configuration is setup correctly, run nginx -s reload.

If you would like to stop the service run npm run docker-down, then run docker system prune before rerunning the service with step 3.

If npm run docker-down does not fully stop the service, check which containers of the service are still running and stop them manually with docker stop.