⚠️ Bump CatalogExtension API to v1

Signed-off-by: Per Goncalves da Silva <[email protected]>
operator-framework · Sep 25, 2024 · ccf704f · ccf704f
1 parent d1a4dbf
commit ccf704f
Show file tree

Hide file tree

Showing 46 changed files with 698 additions and 699 deletions.
diff --git a/PROJECT b/PROJECT
@@ -11,15 +11,15 @@ resources:
  domain: operatorframework.io
  group: olm
  kind: ClusterExtension
- path: github.com/operator-framework/operator-controller/api/v1alpha1
- version: v1alpha1
+ path: github.com/operator-framework/operator-controller/api/v1
+ version: v1
 - api:
  crdVersion: v1
  namespaced: true
  controller: true
  domain: operatorframework.io
  group: olm
  kind: Extension
- path: github.com/operator-framework/operator-controller/api/v1alpha1
- version: v1alpha1
+ path: github.com/operator-framework/operator-controller/api/v1
+ version: v1
 version: "3"
diff --git a/api/v1alpha1/clusterextension_types.go → api/v1/clusterextension_types.go b/api/v1alpha1/clusterextension_types.go → api/v1/clusterextension_types.go
@@ -14,7 +14,7 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 
-package v1alpha1
+package v1
 
 import (
  metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"

diff --git a/api/v1alpha1/clusterextension_types_test.go → api/v1/clusterextension_types_test.go b/api/v1alpha1/clusterextension_types_test.go → api/v1/clusterextension_types_test.go
@@ -1,4 +1,4 @@
-package v1alpha1_test
+package v1_test
 
 import (
  "fmt"

diff --git a/api/v1alpha1/groupversion_info.go → api/v1/groupversion_info.go b/api/v1alpha1/groupversion_info.go → api/v1/groupversion_info.go
@@ -14,10 +14,10 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 
-// Package v1alpha1 contains API Schema definitions for the olm v1alpha1 API group
+// Package v1 contains API Schema definitions for the olm v1 API group
 // +kubebuilder:object:generate=true
 // +groupName=olm.operatorframework.io
-package v1alpha1
+package v1
 
 import (
  "k8s.io/apimachinery/pkg/runtime/schema"
@@ -26,7 +26,7 @@ import (
 
 var (
  // GroupVersion is group version used to register these objects
- GroupVersion = schema.GroupVersion{Group: "olm.operatorframework.io", Version: "v1alpha1"}
+ GroupVersion = schema.GroupVersion{Group: "olm.operatorframework.io", Version: "v1"}
 
  // SchemeBuilder is used to add go types to the GroupVersionKind scheme
  SchemeBuilder = &scheme.Builder{GroupVersion: GroupVersion}

diff --git a/api/v1alpha1/zz_generated.deepcopy.go → api/v1/zz_generated.deepcopy.go b/api/v1alpha1/zz_generated.deepcopy.go → api/v1/zz_generated.deepcopy.go
diff --git a/cmd/manager/main.go b/cmd/manager/main.go
@@ -44,7 +44,7 @@ import (
  catalogd "github.com/operator-framework/catalogd/api/core/v1alpha1"
  helmclient "github.com/operator-framework/helm-operator-plugins/pkg/client"
 
- ocv1alpha1 "github.com/operator-framework/operator-controller/api/v1alpha1"
+ ocv1 "github.com/operator-framework/operator-controller/api/v1"
  "github.com/operator-framework/operator-controller/internal/action"
  "github.com/operator-framework/operator-controller/internal/applier"
  "github.com/operator-framework/operator-controller/internal/authentication"
@@ -120,7 +120,7 @@ func main() {
  systemNamespace = podNamespace()
  }
 
- dependentRequirement, err := k8slabels.NewRequirement(labels.OwnerKindKey, selection.In, []string{ocv1alpha1.ClusterExtensionKind})
+ dependentRequirement, err := k8slabels.NewRequirement(labels.OwnerKindKey, selection.In, []string{ocv1.ClusterExtensionKind})
  if err != nil {
  setupLog.Error(err, "unable to create dependent label selector for cache")
  os.Exit(1)
@@ -136,8 +136,8 @@ func main() {
  LeaderElectionID: "9c4404e7.operatorframework.io",
  Cache: crcache.Options{
  ByObject: map[client.Object]crcache.ByObject{
- &ocv1alpha1.ClusterExtension{}: {Label: k8slabels.Everything()},
- &catalogd.ClusterCatalog{}:  {Label: k8slabels.Everything()},
+ &ocv1.ClusterExtension{}:  {Label: k8slabels.Everything()},
+ &catalogd.ClusterCatalog{}: {Label: k8slabels.Everything()},
  },
  DefaultNamespaces: map[string]crcache.Config{
  systemNamespace: {LabelSelector: k8slabels.Everything()},
@@ -172,7 +172,7 @@ func main() {
  cfgGetter, err := helmclient.NewActionConfigGetter(mgr.GetConfig(), mgr.GetRESTMapper(),
  helmclient.StorageDriverMapper(action.ChunkedStorageDriverMapper(coreClient, mgr.GetAPIReader(), systemNamespace)),
  helmclient.ClientNamespaceMapper(func(obj client.Object) (string, error) {
- ext := obj.(*ocv1alpha1.ClusterExtension)
+ ext := obj.(*ocv1.ClusterExtension)
  return ext.Spec.Install.Namespace, nil
  }),
  helmclient.ClientRestConfigMapper(clientRestConfigMapper),
@@ -257,7 +257,7 @@ func main() {
 
  cm := contentmanager.NewManager(clientRestConfigMapper, mgr.GetConfig(), mgr.GetRESTMapper())
  err = clusterExtensionFinalizers.Register(controllers.ClusterExtensionCleanupContentManagerCacheFinalizer, finalizerFunc(func(ctx context.Context, obj client.Object) (crfinalizer.Result, error) {
- ext := obj.(*ocv1alpha1.ClusterExtension)
+ ext := obj.(*ocv1.ClusterExtension)
  err := cm.Delete(ext)
  return crfinalizer.Result{}, err
  }))

diff --git a/config/base/crd/bases/olm.operatorframework.io_clusterextensions.yaml b/config/base/crd/bases/olm.operatorframework.io_clusterextensions.yaml
@@ -14,7 +14,7 @@ spec:
  singular: clusterextension
  scope: Cluster
  versions:
- - name: v1alpha1
+ - name: v1
  schema:
  openAPIV3Schema:
  description: ClusterExtension is the Schema for the clusterextensions API

diff --git a/config/samples/catalogd_operatorcatalog.yaml b/config/samples/catalogd_operatorcatalog.yaml
@@ -1,4 +1,4 @@
-apiVersion: olm.operatorframework.io/v1alpha1
+apiVersion: olm.operatorframework.io/v1
 kind: ClusterCatalog
 metadata:
  name: operatorhubio

diff --git a/config/samples/kustomization.yaml b/config/samples/kustomization.yaml
@@ -1,5 +1,5 @@
 ## Append samples of your project ##
 resources:
-- olm_v1alpha1_clusterextension.yaml
-- olm_v1alpha1_extension.yaml
+- olm_v1_clusterextension.yaml
+- olm_v1_extension.yaml
 #+kubebuilder:scaffold:manifestskustomizesamples
diff --git a/config/samples/olm_v1alpha1_clusterextension.yaml b/config/samples/olm_v1alpha1_clusterextension.yaml
@@ -267,7 +267,7 @@ subjects:
  name: argocd-installer
  namespace: argocd
 ---
-apiVersion: olm.operatorframework.io/v1alpha1
+apiVersion: olm.operatorframework.io/v1
 kind: ClusterExtension
 metadata:
  name: argocd

diff --git a/docs/Tasks/adding-a-catalog.md b/docs/Tasks/adding-a-catalog.md
@@ -21,7 +21,7 @@ This catalog is distributed as an image [quay.io/operatorhubio/catalog](https://
 1. Create a catalog custom resource (CR):
 
  ``` yaml title="clustercatalog_cr.yaml"
- apiVersion: olm.operatorframework.io/v1alpha1
+ apiVersion: olm.operatorframework.io/v1
  kind: ClusterCatalog
  metadata:
  name: operatorhubio
@@ -43,7 +43,7 @@ This catalog is distributed as an image [quay.io/operatorhubio/catalog](https://
  To disable polling, set a zero value, such as `0s`.
 
  ``` yaml title="Example `operatorhubio.yaml` CR"
- apiVersion: olm.operatorframework.io/v1alpha1
+ apiVersion: olm.operatorframework.io/v1
  kind: ClusterCatalog
  metadata:
  name: operatorhub
@@ -91,7 +91,7 @@ This catalog is distributed as an image [quay.io/operatorhubio/catalog](https://
  Namespace:
  Labels: <none>
  Annotations: <none>
- API Version: olm.operatorframework.io/v1alpha1
+ API Version: olm.operatorframework.io/v1
  Kind: ClusterCatalog
  Metadata:
  Creation Timestamp: 2024-03-12T19:34:50Z

diff --git a/docs/Tasks/installing-an-extension.md b/docs/Tasks/installing-an-extension.md
@@ -16,7 +16,7 @@ After you add a catalog to your cluster, you can install an extension by creatin
 1. Create a CR for the Kubernetes extension you want to install:
 
  ``` yaml title="Example CR"
- apiVersion: olm.operatorframework.io/v1alpha1
+ apiVersion: olm.operatorframework.io/v1
  kind: ClusterExtension
  metadata:
  name: <extension_name>
@@ -89,7 +89,7 @@ After you add a catalog to your cluster, you can install an extension by creatin
  Namespace:
  Labels: <none>
  Annotations: <none>
- API Version: olm.operatorframework.io/v1alpha1
+ API Version: olm.operatorframework.io/v1
  Kind: ClusterExtension
  Metadata:
  Creation Timestamp: 2024-03-15T15:03:47Z

diff --git a/docs/drafts/how-to-pin-version.md b/docs/drafts/how-to-pin-version.md
@@ -5,7 +5,7 @@ To disable automatic updates, and pin the version of an extension, set `version`
 Example:
 
 ```yaml
-apiVersion: olm.operatorframework.io/v1alpha1
+apiVersion: olm.operatorframework.io/v1
 kind: ClusterExtension
 metadata:
  name: argocd

diff --git a/docs/drafts/how-to-version-range-upgrades.md b/docs/drafts/how-to-version-range-upgrades.md
@@ -5,7 +5,7 @@ Set the version for the desired package in the Catalog source to a comparison st
 Example:
 
 ```yaml
-apiVersion: olm.operatorframework.io/v1alpha1
+apiVersion: olm.operatorframework.io/v1
 kind: ClusterExtension
 metadata:
  name: argocd

diff --git a/docs/drafts/how-to-z-stream-upgrades.md b/docs/drafts/how-to-z-stream-upgrades.md
@@ -5,7 +5,7 @@ To restrict automatic updates to only z-stream patches and avoid breaking change
 Example:
 
 ```yaml
-apiVersion: olm.operatorframework.io/v1alpha1
+apiVersion: olm.operatorframework.io/v1
 kind: ClusterExtension
 metadata:
  name: argocd

diff --git a/docs/drafts/upgrade-support.md b/docs/drafts/upgrade-support.md
@@ -33,7 +33,7 @@ If `1.0.0` is installed, OLM v1 behavior differs in the following ways:
 You can change the default behavior of the upgrade constraints by setting the `upgradeConstraintPolicy` parameter in your cluster extension's custom resource (CR).
 
 ``` yaml hl_lines="10"
-apiVersion: olm.operatorframework.io/v1alpha1
+apiVersion: olm.operatorframework.io/v1
 kind: ClusterExtension
 metadata:
  name: <extension_name>
@@ -81,7 +81,7 @@ If you set the field to `SelfCertified`, no upgrade constraints are set on the p
 Example `ClusterExtension` with `.spec.upgradeConstraintPolicy` field set to `SelfCertified`:
 
 ```yaml
-apiVersion: olm.operatorframework.io/v1alpha1
+apiVersion: olm.operatorframework.io/v1
 kind: ClusterExtension
 metadata:
  name: extension-sample

diff --git a/docs/refs/api/operator-controller-api-reference.md b/docs/refs/api/operator-controller-api-reference.md
@@ -1,12 +1,12 @@
 # API Reference
 
 ## Packages
-- [olm.operatorframework.io/v1alpha1](#olmoperatorframeworkiov1alpha1)
+- [olm.operatorframework.io/v1](#olmoperatorframeworkiov1)
 
 
-## olm.operatorframework.io/v1alpha1
+## olm.operatorframework.io/v1
 
-Package v1alpha1 contains API Schema definitions for the olm v1alpha1 API group
+Package v1 contains API Schema definitions for the olm v1 API group
 
 ### Resource Types
 - [ClusterExtension](#clusterextension)
@@ -98,7 +98,7 @@ _Appears in:_
 
 | Field | Description | Default | Validation |
 | --- | --- | --- | --- |
-| `apiVersion` _string_ | `olm.operatorframework.io/v1alpha1` | | |
+| `apiVersion` _string_ | `olm.operatorframework.io/v1` | | |
 | `kind` _string_ | `ClusterExtension` | | |
 | `kind` _string_ | Kind is a string value representing the REST resource this object represents.<br />Servers may infer this from the endpoint the client submits requests to.<br />Cannot be updated.<br />In CamelCase.<br />More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | | |
 | `apiVersion` _string_ | APIVersion defines the versioned schema of this representation of an object.<br />Servers should convert recognized schemas to the latest internal value, and<br />may reject unrecognized values.<br />More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | | |
@@ -154,7 +154,7 @@ ClusterExtensionList contains a list of ClusterExtension
 
 | Field | Description | Default | Validation |
 | --- | --- | --- | --- |
-| `apiVersion` _string_ | `olm.operatorframework.io/v1alpha1` | | |
+| `apiVersion` _string_ | `olm.operatorframework.io/v1` | | |
 | `kind` _string_ | `ClusterExtensionList` | | |
 | `kind` _string_ | Kind is a string value representing the REST resource this object represents.<br />Servers may infer this from the endpoint the client submits requests to.<br />Cannot be updated.<br />In CamelCase.<br />More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds | | |
 | `apiVersion` _string_ | APIVersion defines the versioned schema of this representation of an object.<br />Servers should convert recognized schemas to the latest internal value, and<br />may reject unrecognized values.<br />More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | | |

diff --git a/docs/refs/crd-upgrade-safety.md b/docs/refs/crd-upgrade-safety.md
@@ -56,7 +56,7 @@ The CRD Upgrade Safety preflight check can be entirely disabled by adding the
 `preflight.crdUpgradeSafety.disabled` field with a value of "true" to the ClusterExtension of the CRD.
 
 ```yaml
-apiVersion: olm.operatorframework.io/v1alpha1
+apiVersion: olm.operatorframework.io/v1
 kind: ClusterExtension
 metadata:
  name: clusterextension-sample
@@ -103,7 +103,7 @@ spec:
  singular: sample
  scope: Namespaced
  versions:
- - name: v1alpha1
+ - name: v1
  schema:
  openAPIV3Schema:
  properties:

diff --git a/hack/test/pre-upgrade-setup.sh b/hack/test/pre-upgrade-setup.sh
@@ -20,7 +20,7 @@ TEST_CLUSTER_CATALOG_NAME=$2
 TEST_CLUSTER_EXTENSION_NAME=$3
 
 kubectl apply -f - << EOF
-apiVersion: olm.operatorframework.io/v1alpha1
+apiVersion: olm.operatorframework.io/v1
 kind: ClusterCatalog
 metadata:
  name: ${TEST_CLUSTER_CATALOG_NAME}
@@ -128,7 +128,7 @@ roleRef:
 EOF
 
 kubectl apply -f - << EOF
-apiVersion: olm.operatorframework.io/v1alpha1
+apiVersion: olm.operatorframework.io/v1
 kind: ClusterExtension
 metadata:
  name: ${TEST_CLUSTER_EXTENSION_NAME}

diff --git a/internal/action/restconfig.go b/internal/action/restconfig.go
@@ -8,13 +8,13 @@ import (
  "k8s.io/client-go/rest"
  "sigs.k8s.io/controller-runtime/pkg/client"
 
- ocv1alpha1 "github.com/operator-framework/operator-controller/api/v1alpha1"
+ ocv1 "github.com/operator-framework/operator-controller/api/v1"
  "github.com/operator-framework/operator-controller/internal/authentication"
 )
 
 func ServiceAccountRestConfigMapper(tokenGetter *authentication.TokenGetter) func(ctx context.Context, o client.Object, c *rest.Config) (*rest.Config, error) {
  return func(ctx context.Context, o client.Object, c *rest.Config) (*rest.Config, error) {
- cExt := o.(*ocv1alpha1.ClusterExtension)
+ cExt := o.(*ocv1.ClusterExtension)
  saKey := types.NamespacedName{
  Name: cExt.Spec.Install.ServiceAccount.Name,
  Namespace: cExt.Spec.Install.Namespace,

diff --git a/internal/applier/helm.go b/internal/applier/helm.go
@@ -22,7 +22,7 @@ import (
 
  helmclient "github.com/operator-framework/helm-operator-plugins/pkg/client"
 
- ocv1alpha1 "github.com/operator-framework/operator-controller/api/v1alpha1"
+ ocv1 "github.com/operator-framework/operator-controller/api/v1"
  "github.com/operator-framework/operator-controller/internal/rukpak/convert"
  "github.com/operator-framework/operator-controller/internal/rukpak/preflights/crdupgradesafety"
  "github.com/operator-framework/operator-controller/internal/rukpak/util"
@@ -56,7 +56,7 @@ type Helm struct {
  Preflights []Preflight
 }
 
-func (h *Helm) Apply(ctx context.Context, contentFS fs.FS, ext *ocv1alpha1.ClusterExtension, objectLabels map[string]string, storageLabels map[string]string) ([]client.Object, string, error) {
+func (h *Helm) Apply(ctx context.Context, contentFS fs.FS, ext *ocv1.ClusterExtension, objectLabels map[string]string, storageLabels map[string]string) ([]client.Object, string, error) {
  chrt, err := convert.RegistryV1ToHelmChart(ctx, contentFS, ext.Spec.Install.Namespace, []string{corev1.NamespaceAll})
  if err != nil {
  return nil, "", err
@@ -79,7 +79,7 @@ func (h *Helm) Apply(ctx context.Context, contentFS fs.FS, ext *ocv1alpha1.Clust
 
  for _, preflight := range h.Preflights {
  if ext.Spec.Install.Preflight != nil && ext.Spec.Install.Preflight.CRDUpgradeSafety != nil {
- if _, ok := preflight.(*crdupgradesafety.Preflight); ok && ext.Spec.Install.Preflight.CRDUpgradeSafety.Policy == ocv1alpha1.CRDUpgradeSafetyPolicyDisabled {
+ if _, ok := preflight.(*crdupgradesafety.Preflight); ok && ext.Spec.Install.Preflight.CRDUpgradeSafety.Policy == ocv1.CRDUpgradeSafetyPolicyDisabled {
  // Skip this preflight check because it is of type *crdupgradesafety.Preflight and the CRD Upgrade Safety
  // preflight check has been disabled
  continue
@@ -134,7 +134,7 @@ func (h *Helm) Apply(ctx context.Context, contentFS fs.FS, ext *ocv1alpha1.Clust
  return relObjects, state, nil
 }
 
-func (h *Helm) getReleaseState(cl helmclient.ActionInterface, ext *ocv1alpha1.ClusterExtension, chrt *chart.Chart, values chartutil.Values, post postrender.PostRenderer) (*release.Release, *release.Release, string, error) {
+func (h *Helm) getReleaseState(cl helmclient.ActionInterface, ext *ocv1.ClusterExtension, chrt *chart.Chart, values chartutil.Values, post postrender.PostRenderer) (*release.Release, *release.Release, string, error) {
  currentRelease, err := cl.Get(ext.GetName())
  if err != nil && !errors.Is(err, driver.ErrReleaseNotFound) {
  return nil, nil, StateError, err

diff --git a/internal/bundleutil/bundle.go b/internal/bundleutil/bundle.go
@@ -9,7 +9,7 @@ import (
  "github.com/operator-framework/operator-registry/alpha/declcfg"
  "github.com/operator-framework/operator-registry/alpha/property"
 
- ocv1alpha1 "github.com/operator-framework/operator-controller/api/v1alpha1"
+ ocv1 "github.com/operator-framework/operator-controller/api/v1"
 )
 
 func GetVersion(b declcfg.Bundle) (*bsemver.Version, error) {
@@ -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) ocv1.BundleMetadata {
+ return ocv1.BundleMetadata{
  Name: bundleName,
  Version: bundleVersion.String(),
  }