minor API improvements

Signed-off-by: Joe Lanford <[email protected]>

Author: joelanford

api/v1alpha1/clusterextension_types.go

@@ -23,8 +23,7 @@ import (
 )
 
 var (
-	ClusterExtensionGVK  = SchemeBuilder.GroupVersion.WithKind("ClusterExtension")
-	ClusterExtensionKind = ClusterExtensionGVK.Kind
+	ClusterExtensionKind = "ClusterExtension"
 )
 
 type UpgradeConstraintPolicy string
@@ -386,15 +385,15 @@ type PreflightConfig struct {
 	// The CRD Upgrade Safety pre-flight check safeguards from unintended
 	// consequences of upgrading a CRD, such as data loss.
 	//
-	// This field is required if the spec.preflight field is specified.
+	// This field is required if the spec.install.preflight field is specified.
 	CRDUpgradeSafety *CRDUpgradeSafetyPreflightConfig `json:"crdUpgradeSafety"`
 }
 
 // CRDUpgradeSafetyPreflightConfig is the configuration for CRD upgrade safety preflight check.
 type CRDUpgradeSafetyPreflightConfig struct {
 	// policy is used to configure the state of the CRD Upgrade Safety pre-flight check.
 	//
-	// This field is required when the spec.preflight.crdUpgradeSafety field is
+	// This field is required when the spec.install.preflight.crdUpgradeSafety field is
 	// specified.
 	//
 	// Allowed values are ["Enabled", "Disabled"]. The default value is "Enabled".
@@ -485,15 +484,17 @@ type ClusterExtensionStatus struct {
 	//   - Reason: a string representation of the reason for the current state of the condition. Typically useful for building automation around particular Type+Reason combinations.
 	//   - Message: a human readable message that further elaborates on the state of the condition
 	//
-	// The current set of condition types are:
-	//   - "Installed", represents whether or not the package referenced in the spec.packageName field has been installed
+	// The global set of condition types are:
+	//   - "Installed", represents whether or not the a bundle has been installed for this ClusterExtension
 	//   - "Resolved", represents whether or not a bundle was found that satisfies the selection criteria outlined in the spec
-	//   - "Deprecated", represents an aggregation of the PackageDeprecated, ChannelDeprecated, and BundleDeprecated condition types.
-	//   - "PackageDeprecated", represents whether or not the package specified in the spec.packageName field has been deprecated
-	//   - "ChannelDeprecated", represents whether or not the channel specified in spec.channel has been deprecated
-	//   - "BundleDeprecated", represents whether or not the bundle installed is deprecated
 	//   - "Unpacked", represents whether or not the bundle contents have been successfully unpacked
 	//
+	// When the ClusterExtension is sourced from a catalog, the following conditions are also possible:
+	//   - "Deprecated", represents an aggregation of the PackageDeprecated, ChannelDeprecated, and BundleDeprecated condition types
+	//   - "PackageDeprecated", represents whether or not the package specified in the spec.source.catalog.packageName field has been deprecated
+	//   - "ChannelDeprecated", represents whether or not any channel specified in spec.source.catalog.channels has been deprecated
+	//   - "BundleDeprecated", represents whether or not the installed bundle is deprecated
+	//
 	// The current set of reasons are:
 	//   - "Success", this reason is set on the "Unpacked", "Resolved" and "Installed" conditions when unpacking a bundle's content, resolution and installation/upgrading is successful
 	//   - "Failed", this reason is set on the "Unpacked", "Resolved" and "Installed" conditions when an error has occurred while unpacking the contents of a bundle, during resolution or installation.
@@ -511,22 +512,17 @@ type ClusterExtensionInstallStatus struct {
 	//
 	// A "bundle" is a versioned set of content that represents the resources that
 	// need to be applied to a cluster to install a package.
-	//
-	// This field is only updated once a bundle has been successfully installed and
-	// once set will only be updated when a new version of the bundle has
-	// successfully replaced the currently installed version.
-	//
-	//+optional
-	Bundle *BundleMetadata `json:"bundle,omitempty"`
+	Bundle BundleMetadata `json:"bundle"`
 }
 
 type ClusterExtensionResolutionStatus struct {
 	// bundle is a representation of the bundle that was identified during
 	// resolution to meet all installation/upgrade constraints and is slated to be
 	// installed or upgraded to.
 	//
-	//+optional
-	Bundle *BundleMetadata `json:"bundle,omitempty"`
+	// A "bundle" is a versioned set of content that represents the resources that
+	// need to be applied to a cluster to install a package.
+	Bundle BundleMetadata `json:"bundle"`
 }
 
 //+kubebuilder:object:root=true

api/v1alpha1/zz_generated.deepcopy.go

@@ -100,14 +100,14 @@ spec:
                           The CRD Upgrade Safety pre-flight check safeguards from unintended
                           consequences of upgrading a CRD, such as data loss.
 
-                          This field is required if the spec.preflight field is specified.
+                          This field is required if the spec.install.preflight field is specified.
                         properties:
                           policy:
                             default: Enabled
                             description: |-
                               policy is used to configure the state of the CRD Upgrade Safety pre-flight check.
 
-                              This field is required when the spec.preflight.crdUpgradeSafety field is
+                              This field is required when the spec.install.preflight.crdUpgradeSafety field is
                               specified.
 
                               Allowed values are ["Enabled", "Disabled"]. The default value is "Enabled".
@@ -474,15 +474,17 @@ spec:
                     - Reason: a string representation of the reason for the current state of the condition. Typically useful for building automation around particular Type+Reason combinations.
                     - Message: a human readable message that further elaborates on the state of the condition
 
-                  The current set of condition types are:
-                    - "Installed", represents whether or not the package referenced in the spec.packageName field has been installed
+                  The global set of condition types are:
+                    - "Installed", represents whether or not the a bundle has been installed for this ClusterExtension
                     - "Resolved", represents whether or not a bundle was found that satisfies the selection criteria outlined in the spec
-                    - "Deprecated", represents an aggregation of the PackageDeprecated, ChannelDeprecated, and BundleDeprecated condition types.
-                    - "PackageDeprecated", represents whether or not the package specified in the spec.packageName field has been deprecated
-                    - "ChannelDeprecated", represents whether or not the channel specified in spec.channel has been deprecated
-                    - "BundleDeprecated", represents whether or not the bundle installed is deprecated
                     - "Unpacked", represents whether or not the bundle contents have been successfully unpacked
 
+                  When the ClusterExtension is sourced from a catalog, the following conditions are also possible:
+                    - "Deprecated", represents an aggregation of the PackageDeprecated, ChannelDeprecated, and BundleDeprecated condition types
+                    - "PackageDeprecated", represents whether or not the package specified in the spec.source.catalog.packageName field has been deprecated
+                    - "ChannelDeprecated", represents whether or not any channel specified in spec.source.catalog.channels has been deprecated
+                    - "BundleDeprecated", represents whether or not the installed bundle is deprecated
+
                   The current set of reasons are:
                     - "Success", this reason is set on the "Unpacked", "Resolved" and "Installed" conditions when unpacking a bundle's content, resolution and installation/upgrading is successful
                     - "Failed", this reason is set on the "Unpacked", "Resolved" and "Installed" conditions when an error has occurred while unpacking the contents of a bundle, during resolution or installation.
@@ -552,10 +554,6 @@ spec:
 
                       A "bundle" is a versioned set of content that represents the resources that
                       need to be applied to a cluster to install a package.
-
-                      This field is only updated once a bundle has been successfully installed and
-                      once set will only be updated when a new version of the bundle has
-                      successfully replaced the currently installed version.
                     properties:
                       name:
                         description: |-
@@ -571,6 +569,8 @@ spec:
                     - name
                     - version
                     type: object
+                required:
+                - bundle
                 type: object
               resolution:
                 properties:
@@ -579,6 +579,9 @@ spec:
                       bundle is a representation of the bundle that was identified during
                       resolution to meet all installation/upgrade constraints and is slated to be
                       installed or upgraded to.
+
+                      A "bundle" is a versioned set of content that represents the resources that
+                      need to be applied to a cluster to install a package.
                     properties:
                       name:
                         description: |-
@@ -594,6 +597,8 @@ spec:
                     - name
                     - version
                     type: object
+                required:
+                - bundle
                 type: object
             type: object
         type: object

config/base/crd/bases/olm.operatorframework.io_clusterextensions.yaml

@@ -30,8 +30,8 @@ func GetVersion(b declcfg.Bundle) (*bsemver.Version, error) {
 }
 
 // MetadataFor returns a BundleMetadata for the given bundle name and version.
-func MetadataFor(bundleName string, bundleVersion bsemver.Version) *ocv1alpha1.BundleMetadata {
-	return &ocv1alpha1.BundleMetadata{
+func MetadataFor(bundleName string, bundleVersion bsemver.Version) ocv1alpha1.BundleMetadata {
+	return ocv1alpha1.BundleMetadata{
 		Name:    bundleName,
 		Version: bundleVersion.String(),
 	}

internal/bundleutil/bundle.go

@@ -12,7 +12,7 @@ import (
 	"github.com/operator-framework/operator-controller/internal/features"
 )
 
-func SuccessorsOf(installedBundle *ocv1alpha1.BundleMetadata, channels ...declcfg.Channel) (Predicate[declcfg.Bundle], error) {
+func SuccessorsOf(installedBundle ocv1alpha1.BundleMetadata, channels ...declcfg.Channel) (Predicate[declcfg.Bundle], error) {
 	var successors successorsPredicateFunc = legacySuccessor
 	if features.OperatorControllerFeatureGate.Enabled(features.ForceSemverUpgradeConstraints) {
 		successors = semverSuccessor
@@ -42,9 +42,9 @@ func SuccessorsOf(installedBundle *ocv1alpha1.BundleMetadata, channels ...declcf
 
 // successorsPredicateFunc returns a predicate to find successors
 // for a bundle. Predicate must not include the current version.
-type successorsPredicateFunc func(installedBundle *ocv1alpha1.BundleMetadata, channels ...declcfg.Channel) (Predicate[declcfg.Bundle], error)
+type successorsPredicateFunc func(installedBundle ocv1alpha1.BundleMetadata, channels ...declcfg.Channel) (Predicate[declcfg.Bundle], error)
 
-func legacySuccessor(installedBundle *ocv1alpha1.BundleMetadata, channels ...declcfg.Channel) (Predicate[declcfg.Bundle], error) {
+func legacySuccessor(installedBundle ocv1alpha1.BundleMetadata, channels ...declcfg.Channel) (Predicate[declcfg.Bundle], error) {
 	installedBundleVersion, err := bsemver.Parse(installedBundle.Version)
 	if err != nil {
 		return nil, fmt.Errorf("error parsing installed bundle version: %w", err)
@@ -88,7 +88,7 @@ func legacySuccessor(installedBundle *ocv1alpha1.BundleMetadata, channels ...dec
 // in a channel entry that is necessary to determine if a bundle is a successor.
 // A semver range check is the only necessary element. If filtering by channel
 // membership is necessary, an additional filter for that purpose should be applied.
-func semverSuccessor(installedBundle *ocv1alpha1.BundleMetadata, _ ...declcfg.Channel) (Predicate[declcfg.Bundle], error) {
+func semverSuccessor(installedBundle ocv1alpha1.BundleMetadata, _ ...declcfg.Channel) (Predicate[declcfg.Bundle], error) {
 	currentVersion, err := mmsemver.NewVersion(installedBundle.Version)
 	if err != nil {
 		return nil, err

internal/catalogmetadata/filter/successors.go

@@ -129,7 +129,7 @@ func TestSuccessorsPredicateWithForceSemverUpgradeConstraintsEnabled(t *testing.
 
 	for _, tt := range []struct {
 		name            string
-		installedBundle *ocv1alpha1.BundleMetadata
+		installedBundle ocv1alpha1.BundleMetadata
 		expectedResult  []declcfg.Bundle
 	}{
 		{
@@ -162,7 +162,7 @@ func TestSuccessorsPredicateWithForceSemverUpgradeConstraintsEnabled(t *testing.
 		},
 		{
 			name: "installed bundle not found",
-			installedBundle: &ocv1alpha1.BundleMetadata{
+			installedBundle: ocv1alpha1.BundleMetadata{
 				Name:    "test-package.v9.0.0",
 				Version: "9.0.0",
 			},
@@ -281,7 +281,7 @@ func TestSuccessorsPredicateWithForceSemverUpgradeConstraintsDisabled(t *testing
 
 	for _, tt := range []struct {
 		name            string
-		installedBundle *ocv1alpha1.BundleMetadata
+		installedBundle ocv1alpha1.BundleMetadata
 		expectedResult  []declcfg.Bundle
 	}{
 		{
@@ -319,7 +319,7 @@ func TestSuccessorsPredicateWithForceSemverUpgradeConstraintsDisabled(t *testing
 		},
 		{
 			name: "installed bundle not found",
-			installedBundle: &ocv1alpha1.BundleMetadata{
+			installedBundle: ocv1alpha1.BundleMetadata{
 				Name:    "test-package.v9.0.0",
 				Version: "9.0.0",
 			},
@@ -368,7 +368,7 @@ func TestLegacySuccessor(t *testing.T) {
 			},
 		},
 	}
-	installedBundle := &ocv1alpha1.BundleMetadata{
+	installedBundle := ocv1alpha1.BundleMetadata{
 		Name:    "package1.v0.0.1",
 		Version: "0.0.1",
 	}