Prometeo WebSocket server

This repository contains the Prometeo solution that monitors the MQTT queue for new messages and in turn sends them to the Websocker Server and also stores them in the database.

Setting up the solution

Prerequisites

1. Docker
2. IBM CLI
3. Kubectl
4. Helm
5. Skaffold

Run locally with Node.js

1. Install dependencies

   npm install
   

2. Run server

   npm start
   

   This runs the websocket server using nodemon. See package.json file.

Running locally using docker

1. Build the image and optionally tag

   docker build . -t ws
   

    STEP 1: FROM docker.io/node:12-alpine
    STEP 2: WORKDIR /
    --> ce0dd4bfad1
    STEP 3: COPY package*.json ./
   

2. Run the image

   docker run --name ws ws:latest
   

Running on Kubernetes

1. The project uses helm charts to deploy the service to Kubernetes. You can use the following command to see what the final charts look like:

   helm template <chart_name> chart/ws --dry-run  
   

2. You can use the following command to install the charts on Kubernets, but we suggest creating a CI/CD pipeline to automate code testing and deployment in your cluster.

   helm upgrade <chart_name> chart/ws -i 
   

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting Prometeo pull requests.

License

This project is licensed under the Apache 2 License - see the LICENSE file for details.