Intro

Welcome to the Core APIs User Guide, contained is an in-depth set of instructions to fully set up, configure, and trigger the product so you can start your Knowledge Graph exploration. The Core APIs is a collection of tools providing the ability to easily perform complex queries, analysis, and traversal against any Knowledge Graph, for use by any developer even with no prior Knowledge Graph experience. It can even be used for building user interfaces or as a basis for integration with other services in your architecture. The Core APIs is a lightweight, platform-agnostic tool with support for all common Knowledge Graphs using W3C Semantic Web Standards SPARQL 1.1 query language.

...

Contents

...

Configuring the Core APIs

...

This Quick Create Stack will start up an ECS Cluster with all the required permissions and networking, with the Core APIs running within as a task. All that is required is that you provide the configuration variables as described in the previous section, then once complete, click on the Create Stack button.INSERT SCREENSHOT TO MARKETPLACE WITH DETAILS FILLED

...

Running via a Docker Image on AWS

In addition to the preconfigured stack created by the CloudFormation template, you also have the ability to run the Core APIs in your own new or existing AWS environment.

1. To do this first ensure you have an AWS ECS Cluster running, please ensure that it is in the same VPC as your Knowledge Graph if it is also running in AWS.

2. Next, you must create a Task Definition containing the Core APIs container image.

   1. This is done by selecting the Create New Task Definition button selecting a Launch Type Compatibility of either FARGATE or EC2.

   2. Next, provide the task with a name and create an IAM Task Role that grants permission for your container to call RegisterUsage, as defined in the following code. You must supply this IAM role in the Task Role parameter of the Amazon ECS task or Amazon EKS pod definition.

      Code Block
      { "Version": "2012-10-17", "Statement": [ { "Action": [ "aws-marketplace:RegisterUsage" ], "Effect": "Allow", "Resource": "*" } ] }

   3. Then add the container, this is where you specify the Docker Container image location, along with exposed ports and environment variables. To retrieve the image URI, select the View Container Image Details link on the Core API’s Marketplace Product Launch page. For the port mappings, provide the values of 8080 for both host and container ports, then for the environment variables, provide them as explained in the configuration section about and as shown in the image below. In addition, it is recommended you enable logging by checking the Auto-configure CloudWatch Logs box.

      Image Added

   4. Now that the Task Definition has been created, you may start the new task from within your ECS cluster.

Running via a Local On-Prem Docker Image

...