[api] extend VPC DHCP comments

githedgehog · Mar 6, 2024 · 7fda3f0 · 7fda3f0
1 parent 70dcd3d
commit 7fda3f0
Show file tree

Hide file tree

Showing 6 changed files with 19 additions and 15 deletions.
diff --git a/api/dhcp/v1alpha2/dhcpsubnet_types.go b/api/dhcp/v1alpha2/dhcpsubnet_types.go
@@ -38,7 +38,7 @@ type DHCPSubnetSpec struct {
 	VRF string `json:"vrf"`
 	// VLAN ID to identify specific subnet withing the VPC, such as "Vlan1000" as it's named on switch
 	CircuitID string `json:"circuitID"`
-	// PXE IP (optional) to identify the pxe server to use to boot hosts connected to this segment such as http://10.10.10.99/bootfilename or tftp://10.10.10.99/bootfilename, http query strings are not supported
+	// PXEURL (optional) to identify the pxe server to use to boot hosts connected to this segment such as http://10.10.10.99/bootfilename or tftp://10.10.10.99/bootfilename, http query strings are not supported
 	PXEURL string `json:"pxeURL"`
 }
 

diff --git a/api/vpc/v1alpha2/vpc_types.go b/api/vpc/v1alpha2/vpc_types.go
@@ -76,9 +76,9 @@ type VPCDHCP struct {
 	Relay string `json:"relay,omitempty"`
 	// Enable enables DHCP server for the subnet
 	Enable bool `json:"enable,omitempty"`
-	// Range is the DHCP range for the subnet if DHCP server is enabled
+	// Range (optional) is the DHCP range for the subnet if DHCP server is enabled
 	Range *VPCDHCPRange `json:"range,omitempty"`
-	// PXEURL is the URL for the PXE server if DHCP server is enabled
+	// PXEURL (optional) to identify the pxe server to use to boot hosts connected to this segment such as http://10.10.10.99/bootfilename or tftp://10.10.10.99/bootfilename, http query strings are not supported
 	PXEURL string `json:"pxeURL,omitempty"`
 }
 

diff --git a/config/crd/bases/agent.githedgehog.com_agents.yaml b/config/crd/bases/agent.githedgehog.com_agents.yaml
@@ -1163,12 +1163,14 @@ spec:
                                 description: Enable enables DHCP server for the subnet
                                 type: boolean
                               pxeURL:
-                                description: PXEURL is the URL for the PXE server
-                                  if DHCP server is enabled
+                                description: PXEURL (optional) to identify the pxe
+                                  server to use to boot hosts connected to this segment
+                                  such as http://10.10.10.99/bootfilename or tftp://10.10.10.99/bootfilename,
+                                  http query strings are not supported
                                 type: string
                               range:
-                                description: Range is the DHCP range for the subnet
-                                  if DHCP server is enabled
+                                description: Range (optional) is the DHCP range for
+                                  the subnet if DHCP server is enabled
                                 properties:
                                   end:
                                     description: End is the end IP address of the

diff --git a/config/crd/bases/dhcp.githedgehog.com_dhcpsubnets.yaml b/config/crd/bases/dhcp.githedgehog.com_dhcpsubnets.yaml
@@ -83,7 +83,7 @@ spec:
                 description: Gateway, such as 10.10.10.1
                 type: string
               pxeURL:
-                description: PXE IP (optional) to identify the pxe server to use to
+                description: PXEURL (optional) to identify the pxe server to use to
                   boot hosts connected to this segment such as http://10.10.10.99/bootfilename
                   or tftp://10.10.10.99/bootfilename, http query strings are not supported
                 type: string

diff --git a/config/crd/bases/vpc.githedgehog.com_vpcs.yaml b/config/crd/bases/vpc.githedgehog.com_vpcs.yaml
@@ -93,12 +93,14 @@ spec:
                           description: Enable enables DHCP server for the subnet
                           type: boolean
                         pxeURL:
-                          description: PXEURL is the URL for the PXE server if DHCP
-                            server is enabled
+                          description: PXEURL (optional) to identify the pxe server
+                            to use to boot hosts connected to this segment such as
+                            http://10.10.10.99/bootfilename or tftp://10.10.10.99/bootfilename,
+                            http query strings are not supported
                           type: string
                         range:
-                          description: Range is the DHCP range for the subnet if DHCP
-                            server is enabled
+                          description: Range (optional) is the DHCP range for the
+                            subnet if DHCP server is enabled
                           properties:
                             end:
                               description: End is the end IP address of the DHCP range

diff --git a/docs/api.md b/docs/api.md
@@ -150,7 +150,7 @@ _Appears in:_
 | `endIP` _string_ | End IP from the CIDRBlock to allocate IPs, such as 10.10.10.99 |
 | `vrf` _string_ | VRF name to identify specific VPC (will be added to DHCP packets by DHCP relay in suboption 151), such as "VrfVvpc-1" as it's named on switch |
 | `circuitID` _string_ | VLAN ID to identify specific subnet withing the VPC, such as "Vlan1000" as it's named on switch |
-| `pxeURL` _string_ | PXE IP (optional) to identify the pxe server to use to boot hosts connected to this segment such as http://10.10.10.99/bootfilename or tftp://10.10.10.99/bootfilename, http query strings are not supported |
+| `pxeURL` _string_ | PXEURL (optional) to identify the pxe server to use to boot hosts connected to this segment such as http://10.10.10.99/bootfilename or tftp://10.10.10.99/bootfilename, http query strings are not supported |
 
 
 #### DHCPSubnetStatus
@@ -525,8 +525,8 @@ _Appears in:_
 | --- | --- |
 | `relay` _string_ | Relay is the DHCP relay IP address, if specified, DHCP server will be disabled |
 | `enable` _boolean_ | Enable enables DHCP server for the subnet |
-| `range` _[VPCDHCPRange](#vpcdhcprange)_ | Range is the DHCP range for the subnet if DHCP server is enabled |
-| `pxeURL` _string_ | PXEURL is the URL for the PXE server if DHCP server is enabled |
+| `range` _[VPCDHCPRange](#vpcdhcprange)_ | Range (optional) is the DHCP range for the subnet if DHCP server is enabled |
+| `pxeURL` _string_ | PXEURL (optional) to identify the pxe server to use to boot hosts connected to this segment such as http://10.10.10.99/bootfilename or tftp://10.10.10.99/bootfilename, http query strings are not supported |
 
 
 #### VPCDHCPRange