Skip to content

Commit e6a194b

Browse files
mdboothmdbooth
committed
OpenStackCluster: improve doctext
1 parent 70bfdaf commit e6a194b

File tree

4 files changed

+50
-34
lines changed

4 files changed

+50
-34
lines changed

‎api/v1beta1/openstackcluster_types.go‎

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -152,7 +152,7 @@ type OpenStackClusterSpec struct {
152152
// +optional
153153
DisablePortSecurity optional.Bool `json:"disablePortSecurity,omitempty"`
154154

155-
// Tags for all resources in cluster
155+
// Tags to set on all resources in cluster which support tags
156156
// +listType=set
157157
// +optional
158158
Tags []string `json:"tags,omitempty"`
@@ -166,7 +166,8 @@ type OpenStackClusterSpec struct {
166166
// +optional
167167
ControlPlaneEndpoint *clusterv1.APIEndpoint `json:"controlPlaneEndpoint,omitempty"`
168168

169-
// ControlPlaneAvailabilityZones is the az to deploy control plane to
169+
// ControlPlaneAvailabilityZones is the set of availability zones which
170+
// control plane machines may be deployed to.
170171
// +listType=set
171172
// +optional
172173
ControlPlaneAvailabilityZones []string `json:"controlPlaneAvailabilityZones,omitempty"`
@@ -203,7 +204,7 @@ type OpenStackClusterStatus struct {
203204
// +optional
204205
Network *NetworkStatusWithSubnets `json:"network,omitempty"`
205206

206-
// externalNetwork contains information about the external network used for default ingress and egress traffic.
207+
// ExternalNetwork contains information about the external network used for default ingress and egress traffic.
207208
// +optional
208209
ExternalNetwork *NetworkStatus `json:"externalNetwork,omitempty"`
209210

@@ -218,20 +219,23 @@ type OpenStackClusterStatus struct {
218219
// FailureDomains represent OpenStack availability zones
219220
FailureDomains clusterv1.FailureDomains `json:"failureDomains,omitempty"`
220221

221-
// ControlPlaneSecurityGroups contains all the information about the OpenStack
222-
// Security Group that needs to be applied to control plane nodes.
223-
// TODO: Maybe instead of two properties, we add a property to the group?
222+
// ControlPlaneSecurityGroup contains the information about the
223+
// OpenStack Security Group that needs to be applied to control plane
224+
// nodes.
224225
// +optional
225226
ControlPlaneSecurityGroup *SecurityGroupStatus `json:"controlPlaneSecurityGroup,omitempty"`
226227

227-
// WorkerSecurityGroup contains all the information about the OpenStack Security
228-
// Group that needs to be applied to worker nodes.
228+
// WorkerSecurityGroup contains the information about the OpenStack
229+
// Security Group that needs to be applied to worker nodes.
229230
// +optional
230231
WorkerSecurityGroup *SecurityGroupStatus `json:"workerSecurityGroup,omitempty"`
231232

233+
// BastionSecurityGroup contains the information about the OpenStack
234+
// Security Group that needs to be applied to worker nodes.
232235
// +optional
233236
BastionSecurityGroup *SecurityGroupStatus `json:"bastionSecurityGroup,omitempty"`
234237

238+
// Bastion contains the information about the deployed bastion host
235239
// +optional
236240
Bastion *BastionStatus `json:"bastion,omitempty"`
237241

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

Lines changed: 15 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -5529,8 +5529,9 @@ spec:
55295529
type: object
55305530
type: object
55315531
controlPlaneAvailabilityZones:
5532-
description: ControlPlaneAvailabilityZones is the az to deploy control
5533-
plane to
5532+
description: |-
5533+
ControlPlaneAvailabilityZones is the set of availability zones which
5534+
control plane machines may be deployed to.
55345535
items:
55355536
type: string
55365537
type: array
@@ -6142,7 +6143,8 @@ spec:
61426143
type: array
61436144
x-kubernetes-list-type: atomic
61446145
tags:
6145-
description: Tags for all resources in cluster
6146+
description: Tags to set on all resources in cluster which support
6147+
tags
61466148
items:
61476149
type: string
61486150
type: array
@@ -6180,6 +6182,8 @@ spec:
61806182
- name
61816183
type: object
61826184
bastion:
6185+
description: Bastion contains the information about the deployed bastion
6186+
host
61836187
properties:
61846188
dependentResources:
61856189
properties:
@@ -6593,8 +6597,8 @@ spec:
65936597
type: object
65946598
bastionSecurityGroup:
65956599
description: |-
6596-
SecurityGroupStatus represents the basic information of the associated
6597-
OpenStack Neutron Security Group.
6600+
BastionSecurityGroup contains the information about the OpenStack
6601+
Security Group that needs to be applied to worker nodes.
65986602
properties:
65996603
id:
66006604
description: id of the security group
@@ -6660,9 +6664,9 @@ spec:
66606664
type: object
66616665
controlPlaneSecurityGroup:
66626666
description: |-
6663-
ControlPlaneSecurityGroups contains all the information about the OpenStack
6664-
Security Group that needs to be applied to control plane nodes.
6665-
TODO: Maybe instead of two properties, we add a property to the group?
6667+
ControlPlaneSecurityGroup contains the information about the
6668+
OpenStack Security Group that needs to be applied to control plane
6669+
nodes.
66666670
properties:
66676671
id:
66686672
description: id of the security group
@@ -6727,7 +6731,7 @@ spec:
67276731
- name
67286732
type: object
67296733
externalNetwork:
6730-
description: externalNetwork contains information about the external
6734+
description: ExternalNetwork contains information about the external
67316735
network used for default ingress and egress traffic.
67326736
properties:
67336737
id:
@@ -6868,8 +6872,8 @@ spec:
68686872
type: object
68696873
workerSecurityGroup:
68706874
description: |-
6871-
WorkerSecurityGroup contains all the information about the OpenStack Security
6872-
Group that needs to be applied to worker nodes.
6875+
WorkerSecurityGroup contains the information about the OpenStack
6876+
Security Group that needs to be applied to worker nodes.
68736877
properties:
68746878
id:
68756879
description: id of the security group

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

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2961,8 +2961,9 @@ spec:
29612961
type: object
29622962
type: object
29632963
controlPlaneAvailabilityZones:
2964-
description: ControlPlaneAvailabilityZones is the az to deploy
2965-
control plane to
2964+
description: |-
2965+
ControlPlaneAvailabilityZones is the set of availability zones which
2966+
control plane machines may be deployed to.
29662967
items:
29672968
type: string
29682969
type: array
@@ -3576,7 +3577,8 @@ spec:
35763577
type: array
35773578
x-kubernetes-list-type: atomic
35783579
tags:
3579-
description: Tags for all resources in cluster
3580+
description: Tags to set on all resources in cluster which
3581+
support tags
35803582
items:
35813583
type: string
35823584
type: array

‎docs/book/src/api/v1beta1/api.md‎

Lines changed: 18 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -324,7 +324,7 @@ Kubernetes cluster, which also disables SecurityGroups</p>
324324
</td>
325325
<td>
326326
<em>(Optional)</em>
327-
<p>Tags for all resources in cluster</p>
327+
<p>Tags to set on all resources in cluster which support tags</p>
328328
</td>
329329
</tr>
330330
<tr>
@@ -355,7 +355,8 @@ ControlPlaneEndpoint cannot be modified after ControlPlaneEndpoint.Host has been
355355
</td>
356356
<td>
357357
<em>(Optional)</em>
358-
<p>ControlPlaneAvailabilityZones is the az to deploy control plane to</p>
358+
<p>ControlPlaneAvailabilityZones is the set of availability zones which
359+
control plane machines may be deployed to.</p>
359360
</td>
360361
</tr>
361362
<tr>
@@ -2223,7 +2224,7 @@ Kubernetes cluster, which also disables SecurityGroups</p>
22232224
</td>
22242225
<td>
22252226
<em>(Optional)</em>
2226-
<p>Tags for all resources in cluster</p>
2227+
<p>Tags to set on all resources in cluster which support tags</p>
22272228
</td>
22282229
</tr>
22292230
<tr>
@@ -2254,7 +2255,8 @@ ControlPlaneEndpoint cannot be modified after ControlPlaneEndpoint.Host has been
22542255
</td>
22552256
<td>
22562257
<em>(Optional)</em>
2257-
<p>ControlPlaneAvailabilityZones is the az to deploy control plane to</p>
2258+
<p>ControlPlaneAvailabilityZones is the set of availability zones which
2259+
control plane machines may be deployed to.</p>
22582260
</td>
22592261
</tr>
22602262
<tr>
@@ -2359,7 +2361,7 @@ NetworkStatus
23592361
</td>
23602362
<td>
23612363
<em>(Optional)</em>
2362-
<p>externalNetwork contains information about the external network used for default ingress and egress traffic.</p>
2364+
<p>ExternalNetwork contains information about the external network used for default ingress and egress traffic.</p>
23632365
</td>
23642366
</tr>
23652367
<tr>
@@ -2414,9 +2416,9 @@ SecurityGroupStatus
24142416
</td>
24152417
<td>
24162418
<em>(Optional)</em>
2417-
<p>ControlPlaneSecurityGroups contains all the information about the OpenStack
2418-
Security Group that needs to be applied to control plane nodes.
2419-
TODO: Maybe instead of two properties, we add a property to the group?</p>
2419+
<p>ControlPlaneSecurityGroup contains the information about the
2420+
OpenStack Security Group that needs to be applied to control plane
2421+
nodes.</p>
24202422
</td>
24212423
</tr>
24222424
<tr>
@@ -2430,8 +2432,8 @@ SecurityGroupStatus
24302432
</td>
24312433
<td>
24322434
<em>(Optional)</em>
2433-
<p>WorkerSecurityGroup contains all the information about the OpenStack Security
2434-
Group that needs to be applied to worker nodes.</p>
2435+
<p>WorkerSecurityGroup contains the information about the OpenStack
2436+
Security Group that needs to be applied to worker nodes.</p>
24352437
</td>
24362438
</tr>
24372439
<tr>
@@ -2445,6 +2447,8 @@ SecurityGroupStatus
24452447
</td>
24462448
<td>
24472449
<em>(Optional)</em>
2450+
<p>BastionSecurityGroup contains the information about the OpenStack
2451+
Security Group that needs to be applied to worker nodes.</p>
24482452
</td>
24492453
</tr>
24502454
<tr>
@@ -2458,6 +2462,7 @@ BastionStatus
24582462
</td>
24592463
<td>
24602464
<em>(Optional)</em>
2465+
<p>Bastion contains the information about the deployed bastion host</p>
24612466
</td>
24622467
</tr>
24632468
<tr>
@@ -2801,7 +2806,7 @@ Kubernetes cluster, which also disables SecurityGroups</p>
28012806
</td>
28022807
<td>
28032808
<em>(Optional)</em>
2804-
<p>Tags for all resources in cluster</p>
2809+
<p>Tags to set on all resources in cluster which support tags</p>
28052810
</td>
28062811
</tr>
28072812
<tr>
@@ -2832,7 +2837,8 @@ ControlPlaneEndpoint cannot be modified after ControlPlaneEndpoint.Host has been
28322837
</td>
28332838
<td>
28342839
<em>(Optional)</em>
2835-
<p>ControlPlaneAvailabilityZones is the az to deploy control plane to</p>
2840+
<p>ControlPlaneAvailabilityZones is the set of availability zones which
2841+
control plane machines may be deployed to.</p>
28362842
</td>
28372843
</tr>
28382844
<tr>

0 commit comments

Comments
 (0)