Quick Deployment Guide | ENEXA documentation

Setting Up Environment for Running the Service

To run the service, you need to prepare the environment. Below are the steps to do so:

Prepare Metadata Directory:
- Create a directory named “metadata”.
- Place all required metadata files inside this directory.
- For each module you require, you should place a .ttl file here. These .ttl files can be found in the module repository. If you are integrating your module with Enexa, please refer to this section (Starting the Metadata File) and add your module’s .ttl file in the metadata directory.
- For example, for a scenario, the contents of the metadata directory could be as follows:
```
embeddings.ttl
tentris.ttl
cel-deploy.ttl
extraction.ttl
transform.ttl
cel-train.ttl
repair.ttl
wikidata-preproc.ttl
```
Create a Shared Directory:
- The entire platform requires a shared directory for exchanging files between containers. Since Docker is used, this directory will be utilized by Docker images as a mounted volume. It should be introduced to the service as a path with sufficient read and write access. To fulfill this requirement, create a directory and designate it as the shared directory. Set the path to this directory when running the service.

Run the triple store as META-DATA store

Utilize any triple store of your preference, ensuring it offers an endpoint for executing SPARQL queries. One suggestion is to run Fuseki as a docker-compose, as outlined below:

    
 version: "3.0"
 services:
   fuseki:
     image: stain/jena-fuseki
     container_name: fuseki
     networks:
       - enexaNet
     ports:
       - "3030:3030"
     environment:
       ADMIN_PASSWORD: pw123
     volumes:
       - /data/fusekiData:/fuseki

Running the Service

To run the Enexa service, Docker is required. First, ensure you have Docker installed by running the following command:

docker -v

If Docker is not installed, please install it before proceeding.

Next, pull the Docker image using one of the following commands:

docker pull hub.cs.upb.de/enexa/images/enexa-service-demo:1.2.0
or 
docker pull hub.cs.upb.de/enexa/images/enexa-service:latest (this image is not available yet)

After pulling the image, run the service using the following example Docker command. Replace all placeholders within brackets [] with valid data:

sudo docker run -d --name [set as you wish] --network [replace with network name] 
-v [replace with valid path on your machine]:/home/shared 
-v /var/run/docker.sock:/var/run/docker.sock 
-v [replace with valid path for metadata on your machine]:/home/metadata 
-e ENEXA_META_DATA_ENDPOINT=[triple store endpoint]  
-e ENEXA_META_DATA_GRAPH=[something like http://example.org/meta-data] 
-e ENEXA_MODULE_DIRECTORY=[set] 
-e ENEXA_RESOURCE_NAMESPACE=[set something like http://example.org/enexa/] 
-e ENEXA_SERVICE_URL=[on which URL this service would be available something like http://enexaservice:8080/] 
-e ENEXA_SHARED_DIRECTORY=[shared directory path] 
-e DOCKER_NET_NAME=[network name] 
[image name something like hub.cs.upb.de/enexa/images/enexa-service-demo:1.2.0]

Ensure all placeholders are replaced with the appropriate values according to your setup.

Option Two: Running from the Code (Not Recommended - For Development Purposes Only)

Clone the code from the Git repository here.

Set all these variables:

export ENEXA_META_DATA_ENDPOINT=[triple store endpoint]
export ENEXA_META_DATA_GRAPH=[something like http://example.org/meta-data]
export ENEXA_MODULE_DIRECTORY=[set]
export ENEXA_RESOURCE_NAMESPACE=[set something like http://example.org/enexa/]
export ENEXA_SERVICE_URL=[on which URL this service would be available something like http://enexaservice:8080/]
export ENEXA_SHARED_DIRECTORY=[shared directory path] 
export DOCKER_NET_NAME=[network name] 

Use “mvn clean install”.
Run it with java -jar [path of jar file like target/enexa-service-0.0.1-SNAPSHOT.jar].

Testing Service is Up

After running the service, you can call “[your api address like http://localhost:8080]/test”. If you receive “OK”, then the service is up.