Skip to content

Commit c36341d

Browse files
TheRealJonTheRealJon
committed
Add descriptions to ClusterServiceVersionSpec DisplayName, Description, Keywords, Maintainers, Provider, Links, and Icon fields.
1 parent 5eb90bd commit c36341d

File tree

3 files changed

+50
-22
lines changed

3 files changed

+50
-22
lines changed

Diff for: ‎crds/operators.coreos.com_clusterserviceversions.yaml

+19-12
Original file line numberDiff line numberDiff line change
@@ -127,13 +127,13 @@ spec:
127127
- version
128128
properties:
129129
kind:
130-
description: Kind of the referent
130+
description: Kind of the referent.
131131
type: string
132132
name:
133-
description: Name of the CustomResourceDefinition for the referent, or an empty string when the referent is not a custom resource
133+
description: Name of the CustomResourceDefinition for the referent, or an empty string when the referent is not a custom resource.
134134
type: string
135135
version:
136-
description: API version of the referent
136+
description: API version of the referent.
137137
type: string
138138
specDescriptors:
139139
type: array
@@ -240,13 +240,13 @@ spec:
240240
- version
241241
properties:
242242
kind:
243-
description: Kind of the referent
243+
description: Kind of the referent.
244244
type: string
245245
name:
246-
description: Name of the CustomResourceDefinition for the referent, or an empty string when the referent is not a custom resource
246+
description: Name of the CustomResourceDefinition for the referent, or an empty string when the referent is not a custom resource.
247247
type: string
248248
version:
249-
description: API version of the referent
249+
description: API version of the referent.
250250
type: string
251251
specDescriptors:
252252
type: array
@@ -357,13 +357,13 @@ spec:
357357
- version
358358
properties:
359359
kind:
360-
description: Kind of the referent
360+
description: Kind of the referent.
361361
type: string
362362
name:
363-
description: Name of the CustomResourceDefinition for the referent, or an empty string when the referent is not a custom resource
363+
description: Name of the CustomResourceDefinition for the referent, or an empty string when the referent is not a custom resource.
364364
type: string
365365
version:
366-
description: API version of the referent
366+
description: API version of the referent.
367367
type: string
368368
specDescriptors:
369369
type: array
@@ -462,13 +462,13 @@ spec:
462462
- version
463463
properties:
464464
kind:
465-
description: Kind of the referent
465+
description: Kind of the referent.
466466
type: string
467467
name:
468-
description: Name of the CustomResourceDefinition for the referent, or an empty string when the referent is not a custom resource
468+
description: Name of the CustomResourceDefinition for the referent, or an empty string when the referent is not a custom resource.
469469
type: string
470470
version:
471-
description: API version of the referent
471+
description: API version of the referent.
472472
type: string
473473
specDescriptors:
474474
type: array
@@ -517,10 +517,13 @@ spec:
517517
version:
518518
type: string
519519
description:
520+
description: Description of the operator. Can include the features, limitations or use-cases of the operator.
520521
type: string
521522
displayName:
523+
description: The name of the operator in display format.
522524
type: string
523525
icon:
526+
description: The icon for this operator.
524527
type: array
525528
items:
526529
type: object
@@ -4802,6 +4805,7 @@ spec:
48024805
description: InstallModeType is a supported type of install mode for CSV installation
48034806
type: string
48044807
keywords:
4808+
description: A list of keywords describing the operator.
48054809
type: array
48064810
items:
48074811
type: string
@@ -4811,6 +4815,7 @@ spec:
48114815
additionalProperties:
48124816
type: string
48134817
links:
4818+
description: A list of links related to the operator.
48144819
type: array
48154820
items:
48164821
type: object
@@ -4820,6 +4825,7 @@ spec:
48204825
url:
48214826
type: string
48224827
maintainers:
4828+
description: A list of organizational entities maintaining the operator.
48234829
type: array
48244830
items:
48254831
type: object
@@ -4849,6 +4855,7 @@ spec:
48494855
version:
48504856
type: string
48514857
provider:
4858+
description: The publishing entity behind the operator.
48524859
type: object
48534860
properties:
48544861
name:

Diff for: ‎crds/zz_defs.go

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Diff for: ‎pkg/operators/v1alpha1/clusterserviceversion_types.go

+30-9
Original file line numberDiff line numberDiff line change
@@ -149,9 +149,9 @@ type APIServiceDescription struct {
149149
// +k8s:openapi-gen=true
150150
type APIResourceReference struct {
151151
// Name of the CustomResourceDefinition for the referent, or an empty string when the referent is not a custom resource.
152-
Name string `json:"name"`
152+
Name string `json:"name"`
153153
// Kind of the referent.
154-
Kind string `json:"kind"`
154+
Kind string `json:"kind"`
155155
// API version of the referent.
156156
Version string `json:"version"`
157157
}
@@ -282,13 +282,34 @@ type ClusterServiceVersionSpec struct {
282282
WebhookDefinitions []WebhookDescription `json:"webhookdefinitions,omitempty"`
283283
NativeAPIs []metav1.GroupVersionKind `json:"nativeAPIs,omitempty"`
284284
MinKubeVersion string `json:"minKubeVersion,omitempty"`
285-
DisplayName string `json:"displayName"`
286-
Description string `json:"description,omitempty"`
287-
Keywords []string `json:"keywords,omitempty"`
288-
Maintainers []Maintainer `json:"maintainers,omitempty"`
289-
Provider AppLink `json:"provider,omitempty"`
290-
Links []AppLink `json:"links,omitempty"`
291-
Icon []Icon `json:"icon,omitempty"`
285+
286+
// The name of the operator in display format.
287+
DisplayName string `json:"displayName"`
288+
289+
// Description of the operator. Can include the features, limitations or use-cases of the
290+
// operator.
291+
// +optional
292+
Description string `json:"description,omitempty"`
293+
294+
// A list of keywords describing the operator.
295+
// +optional
296+
Keywords []string `json:"keywords,omitempty"`
297+
298+
// A list of organizational entities maintaining the operator.
299+
// +optional
300+
Maintainers []Maintainer `json:"maintainers,omitempty"`
301+
302+
// The publishing entity behind the operator.
303+
// +optional
304+
Provider AppLink `json:"provider,omitempty"`
305+
306+
// A list of links related to the operator.
307+
// +optional
308+
Links []AppLink `json:"links,omitempty"`
309+
310+
// The icon for this operator.
311+
// +optional
312+
Icon []Icon `json:"icon,omitempty"`
292313

293314
// InstallModes specify supported installation types
294315
// +optional

0 commit comments

Comments
 (0)