From 1a0cc129152c86bd14ab993af8205b7dcbe81352 Mon Sep 17 00:00:00 2001 From: Brett Tofel Date: Wed, 3 Jul 2024 10:50:14 -0400 Subject: [PATCH] Align CRD for added Go doc on InstalledBundle Signed-off-by: Brett Tofel --- api/v1alpha1/clusterextension_types.go | 5 ++--- .../bases/olm.operatorframework.io_clusterextensions.yaml | 4 +++- 2 files changed, 5 insertions(+), 4 deletions(-) diff --git a/api/v1alpha1/clusterextension_types.go b/api/v1alpha1/clusterextension_types.go index afcd439f..69315bb7 100644 --- 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 index 6331068a..2d71e459 100644 --- 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: