Skip to content

Commit 4eec0e7

Browse files
mdboothmdbooth
committed
Fix doc references to NodeCIDR in v1alpha8
1 parent 522ed82 commit 4eec0e7

File tree

3 files changed

+35
-19
lines changed

3 files changed

+35
-19
lines changed

‎api/v1alpha8/openstackcluster_types.go

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -40,21 +40,27 @@ type OpenStackClusterSpec struct {
4040
// +kubebuilder:validation:MaxItems=1
4141
ManagedSubnets []SubnetSpec `json:"managedSubnets,omitempty"`
4242

43-
// If NodeCIDR is set this option can be used to detect an existing router.
44-
// If specified, no new router will be created.
43+
// Router specifies an existing router to be used if ManagedSubnets are
44+
// specified. If specified, no new router will be created.
4545
// +optional
4646
Router *RouterFilter `json:"router,omitempty"`
4747

48-
// If NodeCIDR cannot be set this can be used to detect an existing network.
48+
// Network specifies an existing network to use if no ManagedSubnets
49+
// are specified.
4950
Network NetworkFilter `json:"network,omitempty"`
5051

51-
// If NodeCIDR cannot be set this can be used to detect existing IPv4 and/or IPv6 subnets.
52+
// Subnets specifies existing subnets to use if not ManagedSubnets are
53+
// specified. All subnets must be in the network specified by Network.
54+
// There can be zero, one, or two subnets. If no subnets are specified,
55+
// all subnets in Network will be used. If 2 subnets are specified, one
56+
// must be IPv4 and the other IPv6.
5257
// +kubebuilder:validation:MaxItems=2
58+
// +optional
5359
Subnets []SubnetFilter `json:"subnets,omitempty"`
5460

5561
// NetworkMTU sets the maximum transmission unit (MTU) value to address fragmentation for the private network ID.
5662
// This value will be used only if the Cluster actuator creates the network.
57-
// If leaved empty, the network will have the default MTU defined in Openstack network service.
63+
// If left empty, the network will have the default MTU defined in Openstack network service.
5864
// To use this field, the Openstack installation requires the net-mtu neutron API extension.
5965
// +optional
6066
NetworkMTU int `json:"networkMtu,omitempty"`

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

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5484,8 +5484,9 @@ spec:
54845484
maxItems: 1
54855485
type: array
54865486
network:
5487-
description: If NodeCIDR cannot be set this can be used to detect
5488-
an existing network.
5487+
description: |-
5488+
Network specifies an existing network to use if no ManagedSubnets
5489+
are specified.
54895490
properties:
54905491
description:
54915492
type: string
@@ -5508,13 +5509,13 @@ spec:
55085509
description: |-
55095510
NetworkMTU sets the maximum transmission unit (MTU) value to address fragmentation for the private network ID.
55105511
This value will be used only if the Cluster actuator creates the network.
5511-
If leaved empty, the network will have the default MTU defined in Openstack network service.
5512+
If left empty, the network will have the default MTU defined in Openstack network service.
55125513
To use this field, the Openstack installation requires the net-mtu neutron API extension.
55135514
type: integer
55145515
router:
55155516
description: |-
5516-
If NodeCIDR is set this option can be used to detect an existing router.
5517-
If specified, no new router will be created.
5517+
Router specifies an existing router to be used if ManagedSubnets are
5518+
specified. If specified, no new router will be created.
55185519
properties:
55195520
description:
55205521
type: string
@@ -5534,8 +5535,12 @@ spec:
55345535
type: string
55355536
type: object
55365537
subnets:
5537-
description: If NodeCIDR cannot be set this can be used to detect
5538-
existing IPv4 and/or IPv6 subnets.
5538+
description: |-
5539+
Subnets specifies existing subnets to use if not ManagedSubnets are
5540+
specified. All subnets must be in the network specified by Network.
5541+
There can be zero, one, or two subnets. If no subnets are specified,
5542+
all subnets in Network will be used. If 2 subnets are specified, one
5543+
must be IPv4 and the other IPv6.
55395544
items:
55405545
properties:
55415546
cidr:

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

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2919,8 +2919,9 @@ spec:
29192919
maxItems: 1
29202920
type: array
29212921
network:
2922-
description: If NodeCIDR cannot be set this can be used to
2923-
detect an existing network.
2922+
description: |-
2923+
Network specifies an existing network to use if no ManagedSubnets
2924+
are specified.
29242925
properties:
29252926
description:
29262927
type: string
@@ -2943,13 +2944,13 @@ spec:
29432944
description: |-
29442945
NetworkMTU sets the maximum transmission unit (MTU) value to address fragmentation for the private network ID.
29452946
This value will be used only if the Cluster actuator creates the network.
2946-
If leaved empty, the network will have the default MTU defined in Openstack network service.
2947+
If left empty, the network will have the default MTU defined in Openstack network service.
29472948
To use this field, the Openstack installation requires the net-mtu neutron API extension.
29482949
type: integer
29492950
router:
29502951
description: |-
2951-
If NodeCIDR is set this option can be used to detect an existing router.
2952-
If specified, no new router will be created.
2952+
Router specifies an existing router to be used if ManagedSubnets are
2953+
specified. If specified, no new router will be created.
29532954
properties:
29542955
description:
29552956
type: string
@@ -2969,8 +2970,12 @@ spec:
29692970
type: string
29702971
type: object
29712972
subnets:
2972-
description: If NodeCIDR cannot be set this can be used to
2973-
detect existing IPv4 and/or IPv6 subnets.
2973+
description: |-
2974+
Subnets specifies existing subnets to use if not ManagedSubnets are
2975+
specified. All subnets must be in the network specified by Network.
2976+
There can be zero, one, or two subnets. If no subnets are specified,
2977+
all subnets in Network will be used. If 2 subnets are specified, one
2978+
must be IPv4 and the other IPv6.
29742979
items:
29752980
properties:
29762981
cidr:

0 commit comments

Comments
 (0)