Skip to content

Commit

Permalink
Add descriptions to ClusterServiceVersionSpec DisplayName, Descriptio…
Browse files Browse the repository at this point in the history 
…n, Keywords, Maintainers, Provider, Links, and Icon fields.
  • Loading branch information
@TheRealJon
TheRealJon committed May 31, 2022
1 parent 5eb90bd commit c36341d
Show file tree
Hide file tree
Showing 3 changed files with 50 additions and 22 deletions.
31 changes: 19 additions & 12 deletions crds/operators.coreos.com_clusterserviceversions.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -127,13 +127,13 @@ spec:
- version
properties:
kind:
description: Kind of the referent
description: Kind of the referent.
type: string
name:
description: Name of the CustomResourceDefinition for the referent, or an empty string when the referent is not a custom resource
description: Name of the CustomResourceDefinition for the referent, or an empty string when the referent is not a custom resource.
type: string
version:
description: API version of the referent
description: API version of the referent.
type: string
specDescriptors:
type: array
Expand Down Expand Up @@ -240,13 +240,13 @@ spec:
- version
properties:
kind:
description: Kind of the referent
description: Kind of the referent.
type: string
name:
description: Name of the CustomResourceDefinition for the referent, or an empty string when the referent is not a custom resource
description: Name of the CustomResourceDefinition for the referent, or an empty string when the referent is not a custom resource.
type: string
version:
description: API version of the referent
description: API version of the referent.
type: string
specDescriptors:
type: array
Expand Down Expand Up @@ -357,13 +357,13 @@ spec:
- version
properties:
kind:
description: Kind of the referent
description: Kind of the referent.
type: string
name:
description: Name of the CustomResourceDefinition for the referent, or an empty string when the referent is not a custom resource
description: Name of the CustomResourceDefinition for the referent, or an empty string when the referent is not a custom resource.
type: string
version:
description: API version of the referent
description: API version of the referent.
type: string
specDescriptors:
type: array
Expand Down Expand Up @@ -462,13 +462,13 @@ spec:
- version
properties:
kind:
description: Kind of the referent
description: Kind of the referent.
type: string
name:
description: Name of the CustomResourceDefinition for the referent, or an empty string when the referent is not a custom resource
description: Name of the CustomResourceDefinition for the referent, or an empty string when the referent is not a custom resource.
type: string
version:
description: API version of the referent
description: API version of the referent.
type: string
specDescriptors:
type: array
Expand Down Expand Up @@ -517,10 +517,13 @@ spec:
version:
type: string
description:
description: Description of the operator. Can include the features, limitations or use-cases of the operator.
type: string
displayName:
description: The name of the operator in display format.
type: string
icon:
description: The icon for this operator.
type: array
items:
type: object
Expand Down Expand Up @@ -4802,6 +4805,7 @@ spec:
description: InstallModeType is a supported type of install mode for CSV installation
type: string
keywords:
description: A list of keywords describing the operator.
type: array
items:
type: string
Expand All @@ -4811,6 +4815,7 @@ spec:
additionalProperties:
type: string
links:
description: A list of links related to the operator.
type: array
items:
type: object
Expand All @@ -4820,6 +4825,7 @@ spec:
url:
type: string
maintainers:
description: A list of organizational entities maintaining the operator.
type: array
items:
type: object
Expand Down Expand Up @@ -4849,6 +4855,7 @@ spec:
version:
type: string
provider:
description: The publishing entity behind the operator.
type: object
properties:
name:
Expand Down
2 changes: 1 addition & 1 deletion crds/zz_defs.go
View file

Large diffs are not rendered by default.

39 changes: 30 additions & 9 deletions pkg/operators/v1alpha1/clusterserviceversion_types.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -149,9 +149,9 @@ type APIServiceDescription struct {
// +k8s:openapi-gen=true
type APIResourceReference struct {
// Name of the CustomResourceDefinition for the referent, or an empty string when the referent is not a custom resource.
Name string `json:"name"`
Name string `json:"name"`
// Kind of the referent.
Kind string `json:"kind"`
Kind string `json:"kind"`
// API version of the referent.
Version string `json:"version"`
}
Expand Down Expand Up @@ -282,13 +282,34 @@ type ClusterServiceVersionSpec struct {
WebhookDefinitions []WebhookDescription `json:"webhookdefinitions,omitempty"`
NativeAPIs []metav1.GroupVersionKind `json:"nativeAPIs,omitempty"`
MinKubeVersion string `json:"minKubeVersion,omitempty"`
DisplayName string `json:"displayName"`
Description string `json:"description,omitempty"`
Keywords []string `json:"keywords,omitempty"`
Maintainers []Maintainer `json:"maintainers,omitempty"`
Provider AppLink `json:"provider,omitempty"`
Links []AppLink `json:"links,omitempty"`
Icon []Icon `json:"icon,omitempty"`

// The name of the operator in display format.
DisplayName string `json:"displayName"`

// Description of the operator. Can include the features, limitations or use-cases of the
// operator.
// +optional
Description string `json:"description,omitempty"`

// A list of keywords describing the operator.
// +optional
Keywords []string `json:"keywords,omitempty"`

// A list of organizational entities maintaining the operator.
// +optional
Maintainers []Maintainer `json:"maintainers,omitempty"`

// The publishing entity behind the operator.
// +optional
Provider AppLink `json:"provider,omitempty"`

// A list of links related to the operator.
// +optional
Links []AppLink `json:"links,omitempty"`

// The icon for this operator.
// +optional
Icon []Icon `json:"icon,omitempty"`

// InstallModes specify supported installation types
// +optional
Expand Down

0 comments on commit c36341d

Please sign in to comment.