Amiable

Amiable is a web app for monitoring the use of AMIs. You can access it here: https://amiable.gutools.co.uk

How to run Amiable locally

Amiable uses Google Auth. For this reason, we need to run Amiable through an nginx proxy amiable.local.dev-gutools.co.uk. This can be achieved by running:

./script/setup

• Setup Amiable configuration. A conf file is expected from Amiable. The location of that file (as shown in ./sbt) is: $HOME/.gu/amiable.local.conf That file must contain all the configuration values that exist in application.conf

For example the following values must be set:

   APPLICATION_SECRET="abcdefghijklmnopqrstuvwxyz"
   PRISM_URL="https://prism.gutools.co.uk"
   AMIGO_URL="https://amigo.gutools.co.uk"
   HOST="https://amiable.local.dev-gutools.co.uk"

In order to setup the auth parameters (eg. serviceAccountCertPath), please consult someone from the Dev Tools team.

• ./sbt run open your browser at https://amiable.local.dev-gutools.co.uk!

Common problems

• If when running main you can an error "Could not find a suitable constructor..." it's something wrong with your config file - you probably need to add include "application.conf" to your application.local.conf file.

CI/CD

CI is configured in TeamCity. It will execute ./script/ci.

CD is configured in RiffRaff. The project name is tools::amiable.

Note, it was also "amiable" at one point too, however was namespaced to "tools::" for consistency with other projects. The "amiable" project has a block on it to prevent mistakes.