RDKCOM-5494: RDKBDEV-3334 Add Wan Manager Documentation#189
RDKCOM-5494: RDKBDEV-3334 Add Wan Manager Documentation#189Ashrafbhanu-k wants to merge 6 commits into
Conversation
|
All contributors have signed the CLA ✍️ ✅ |
|
@guto86 @S-Parthiban-Selvaraj is it worth building the /docs folder into a wiki? Wiki is here: https://rdkcentral.github.io/meta-rdk-broadband-apps/ |
pradeeptakdas
changed the title
|
Hi @guto86 , @S-Parthiban-Selvaraj Can you please review and merge this PR? |
Ashrafbhanu-k
force-pushed
the
feature/RDKBDEV-3334
branch
from
912769c to
0bf91e5
Compare
|
I have read the CLA Document and I hereby sign the CLA |
|
Hi @guto86, |
Ashrafbhanu-k
force-pushed
the
feature/RDKBDEV-3334
branch
from
0bf91e5 to
ba0a725
Compare
pradeeptakdas
added
documentation
| **Key Features & Responsibilities**: | ||
|
|
||
| - **Multi-Interface WAN Management**: Manages multiple WAN interface types (DOCSIS, Cellular, Ethernet, DSL, PON) through unified policy-based selection algorithms ensuring optimal connectivity based on availability, priority, and validation status | ||
| - **Policy-Based Interface Selection**: Implements seven distinct selection policies (Fixed Mode, Primary Priority, AutoWAN, Parallel Scan, and their variants) providing flexible interface selection strategies based on deployment requirements and network conditions |
There was a problem hiding this comment.
Only AutoWAN, Parallel Scan are actively maintained. rest is not compiled. Mwy be weould add a note
| - **Comprehensive State Machine Management**: Orchestrates WAN interface lifecycle through sophisticated state machines handling VLAN configuration, PPP setup, IP address acquisition, validation, and teardown processes with proper error handling | ||
| - **Network Validation and Health Monitoring**: Performs DNS connectivity checks, internet validation, and continuous health monitoring of active WAN connections with configurable validation parameters and retry mechanisms | ||
| - **TR-181 Data Model Integration**: Exposes comprehensive TR-181 parameter tree for WAN management configuration, status monitoring, and statistics reporting with both standard and custom extensions for advanced features | ||
| - **Multi-Protocol IP Support**: Handles IPv4, IPv6, and dual-stack configurations with automatic protocol selection, DHCPv4/DHCPv6 client management, and support for advanced features like MAPT and 464XLAT tunneling |
There was a problem hiding this comment.
we could mention DSlite, MAPE aswell
|
|
||
| | Configuration File | Selection Logic | Purpose | | ||
| | ---------------------- | ----------------------------------------------------------------- | ------------------------------------- | | ||
| | `RdkWanManager_v2.xml` | Used when `WanManagerUnificationEnable` DISTRO feature is enabled | Unified WAN Manager TR-181 data model | |
There was a problem hiding this comment.
we could mention WanManagerUnificationEnable is the default supported mode.
|
|
||
| WAN Manager follows a structured initialization sequence that ensures all dependencies are satisfied before beginning WAN interface management operations. The component waits for critical RDK-B services to become available, registers its TR-181 data model, establishes IPC connections, and initializes policy engines before transitioning to active operation. | ||
|
|
||
| ```mermaid |
There was a problem hiding this comment.
This sequence diagram seems including the external componenet and sequence is simplified. Selection policy + interface state machine is not covered properly.
| | Parameter Path | Data Type | Access | Default Value | Description | BBF Compliance | | ||
| | ----------------------------------------------------------------------- | ----------- | ------ | ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------- | | ||
| | `Device.X_RDK_WanManager.Enable` | boolean | R/W | `true` | Master enable/disable control for WAN Manager component. When disabled, all WAN interface management operations are suspended and existing connections are maintained in current state. | Custom Extension | | ||
| | `Device.X_RDK_WanManager.Policy` | string | R/W | `"AUTOWAN_MODE"` | WAN interface selection policy defining algorithm used for interface selection. Enumerated values: FIXED_MODE_ON_BOOTUP, FIXED_MODE, PRIMARY_PRIORITY_ON_BOOTUP, PRIMARY_PRIORITY, MULTIWAN_MODE, AUTOWAN_MODE, PARALLEL_SCAN. | Custom Extension | |
There was a problem hiding this comment.
Device.X_RDK_WanManager.Policy moved to group specific policy. This is a older version of tr181
| | `Device.X_RDK_WanManager.CPEInterface.{i}.Name` | string | R/W | `"erouter0"` | Logical interface name used for WAN interface identification within RDK-B middleware. Must be unique across all WAN interfaces in the system. | Custom Extension | | ||
| | `Device.X_RDK_WanManager.CPEInterface.{i}.Phy.Status` | string | R/W | `"Down"` | Physical interface status reported by Interface Manager. Enumerated values: Down, Initializing, Up. Reflects actual hardware interface state. | Custom Extension | | ||
| | `Device.X_RDK_WanManager.CPEInterface.{i}.Wan.Type` | string | R/W | `"DOCSIS"` | WAN technology type for interface classification. Enumerated values: DOCSIS, ETHERNET, CELLULAR, DSL, PON, REMOTE. Used for policy selection and interface prioritization. | Custom Extension | | ||
| | `Device.X_RDK_WanManager.CPEInterface.{i}.Wan.Priority` | unsignedInt | R/W | `1` | Interface selection priority within policy group. Lower numerical values indicate higher priority. Range 1-255 where 1 is highest priority. | Custom Extension | |
There was a problem hiding this comment.
| Device.X_RDK_WanManager.CPEInterface.{i}.Name | string | R/W | "erouter0" | Logical interface name used for WAN interface identification within RDK-B middleware. Must be unique across all WAN interfaces in the system. | Custom Extension |
| Device.X_RDK_WanManager.CPEInterface.{i}.Phy.Status | string | R/W | "Down" | Physical interface status reported by Interface Manager. Enumerated values: Down, Initializing, Up. Reflects actual hardware interface state. | Custom Extension |
| Device.X_RDK_WanManager.CPEInterface.{i}.Wan.Type | string | R/W | "DOCSIS" | WAN technology type for interface classification. Enumerated values: DOCSIS, ETHERNET, CELLULAR, DSL, PON, REMOTE. Used for policy selection and interface prioritization. | Custom Extension |
| Device.X_RDK_WanManager.CPEInterface.{i}.Wan.Priority
older tr181 dml, should use the v2 dml
|
|
||
| **Core HAL APIs:** | ||
|
|
||
| | HAL API | Purpose | Implementation File | |
There was a problem hiding this comment.
I don't these hal APIs are used in the wanmanager , please check
6 participants
RDKBDEV-3334
Reason for Change:
To add Component Documentation for Wan Manager component. Added README under new folder ./docs
Fix:
Added the documentation
Test Procedure:
None
Signed-off-by: Ashrafbhanu-k [Ashraf_bhanu@comcast.com]