Documentation Overview

Release 24.3.1 (current), 06 May 2024

The documentation is divided into the following major types:

Platform
List of RBFS software images and detailed feature matrix.
- RBFS Platform Guide

Reference Designs
Implementation use-cases as validated in RtBrick’s labs that can be used to model deployment or lab topologies.

Installation
Instructions to complete the tasks of installing RBFS.
- RBFS Installation, ZTP, and Licensing

RBFS User Guides
Guides featuring configuration and operational commands for the protocols and applications in RtBrick Full Stack (RBFS).
- Overview Guides
  RBFS Overview, RBFS CLI Overview, BDS Overview
- Routing
  RIB, BGP, IS-IS, OSPFv2/v3, LDP, Policy, Static Routing
- Layer 2 Services
  L2X, EVPN-VPWS
- Subscriber Management
  Subscriber Management, RADIUS Services, CGNAT, HTTP Redirect Service, Subscriber Filters, Lawful Interception, L2BSA, Redundancy
- Forwarding
  Interfaces, ARP/ND, ACLs, Port Mirroring, OAM Support, LAG, HQoS, LLDP
- Multicast
  IGMP, PIM, Multicast VPN
- Infrastructure
  NTP, Logging, LED Control, IPMI, Inband Management, DHCP Relay/Proxy
- Telemetry
  TSDB, Resmon, SNMP
- Security
  Securing Management Plane, Securing Control Plane, Local User Management

API References
List of the APIs for RBFS and RBMS, along with their details.

RBMS User Guides
Guides featuring various functionalities of RtBrick’s Management System (RBMS).
- RBMS Overview, Managing Inventory, Managing Software Images, Managing Logs, Metric Management, Metric Sampling and Monitoring, Administering RBMS, RBMS Configuration Store, RBMS Template Engine, Auto-DNS Provisioning

Troubleshooting
Troubleshoot issues that might occur with RtBrick Full Stack.
- RBFS Troubleshooting Guide

End-of-Life Policy
RtBrick’s policies on End of Life (EOL) and list of EOL Notices.
- End-of-Life Policy