Add documentation URLs into CRD descriptions

These documentation URLs are templated, so that they can be updated
downstream as needed.

Signed-off-by: Todd Short <tshort@redhat.com>

Author: tmshort

api/v1/clustercatalog_types.go

@@ -53,6 +53,7 @@ const (
 
 // ClusterCatalog enables users to make File-Based Catalog (FBC) catalog data available to the cluster.
 // For more information on FBC, see https://olm.operatorframework.io/docs/reference/file-based-catalogs/#docs
+// Please see ClusterCatalog documentation located at {{ .Values.docs.clusterCatalogURL }}
 type ClusterCatalog struct {
 	metav1.TypeMeta `json:",inline"`
 

api/v1/clusterextension_types.go

@@ -527,6 +527,7 @@ type ClusterExtensionInstallStatus struct {
 // +kubebuilder:printcolumn:name=Age,type=date,JSONPath=`.metadata.creationTimestamp`
 
 // ClusterExtension is the Schema for the clusterextensions API
+// Please see ClusterExtension documentation located at {{ .Values.docs.clusterExtensionURL }}
 type ClusterExtension struct {
 	metav1.TypeMeta   `json:",inline"`
 	metav1.ObjectMeta `json:"metadata,omitempty"`

api/v1/clusterextensionrevision_types.go

@@ -214,6 +214,7 @@ type ClusterExtensionRevisionStatus struct {
 // at a time. Ownership of objects is transitioned from one revision to the next as the extension is upgraded
 // or reconfigured. Once the latest revision has rolled out successfully, previous active revisions are archived for
 // posterity.
+// Please see ClusterExtensionRevision documentation located at {{ .Values.docs.clusterExtensionRevisionURL }}
 type ClusterExtensionRevision struct {
 	metav1.TypeMeta   `json:",inline"`
 	metav1.ObjectMeta `json:"metadata,omitempty"`

helm/olmv1/base/catalogd/crd/experimental/olm.operatorframework.io_clustercatalogs.yaml

@@ -31,6 +31,7 @@ spec:
         description: |-
           ClusterCatalog enables users to make File-Based Catalog (FBC) catalog data available to the cluster.
           For more information on FBC, see https://olm.operatorframework.io/docs/reference/file-based-catalogs/#docs
+          Please see ClusterCatalog documentation located at {{ .Values.docs.clusterCatalogURL }}
         properties:
           apiVersion:
             description: |-

helm/olmv1/base/catalogd/crd/standard/olm.operatorframework.io_clustercatalogs.yaml

@@ -31,6 +31,7 @@ spec:
         description: |-
           ClusterCatalog enables users to make File-Based Catalog (FBC) catalog data available to the cluster.
           For more information on FBC, see https://olm.operatorframework.io/docs/reference/file-based-catalogs/#docs
+          Please see ClusterCatalog documentation located at {{ .Values.docs.clusterCatalogURL }}
         properties:
           apiVersion:
             description: |-

helm/olmv1/base/operator-controller/crd/experimental/olm.operatorframework.io_clusterextensionrevisions.yaml

@@ -35,6 +35,7 @@ spec:
           at a time. Ownership of objects is transitioned from one revision to the next as the extension is upgraded
           or reconfigured. Once the latest revision has rolled out successfully, previous active revisions are archived for
           posterity.
+          Please see ClusterExtensionRevision documentation located at {{ .Values.docs.clusterExtensionRevisionURL }}
         properties:
           apiVersion:
             description: |-

helm/olmv1/base/operator-controller/crd/experimental/olm.operatorframework.io_clusterextensions.yaml

@@ -34,7 +34,9 @@ spec:
     name: v1
     schema:
       openAPIV3Schema:
-        description: ClusterExtension is the Schema for the clusterextensions API
+        description: |-
+          ClusterExtension is the Schema for the clusterextensions API
+          Please see ClusterExtension documentation located at {{ .Values.docs.clusterExtensionURL }}
         properties:
           apiVersion:
             description: |-

helm/olmv1/base/operator-controller/crd/standard/olm.operatorframework.io_clusterextensions.yaml

@@ -34,7 +34,9 @@ spec:
     name: v1
     schema:
       openAPIV3Schema:
-        description: ClusterExtension is the Schema for the clusterextensions API
+        description: |-
+          ClusterExtension is the Schema for the clusterextensions API
+          Please see ClusterExtension documentation located at {{ .Values.docs.clusterExtensionURL }}
         properties:
           apiVersion:
             description: |-

helm/olmv1/values.yaml

@@ -96,3 +96,8 @@ deployments:
           - ALL
       readOnlyRootFilesystem: true
     terminationMessagePolicy: FallbackToLogsOnError
+# Documentation URLs
+docs:
+  clusterExtensionURL: https://www.example.com/ClusterExtension
+  clusterExtensionRevisionURL: https://www.example.com/ClusterExtensionRevision
+  clusterCatalogURL: https://www.example.com/ClusterCatalog

manifests/experimental-e2e.yaml

@@ -213,6 +213,7 @@ spec:
         description: |-
           ClusterCatalog enables users to make File-Based Catalog (FBC) catalog data available to the cluster.
           For more information on FBC, see https://olm.operatorframework.io/docs/reference/file-based-catalogs/#docs
+          Please see ClusterCatalog documentation located at https://www.example.com/ClusterCatalog
         properties:
           apiVersion:
             description: |-
@@ -660,6 +661,7 @@ spec:
           at a time. Ownership of objects is transitioned from one revision to the next as the extension is upgraded
           or reconfigured. Once the latest revision has rolled out successfully, previous active revisions are archived for
           posterity.
+          Please see ClusterExtensionRevision documentation located at https://www.example.com/ClusterExtensionRevision
         properties:
           apiVersion:
             description: |-
@@ -934,7 +936,9 @@ spec:
     name: v1
     schema:
       openAPIV3Schema:
-        description: ClusterExtension is the Schema for the clusterextensions API
+        description: |-
+          ClusterExtension is the Schema for the clusterextensions API
+          Please see ClusterExtension documentation located at https://www.example.com/ClusterExtension
         properties:
           apiVersion:
             description: |-