skydive-project / skydive

An open source real-time network topology and protocols analyzer
https://skydive.network
Apache License 2.0
2.65k stars 400 forks source link

Operator projects using the removed APIs in k8s 1.22 requires changes. #2398

Open camilamacedo86 opened 3 years ago

camilamacedo86 commented 3 years ago

Problem Description

Kubernetes has been deprecating API(s), which will be removed and are no longer available in 1.22. Operators projects using these APIs versions will not work on Kubernetes 1.22 or any cluster vendor using this Kubernetes version(1.22), such as OpenShift 4.9+. Following the APIs that are most likely your projects to be affected by:

Therefore, looks like this project distributes solutions in the repository and does not contain any version compatible with k8s 1.22/OCP 4.9. (More info). Following some findings by checking the distributions published:

NOTE: The above findings are only about the manifests shipped inside of the distribution. It is not checking the codebase.

How to solve

It would be very nice to see new distributions of this project that are no longer using these APIs and so they can work on Kubernetes 1.22 and newer and published in the community-operators collection. OpenShift 4.9, for example, will not ship operators anymore that do still use v1beta1 extension APIs.

Due to the number of options available to build Operators, it is hard to provide direct guidance on updating your operator to support Kubernetes 1.22. Recent versions of the OperatorSDK greater than 1.0.0 and Kubebuilder greater than 3.0.0 scaffold your project with the latest versions of these APIs (all that is generated by tools only). See the guides to upgrade your projects with OperatorSDK Golang, Ansible, Helm or the Kubebuilder one. For APIs other than the ones mentioned above, you will have to check your code for usage of removed API versions and upgrade to newer APIs. The details of this depend on your codebase.

If this projects only need to migrate the API for CRDs and it was built with OperatorSDK versions lower than 1.0.0 then, you maybe able to solve it with an OperatorSDK version >= v0.18.x < 1.0.0:

$ operator-sdk generate crds --crd-version=v1 INFO[0000] Running CRD generator.
INFO[0000] CRD generation complete.

Alternatively, you can try to upgrade your manifests with controller-gen (version >= v0.4.1) :

If this project does not use Webhooks:

$ controller-gen crd:trivialVersions=true,preserveUnknownFields=false rbac:roleName=manager-role paths="./..."

If this project is using Webhooks:

  1. Add the markers sideEffects and admissionReviewVersions to your webhook (Example with sideEffects=None and admissionReviewVersions={v1,v1beta1}: memcached-operator/api/v1alpha1/memcached_webhook.go):

  2. Run the command:

    $ controller-gen crd:trivialVersions=true,preserveUnknownFields=false rbac:roleName=manager-role webhook paths="./..."

For further information and tips see the comment.

camilamacedo86 commented 2 years ago

Hi, would we have any update on this?

See that we are very close to the release data and fix the projects seems not very hard. See how to fix it in the first comment. Then, would be great to be able to check a new version of your project distributed which is compatible with 4.9.

lebauce commented 2 years ago

Hello @camilamacedo86 I am a bit confused between https://github.com/redhat-openshift-ecosystem/community-operators-prod/tree/main/operators/skydive-operator and https://github.com/k8s-operatorhub/community-operators/tree/main/operators/skydive-operator

I can't see who created the former as it seems to have imported from an other repository. The later looks up to date.

That being said, I checked for usage of deprecated resource in https://github.com/skydive-project/skydive-golang-operator and I submitted this PR with some fixes : https://github.com/skydive-project/skydive-golang-operator/pull/5

I'll try to update https://github.com/redhat-openshift-ecosystem/community-operators-prod/tree/main/operators/skydive-operator but I know nothing about the process.

camilamacedo86 commented 2 years ago

That is great. We need to create a new distribution with a new version of the operator to publish in https://github.com/redhat-openshift-ecosystem/community-operators-prod/tree/main/operators/skydive-operator. See; https://sdk.operatorframework.io/docs/olm-integration/tutorial-package-manifests/ (it is using the old format package manifest)

A possible workaround maybe works in this case. We can try just apply the changes for the CRDs for the both versions distribute in https://github.com/redhat-openshift-ecosystem/community-operators-prod/tree/main/operators/skydive-operator .