Skip to content

Commit

Permalink
Merge pull request #2168 from killianmuldoon/pr-update-ip-addr-godoc
Browse files Browse the repository at this point in the history 
📖 Improve godoc of the ipAddrs field
  • Loading branch information
@k8s-ci-robot
k8s-ci-robot authored Aug 4, 2023
2 parents 32cbee4 + 26cd336 commit a2f8e74
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
View file
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
View file
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
View file
Original file line number Diff line number Diff line change
Expand Up @@ -313,7 +313,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
5 changes: 3 additions & 2 deletions config/default/crd/bases/infrastructure.cluster.x-k8s.io_haproxyloadbalancers.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -132,8 +132,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
15 changes: 9 additions & 6 deletions config/default/crd/bases/infrastructure.cluster.x-k8s.io_vspheremachines.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -140,8 +140,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 @@ -535,8 +536,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 @@ -1085,8 +1087,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
14 changes: 10 additions & 4 deletions config/default/crd/bases/infrastructure.cluster.x-k8s.io_vspheremachinetemplates.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -241,7 +241,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 @@ -529,7 +531,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 @@ -988,8 +992,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
15 changes: 9 additions & 6 deletions config/default/crd/bases/infrastructure.cluster.x-k8s.io_vspherevms.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -157,8 +157,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 @@ -568,8 +569,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 @@ -1134,8 +1136,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 a2f8e74

Please sign in to comment.