OpenLXP - Experience Search Engine (XSE)

XSE works to streamline the search capabilities relied upon by Experience Discovery Service (XDS). The Experience Indexing Service (XIS) loads records into XSE (assumed to be Elasticsearch).

This repository contains an example docker-compose in order to deploy an Elasticsearch cluster for the OpenLXP platform. For local testing it is recommended that the user simply uncomment the eso1 instance defined in the XIS docker-compose (eso1)

ECC System Architecture

---
title: ECC Connected Systems
---
graph TD;
        subgraph Legend
                1("System")-->|MVP|2("System");
                1("System")-.->|Future Planned|2("System");
        end
        subgraph External Applications
                XSR;
                XSS[XSS/LDSS];
        end
        subgraph ECC
                XIS;
                XDS;
                XDSUI[XDS UI];
                XMS;
                XMSUI[XMS UI];
                XIA;
                XSE;
        end
        XSS-->|Schema|XIS & XIA;
        XIA-->|Courses|XIS;
        XIS-->|Courses|XMS & XDS & XSE;
        XSE-->|Courses|XDS;
        XSR-->|Courses|XIA;
        XDS-->|Courses|XDSUI;
        XMS-->|Courses|XMSUI;

Loading

Intended use

Intended use of this is that a user could reference this architecture as boilerplate to stand-up a search engine for their learning experience platform on OpenLXP.

Prerequisites

Install Docker & docker-compose

Windows & MacOS

• Download and install Docker Desktop (docker compose included)

Linux

You can download Docker Compose binaries from the release page on this repository.

Rename the relevant binary for your OS to docker-compose and copy it to $HOME/.docker/cli-plugins

Or copy it into one of these folders to install it system-wide:

• /usr/local/lib/docker/cli-plugins OR /usr/local/libexec/docker/cli-plugins
• /usr/lib/docker/cli-plugins OR /usr/libexec/docker/cli-plugins

(might require making the downloaded file executable with chmod +x)

Clone the project

Clone the Github repository

git clone https://github.com/adlnet/ecc-openlxp-xse.git

Deployment

1. Create the elastic docker network Open a terminal and run the following command in the root directory of the project.

   docker network create elastic
   

2. Run the command below to deploy XSE from docker-compose.yaml

   docker-compose up -d --build
   

Further resources

For more details on Elasticsearch, please refer to the following documentation:

• Elasticsearch - What is Elasticsearch

Additional Documentation

ECC-Openlxp Wiki can be found here

License

This project uses the Apache license.