poc-cb-net/

README

Read this in other languages: English, 한국어

[Shortcut]

• An overview of Cloud-Barista Network
• Introduction to Cloud Adaptive Network
• Getting started with cb-network system
  • How to run
• Demo: 1st step, to run existing services in multi-cloud

An overview of Cloud-Barista Network

Cloud-Barista Network (cb-network) is under-study. It is the global scale network that copes with the differences and variability of cloud networks (e.g., VPC, vNet) to link cloud infrastructures around the world.

As the top-level concept, it will gradually expand by adding network-related technologies (e.g., Subnet, DNS, and Load balancer). It could be a virtual network for Cloud-Barista independent of the CSPs' network.

The cb-network will mainly represent systems or visions, and Cloud Adaptive Network (CLADNet) represent a technology under research and development.

Introduction to Cloud Adaptive Network

Cloud Adaptive Network (CLADNet) is simply an overlay network that can be adaptable to various networks in multi-cloud.

CLADNet could provide a logical group of nodes with the common network (e.g., Subnet) and related core functions. Simply, CLADNet (cb-cladnet) provides a common network for multiple VMs and supports communication between VMs.

CLADNet's directions

• Adaptive: an adaptable network which is adaptive to different cloud networks from multiple cloud service providers (CSPs)
• Fault tolerant: a global fault-tolerant network that can operate even in issues of CSPs and regions
• Lightweight: A lightweight network that minimizes host (VM) resource usage
• Handy: An easy-to-use network for users or programs running on the CLADNet

CLADNet's structures

• Event-driven architecture: We have chosen an event-driven architecture based on distributed key-value store. It performs efficient workflows by meaningful change events in services. The events occur during data change, creation, and deletion (CUD).
  • Moving towards a Microservice Architecture (MSA)
• Mesh topology: We have chosen the mesh topology for the overlay network. It's needed to minimize the performance difference depending on the location of the intermediary node.
  • Research in progress to improve communication performance

Getting started with cb-network system

This section describes the preparations required to start the cb-network system and how to run each component. Basically, all components of cb-network system can be executed independently. However, we run as many components as possible on the same node for better understanding.

Components:

• Distributed key-value store
• cb-network controller
• cb-network service
• cb-network admin-web
• cb-network agent

Client to test and demonstration:

• cb-network demo-client

In this description, distributed key-value store, cb-network controller, cb-network service, and cb-network admin-web are run on the same node.

Each cb-network agent must be run on a different host (VM).

👀 How to run

• Install based on source code
• Install based on container

Demo: 1st step, to run existing services in multi-cloud

Please refer to the video for more details :-)

NOTE - Please refer to the below for how to run the demo-client used in the video.

How to run a demo-client based on source code

It was deployed and tested on the "home" directory of Ubuntu 18.04. It's possible to change project root path.

NOTE - Please, run it on the same node with the CB-Tumblebug server.
If it is running on another node, it is required to modify source code (related part: endpointTB = "http://localhost:1323")

Prepare the config for the demo-client

config.yaml

• Create config.yaml (Use the provided template-config.yaml)

  cd ${HOME}/cb-larva/poc-cb-net/cmd/test-client/config
  cp template-config.yaml config.yaml
  

• Edit the "xxxx" part of etcd_cluster and grpc in the text below
  • [Required] If cb_network > host_id is set mannually, host_id must be set differently on each agent.
• The config.yaml template:

  # A config for an etcd cluster (required for all cb-netwwork components):
  etcd_cluster:
    endpoints: [ "localhost:2379" ] # e.g., [ "123.123.123.123:2379", "124.124.124.124:2379", ... ]
  
  # A config for the cb-network service and cb-network admin-web as follows:
  service:
    endpoint: "localhost:8053" # e.g., "123.123.123.123:8053"
    port: "8053"
  
  # A config for the cb-network admin-web as follows:
  admin_web:
    host: "localhost" # e.g., "123.123.123.123"
    port: "8054"
  
  # A config for the cb-network agent as follows:
  cb_network:
    cladnet_id: "xxxx"
    host: # for each host
      name: "" # if name is "" (empty string), the cb-network agent will use hostname.
      network_interface_name: "" # if network_interface_name is "" (empty string), the cb-network agent will use "cbnet0".
      tunneling_port: "" # if network_interface_port is "" (empty string), the cb-network agent will use "8055".
      is_encrypted: false  # false is default.
  
  # A config for the demo-client as follows:
  service_call_method: "grpc" # i.e., "rest" / "grpc"
  
  

Build the demo-client

In the building process, the required packages are automatically installed based on the "go module".

cd ${HOME}/cb-larva/poc-cb-net/cmd/test-client
go build demo-client.go

Run the demo-client

sudo ./demo-client