Skip to content

Commit 73b771d

Browse files
qiujian16qiujian16
committed
Update godoc of APIs to follow jsonField pattern
Signed-off-by: Jian Qiu <[email protected]>
1 parent c6702ad commit 73b771d

26 files changed

+147
-147
lines changed

‎addon/v1alpha1/0000_00_addon.open-cluster-management.io_clustermanagementaddons.crd.yaml

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -148,7 +148,7 @@ spec:
148148
The rollout strategy only watches the addon configurations defined in ClusterManagementAddOn.
149149
properties:
150150
all:
151-
description: All defines required fields for RolloutStrategy
151+
description: all defines required fields for RolloutStrategy
152152
type All
153153
properties:
154154
maxFailures:
@@ -195,7 +195,7 @@ spec:
195195
type: string
196196
type: object
197197
progressive:
198-
description: Progressive defines required fields for
198+
description: progressive defines required fields for
199199
RolloutStrategy type Progressive
200200
properties:
201201
mandatoryDecisionGroups:
@@ -211,13 +211,13 @@ spec:
211211
properties:
212212
groupIndex:
213213
description: |-
214-
GroupIndex of the decision group should match the placementDecisions label value with label key
214+
groupIndex of the decision group should match the placementDecisions label value with label key
215215
cluster.open-cluster-management.io/decision-group-index
216216
format: int32
217217
type: integer
218218
groupName:
219219
description: |-
220-
GroupName of the decision group should match the placementDecisions label value with label key
220+
groupName of the decision group should match the placementDecisions label value with label key
221221
cluster.open-cluster-management.io/decision-group-name
222222
type: string
223223
type: object
@@ -227,7 +227,7 @@ spec:
227227
- type: integer
228228
- type: string
229229
description: |-
230-
MaxConcurrency is the max number of clusters to deploy workload concurrently. The default value
230+
maxConcurrency is the max number of clusters to deploy workload concurrently. The default value
231231
for MaxConcurrency is determined from the clustersPerDecisionGroup defined in the
232232
placement->DecisionStrategy.
233233
pattern: ^((100|[0-9]{1,2})%|[0-9]+)$
@@ -276,7 +276,7 @@ spec:
276276
type: string
277277
type: object
278278
progressivePerGroup:
279-
description: ProgressivePerGroup defines required fields
279+
description: progressivePerGroup defines required fields
280280
for RolloutStrategy type ProgressivePerGroup
281281
properties:
282282
mandatoryDecisionGroups:
@@ -292,13 +292,13 @@ spec:
292292
properties:
293293
groupIndex:
294294
description: |-
295-
GroupIndex of the decision group should match the placementDecisions label value with label key
295+
groupIndex of the decision group should match the placementDecisions label value with label key
296296
cluster.open-cluster-management.io/decision-group-index
297297
format: int32
298298
type: integer
299299
groupName:
300300
description: |-
301-
GroupName of the decision group should match the placementDecisions label value with label key
301+
groupName of the decision group should match the placementDecisions label value with label key
302302
cluster.open-cluster-management.io/decision-group-name
303303
type: string
304304
type: object

‎addon/v1alpha1/0000_02_addon.open-cluster-management.io_addondeploymentconfigs.crd.yaml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ spec:
4848
type: string
4949
customizedVariables:
5050
description: |-
51-
CustomizedVariables is a list of name-value variables for the current add-on deployment.
51+
customizedVariables is a list of name-value variables for the current add-on deployment.
5252
The add-on implementation can use these variables to render its add-on deployment.
5353
The default is an empty list.
5454
items:
@@ -73,7 +73,7 @@ spec:
7373
x-kubernetes-list-type: map
7474
nodePlacement:
7575
description: |-
76-
NodePlacement enables explicit control over the scheduling of the add-on agents on the
76+
nodePlacement enables explicit control over the scheduling of the add-on agents on the
7777
managed cluster.
7878
All add-on agent pods are expected to comply with this node placement.
7979
If the placement is nil, the placement is not specified, it will be omitted.
@@ -156,7 +156,7 @@ spec:
156156
type: object
157157
registries:
158158
description: |-
159-
Registries describes how to override images used by the addon agent on the managed cluster.
159+
registries describes how to override images used by the addon agent on the managed cluster.
160160
the following example will override image "quay.io/open-cluster-management/addon-agent" to
161161
"quay.io/ocm/addon-agent" when deploying the addon agent
162162

‎addon/v1alpha1/0000_03_addon.open-cluster-management.io_addontemplates.crd.yaml

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -50,16 +50,16 @@ spec:
5050
addon agent resources yaml description.
5151
properties:
5252
addonName:
53-
description: AddonName represents the name of the addon which the
53+
description: addonName represents the name of the addon which the
5454
template belongs to
5555
type: string
5656
agentSpec:
57-
description: AgentSpec describes what/how the kubernetes resources
57+
description: agentSpec describes what/how the kubernetes resources
5858
of the addon agent to be deployed on a managed cluster.
5959
properties:
6060
deleteOption:
6161
description: |-
62-
DeleteOption represents deletion strategy when the manifestwork is deleted.
62+
deleteOption represents deletion strategy when the manifestwork is deleted.
6363
Foreground deletion strategy is applied to all the resource in this manifestwork if it is not set.
6464
properties:
6565
propagationPolicy:
@@ -171,7 +171,7 @@ spec:
171171
type: object
172172
type: object
173173
manifestConfigs:
174-
description: ManifestConfigs represents the configurations of
174+
description: manifestConfigs represents the configurations of
175175
manifests defined in workload field.
176176
items:
177177
description: ManifestConfigOption represents the configurations
@@ -388,11 +388,11 @@ spec:
388388
type: object
389389
type: array
390390
workload:
391-
description: Workload represents the manifest workload to be deployed
391+
description: workload represents the manifest workload to be deployed
392392
on a managed cluster.
393393
properties:
394394
manifests:
395-
description: Manifests represents a list of kuberenetes resources
395+
description: manifests represents a list of kuberenetes resources
396396
to be deployed on a managed cluster.
397397
items:
398398
description: Manifest represents a resource to be deployed
@@ -404,7 +404,7 @@ spec:
404404
type: object
405405
type: object
406406
registration:
407-
description: Registration holds the registration configuration for
407+
description: registration holds the registration configuration for
408408
the addon
409409
items:
410410
description: |-

‎addon/v1alpha1/types_addondeploymentconfig.go

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,23 +21,23 @@ type AddOnDeploymentConfig struct {
2121
}
2222

2323
type AddOnDeploymentConfigSpec struct {
24-
// CustomizedVariables is a list of name-value variables for the current add-on deployment.
24+
// customizedVariables is a list of name-value variables for the current add-on deployment.
2525
// The add-on implementation can use these variables to render its add-on deployment.
2626
// The default is an empty list.
2727
// +optional
2828
// +listType=map
2929
// +listMapKey=name
3030
CustomizedVariables []CustomizedVariable `json:"customizedVariables,omitempty"`
3131

32-
// NodePlacement enables explicit control over the scheduling of the add-on agents on the
32+
// nodePlacement enables explicit control over the scheduling of the add-on agents on the
3333
// managed cluster.
3434
// All add-on agent pods are expected to comply with this node placement.
3535
// If the placement is nil, the placement is not specified, it will be omitted.
3636
// If the placement is an empty object, the placement will match all nodes and tolerate nothing.
3737
// +optional
3838
NodePlacement *NodePlacement `json:"nodePlacement,omitempty"`
3939

40-
// Registries describes how to override images used by the addon agent on the managed cluster.
40+
// registries describes how to override images used by the addon agent on the managed cluster.
4141
// the following example will override image "quay.io/open-cluster-management/addon-agent" to
4242
// "quay.io/ocm/addon-agent" when deploying the addon agent
4343
//

‎addon/v1alpha1/types_addontemplate.go

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,17 +32,17 @@ type AddOnTemplate struct {
3232

3333
// AddOnTemplateSpec defines the template of an addon agent which will be deployed on managed clusters.
3434
type AddOnTemplateSpec struct {
35-
// AddonName represents the name of the addon which the template belongs to
35+
// addonName represents the name of the addon which the template belongs to
3636
// +kubebuilder:validation:Required
3737
// +required
3838
AddonName string `json:"addonName"`
3939

40-
// AgentSpec describes what/how the kubernetes resources of the addon agent to be deployed on a managed cluster.
40+
// agentSpec describes what/how the kubernetes resources of the addon agent to be deployed on a managed cluster.
4141
// +kubebuilder:validation:Required
4242
// +required
4343
AgentSpec work.ManifestWorkSpec `json:"agentSpec"`
4444

45-
// Registration holds the registration configuration for the addon
45+
// registration holds the registration configuration for the addon
4646
// +optional
4747
Registration []RegistrationSpec `json:"registration"`
4848
}

‎cluster/v1/0000_00_clusters.open-cluster-management.io_managedclusters.crd.yaml

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ spec:
8686
leaseDurationSeconds:
8787
default: 60
8888
description: |-
89-
LeaseDurationSeconds is used to coordinate the lease update time of Klusterlet agents on the managed cluster.
89+
leaseDurationSeconds is used to coordinate the lease update time of Klusterlet agents on the managed cluster.
9090
If its value is zero, the Klusterlet agent will update its lease every 60 seconds by default
9191
format: int32
9292
type: integer
@@ -114,7 +114,7 @@ spec:
114114
type: array
115115
taints:
116116
description: |-
117-
Taints is a property of managed cluster that allow the cluster to be repelled when scheduling.
117+
taints is a property of managed cluster that allow the cluster to be repelled when scheduling.
118118
Taints, including 'ManagedClusterUnavailable' and 'ManagedClusterUnreachable', can not be added/removed by agent
119119
running on the managed cluster; while it's fine to add/remove other taints from either hub cluser or managed cluster.
120120
items:
@@ -124,7 +124,7 @@ spec:
124124
properties:
125125
effect:
126126
description: |-
127-
Effect indicates the effect of the taint on placements that do not tolerate the taint.
127+
effect indicates the effect of the taint on placements that do not tolerate the taint.
128128
Valid effects are NoSelect, PreferNoSelect and NoSelectIfNew.
129129
enum:
130130
- NoSelect
@@ -133,19 +133,19 @@ spec:
133133
type: string
134134
key:
135135
description: |-
136-
Key is the taint key applied to a cluster. e.g. bar or foo.example.com/bar.
136+
key is the taint key applied to a cluster. e.g. bar or foo.example.com/bar.
137137
The regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt)
138138
maxLength: 316
139139
pattern: ^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$
140140
type: string
141141
timeAdded:
142-
description: TimeAdded represents the time at which the taint
142+
description: timeAdded represents the time at which the taint
143143
was added.
144144
format: date-time
145145
nullable: true
146146
type: string
147147
value:
148-
description: Value is the taint value corresponding to the taint
148+
description: value is the taint value corresponding to the taint
149149
key.
150150
maxLength: 1024
151151
type: string
@@ -192,13 +192,13 @@ spec:
192192
properties:
193193
name:
194194
description: |-
195-
Name is the name of a ClusterClaim resource on managed cluster. It's a well known
195+
name is the name of a ClusterClaim resource on managed cluster. It's a well known
196196
or customized name to identify the claim.
197197
maxLength: 253
198198
minLength: 1
199199
type: string
200200
value:
201-
description: Value is a claim-dependent string
201+
description: value is a claim-dependent string
202202
maxLength: 1024
203203
minLength: 1
204204
type: string
@@ -349,7 +349,7 @@ spec:
349349
cluster.
350350
properties:
351351
kubernetes:
352-
description: Kubernetes is the kubernetes version of managed cluster.
352+
description: kubernetes is the kubernetes version of managed cluster.
353353
type: string
354354
type: object
355355
type: object

‎cluster/v1/types.go

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -63,13 +63,13 @@ type ManagedClusterSpec struct {
6363
// +optional
6464
HubAcceptsClient bool `json:"hubAcceptsClient"`
6565

66-
// LeaseDurationSeconds is used to coordinate the lease update time of Klusterlet agents on the managed cluster.
66+
// leaseDurationSeconds is used to coordinate the lease update time of Klusterlet agents on the managed cluster.
6767
// If its value is zero, the Klusterlet agent will update its lease every 60 seconds by default
6868
// +optional
6969
// +kubebuilder:default=60
7070
LeaseDurationSeconds int32 `json:"leaseDurationSeconds,omitempty"`
7171

72-
// Taints is a property of managed cluster that allow the cluster to be repelled when scheduling.
72+
// taints is a property of managed cluster that allow the cluster to be repelled when scheduling.
7373
// Taints, including 'ManagedClusterUnavailable' and 'ManagedClusterUnreachable', can not be added/removed by agent
7474
// running on the managed cluster; while it's fine to add/remove other taints from either hub cluser or managed cluster.
7575
// +optional
@@ -92,24 +92,24 @@ type ClientConfig struct {
9292
// The managed cluster this Taint is attached to has the "effect" on
9393
// any placement that does not tolerate the Taint.
9494
type Taint struct {
95-
// Key is the taint key applied to a cluster. e.g. bar or foo.example.com/bar.
95+
// key is the taint key applied to a cluster. e.g. bar or foo.example.com/bar.
9696
// The regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt)
9797
// +kubebuilder:validation:Required
9898
// +kubebuilder:validation:Pattern=`^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$`
9999
// +kubebuilder:validation:MaxLength=316
100100
// +required
101101
Key string `json:"key"`
102-
// Value is the taint value corresponding to the taint key.
102+
// value is the taint value corresponding to the taint key.
103103
// +kubebuilder:validation:MaxLength=1024
104104
// +optional
105105
Value string `json:"value,omitempty"`
106-
// Effect indicates the effect of the taint on placements that do not tolerate the taint.
106+
// effect indicates the effect of the taint on placements that do not tolerate the taint.
107107
// Valid effects are NoSelect, PreferNoSelect and NoSelectIfNew.
108108
// +kubebuilder:validation:Required
109109
// +kubebuilder:validation:Enum:=NoSelect;PreferNoSelect;NoSelectIfNew
110110
// +required
111111
Effect TaintEffect `json:"effect"`
112-
// TimeAdded represents the time at which the taint was added.
112+
// timeAdded represents the time at which the taint was added.
113113
// +nullable
114114
// +optional
115115
TimeAdded metav1.Time `json:"timeAdded"`
@@ -177,20 +177,20 @@ type ManagedClusterStatus struct {
177177
// ManagedClusterVersion represents version information about the managed cluster.
178178
// TODO add managed agent versions
179179
type ManagedClusterVersion struct {
180-
// Kubernetes is the kubernetes version of managed cluster.
180+
// kubernetes is the kubernetes version of managed cluster.
181181
// +optional
182182
Kubernetes string `json:"kubernetes,omitempty"`
183183
}
184184

185185
// ManagedClusterClaim represents a ClusterClaim collected from a managed cluster.
186186
type ManagedClusterClaim struct {
187-
// Name is the name of a ClusterClaim resource on managed cluster. It's a well known
187+
// name is the name of a ClusterClaim resource on managed cluster. It's a well known
188188
// or customized name to identify the claim.
189189
// +kubebuilder:validation:MaxLength=253
190190
// +kubebuilder:validation:MinLength=1
191191
Name string `json:"name,omitempty"`
192192

193-
// Value is a claim-dependent string
193+
// value is a claim-dependent string
194194
// +kubebuilder:validation:MaxLength=1024
195195
// +kubebuilder:validation:MinLength=1
196196
Value string `json:"value,omitempty"`

‎cluster/v1alpha1/0000_02_clusters.open-cluster-management.io_clusterclaims.crd.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ spec:
4646
description: Spec defines the attributes of the ClusterClaim.
4747
properties:
4848
value:
49-
description: Value is a claim-dependent string
49+
description: value is a claim-dependent string
5050
maxLength: 1024
5151
minLength: 1
5252
type: string

0 commit comments

Comments
 (0)