chore: add dhcp section in user guide #230
Conversation
|
🚀 Deployed on https://preview-230--hedgehog-docs.netlify.app |
| @@ -0,0 +1,346 @@ | |||
| # DHCP | |||
|
|
|||
| The Fabric includes an integrated DHCP server that dinamically assigns IP addresses to hosts connected to VPC subnets. The DHCP server supports dynamic IP allocation, static leases, and various configuration options. | |||
There was a problem hiding this comment.
| The Fabric includes an integrated DHCP server that dinamically assigns IP addresses to hosts connected to VPC subnets. The DHCP server supports dynamic IP allocation, static leases, and various configuration options. | |
| The Fabric includes an integrated DHCP server that dynamically assigns IP addresses to hosts connected to VPC subnets. The DHCP server supports dynamic IP allocation, static leases, and various configuration options. |
docs/user-guide/dhcp.md
Outdated
| namespace: default | ||
| spec: | ||
| subnets: | ||
| default: |
There was a problem hiding this comment.
Could you add a comment or annotation to mention that this is the name of the subnet and can be changed as the user desires?
docs/user-guide/dhcp.md
Outdated
| | `timeServers` | List of NTP server IP addresses | None | | ||
| | `interfaceMTU` | MTU size for the interface (doesn't affect switch interfaces) | 9036 | | ||
| | `pxeURL` | PXE boot server URL (TFTP only, no HTTP query strings) | None | | ||
| | `disableDefaultRoute` | If true, don't send default route to clients | false | |
There was a problem hiding this comment.
Can you put the option number we either are or aren't sending with this YAML config
docs/user-guide/dhcp.md
Outdated
| !!! warning "VPC vs DHCPSubnet Configuration" | ||
| - Changes made to the VPC YAML will overwrite static leases configured directly in DHCPSubnet | ||
| - It's recommended to choose one method and stick with it to avoid configuration conflicts | ||
| - The VPC method is preferred for most use cases as it keeps configuration centralized |
There was a problem hiding this comment.
Based on these warnings I am inferring that if a user makes a change in the DHCPSubnet configuration, the use won't be able to see those changes in the VPC object? If that is true, can we add that explicitly here? My concern comes from there being two people making changes and stepping on each others toes.
I like that you give guidance to use the VPC method.
mrbojangles3
left a comment
mrbojangles3
left a comment
There was a problem hiding this comment.
Left comments inline
There was a problem hiding this comment.
Pull request overview
This PR adds comprehensive documentation for the integrated DHCP server feature in the Fabric user guide. The documentation covers configuration, management, and usage of DHCP services for VPC subnets.
- Introduces complete DHCP server documentation with basic and advanced configuration examples
- Documents static lease management via both VPC YAML and DHCPSubnet resources
- Adds support for DHCP relay configuration with third-party DHCP servers
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 5 comments.
| File | Description |
|---|---|
| docs/user-guide/dhcp.md | New comprehensive documentation covering DHCP server configuration, options, static leases, and relay support |
| docs/user-guide/.pages | Adds dhcp.md to the navigation menu in the user guide |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Signed-off-by: Pau Capdevila <pau@githedgehog.com>
Signed-off-by: Pau Capdevila <pau@githedgehog.com>
Signed-off-by: Pau Capdevila <pau@githedgehog.com>
pau-hedgehog
force-pushed
the
pau/dhcpd_user_guide
branch
from
91d5e0c to
5c3d794
Compare
No description provided.