Skip to content

Commit a2f8e74

Browse files
k8s-ci-robotk8s-ci-robot
authored
Merge pull request #2168 from killianmuldoon/pr-update-ip-addr-godoc
📖 Improve godoc of the ipAddrs field
2 parents 32cbee4 + 26cd336 commit a2f8e74

7 files changed

+37
-21
lines changed

‎apis/v1alpha3/types.go

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -237,7 +237,8 @@ type NetworkDeviceSpec struct {
237237
Gateway6 string `json:"gateway6,omitempty"`
238238

239239
// IPAddrs is a list of one or more IPv4 and/or IPv6 addresses to assign
240-
// to this device.
240+
// to this device. IP addresses must also specify the segment length in
241+
// CIDR notation.
241242
// Required when DHCP4 and DHCP6 are both false.
242243
// +optional
243244
IPAddrs []string `json:"ipAddrs,omitempty"`

‎apis/v1alpha4/types.go

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -237,7 +237,8 @@ type NetworkDeviceSpec struct {
237237
Gateway6 string `json:"gateway6,omitempty"`
238238

239239
// IPAddrs is a list of one or more IPv4 and/or IPv6 addresses to assign
240-
// to this device.
240+
// to this device. IP addresses must also specify the segment length in
241+
// CIDR notation.
241242
// Required when DHCP4 and DHCP6 are both false.
242243
// +optional
243244
IPAddrs []string `json:"ipAddrs,omitempty"`

‎apis/v1beta1/types.go

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -313,7 +313,8 @@ type NetworkDeviceSpec struct {
313313
Gateway6 string `json:"gateway6,omitempty"`
314314

315315
// IPAddrs is a list of one or more IPv4 and/or IPv6 addresses to assign
316-
// to this device.
316+
// to this device. IP addresses must also specify the segment length in
317+
// CIDR notation.
317318
// Required when DHCP4 and DHCP6 are both false.
318319
// +optional
319320
IPAddrs []string `json:"ipAddrs,omitempty"`

‎config/default/crd/bases/infrastructure.cluster.x-k8s.io_haproxyloadbalancers.yaml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -132,8 +132,9 @@ spec:
132132
type: string
133133
ipAddrs:
134134
description: IPAddrs is a list of one or more IPv4 and/or
135-
IPv6 addresses to assign to this device. Required
136-
when DHCP4 and DHCP6 are both false.
135+
IPv6 addresses to assign to this device. IP addresses
136+
must also specify the segment length in CIDR notation.
137+
Required when DHCP4 and DHCP6 are both false.
137138
items:
138139
type: string
139140
type: array

‎config/default/crd/bases/infrastructure.cluster.x-k8s.io_vspheremachines.yaml

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -140,8 +140,9 @@ spec:
140140
type: string
141141
ipAddrs:
142142
description: IPAddrs is a list of one or more IPv4 and/or
143-
IPv6 addresses to assign to this device. Required when
144-
DHCP4 and DHCP6 are both false.
143+
IPv6 addresses to assign to this device. IP addresses
144+
must also specify the segment length in CIDR notation.
145+
Required when DHCP4 and DHCP6 are both false.
145146
items:
146147
type: string
147148
type: array
@@ -535,8 +536,9 @@ spec:
535536
type: string
536537
ipAddrs:
537538
description: IPAddrs is a list of one or more IPv4 and/or
538-
IPv6 addresses to assign to this device. Required when
539-
DHCP4 and DHCP6 are both false.
539+
IPv6 addresses to assign to this device. IP addresses
540+
must also specify the segment length in CIDR notation.
541+
Required when DHCP4 and DHCP6 are both false.
540542
items:
541543
type: string
542544
type: array
@@ -1085,8 +1087,9 @@ spec:
10851087
type: string
10861088
ipAddrs:
10871089
description: IPAddrs is a list of one or more IPv4 and/or
1088-
IPv6 addresses to assign to this device. Required when
1089-
DHCP4 and DHCP6 are both false.
1090+
IPv6 addresses to assign to this device. IP addresses
1091+
must also specify the segment length in CIDR notation.
1092+
Required when DHCP4 and DHCP6 are both false.
10901093
items:
10911094
type: string
10921095
type: array

‎config/default/crd/bases/infrastructure.cluster.x-k8s.io_vspheremachinetemplates.yaml

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -241,7 +241,9 @@ spec:
241241
ipAddrs:
242242
description: IPAddrs is a list of one or more IPv4
243243
and/or IPv6 addresses to assign to this device.
244-
Required when DHCP4 and DHCP6 are both false.
244+
IP addresses must also specify the segment length
245+
in CIDR notation. Required when DHCP4 and DHCP6
246+
are both false.
245247
items:
246248
type: string
247249
type: array
@@ -529,7 +531,9 @@ spec:
529531
ipAddrs:
530532
description: IPAddrs is a list of one or more IPv4
531533
and/or IPv6 addresses to assign to this device.
532-
Required when DHCP4 and DHCP6 are both false.
534+
IP addresses must also specify the segment length
535+
in CIDR notation. Required when DHCP4 and DHCP6
536+
are both false.
533537
items:
534538
type: string
535539
type: array
@@ -988,8 +992,10 @@ spec:
988992
type: string
989993
ipAddrs:
990994
description: IPAddrs is a list of one or more IPv4
991-
and/or IPv6 addresses to assign to this device.
992-
Required when DHCP4 and DHCP6 are both false.
995+
and/or IPv6 addresses to assign to this device. IP
996+
addresses must also specify the segment length
997+
in CIDR notation. Required when DHCP4 and DHCP6
998+
are both false.
993999
items:
9941000
type: string
9951001
type: array

‎config/default/crd/bases/infrastructure.cluster.x-k8s.io_vspherevms.yaml

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -157,8 +157,9 @@ spec:
157157
type: string
158158
ipAddrs:
159159
description: IPAddrs is a list of one or more IPv4 and/or
160-
IPv6 addresses to assign to this device. Required when
161-
DHCP4 and DHCP6 are both false.
160+
IPv6 addresses to assign to this device. IP addresses
161+
must also specify the segment length in CIDR notation.
162+
Required when DHCP4 and DHCP6 are both false.
162163
items:
163164
type: string
164165
type: array
@@ -568,8 +569,9 @@ spec:
568569
type: string
569570
ipAddrs:
570571
description: IPAddrs is a list of one or more IPv4 and/or
571-
IPv6 addresses to assign to this device. Required when
572-
DHCP4 and DHCP6 are both false.
572+
IPv6 addresses to assign to this device. IP addresses
573+
must also specify the segment length in CIDR notation.
574+
Required when DHCP4 and DHCP6 are both false.
573575
items:
574576
type: string
575577
type: array
@@ -1134,8 +1136,9 @@ spec:
11341136
type: string
11351137
ipAddrs:
11361138
description: IPAddrs is a list of one or more IPv4 and/or
1137-
IPv6 addresses to assign to this device. Required when
1138-
DHCP4 and DHCP6 are both false.
1139+
IPv6 addresses to assign to this device. IP addresses
1140+
must also specify the segment length in CIDR notation.
1141+
Required when DHCP4 and DHCP6 are both false.
11391142
items:
11401143
type: string
11411144
type: array

0 commit comments

Comments
 (0)