Skip to main content

An Ethernet software-based open source demarcation NID

Project description

vMark-node by Pathgate

An effort towards the first Ethernet software-based open source demarcation NID.

Latest version: 0.3.4 / Release notes: Link

Features:

  • Modular tree-style CLI with tab autocompletions and '?' helper.
  • Shell/Dispatcher/Modules/Plugins architecture.
  • Complete Interface management.
  • GPLv3 License.
  • Add & delete sub.interfaces (QinQ / dual-tags supported) (v0.2)
  • TWAMP Light implementation for End-to-End L3 tests. (ipv4 & ipv6, sender/responder modes). (v0.3)
  • Pypi (pip) packaging. (v0.3.1)
  • Remote Management via vMark. (v0.3.4)

Feature roadmap:

  • web GUI.
  • Docker version.
  • Ethernet OAM.
  • L2TP.
  • MEF3 Services deployment.
  • Automated EVC-WAN failover.
  • Loopback testing with automatic timeout.
  • RFC2544 testing and reflector.
  • open-BFDD implementation for service assurance and OAM.
  • fiber-interface management and optic levels monitoring.
  • Enable API-operated dispatcher.
  • SNMP Support.
  • Multi-vendor IPSec Tunnel support.
xxx

# Overview

vMark-node is a software-based open-source Ethernet demarcation NID designed for flexibility and democratization in the Carrier industry.

The "-node"** refers to this being the client-side of vMark server. (vMark-node doenst need vMark to work).

xxx

# Architecture

Shell: Provides command-line auto-completion, some help-related features and dynamically builds the command tree based on the modules and installed plugins. This enables a modular, scalable and re-usable interactive CLI experience.

Dispatcher: Interprets user commands, determines the appropriate module to handle each command, and routes execution accordingly. The dispatcher acts as the central coordinator between the shell and the available modules/plugins, Web-UI and API interactions talk directly with the Dispatcher.

Modules: Shell modules encapsulate core command logic and define the command tree structure. Examples: 'show', 'config', and 'system', each representing a set of related commands and subcommands with item descriptions.

Plugins: Integrate external libraries or tools to extend functionality. For example, plugins can provide access to third-party systems such as OpenBFDD, allowing seamless integration with external services.


Quick Install

gh repo clone https://github.com/xmas-ar/vMark-node.git
cd vMark-node/vMark-node
pip3 install -r requirements.txt
python3 main.py

PIP Install

pip install vmark-node
vmark-node

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

vmark_node-0.3.4.tar.gz (61.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

vmark_node-0.3.4-py3-none-any.whl (62.0 kB view details)

Uploaded Python 3

File details

Details for the file vmark_node-0.3.4.tar.gz.

File metadata

  • Download URL: vmark_node-0.3.4.tar.gz
  • Upload date:
  • Size: 61.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.9.21

File hashes

Hashes for vmark_node-0.3.4.tar.gz
Algorithm Hash digest
SHA256 fdb4910b2775aa16409636e8feaae7814380c181e744a93c89be92025c4a54b3
MD5 391be719f3463634b2bc31d970ff2ff3
BLAKE2b-256 652ecb10a9103042c4d1961b6bc08eb056a0609ae737f9e7a9ca78ed5f793c07

See more details on using hashes here.

File details

Details for the file vmark_node-0.3.4-py3-none-any.whl.

File metadata

  • Download URL: vmark_node-0.3.4-py3-none-any.whl
  • Upload date:
  • Size: 62.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.9.21

File hashes

Hashes for vmark_node-0.3.4-py3-none-any.whl
Algorithm Hash digest
SHA256 d63050baeaf4687fac15e3b72fb16df3c746d417188029792250408fa51f61e0
MD5 f589f6b9de6f7e0bdb05cbc71e24dee8
BLAKE2b-256 ce88bb50e1426bed73368ca8859cc0fdbfa2f9fabddc8b5de2255b6ce886945b

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page