Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

📖 improve godoc of the ipAddrs field #1828

Closed
wants to merge 1 commit into from
Closed

📖 improve godoc of the ipAddrs field #1828

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion apis/v1alpha3/types.go
View file
Open in desktop
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
Open in desktop
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
Open in desktop
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
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
// to this device. IP addresses must also specify the segment length in
// to this device. IP addresses must also specify the segment length in

@rvanderp3 this change in all 3 files should make the linter happy

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe also rebase onto main

// 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
Open in desktop
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
15 changes: 9 additions & 6 deletions config/default/crd/bases/infrastructure.cluster.x-k8s.io_vspheremachines.yaml
View file
Open in desktop
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
14 changes: 10 additions & 4 deletions config/default/crd/bases/infrastructure.cluster.x-k8s.io_vspheremachinetemplates.yaml
View file
Open in desktop
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
15 changes: 9 additions & 6 deletions config/default/crd/bases/infrastructure.cluster.x-k8s.io_vspherevms.yaml
View file
Open in desktop
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