Documentation Overview

Release 25.1.1 (current), 16 April 2024

The documentation is divided into the following major types:

RBFS Overview and Platforms
Provides an overview of RtBrick FullStack (RBFS) and outlines the hardware platforms that it supports.
- RBFS Overview
- RBFS Platform Guide

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

RBFS Installation and Licensing
Instructions to complete the tasks of installing RBFS and obtaining licenses.
- Installation Overview, RBFS Image Download, RBFS Manual Installation, RBFS Automated Installation (ZTP)
- RBFS Licensing

RBFS User Guides
Guides featuring configuration and operational commands for the protocols and applications in RtBrick Full Stack (RBFS).
- Overview Guides
  RBFS CLI Overview, BDS Overview
- Routing
  BGP, IS-IS, OSPFv2/v3, Static Routing, LDP, BGP FlowSpec, BGP RPKI, Policy, Route Leaking, RIB
- Layer 2 Services
  EVPN-VPWS, BGP-signaled L2VPN, L2X
- Layer 3 Services
  L3VPN
- Subscriber Management
  Subscriber Management, RADIUS Services, CGNAT BNG, CGNAT Appliance, 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
- Security
  Securing Management Plane, Securing Control Plane, Local User Management, BGP FlowSpec, BGP RPKI, sFlow
- Telemetry
  TSDB, Resmon, SNMP, sFlow
- Infrastructure
  NTP, Logging, LED Control, IPMI, Inband Management, DHCP Relay/Proxy

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