Add HLD for IPv4 port based DHCP server in SONiC #1282

yaqiangz · 2023-03-14T12:43:32Z

This document describes the design details of ipv4 port based DHCP server in SONiC.

Description	Repo	PR title
Add yang model	sonic-buildimage	[yang][dhcp_server] Add dhcp_server_ipv4 yang model
Add dhcp_server container	sonic-buildimage	[dhcp_server] Add dhcp_server container
~~Add support for dhcp_server in minigraph parser~~ No need any more	~~sonic-buildimage~~	~~[minigraph] Add support for ipv4 dhcp_server in minigraph parser~~
Add dhcpservd	sonic-buildimage	[dhcp_server] Add dhcpservd to dhcp_server container
Update DHCPv4 relay start parameter when dhcp_server feature enabled	sonic-buildimage	sonic-net/sonic-buildimage#16947
Support to customize unassigned DHCP options and add db monitor	sonic-buildimage	sonic-net/sonic-buildimage#17051
Add dhcprelayd for dhcp_server feature	sonc-buildimage	sonic-net/sonic-buildimage#16947
Use dhcprelayd to manage critical processes	sonic-buildimag	sonic-net/sonic-buildimage#17236
Publish test plan	sonic-mgmt	sonic-net/sonic-mgmt#11348
Add config add CLI	sonic-buildimage	sonic-net/sonic-buildimage#17489
Add config del CLI	sonic-buildimage	sonic-net/sonic-buildimage#17603
Add config enable CLI	sonic-buildimage	sonic-net/sonic-buildimage#17605
Add config update CLI	sonic-buildimage	sonic-net/sonic-buildimage#17736
Add config range add/del/update CLI	sonic-buildimage	sonic-net/sonic-buildimage#17741
Add config option add/del CLI	sonic-buildimage	sonic-net/sonic-buildimage#18013
Add config ip bind/unbind CLI	sonic-buildimage	sonic-net/sonic-buildimage#17811
Add config option bind/unbind CLI	sonic-buildimage	sonic-net/sonic-buildimage#18013
Add show info CLI	sonic-buildimage	sonic-net/sonic-buildimage#17468
Add show range CLI	sonic-buildimage	sonic-net/sonic-buildimage#17262
Add show lease CLI	sonic-buildimage	sonic-net/sonic-buildimage#17125
Add show port CLI	sonic-buildimage	sonic-net/sonic-buildimage#17491
Add show option CLI	sonic-buildimage	sonic-net/sonic-buildimage#17469

zhangyanzhao · 2023-09-26T16:01:04Z

community review recording https://zoom.us/rec/share/4Ly7ECsogSJAUmwKps8QemUB0qXNg7OS4Tw940nfMsVcs6eVugIkRaPnf3Szhdtl.d9A5dIBXwGCLPq2R

ridahanif96 · 2023-09-26T16:18:06Z

doc/dhcp_server/port_based_dhcp_server_high_level_design.md

+
+1. Relatively more secure and stable, if other no-configured interface requests IP, it will not be assigned.
+2. Assigning IP based on port can quickly complete a self-made network without external information input.
+


Please add a out of scope section as well to call out specific cases like "MCLAG" or any other , thanks.

Added Design considerations section

madhupalu · 2023-09-27T00:22:06Z

doc/dhcp_server/port_based_dhcp_server_high_level_design.md

+- [Design](#design)
+    - [Design Overview](#design-overview)
+    - [Container](#container)
+    - [DHCP Server Daemon](#dhcp-server-daemon)


Is this HLD replacing the original dhcp relay container functionality? or will dhcp server and relay functionality coexists? if it co exists do you see any conflicts with dhcp server and dhcp relay functions?

This HLD wouldn't replace the original dhcp relay container functionality. In the scenario of disabling dhcp_server feature, functionality of dhcp_relay is exactly the same as before. Currently only support enabling dhcp_server per switch, means functionality of dhcp_relay cannot work with functionality dhcp_server. We will add restrictions in CLI to prevent users from configuring dhcp_relay when dhcp_server feature is enabled. Maybe add support in future releases for enabling dhcp_server feature per vlan, means enable dhcp_server in one vlan and enable dhcp_relay in other vlan.

venkatmahalingam · 2023-09-27T05:32:46Z

doc/dhcp_server/port_based_dhcp_server_high_level_design.md

+# About this Manual
+
+This document describes the design details of **ipv4 port based DHCP server** feature.
+Dynamic Host Configuration Protocol (DHCP) server is used to centrally manage and configure IP addresses of clients dynamically. When server receives requests from DHCP-enabled clients, it would offer information to client about IP address, subnet mask, gateway etc.


If you could mention the exact use-case for this feature, would be helpful.

Added, pls refer to pic in Design considerations section

ridahanif96

Please add me as reviewer of this HLD code PRs as well. thanks!

Why I did it Part implementation of dhcp_server. HLD: sonic-net/SONiC#1282. Add dhcpservd to dhcp_server container. How I did it Add installing required pkg (psutil) in Dockerfile. Add copying required file to container in Dockerfile (kea-dhcp related and dhcpservd related) Add critical_process and supervisor config. Add support for generating kea config (only in dhcpservd.py) and updating lease table (in dhcpservd.py and lease_update.sh) How to verify it Build image with setting INCLUDE_DHCP_SERVER to y and enabled dhcp_server feature after installed image, container start as expected. Enter container and found that all processes defined in supervisor configuration running as expected. Kill processes defined in critical_processes, container exist.

Add support in dhcp_relay container for dhcp_server_ipv4 feature. HLD: sonic-net/SONiC#1282

…vd (#17051) Why I did it Add config_db monitor and customize options for dhcpservd. HLD: sonic-net/SONiC#1282 Work item tracking Microsoft ADO (number only): 25600859 How I did it Add support to customize unassigned DHCP options. Current support type: binary, boolean, ipv4-address, string, uint8, uint16, uint32 Add db config change monitor for dhcpservd How to verify it Unit tests in sonic-dhcp-server all passed

zhangyanzhao · 2024-02-05T07:08:37Z

@yaqiangz what are the plan for the missed code PRs? Thanks.

yaqiangz · 2024-02-05T07:41:00Z

@yaqiangz what are the plan for the missed code PRs? Thanks.

@zhangyanzhao Updated PR description. Test plan will be merged next month, and I think other PRs can be merged this week.

zhangyanzhao · 2024-05-06T02:20:05Z

all code PRs are merged.

yaqiangz added 10 commits February 14, 2023 06:53

[dhcp_server] Add hld for dhcp_server

b5b3f53

Update

10b7304

Update

75755b7

Remove monitor and add opiton

8b76681

Update

4660ce9

Add option type

859577d

Merge branch 'master' into master_dhcp_server_hld

cb3b2cd

Modify option type

000f556

Update

a1446a5

Update lease pic

3357566

yaqiangz force-pushed the master_dhcp_server_hld branch from 3ccbc41 to 3357566 Compare April 6, 2023 11:42

yaqiangz added 2 commits April 7, 2023 09:37

update

0578207

Update toc

149601e

yaqiangz force-pushed the master_dhcp_server_hld branch from 1c11d31 to be0b079 Compare April 10, 2023 06:42

Add option type

ee5c3e8

yaqiangz force-pushed the master_dhcp_server_hld branch 2 times, most recently from 82ec39e to c2e4c6b Compare April 13, 2023 08:12

Change packt img

63a1ae6

yaqiangz force-pushed the master_dhcp_server_hld branch from c2e4c6b to 63a1ae6 Compare April 13, 2023 09:30

Change pic

ee04a1c

yaqiangz force-pushed the master_dhcp_server_hld branch from f51237e to ee04a1c Compare April 13, 2023 09:49

yaqiangz force-pushed the master_dhcp_server_hld branch 3 times, most recently from 065541e to d5d7e5b Compare May 26, 2023 08:29

Update after review

8125e00

yaqiangz force-pushed the master_dhcp_server_hld branch from d5d7e5b to 8125e00 Compare June 6, 2023 11:10

yaqiangz force-pushed the master_dhcp_server_hld branch 4 times, most recently from 0450c90 to 8558ed3 Compare June 15, 2023 07:08

yaqiangz force-pushed the master_dhcp_server_hld branch 3 times, most recently from 42a7344 to 697e2a5 Compare September 26, 2023 12:02

Add dhcrelay related

ac04262

yaqiangz force-pushed the master_dhcp_server_hld branch from 697e2a5 to ac04262 Compare September 26, 2023 13:00

ridahanif96 reviewed Sep 26, 2023

View reviewed changes

madhupalu reviewed Sep 27, 2023

View reviewed changes

venkatmahalingam reviewed Sep 27, 2023

View reviewed changes

yaqiangz force-pushed the master_dhcp_server_hld branch 2 times, most recently from 0cb1d89 to 8c88e58 Compare October 10, 2023 10:43

Update

fba2d31

yaqiangz force-pushed the master_dhcp_server_hld branch from 8c88e58 to fba2d31 Compare October 10, 2023 10:48

Blueve approved these changes Oct 11, 2023

View reviewed changes

ridahanif96 approved these changes Oct 11, 2023

View reviewed changes

zhangyanzhao merged commit 6037ad7 into sonic-net:master Oct 12, 2023
1 check passed

yaqiangz mentioned this pull request Oct 17, 2023

[dhcp_server] Add dhcpservd to dhcp_server container sonic-net/sonic-buildimage#16560

Merged

11 tasks

yaqiangz mentioned this pull request Oct 25, 2023

[dhcp_server] Add dhcprelayd for dhcp_server feature sonic-net/sonic-buildimage#16947

Merged

11 tasks

yxieca pushed a commit to sonic-net/sonic-buildimage that referenced this pull request Nov 2, 2023

[dhcp_server] Add dhcprelayd for dhcp_server feature (#16947)

274d320

Add support in dhcp_relay container for dhcp_server_ipv4 feature. HLD: sonic-net/SONiC#1282

yaqiangz mentioned this pull request Nov 6, 2023

[dhcp_server] Add config_db monitor and customize options for dhcpservd sonic-net/sonic-buildimage#17051

Merged

11 tasks

yaqiangz mentioned this pull request Nov 16, 2023

[featured] Add support for dhcp_server in featured sonic-net/sonic-host-services#85

Closed

yaqiangz mentioned this pull request Nov 20, 2023

[dhcp_relay] Use dhcprelayd to manage critical processes sonic-net/sonic-buildimage#17236

Merged

11 tasks

yaqiangz mentioned this pull request Apr 10, 2024

DHCP DOS Mitigation HLD in SONiC #1651

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add HLD for IPv4 port based DHCP server in SONiC #1282

Add HLD for IPv4 port based DHCP server in SONiC #1282

yaqiangz commented Mar 14, 2023 •

edited

Loading

zhangyanzhao commented Sep 26, 2023

ridahanif96 Sep 26, 2023

yaqiangz Oct 10, 2023

madhupalu Sep 27, 2023

yaqiangz Oct 10, 2023 •

edited

Loading

venkatmahalingam Sep 27, 2023

yaqiangz Oct 10, 2023

ridahanif96 left a comment

zhangyanzhao commented Feb 5, 2024

yaqiangz commented Feb 5, 2024

zhangyanzhao commented May 6, 2024


		1. Relatively more secure and stable, if other no-configured interface requests IP, it will not be assigned.
		2. Assigning IP based on port can quickly complete a self-made network without external information input.

Add HLD for IPv4 port based DHCP server in SONiC #1282

Add HLD for IPv4 port based DHCP server in SONiC #1282

Conversation

yaqiangz commented Mar 14, 2023 • edited Loading

zhangyanzhao commented Sep 26, 2023

ridahanif96 Sep 26, 2023

Choose a reason for hiding this comment

yaqiangz Oct 10, 2023

Choose a reason for hiding this comment

madhupalu Sep 27, 2023

Choose a reason for hiding this comment

yaqiangz Oct 10, 2023 • edited Loading

Choose a reason for hiding this comment

venkatmahalingam Sep 27, 2023

Choose a reason for hiding this comment

yaqiangz Oct 10, 2023

Choose a reason for hiding this comment

ridahanif96 left a comment

Choose a reason for hiding this comment

zhangyanzhao commented Feb 5, 2024

yaqiangz commented Feb 5, 2024

zhangyanzhao commented May 6, 2024

yaqiangz commented Mar 14, 2023 •

edited

Loading

yaqiangz Oct 10, 2023 •

edited

Loading