Align CRD for added Go doc on InstalledBundle

Signed-off-by: Brett Tofel <btofel@redhat.com>
operator-framework · Jul 3, 2024 · 1a0cc12 · 1a0cc12
1 parent 5758f10
commit 1a0cc12
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 4 deletions.
diff --git a/api/v1alpha1/clusterextension_types.go b/api/v1alpha1/clusterextension_types.go
@@ -159,9 +159,8 @@ type BundleMetadata struct {
 	Version string `json:"version"`
 }
 
-// ClusterExtensionStatus defines the observed state of ClusterExtension
-// InstalledBundle should only be modified when a new bundle is successfully installed, that way if you've previously successfully installed a bundle before,
-// if an upgrade fails it is still appropriately communicated to you that there is still a bundle that is currently installed and owned by the ClusterExtension
+// ClusterExtensionStatus defines the observed state of ClusterExtension.
+// InstalledBundle should only be modified when a new bundle is successfully installed. This ensures that if you've previously successfully installed a bundle before, and an upgrade fails, it is still appropriately communicated to you that there is still a bundle that is currently installed and owned by the ClusterExtension.
 type ClusterExtensionStatus struct {
 	// +optional
 	InstalledBundle *BundleMetadata `json:"installedBundle,omitempty"`

diff --git a/config/base/crd/bases/olm.operatorframework.io_clusterextensions.yaml b/config/base/crd/bases/olm.operatorframework.io_clusterextensions.yaml
@@ -95,7 +95,9 @@ spec:
             - packageName
             type: object
           status:
-            description: ClusterExtensionStatus defines the observed state of ClusterExtension
+            description: |-
+              ClusterExtensionStatus defines the observed state of ClusterExtension.
+              InstalledBundle should only be modified when a new bundle is successfully installed. This ensures that if you've previously successfully installed a bundle before, and an upgrade fails, it is still appropriately communicated to you that there is still a bundle that is currently installed and owned by the ClusterExtension.
             properties:
               conditions:
                 items: