Skip to content

Commit

Permalink
provide clarification on the syntax of the IP address definition
Browse files Browse the repository at this point in the history
  • Loading branch information
rvanderp3 committed Mar 17, 2023
1 parent 881d44b commit 2929ebe
Show file tree
Hide file tree
Showing 7 changed files with 37 additions and 21 deletions.
3 changes: 2 additions & 1 deletion apis/v1alpha3/types.go
Original file line number Diff line number Diff line change
Expand Up @@ -237,7 +237,8 @@ type NetworkDeviceSpec struct {
Gateway6 string `json:"gateway6,omitempty"`

// IPAddrs is a list of one or more IPv4 and/or IPv6 addresses to assign
// to this device.
// to this device. IP addresses must also specify the segment length in
// CIDR notation.
// Required when DHCP4 and DHCP6 are both false.
// +optional
IPAddrs []string `json:"ipAddrs,omitempty"`
Expand Down
3 changes: 2 additions & 1 deletion apis/v1alpha4/types.go
Original file line number Diff line number Diff line change
Expand Up @@ -237,7 +237,8 @@ type NetworkDeviceSpec struct {
Gateway6 string `json:"gateway6,omitempty"`

// IPAddrs is a list of one or more IPv4 and/or IPv6 addresses to assign
// to this device.
// to this device. IP addresses must also specify the segment length in
// CIDR notation.
// Required when DHCP4 and DHCP6 are both false.
// +optional
IPAddrs []string `json:"ipAddrs,omitempty"`
Expand Down
3 changes: 2 additions & 1 deletion apis/v1beta1/types.go
Original file line number Diff line number Diff line change
Expand Up @@ -280,7 +280,8 @@ type NetworkDeviceSpec struct {
Gateway6 string `json:"gateway6,omitempty"`

// IPAddrs is a list of one or more IPv4 and/or IPv6 addresses to assign
// to this device.
// to this device. IP addresses must also specify the segment length in
// CIDR notation.
// Required when DHCP4 and DHCP6 are both false.
// +optional
IPAddrs []string `json:"ipAddrs,omitempty"`
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -134,8 +134,9 @@ spec:
type: string
ipAddrs:
description: IPAddrs is a list of one or more IPv4 and/or
IPv6 addresses to assign to this device. Required
when DHCP4 and DHCP6 are both false.
IPv6 addresses to assign to this device. IP addresses
must also specify the segment length in CIDR notation.
Required when DHCP4 and DHCP6 are both false.
items:
type: string
type: array
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -138,8 +138,9 @@ spec:
type: string
ipAddrs:
description: IPAddrs is a list of one or more IPv4 and/or
IPv6 addresses to assign to this device. Required when
DHCP4 and DHCP6 are both false.
IPv6 addresses to assign to this device. IP addresses
must also specify the segment length in CIDR notation.
Required when DHCP4 and DHCP6 are both false.
items:
type: string
type: array
Expand Down Expand Up @@ -529,8 +530,9 @@ spec:
type: string
ipAddrs:
description: IPAddrs is a list of one or more IPv4 and/or
IPv6 addresses to assign to this device. Required when
DHCP4 and DHCP6 are both false.
IPv6 addresses to assign to this device. IP addresses
must also specify the segment length in CIDR notation.
Required when DHCP4 and DHCP6 are both false.
items:
type: string
type: array
Expand Down Expand Up @@ -929,8 +931,9 @@ spec:
type: string
ipAddrs:
description: IPAddrs is a list of one or more IPv4 and/or
IPv6 addresses to assign to this device. Required when
DHCP4 and DHCP6 are both false.
IPv6 addresses to assign to this device. IP addresses
must also specify the segment length in CIDR notation.
Required when DHCP4 and DHCP6 are both false.
items:
type: string
type: array
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -239,7 +239,9 @@ spec:
ipAddrs:
description: IPAddrs is a list of one or more IPv4
and/or IPv6 addresses to assign to this device.
Required when DHCP4 and DHCP6 are both false.
IP addresses must also specify the segment length
in CIDR notation. Required when DHCP4 and DHCP6
are both false.
items:
type: string
type: array
Expand Down Expand Up @@ -527,7 +529,9 @@ spec:
ipAddrs:
description: IPAddrs is a list of one or more IPv4
and/or IPv6 addresses to assign to this device.
Required when DHCP4 and DHCP6 are both false.
IP addresses must also specify the segment length
in CIDR notation. Required when DHCP4 and DHCP6
are both false.
items:
type: string
type: array
Expand Down Expand Up @@ -824,8 +828,10 @@ spec:
type: string
ipAddrs:
description: IPAddrs is a list of one or more IPv4
and/or IPv6 addresses to assign to this device.
Required when DHCP4 and DHCP6 are both false.
and/or IPv6 addresses to assign to this device. IP
addresses must also specify the segment length
in CIDR notation. Required when DHCP4 and DHCP6
are both false.
items:
type: string
type: array
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -156,8 +156,9 @@ spec:
type: string
ipAddrs:
description: IPAddrs is a list of one or more IPv4 and/or
IPv6 addresses to assign to this device. Required when
DHCP4 and DHCP6 are both false.
IPv6 addresses to assign to this device. IP addresses
must also specify the segment length in CIDR notation.
Required when DHCP4 and DHCP6 are both false.
items:
type: string
type: array
Expand Down Expand Up @@ -566,8 +567,9 @@ spec:
type: string
ipAddrs:
description: IPAddrs is a list of one or more IPv4 and/or
IPv6 addresses to assign to this device. Required when
DHCP4 and DHCP6 are both false.
IPv6 addresses to assign to this device. IP addresses
must also specify the segment length in CIDR notation.
Required when DHCP4 and DHCP6 are both false.
items:
type: string
type: array
Expand Down Expand Up @@ -985,8 +987,9 @@ spec:
type: string
ipAddrs:
description: IPAddrs is a list of one or more IPv4 and/or
IPv6 addresses to assign to this device. Required when
DHCP4 and DHCP6 are both false.
IPv6 addresses to assign to this device. IP addresses
must also specify the segment length in CIDR notation.
Required when DHCP4 and DHCP6 are both false.
items:
type: string
type: array
Expand Down

0 comments on commit 2929ebe

Please sign in to comment.