Skip to content

Latest commit

 

History

History
268 lines (202 loc) · 11.1 KB

README.md

File metadata and controls

268 lines (202 loc) · 11.1 KB
Raw

Bondy logo

Version
Docker Pulls Docker Build (master) Docker Build (develop) Docker Build (latest-tag)
Architectures

Bondy

The distributed application networking platform

Bondy is an open source, always-on and scalable application networking platform connecting all elements of a distributed application—offering service and event mesh capabilities combined.

From web and mobile apps to IoT devices and backend microservices, Bondy allows everything to talk using one simple and secured communication protocol in a decoupled and dynamic way.

Bondy implements the open Web Application Messaging Protocol (WAMP).



drawing



Documentation

For our work-in-progress documentation for v1.0.0 go to https://developer.bondy.io.

Supported WAMP features

Authentication

  • Anonymous
  • Cryptosign
  • Ticket
  • WAMP-CRA
  • WAMP-SCRAM (WIP)
  • Cookie

In addition Bondy provides:

  • HTTP OAuth2
  • HTTP Password
  • Same Sign-on -- use a single set of credentials to sign on to multiple realms
  • Single Sign-on -- combines Same Sign-on with Ticket authentication. The resulting ticket can be used to sign on to multiple realms.

Advanced RPC features

  • Call Canceling
  • Call Timeouts
  • Call Trust Levels
  • Caller Identification
  • Pattern-based registration
  • Shared Registration
    • Load Balancing
      • Random
      • Round robin
    • Hot Stand-by
      • First
      • Last
  • Payload Passthru Mode (WIP)
  • Registration Revocation (WIP)
  • Progressive Call Results
  • Progressive Calls

Advanced Pub/Sub features

  • Event Retention
  • Pattern-based Subscriptions
  • Publication Trust Levels
  • Publisher Exclusion
  • Publisher Identification
  • Subscriber Black- and Whitelisting
  • Payload Passthru Mode (WIP)
  • Sharded Subscriptions
  • Subscription Revocation

Transport

  • WebSockets
  • RawSockets
  • E2E encryption

Transport Serialization

  • JSON
  • Msgpack
  • BERT
  • Erlang (subset)
  • JSON batched
  • Msgpack batched

How is Bondy different than other WAMP routers?

Bondy provides a unique combination of features which sets it apart from other application networking solutions and WAMP routers in terms of scalability, reliability, high-performance, development and operational simplicity.

  • Distributed by design – As opposed to other WAMP Router implementations, Bondy was designed as a reliable distributed router, ensuring continued operation in the event of node or network failures through clustering and data replication.
  • Scalability – Bondy is written in Erlang/OTP which provides the underlying operating system to handle concurrency and scalability requirements, allowing Bondy to scale to thousands and even millions of concurrent connections on a single node. Its distributed architecture also allows for horizontal scaling by simply adding nodes to the cluster.
  • Decentralised peer-to-peer master-less clustering – All nodes in a Bondy cluster are equal, thanks to the underlying clustering and networking technology which provides a decentralised master-less architecture. This includes all nodes acting as relays enabling Transparent routing. All nodes can also act as Bridge Relays to enable per-realm inter-cluster routing (aka Bondy Edge [Experimental]).
  • Transparent routing - Bondy will route any Caller/Publisher (sender) messages to any Callee/Subscriber (receiver) regardless of their session location in the cluster. When using Full Mesh topology (default), this results in a single hop between sender and receiver. When using the upcoming Peer-to-Peer topology this results in one or multiple hops between sender and receiver.
  • Low latency data replication – All nodes in a Bondy cluster share a global state which is replicated through a highly scalable and low latency eventually consistency model which combines causality tracking, real-time epidemic broadcasting (gossip) and periodic active anti-entropy. Bondy uses Partisan), a high-performance Distributed Erlang replacement that enables various network topologies and supports large clusters (Partisan has been demonstrated to scale up to 1,024 Erlang nodes, and provide better scalability and reduced latency than Distributed Erlang).
  • Ease of use – Bondy is easy to operate due to its operational simplicity enabled by its peer-to-peer nature, the lack of special nodes, automatic data replication and self-healing.
  • Embedded HTTP API Gateway – Bondy embeds a powerful API Gateway that can translate HTTP actions to WAMP routed RPC and PubSub operations. The API Gateway leverages the underlying storage and replication technology to deploy the API Specifications to the cluster nodes in real-time.
  • Embedded Identity Management & Authentication - Each realm manages user identity and authentication using multiple WAMP and HTTP authentication methods. Identity data is replicated across the cluster to ensure always-on and low-latency operations.
  • Embedded Role-based Access Control (RBAC) – Each realm embeds a RBAC subsystem controlling access to realm resources and authorizing message routing through the definition of groups and the assignment of permissions. RBAC data is replicated across the cluster to ensure always-on and low-latency operations.
  • Embedded Broker Bridge – Bondy embeds a Broker Bridge that can manage a set of WAMP subscribers that re-publish WAMP events to an external non-WAMP system e.g. another message broker (Kafka Bridge implemented).

Quick Start

Docker

The fastest way to get started is by using our official docker images.

  1. Make sure you have Docker installed and running.
  2. Download the examples/custom_config folder to a location of your choice, then cd to that location and run the following command (If you already cloned the Bondy repository then just cd to the location of the repo).
docker run \
--rm \
-e [email protected] \
-e BONDY_ERL_DISTRIBUTED_COOKIE=bondy \
-u 0:1000 \
-p 18080:18080 \
-p 18081:18081 \
-p 18082:18082 \
-p 18083:18083 \
-p 18084:18084 \
-p 18085:18085 \
-v "$(PWD)/examples/custom_config/etc:/bondy/etc" \
-v "/tmp/data:/bondy/data" \
leapsight/bondy:master

Building from source

Requirements

  • macOS (Intel|Apple Silicon) or Linux (amd64|arm64)
  • Erlang 26.0.2 or later
  • Rebar3 3.22.1 or later
  • openssl
  • libssl
  • Libsodium - if installing on Apple Silicon and having an issue compiling the libary check the last response on this Github Issue
  • libsnappy
  • liblz4
  • libcrypto

Building

Clone this repository and cd to the location where you cloned it.

To generate a Bondy release to be used in production execute the following command which will generate a tarball containing the release at $(PWD)/_build/prod/rel/.

make release

Untar and copy the resulting tarball to the location where you want to install Bondy e.g. ~/tmp/bondy.

tar -zxvf _build/prod/rel/bondy-1.0.0-rc.27.tar.qz -C ~/tmp/bondy

Running

To run Bondy, cd to the location where you installed it e.g. ~/tmp/bondy and run the following command which will print all the options.

bin/bondy

For example, to run Bondy with output to stdout do

bin/bondy foreground

And to run Bondy with an interactive Erlang shell do

bin/bondy console

Local cluster testing

Run a first node

We will start a node named [email protected] which uses the following variables from the config file (config/test/node_1_vars.config).

Transport Description Port
HTTP REST API GATEWAY 18080
HTTP REST API GATEWAY 18083
HTTP REST Admin API 18081
HTTPS REST Admin API 18084
Websockets WAMP 18080
TCP WAMP Raw Socket 18082
TLS WAMP Raw Socket 18085 
make node1

Create a Realm

WAMP is a session-based protocol. Each session belongs to a Realm.

curl -X "POST" "http://localhost:18081/realms/" \
     -H 'Content-Type: application/json; charset=utf-8' \
     -H 'Accept: application/json; charset=utf-8' \
     -d $'{
  "uri": "com.myrealm",
  "description": "My First Realm"
}'

Disable Security

We will disable security to avoid setting up credentials at this moment.

curl -X "DELETE" "http://localhost:18081/realms/com.myrealm/security_enabled" \
     -H 'Content-Type: application/json; charset=utf-8' \
     -H 'Accept: application/json; charset=utf-8'

Run a second node

We start a second node named [email protected] which uses the following variables from the config file (config/test/node_2_vars.config).

Transport Description Port
HTTP REST API GATEWAY 18180
HTTP REST API GATEWAY 18183
HTTP REST Admin API 18181
HTTPS REST Admin API 18184
Websockets WAMP 18180
TCP WAMP Raw Socket 18182
TLS WAMP Raw Socket 18185 
make node2

After a minute the two nodes will automatically connect. From now on all new Bondy control plane state changes will be propagated in real-time through broadcasting. One minute after joining the cluster, the Active Anti-entropy service will trigger an exchange after which the Realm we have created in [email protected] will have been replicated to [email protected].

Run a third node

make node3

Resources

Copyright by Leapsight, material licensed under the CC-BY-SA 4.0, provided as-is without any warranties, Bondy documentation (https://developer.bondy.io).