Add more documentation on deploying TRSS

[jiekang]

The instructions to configure and deploy TRSS (MongoDB, trssConf.json) are sparse. This issue is additions to these instructions.

[jiekang]

The deployment script [1] references two system services, TRSSFrontend and TRSSBackend. What are the contents of these service scripts? There aren't any other references to them in the project.

[1]
https://github.com/adoptium/aqa-test-tools/blob/master/TestResultSummaryService/scripts/deployment.sh

[smlambert]

As far as I am aware, they are 'codenames' for the client/server, the TRSSFrontend is the client (https://github.com/adoptium/aqa-test-tools/tree/master/test-result-summary-client), the TRSSBackend is the server (https://github.com/adoptium/aqa-test-tools/tree/master/TestResultSummaryService).

[jiekang]

If a system is running sudo service TRSSFrontend start, there should be a .service file on the system, otherwise you get "Failed to start TRSSFrontend.service: Unit TRSSFrontend.service not found."

I wonder if this deployment script is used anymore.

@annaibm

Do you know how TRSS is deployed on hyc/fyre?

@steelhead31

Is TRSS deployed via docker compose for Adoptium? Or are there service files for which we could get the contents for? It would be useful to have those committed if they exist.

[smlambert]

It would be useful to have those committed if they exist.

There is a config file, described in https://github.com/adoptium/aqa-test-tools/tree/master/TestResultSummaryService#configure-file which should not be committed, as it has the functional ID and credentials to be able to see the private jobs on the Jenkins server.

At Adoptium, we are running the instance in containers, so utilizing the docker compose scripts. That may not be an option for others utilizing this codebase.

[jiekang]

Right, the contents of the trssConf.json should not be committed. The documentation is already good for that file.

I meant for the TRSSFrontend.service and TRSSBackend.service files that would be required by the deployment.sh script to be located in /etc/systemd/sytem on Linux. I think it would be nice to have documentation with example contents for those.