abchow / pathstore-all

Edge Computing Framework

 ________  ________  _________  ___  ___  ________  _________  ________  ________  _______      
|\   __  \|\   __  \|\___   ___\\  \|\  \|\   ____\|\___   ___\\   __  \|\   __  \|\  ___ \     
\ \  \|\  \ \  \|\  \|___ \  \_\ \  \\\  \ \  \___|\|___ \  \_\ \  \|\  \ \  \|\  \ \   __/|    
 \ \   ____\ \   __  \   \ \  \ \ \   __  \ \_____  \   \ \  \ \ \  \\\  \ \   _  _\ \  \_|/__  
  \ \  \___|\ \  \ \  \   \ \  \ \ \  \ \  \|____|\  \   \ \  \ \ \  \\\  \ \  \\  \\ \  \_|\ \ 
   \ \__\    \ \__\ \__\   \ \__\ \ \__\ \__\____\_\  \   \ \__\ \ \_______\ \__\\ _\\ \_______\
    \|__|     \|__|\|__|    \|__|  \|__|\|__|\_________\   \|__|  \|_______|\|__|\|__|\|_______|
                                            \|_________|                                        

Usage

In order to startup a PathStore network you need to do the following:

mvn package
java -jar pathstore-startup-utility/target/main.jar

The first prompt will ask you for the directory that PathStore is in. Provide the utility with the absolute path on your machine to the repository code (i.e. /home/myles/pathstore-all)

Follow the instructions on the screen and you will have deployed the first node in your network.

After this is complete you can naviagte to the ip address of the machine you provided during start up on port 8080 in your web browser of choice to make changes to your network (scale, application creation / deployment, health monitoring, etc)

Server Assumptions

Every machine that runs any pathstore code should have the following:

Docker CE (Version: Docker version 19.03.13, build 4484c46d9d)

sudo apt-get install docker.io

User account with docker group

# Create user with docker admin privileges
sudo adduser pathstore-installer
sudo usermod -aG docker pathstore-installer

# Creates the certs directory for the networks private registry
sudo mkdir -p /etc/docker/certs.d
sudo chown root:docker /etc/docker/certs.d
sudo chmod 775 /etc/docker/certs.d

Maven (Version: Apache Maven 3.6.0)

sudo apt-get install maven

Java (Version: OpenJDK 11.0.6)

sudo apt-get install openjdk-11-jdk

Client Driver

In order to use PathStore you must have the client driver imported as a dependency in your maven project. First you must run the following commands in the root directory of the repository on your development machine

mvn clean && mvn install package

Then in your maven project you can include the driver by

<dependency>
    <groupId>smartpath</groupId>
    <artifactId>pathstore</artifactId>
    <version>1.0-SNAPSHOT</version>
</dependency>

For an example of api usage see ReadWriteTest

Client Properties File

An example client properties file for a server at 10.70.20.95 on port 1099, with application name pathstore_demo and same master password. This file needs to be present on the machine running any client appication in /etc/pathstore/pathstore.properties

Role=CLIENT
GRPCIP=10.70.20.95
GRPCPort=1099
applicationName=pathstore_demo
applicationMasterPassword=pathstore_demo