beluganos/beluganos

The new network OS designed for white-box switches based on open API.

Beluganos

Beluganos is a new network OS designed for white-box switches, which can apply large-scale networks.

• IP Routing (BGP, OSPF, IPv6, ...) and L2 switching
• IP/MPLS, BGP/MPLS IP-VPNs, IP-IP tunneling
• Interoperability with conventional IP or IP/MPLS router
• ASIC based hardware packet processing

The feature matrix of Beluganos is available at doc/function.md. Beluganos was named after beluga whale.

note

• The commercial version of "Beluganos" released on March 31,2023 does not use the OSS technology published on theGitHub.
• After March 31, 2023, NTT's registered trademark "Beluganos"will be used for the commercial version of "Beluganos" and willnot be used for the OSS version on the GitHub.
• For details of the commercial version of “Beluganos”, please click here.

Architecture

Beluganos has one or more Linux containers. The main effort of Beluganos is that the route table which is installed to Linux containers is copied to white-box switches. If you will configure router settings like IP addresses or parameter of routing protocols, you may configure the settings of Linux containers by ansible or NETCONF. Moreover, in order to control white-box switches, OpenNSL or OF-DPA is used.

For more details, please check doc/architecture.md.

Getting Started

1. Quick start by example case

In order to try Beluganos quickly, some example cases are prepared. This example can configure automatically not only Beluganos but also other routers to connect with Beluganos. If you wish to use this, please refer to doc/example/case1/case1.md instead of the following description.

2. Step-by-step procedure

• Step 1: Build
  • Install Beluganos and related OSS automatically.
    • Check doc/install.md.
• Step 2: Setup
  • Register your white-box switch to Beluganos.
    • Check doc/setup.md.
  • Initial setup of your white-box switch.
    • Check doc/setup-hardware.md
  • Initial setup of ASIC API.
    • If you use OpenNSL switch, check doc/setup-onsl.md.
    • If you use OF-DPA switch, check doc/setup-ofdpa.md.
• Step 3: Configure
  • Change router settings like IP address, VLAN, and routing protocols as you like.
    • Check doc/configure.md.
  • Some advanced configuration technology is also supported.
    • To configure by ansible, check doc/configure-ansible.md.
    • To configure by NETCONF, check doc/configure-netconf.md.
• Step 4: Operation
  • Start Beluganos. Monitor Beluganos.
    • Check doc/operation.md

Other document is listed at document index page.

Support

Github issue page and e-mail are available. If you prefer to use e-mail, please contact msf-contact-ml [at] hco.ntt.co.jp.

Development & Contribution

Any contribution is encouraged. The main component is written in Go and Python. For more details, please refer to CONTRIBUTING.md.

License

Beluganos is licensed under the Apache 2.0 license. Check LICENSE.

Project

This project is a part of Multi-Service Fabric.

beluganos's Issues

ARMEL architecture port

Hi,

I tried to install the OpenNSL agent on an AS4610-54T which uses ARM Cortex A9 and got an error "package architecture (amd64) does not match system (armel)". Any chance of this getting ported to the said architecture? Or how do I compile the agent for armel? Thanks.

Link to Edge-core's blog for OpenNSL is broken

In doc/install.md, there is a link to the webpage of Edge-core's blog for downloading OpenNSL (Resources - 2. Whitebox switches), but this link is broken.

Build using .deb packet

Hello,

My switch's hardware platform is AS7312-54x, and I didn't find this name in Broadcom's repository.
So I tried build BeluganOS in separated-style (with OpenNSL support) using .deb package from Edge-core's blog. In install.md (Appendix C) written:

BEL_ONSL_PLATFORM: OpenNSL supported platform name (as5712, as7712, ...). The platform name is shown at the directory name of Broadcom's repository. If you will use the .deb package which is provided by switch vendor, you have not to care this parameter.

But when I tryed build without this parameter (I added # before BEL_ONSL_PLATFORM) I got error:

Usage: /home/dis/beluganos/etc/installer/opennsl_install.sh <clone | pkg-config | install> <as5712 | as7712 | ...>

Where I missed? Thanks.

Does Beluganos use LXD's LXC or the older non-LXD LXC?

i couldn't tell which Beluganos uses.

I use LXD and if Beluganos does also I would try it out.

The link:
Beluganos has one or more Linux containers

Just takes you to the Top of the linuxcontainers.org website and from there you could goto the older LXC or goto the newer LXD/LXC?

thanks for any info
brian