song-search

Song Search - GQL microservice for searching maestro generated song indexes

Graphql

• Graphql Endpoint:

  POST /graphql

• full schema can be found here:

./src/main/resources/schema.graphql

If using secure profile, include token in authorization header: { Authorization: Bearer $JWT }

Apollo Federation support

This service has support for Apollo Federation which extends certain gql types found in workflow-search.

With a service like rdpc-gateway the schemas from these two services can be federated into a larger schema that joins the entities.

Configuration

Configuration is setup in ./src/main/resources/application.yaml

Elasticsearch

This service requires two elastic search index, analysisCentricIndex and fileCentricIndex.

The mappings for these indices can be found from Maestro's mappings:

analysis centric - https://github.com/overture-stack/maestro/blob/master/maestro-app/src/main/resources/analysis_centric.json

file centric - https://github.com/overture-stack/maestro/blob/master/maestro-app/src/main/resources/file_centric.json

Configure other es properties as required.

Secure profile

The secure profile enables Oauth2 scope based authorization on requests.

Configure jwtPublicKeyUrl (or jwtPublicKeyStr for dev setup) in conjunction with the JWT issuer. Also configure the expected scopes as needed.

Test

mvn clean test

Build

With maven:

mvn clean package

With docker:

docker build . -t icgcargo/song-search:test

Run

Maven with app default and secure profile:

mvn spring-boot:run

mvn -Dspring-boot.run.profiles=secure spring-boot:run

Docker with app default and secure profile:

docker run icgcargo/song-search:test

docker run -e "SPRING_PROFILES_ACTIVE=secure" icgcargo/song-search:test