Scaling Experiments with Hyperledger Umbra: Internship Activities - Project Plan

Overview

This document contains the roadmap of activities to accomplish the topics proposed by the 2020 internship project named Scaling Experiments with Hyperledger Umbra. 

The source code and documentation of this project is going to be sent as a pull request to the main umbra repository https://github.com/hyperledger-labs/umbra. 

During the development of the project a fork of such repository will be used for the activities below.

Activities

1. Add monitor and agent source code
   1. Add monitor component to umbra - hosts, processes and containers can be monitored (cpu, mem, disk) and network (capture pcaps)
      1. Monitor is triggered by broker events
      2. Monitoring can be continuous or not
   2. Add agent component to umbra - enables containers to run tools that can create disturbances in the network (e.g., play pcaps, iperf, ping, etc)
      1. Agent is triggered by broker events
      2. Different types of agent events can be called (live stream metrics to database, repetitions, etc)
2. Provide support for HL Fabric 2.0
   1. Read the docs about Fabric 2.0 
   2. Implement modifications to fully support Fabric 2.0
3. Scale to cluster of servers
   1. Define requirements to scale project
   2. e.g., ssh keys, config files, docker image downloads/builds
   3. Code needed modules/classes
   4. Test all the architecture running with Fabric in scaled experimental scenarios
4. Build umbra monitoring toolset
   1. Define monitoring interfaces for nodes and links
   2. e.g., capture node cpu percent, link packet statistics
   3. Add methods to capture pcaps in node interfaces
   4. Set database interface to store monitored data (e.g., influxdb, elasticsearch)
   5. Set visualization interface to show stored data (e.g., graphana/kibana)
5. Build Experimental Analysis Report
   1. Define possible analysis of results to generate test report
   2. Define test report format
   3. Code modules/classes to report test results
   4. Test modules and output report
6. Document the project
1. Iterate documentation of source code during project
2. Refine documentation by the end of project
3. Publish readthedocs documentation for the whole project
4. Containing multiple test cases exploring: basic architecture, scaling techniques, analysis report
5. Write project demo and article describing internship activities

Extra (If time allows):

• Extend architecture to other Hyperledger project(s)
• Choose a HL blockchain project
• Define how architecture can be extended
• e.g., needed components, interfaces, modules
• Create the basic architecture to extend project

Schedule

Communication

On weekly basis by zoom call with other umbra related projects