Skip to content

Commit

Permalink
Merge pull request sonic-net#15 from sayedsaquibbrcm/master
Browse files Browse the repository at this point in the history 
Add KLiSH/OCyang support for IP helper feature
  • Loading branch information
@NarendraBandarupalli
NarendraBandarupalli committed Sep 17, 2020
2 parents 17a8c0b + b20db79 commit 896df55
Showing 1 changed file with 220 additions and 7 deletions.
227 changes: 220 additions & 7 deletions L3/ip_helper/ip_helper.md
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# IP Helper in SONiC

# High Level Design Document
#### Rev 0.1
#### Rev 0.2

# Table of Contents
* [List of Tables](#list-of-tables)
Expand Down Expand Up @@ -60,6 +60,7 @@
| Rev | Date | Author | Change Description |
|:---:|:-----------:|:---------------------:|-----------------------------------|
| 0.1 | 10/23/2019 | Kiran Kumar Kella | Initial version |
| 0.2 | 06/04/2020 | Sayed Saquib | Add KliSH support information |

# About this Manual
This document provides details on achieving IP Helper functionality in SONiC.
Expand Down Expand Up @@ -97,7 +98,7 @@ This document describes the high level design of IP Helper functionality.
16. Support rate limiting of incoming UDP broadcast traffic.

### 1.1.2 Configuration and Management Requirements
1. Provide configuration and management commands using Python Click framework CLI.
1. Provide configuration and management commands using Python Click framework CLI and Unified KliSH framework CLI and REST URIs.
2. Provide per interface configuration command to add/delete relay addresses.
3. Provide global command to specify the UDP protocols to be relayed.
4. Provide global command to specify the UDP broadcast trap rate to CPU.
Expand Down Expand Up @@ -270,7 +271,7 @@ No changes needed in SAI for this feature.
N/A

### 3.4.2 Configuration Commands

#### Using Python Click framework
```
1. config interface ip helper_address add <interface-name> <ip-address> [-vrf <vrf-name]
Add IP helper address on an interface.
Expand All @@ -293,9 +294,53 @@ Remove UDP port from the list of forwarding ports.
7. config ip forward_protocol udp rate_limit <value-in-pps>
Configure the UDP broadcast packet rate limiting value in the range 600 - 10000 pps. The default value is 600 pps.
```
#### Using unified KliSH framework
```
1. Add/Remove IP helper address on an interface.
### 3.4.3 Show Commands
[no] ip helper-address [ vrf <vrf-name> ] <ip-address>
example:
sonic-cli(conf-if-Ethernet0)# ip helper-address 192.168.1.254
sonic-cli(conf-if-Ethernet0)# ip helper-address vrf Vrf1 192.168.1.254
sonic-cli(conf-if-Ethernet0)# no ip helper-address 192.168.1.254
sonic-cli(conf-if-Ethernet0)# no ip helper-address vrf Vrf1 192.168.1.254
2. Enable/Disable UDP broadcast forwarding.
[no] ip forward-protocol udp enable
example:
sonic-cli(config)# ip forward_protocol udp enable
sonic-cli(config)# no ip forward-protocol udp enable
3. Add UDP port to the list of forwarding ports.
ip forward-protocol udp include {[tftp/dns/ntp/netbios-name-server/netbios-datagram-server/tacacs] | <port>}
example:
sonic-cli(config)# ip forward-protocol udp include ntp
sonic-cli(config)# ip forward-protocol udp include 540
4. Remove UDP port from the list of forwarding ports.
ip forward_protocol udp exclude {[tftp/dns/ntp/netbios-name-server/netbios-datagram-server/tacacs] | <port>}
example:
sonic-cli(config)# ip forward-protocol udp exclude dns
sonic-cli(config)# ip forward-protocol udp exclude 541
5. Configure the UDP broadcast packet rate limiting value in the range 600 - 10000 pps. The default value is 600 pps.
[no] ip forward-protocol udp rate-limit <value-in-pps>
example:
sonic-cli(config)# ip forward-protocol udp rate-limit 1000
sonic-cli(config)# no ip forward-protocol udp rate-limit
```

### 3.4.3 Show Commands
#### Using Python Click framework
```
1. show ip helper_address config <interface>
Use this command to display the IP Helper configuration on the interface
Expand Down Expand Up @@ -368,17 +413,176 @@ Ethernet28
All ones broadcast packets received : 50
Net directed broadcast packets received : 50
```
#### Using unified KliSH framework
```
### 3.4.4 Clear Commands
1. show ip helper-address <interface>
Use this command to display the IP Helper configuration on the interface
# show ip helper-address Ethernet24
Interface Vrf Relay address
-------------------------------------
Ethernet24 31.1.0.2
2.2.2.3
vrf20 11.19.0.144
2. show ip helper-address
Use this command to display the IP Helper configuration on all the interfaces
# show ip helper-address
Interface Vrf Relay address
-------------------------------------
Ethernet24 31.1.0.2
2.2.2.3
vrf20 11.19.0.144
Ethernet28 31.1.0.2
3. show ip forward-protocol
Use this command to display the IP Helper Global configuration
# show ip forward-protocol
UDP forwarding: Enabled
UDP rate limit: 6000 pps
UDP forwarding enabled on the ports: TFTP , NTP , 330 , 234, 1000
UDP forwarding disabled on the ports: DNS , NetBios-Name-server , NetBios-datagram-server
4. show ip helper-address statistics [<interface>]
Use this command to display the IP Helper statistics on the interface.
Without the optional interface argument, the statistics are displayed for all the configured interfaces.
# show ip helper-address statistics Ethernet24
Packets received : 1098
Packets relayed : 980
Packets dropped : 118
Invalid TTL packets : 22
All ones broadcast packets received : 602
Net directed broadcast packets received : 496
# show ip helper-address statistics
Ethernet24
-----------
Packets received : 1098
Packets relayed : 980
Packets dropped : 118
Invalid TTL packets : 22
All ones broadcast packets received : 602
Net directed broadcast packets received : 496
Ethernet28
-----------
Packets received : 100
Packets relayed : 90
Packets dropped : 10
Invalid TTL packets : 5
All ones broadcast packets received : 50
Net directed broadcast packets received : 50
```
### 3.4.4 Clear Commands
#### Using Python Click framework
```
1. clear ip helper_address statistics <interface>
Use this command to clear the relay statistics on an interface.
2. clear ip helper_address statistics
Use this command to clear the relay statistics on all the interfaces.
```
#### Using unified KliSH framework
```
1. clear ip helper-address statistics <interface>
Use this command to clear the relay statistics on an interface.
2. clear ip helper-address statistics
Use this command to clear the relay statistics on all the interfaces.
```
### 3.4.5 REST APIs

#### Global Parameters
The REST URI for global parameters will available under the following subtree
```
/restconf/data/openconfig-ip-helper:ip-helper
```
#### IP Helper address
The REST data model fo IP Helper addresses under interface will be available under following subtree
```
/restconf/data/openconfig-interfaces:interfaces/interface={name}/subinterfaces/subinterface={index}/openconfig-if-ip:ipv4/openconfig-interfaces-ext:ip-helper
```
#### Global Parameters data model
```
"openconfig-ip-helper:ip-helper": {
"config": {
"enable": true,
"incoming-rate-limit": 0,
"ports": [ 0 ]
},
"state": {
"enable": true,
"incoming-rate-limit": 0,
"ports": [ 0 ],
"exclude-default-ports": [ 0 ]
}
}
```
Note: read-only "default-ports" will contain the ports for which relay is active by default, as Openconfig does not support yang 1.1 which has support for default values for leaf-list.
#### IP Helper address data model
```
"openconfig-interfaces-ext:ip-helper": {
"config": {
"helper-address": [ "string" ],
"servers": {
"server": [
{
"vrf": "string",
"ip": "string"
}
]
}
},
"state": {
"helper-address": [ "string" ],
"servers": {
"server": [
{
"vrf": "string",
"ip": "string"
}
]
},
"counters": {
"received-packets": 0,
"relayed-packets": 0,
"dropped-packets": 0,
"packets-with-invalid-ttl": 0,
"broadcast-packets": 0,
"net-broadcast-packets": 0
}
}
}
```
#### Clear RPC
```
/restconf/operations/openconfig-ip-helper:clear-ip-helper-statistics
```
Input model:
```
"openconfig-ip-helper:input": {
"interface": "string"
}
```
Output model:
```
"openconfig-ip-helper:output": {
"result": "string"
}
```
# 4 Error Handling

As there is no programming related to the IP Helper feature in the hardware, no hardware error handling is needed for this feature. Any error conditions while relaying the packets can be monitored from the statistics and the logs.
Expand All @@ -403,9 +607,18 @@ Up to 15 UDP ports (including default and custom ports) are allowed to be config
4. Verify that the IP Helper addresses can be configured in a VRF routing domain.
5. Verify that the clear statistics command is working as expected.
6. Verify that all show commands are correctly formatted and show the correct information.
7. Verify #1 to #6 with corresponding KLiSH command

## 8.2 Rest API Test Cases
N/A
1. Verify global parameters config/unconfig using REST
2. Verify default ports configured correctly in backend with changes to config
3. Verify helper address config/unconfig
4. Verify GET for global parameters
5. Verify GET for interface helper address
6. Verify GET for interface helper statistics
7. Verify RPC for clear statistics
8. Verify GET at all levels for all URIs
9. Verify GET for corner cases; ie empty config etc

## 8.3 Functional Test Cases
1. Enable global UDP forwarding and configure IP Helper address on an interface and verify relaying is working.
Expand All @@ -429,4 +642,4 @@ N/A

# 9 Future support
1. Support for per interface per helper address statistics.
2. Support for REST/gNMI/IS-CLI UI interfaces.

0 comments on commit 896df55

Please sign in to comment.