From 88f4d40dbaee67bbeb86692ad1255a9ad56c7778 Mon Sep 17 00:00:00 2001 From: Per Goncalves da Silva Date: Mon, 7 Oct 2024 16:43:06 +0200 Subject: [PATCH] :warning: bump ClusterExtension API to v1 Signed-off-by: Per Goncalves da Silva --- api/{v1alpha1 => v1}/clusterextension_types.go | 2 +- api/{v1alpha1 => v1}/clusterextension_types_test.go | 2 +- api/{v1alpha1 => v1}/groupversion_info.go | 4 ++-- api/{v1alpha1 => v1}/zz_generated.deepcopy.go | 6 +++--- cmd/manager/main.go | 2 +- .../olm.operatorframework.io_clusterextensions.yaml | 2 +- config/samples/kustomization.yaml | 2 +- ...erextension.yaml => olm_v1_clusterextension.yaml} | 2 +- .../operator-controller-api-reference.md | 8 ++++---- docs/concepts/controlling-catalog-selection.md | 12 ++++++------ docs/concepts/crd-upgrade-safety.md | 2 +- docs/concepts/upgrade-support.md | 4 ++-- docs/howto/how-to-channel-based-upgrades.md | 4 ++-- docs/howto/how-to-pin-version.md | 2 +- docs/howto/how-to-version-range-upgrades.md | 2 +- docs/howto/how-to-z-stream-upgrades.md | 2 +- docs/tutorials/downgrade-extension.md | 6 +++--- docs/tutorials/install-extension.md | 4 ++-- docs/tutorials/upgrade-extension.md | 8 ++++---- hack/tools/catalogs/lib/manifests.sh | 2 +- internal/action/restconfig.go | 2 +- internal/applier/helm.go | 2 +- internal/bundleutil/bundle.go | 2 +- internal/catalogmetadata/filter/successors.go | 2 +- internal/catalogmetadata/filter/successors_test.go | 2 +- internal/contentmanager/cache/cache_test.go | 2 +- internal/contentmanager/contentmanager.go | 12 ++++++------ internal/contentmanager/source/dynamicsource_test.go | 4 ++-- internal/contentmanager/sourcerer.go | 4 ++-- .../controllers/clusterextension_admission_test.go | 2 +- internal/controllers/clusterextension_controller.go | 2 +- .../controllers/clusterextension_controller_test.go | 2 +- internal/controllers/common_controller.go | 2 +- internal/controllers/common_controller_test.go | 2 +- internal/controllers/suite_test.go | 2 +- internal/resolve/catalog.go | 2 +- internal/resolve/catalog_test.go | 2 +- internal/resolve/resolver.go | 2 +- internal/scheme/scheme.go | 2 +- test/e2e/cluster_extension_install_test.go | 2 +- .../extension_developer_test.go | 2 +- test/upgrade-e2e/post_upgrade_test.go | 2 +- 42 files changed, 68 insertions(+), 68 deletions(-) rename api/{v1alpha1 => v1}/clusterextension_types.go (99%) rename api/{v1alpha1 => v1}/clusterextension_types_test.go (99%) rename api/{v1alpha1 => v1}/groupversion_info.go (96%) rename api/{v1alpha1 => v1}/zz_generated.deepcopy.go (98%) rename config/samples/{olm_v1alpha1_clusterextension.yaml => olm_v1_clusterextension.yaml} (99%) diff --git a/api/v1alpha1/clusterextension_types.go b/api/v1/clusterextension_types.go similarity index 99% rename from api/v1alpha1/clusterextension_types.go rename to api/v1/clusterextension_types.go index ad99e7251..6eeff0889 100644 --- a/api/v1alpha1/clusterextension_types.go +++ b/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 b/api/v1/clusterextension_types_test.go similarity index 99% rename from api/v1alpha1/clusterextension_types_test.go rename to api/v1/clusterextension_types_test.go index 0ed4f1a08..297a15b13 100644 --- a/api/v1alpha1/clusterextension_types_test.go +++ b/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 b/api/v1/groupversion_info.go similarity index 96% rename from api/v1alpha1/groupversion_info.go rename to api/v1/groupversion_info.go index f46abbf3d..fdd9174ac 100644 --- a/api/v1alpha1/groupversion_info.go +++ b/api/v1/groupversion_info.go @@ -17,7 +17,7 @@ limitations under the License. // Package v1alpha1 contains API Schema definitions for the olm v1alpha1 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 b/api/v1/zz_generated.deepcopy.go similarity index 98% rename from api/v1alpha1/zz_generated.deepcopy.go rename to api/v1/zz_generated.deepcopy.go index ccd143aec..b9ebc655a 100644 --- a/api/v1alpha1/zz_generated.deepcopy.go +++ b/api/v1/zz_generated.deepcopy.go @@ -18,10 +18,10 @@ limitations under the License. // Code generated by controller-gen. DO NOT EDIT. -package v1alpha1 +package v1 import ( - "k8s.io/apimachinery/pkg/apis/meta/v1" + metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" runtime "k8s.io/apimachinery/pkg/runtime" ) @@ -199,7 +199,7 @@ func (in *ClusterExtensionStatus) DeepCopyInto(out *ClusterExtensionStatus) { } if in.Conditions != nil { in, out := &in.Conditions, &out.Conditions - *out = make([]v1.Condition, len(*in)) + *out = make([]metav1.Condition, len(*in)) for i := range *in { (*in)[i].DeepCopyInto(&(*out)[i]) } diff --git a/cmd/manager/main.go b/cmd/manager/main.go index a64ba4ac2..ea9c0111c 100644 --- 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" + ocv1alpha1 "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" diff --git a/config/base/crd/bases/olm.operatorframework.io_clusterextensions.yaml b/config/base/crd/bases/olm.operatorframework.io_clusterextensions.yaml index 61b81606b..f1c932e7e 100644 --- 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/kustomization.yaml b/config/samples/kustomization.yaml index bd1783176..7816e8fef 100644 --- 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_v1_clusterextension.yaml - olm_v1alpha1_extension.yaml #+kubebuilder:scaffold:manifestskustomizesamples diff --git a/config/samples/olm_v1alpha1_clusterextension.yaml b/config/samples/olm_v1_clusterextension.yaml similarity index 99% rename from config/samples/olm_v1alpha1_clusterextension.yaml rename to config/samples/olm_v1_clusterextension.yaml index 7536c3d90..71544ea5d 100644 --- a/config/samples/olm_v1alpha1_clusterextension.yaml +++ b/config/samples/olm_v1_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/api-reference/operator-controller-api-reference.md b/docs/api-reference/operator-controller-api-reference.md index 86bd90190..0952ca48e 100644 --- a/docs/api-reference/operator-controller-api-reference.md +++ b/docs/api-reference/operator-controller-api-reference.md @@ -1,10 +1,10 @@ # 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 @@ -97,7 +97,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.
Servers may infer this from the endpoint the client submits requests to.
Cannot be updated.
In CamelCase.
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.
Servers should convert recognized schemas to the latest internal value, and
may reject unrecognized values.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | | | @@ -153,7 +153,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.
Servers may infer this from the endpoint the client submits requests to.
Cannot be updated.
In CamelCase.
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.
Servers should convert recognized schemas to the latest internal value, and
may reject unrecognized values.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources | | | diff --git a/docs/concepts/controlling-catalog-selection.md b/docs/concepts/controlling-catalog-selection.md index 68d19c2b3..479124b5f 100644 --- a/docs/concepts/controlling-catalog-selection.md +++ b/docs/concepts/controlling-catalog-selection.md @@ -18,7 +18,7 @@ To select a specific catalog by name, you can use the `matchLabels` field in you #### Example ```yaml -apiVersion: olm.operatorframework.io/v1alpha1 +apiVersion: olm.operatorframework.io/v1 kind: ClusterExtension metadata: name: my-extension @@ -39,7 +39,7 @@ If you have catalogs labeled with specific metadata, you can select them using ` #### Using `matchLabels` ```yaml -apiVersion: olm.operatorframework.io/v1alpha1 +apiVersion: olm.operatorframework.io/v1 kind: ClusterExtension metadata: name: my-extension @@ -56,7 +56,7 @@ This selects catalogs labeled with `example.com/support: "true"`. #### Using `matchExpressions` ```yaml -apiVersion: olm.operatorframework.io/v1alpha1 +apiVersion: olm.operatorframework.io/v1 kind: ClusterExtension metadata: name: my-extension @@ -81,7 +81,7 @@ You can exclude catalogs by using the `NotIn` or `DoesNotExist` operators in `ma #### Example: Exclude Specific Catalogs ```yaml -apiVersion: olm.operatorframework.io/v1alpha1 +apiVersion: olm.operatorframework.io/v1 kind: ClusterExtension metadata: name: my-extension @@ -101,7 +101,7 @@ This excludes the catalog named `unwanted-catalog` from consideration. #### Example: Exclude Catalogs with a Specific Label ```yaml -apiVersion: olm.operatorframework.io/v1alpha1 +apiVersion: olm.operatorframework.io/v1 kind: ClusterExtension metadata: name: my-extension @@ -194,7 +194,7 @@ If the system cannot resolve to a single bundle due to ambiguity, it will genera 2. **Create a `ClusterExtension` with Catalog Selection** ```yaml - apiVersion: olm.operatorframework.io/v1alpha1 + apiVersion: olm.operatorframework.io/v1 kind: ClusterExtension metadata: name: install-my-operator diff --git a/docs/concepts/crd-upgrade-safety.md b/docs/concepts/crd-upgrade-safety.md index 47ad18d7b..339315472 100644 --- a/docs/concepts/crd-upgrade-safety.md +++ b/docs/concepts/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 diff --git a/docs/concepts/upgrade-support.md b/docs/concepts/upgrade-support.md index 9bc6e31ad..5abd579f1 100644 --- a/docs/concepts/upgrade-support.md +++ b/docs/concepts/upgrade-support.md @@ -38,7 +38,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: @@ -86,7 +86,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/howto/how-to-channel-based-upgrades.md b/docs/howto/how-to-channel-based-upgrades.md index 501a7f951..e7638d1a1 100644 --- a/docs/howto/how-to-channel-based-upgrades.md +++ b/docs/howto/how-to-channel-based-upgrades.md @@ -5,7 +5,7 @@ A "channel" is a package author defined stream of updates for an extension. A se Example: ```yaml -apiVersion: olm.operatorframework.io/v1alpha1 +apiVersion: olm.operatorframework.io/v1 kind: ClusterExtension metadata: name: argocd @@ -27,7 +27,7 @@ Note that the `version` field also accepts a version range to further restrict t Example: ```yaml -apiVersion: olm.operatorframework.io/v1alpha1 +apiVersion: olm.operatorframework.io/v1 kind: ClusterExtension metadata: name: argocd diff --git a/docs/howto/how-to-pin-version.md b/docs/howto/how-to-pin-version.md index 606b994aa..5dc0660b0 100644 --- a/docs/howto/how-to-pin-version.md +++ b/docs/howto/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/howto/how-to-version-range-upgrades.md b/docs/howto/how-to-version-range-upgrades.md index ddb753fba..dc239fa39 100644 --- a/docs/howto/how-to-version-range-upgrades.md +++ b/docs/howto/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/howto/how-to-z-stream-upgrades.md b/docs/howto/how-to-z-stream-upgrades.md index 8666e09b7..1a638fd1b 100644 --- a/docs/howto/how-to-z-stream-upgrades.md +++ b/docs/howto/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/tutorials/downgrade-extension.md b/docs/tutorials/downgrade-extension.md index 0e57d4687..e400600fa 100644 --- a/docs/tutorials/downgrade-extension.md +++ b/docs/tutorials/downgrade-extension.md @@ -31,7 +31,7 @@ Add the `crdUpgradeSafety` field and set its `policy` to `Disabled` in the `Clus **Example:** ```yaml -apiVersion: olm.operatorframework.io/v1alpha1 +apiVersion: olm.operatorframework.io/v1 kind: ClusterExtension metadata: name: example-extension @@ -71,7 +71,7 @@ Set the `upgradeConstraintPolicy` to `SelfCertified` in the `ClusterExtension` r **Example:** ```yaml -apiVersion: olm.operatorframework.io/v1alpha1 +apiVersion: olm.operatorframework.io/v1 kind: ClusterExtension metadata: name: example-extension @@ -113,7 +113,7 @@ Once the CRD safety checks are disabled and upgrade constraints are set, you can Within the YAML editor, update the `spec` section as follows: ```yaml - apiVersion: olm.operatorframework.io/v1alpha1 + apiVersion: olm.operatorframework.io/v1 kind: ClusterExtension metadata: name: diff --git a/docs/tutorials/install-extension.md b/docs/tutorials/install-extension.md index 95bdb5c3a..92b7aadeb 100644 --- a/docs/tutorials/install-extension.md +++ b/docs/tutorials/install-extension.md @@ -34,7 +34,7 @@ For information on determining the ServiceAccount's permission, please see [Deri 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: @@ -107,7 +107,7 @@ For information on determining the ServiceAccount's permission, please see [Deri Namespace: Labels: Annotations: - API Version: olm.operatorframework.io/v1alpha1 + API Version: olm.operatorframework.io/v1 Kind: ClusterExtension Metadata: Creation Timestamp: 2024-10-03T16:02:40Z diff --git a/docs/tutorials/upgrade-extension.md b/docs/tutorials/upgrade-extension.md index ea0a20344..1c0e8b061 100644 --- a/docs/tutorials/upgrade-extension.md +++ b/docs/tutorials/upgrade-extension.md @@ -23,7 +23,7 @@ For more detailed information see [Upgrade Support](../concepts/upgrade-support. Suppose we have successfully created and installed v0.5.0 of the ArgoCD operator with the following `ClusterExtension`: ``` yaml title="Example CR" -apiVersion: olm.operatorframework.io/v1alpha1 +apiVersion: olm.operatorframework.io/v1 kind: ClusterExtension metadata: name: argocd @@ -43,7 +43,7 @@ spec: ``` terminal kubectl apply -f - <