Skip to content

Commit 3e97a04

Browse files
committed
Add descriptions to ClusterServiceVersionSpec DisplayName, Description, Keywords, Maintainers, Provider, Links, and Icon fields.
1 parent 62c413d commit 3e97a04

File tree

3 files changed

+38
-10
lines changed

3 files changed

+38
-10
lines changed

crds/operators.coreos.com_clusterserviceversions.yaml

+7
Original file line numberDiff line numberDiff line change
@@ -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
@@ -4920,6 +4923,7 @@ spec:
49204923
description: InstallModeType is a supported type of install mode for CSV installation
49214924
type: string
49224925
keywords:
4926+
description: A list of keywords describing the operator.
49234927
type: array
49244928
items:
49254929
type: string
@@ -4929,6 +4933,7 @@ spec:
49294933
additionalProperties:
49304934
type: string
49314935
links:
4936+
description: A list of links related to the operator.
49324937
type: array
49334938
items:
49344939
type: object
@@ -4938,6 +4943,7 @@ spec:
49384943
url:
49394944
type: string
49404945
maintainers:
4946+
description: A list of organizational entities maintaining the operator.
49414947
type: array
49424948
items:
49434949
type: object
@@ -4967,6 +4973,7 @@ spec:
49674973
version:
49684974
type: string
49694975
provider:
4976+
description: The publishing entity behind the operator.
49704977
type: object
49714978
properties:
49724979
name:

crds/zz_defs.go

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

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)