README.md

Indexer Service

Indexer-gc is a Spring Boot service that is responsible for indexing Records that enable the search service to execute OSDU R2 domain searches against Elasticsearch.

Table of Contents

• Getting started
• Mappers
• Settings and Configuration
• Run service
• Testing
• Deployment
• Entitlements groups
• Licence

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Configuration

Service Configuration

Baremetal

Baremetal service configuration

Google Cloud

Google Cloud service configuration

Mappers

This is a universal solution created using EPAM OQM mappers technology. It allows you to work with various implementations of message brokers.

For more information about mappers:

• OQM Readme

Limitations of the current version

In the current version, the mappers are equipped with several drivers to the stores and the message broker:

• OQM (mapper to message brokers): Google PubSub; RabbitMQ

Settings and Configuration

Prerequisites

1. Mandatory

• JDK 8
• Lombok 1.16 or later
• Maven

2. For Google Cloud only

• GCloud SDK with java (latest version)

Baremetal Service Configuration

Baremetal service configuration

Google Cloud Service Configuration

Google Cloud service configuration

Run service

Run Locally

Check that maven is installed:

$ mvn --version
Apache Maven 3.6.0
Maven home: /usr/share/maven
Java version: 1.8.0_212, vendor: AdoptOpenJDK, runtime: /usr/lib/jvm/jdk8u212-b04/jre
...

You may need to configure access to the remote maven repository that holds the OSDU dependencies. This file should live within ~/.mvn/community-maven.settings.xml:

$ cat ~/.m2/settings.xml
<?xml version="1.0" encoding="UTF-8"?>
<settings xmlns="http://maven.apache.org/SETTINGS/1.0.0"
          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
          xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.0.0 http://maven.apache.org/xsd/settings-1.0.0.xsd">
    <servers>
        <server>
            <id>community-maven-via-private-token</id>
            <!-- Treat this auth token like a password. Do not share it with anyone, including Microsoft support. -->
            <!-- The generated token expires on or before 11/14/2019 -->
             <configuration>
              <httpHeaders>
                  <property>
                      <name>Private-Token</name>
                      <value>${env.COMMUNITY_MAVEN_TOKEN}</value>
                  </property>
              </httpHeaders>
             </configuration>
        </server>
    </servers>
</settings>

• Update the Google cloud SDK to the latest version:

gcloud components update

• Set Google Project Id:

gcloud config set project <YOUR-PROJECT-ID>

• Perform a basic authentication in the selected project:

gcloud auth application-default login

• Navigate to indexer service's root folder and run:

mvn jetty:run
## Testing
* Navigate to indexer service's root folder and run:
 
```bash
mvn clean install   

• If you wish to see the coverage report then go to testing/target/site/jacoco-aggregate and open index.html

• If you wish to build the project without running tests

mvn clean install -DskipTests

After configuring your environment as specified above, you can follow these steps to build and run the application. These steps should be invoked from the repository root.

cd provider/indexer-gc && mvn spring-boot:run

Testing

Navigate to indexer service's root folder and run all the tests:

# build + install integration test core
$ (cd testing/indexer-test-core/ && mvn clean install)