Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
camilamacedo86 opened this issue Sep 1, 2021 · 1 comment

Comments

@camilamacedo86
Copy link

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:

  • apiextensions.k8s.io/v1beta1: (Used for CRDs and available since v1.16)
  • rbac.authorization.k8s.io/v1beta1: (Used for RBAC/rules and available since v1.8)
  • admissionregistration.k8s.io/v1beta1 (Used for Webhooks and available since v1.16)

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:

  • crane-operator.v1.4.4: this distribution is using APIs which were deprecated and removed in v1.22. More info: https://kubernetes.io/docs/reference/using-api/deprecation-guide/#v1-22. Migrate the API(s) for CRD: (["backups.velero.io" "backupstoragelocations.velero.io" "deletebackuprequests.velero.io" "downloadrequests.velero.io" "directimagemigrations.migration.openshift.io" "directimagestreammigrations.migration.openshift.io" "directvolumemigrationprogresses.migration.openshift.io" "directvolumemigrations.migration.openshift.io" "miganalytics.migration.openshift.io" "migclusters.migration.openshift.io" "mighooks.migration.openshift.io" "migmigrations.migration.openshift.io" "migplans.migration.openshift.io" "migstorages.migration.openshift.io" "migrationcontrollers.migration.openshift.io" "podvolumebackups.velero.io" "podvolumerestores.velero.io" "resticrepositories.velero.io" "restores.velero.io" "schedules.velero.io" "serverstatusrequests.velero.io" "volumesnapshotlocations.velero.io"])
  • crane-operator.v1.4.5: this distribution is using APIs which were deprecated and removed in v1.22. More info: https://kubernetes.io/docs/reference/using-api/deprecation-guide/#v1-22. Migrate the API(s) for CRD: (["backups.velero.io" "backupstoragelocations.velero.io" "deletebackuprequests.velero.io" "downloadrequests.velero.io" "directimagemigrations.migration.openshift.io" "directimagestreammigrations.migration.openshift.io" "directvolumemigrationprogresses.migration.openshift.io" "directvolumemigrations.migration.openshift.io" "miganalytics.migration.openshift.io" "migclusters.migration.openshift.io" "mighooks.migration.openshift.io" "migmigrations.migration.openshift.io" "migplans.migration.openshift.io" "migstorages.migration.openshift.io" "migrationcontrollers.migration.openshift.io" "podvolumebackups.velero.io" "podvolumerestores.velero.io" "resticrepositories.velero.io" "restores.velero.io" "schedules.velero.io" "serverstatusrequests.velero.io" "volumesnapshotlocations.velero.io"])
  • crane-operator.v1.4.6: this distribution is using APIs which were deprecated and removed in v1.22. More info: https://kubernetes.io/docs/reference/using-api/deprecation-guide/#v1-22. Migrate the API(s) for CRD: (["backups.velero.io" "backupstoragelocations.velero.io" "deletebackuprequests.velero.io" "downloadrequests.velero.io" "directimagemigrations.migration.openshift.io" "directimagestreammigrations.migration.openshift.io" "directvolumemigrationprogresses.migration.openshift.io" "directvolumemigrations.migration.openshift.io" "miganalytics.migration.openshift.io" "migclusters.migration.openshift.io" "mighooks.migration.openshift.io" "migmigrations.migration.openshift.io" "migplans.migration.openshift.io" "migstorages.migration.openshift.io" "migrationcontrollers.migration.openshift.io" "podvolumebackups.velero.io" "podvolumerestores.velero.io" "resticrepositories.velero.io" "restores.velero.io" "schedules.velero.io" "serverstatusrequests.velero.io" "volumesnapshotlocations.velero.io"])
  • crane-operator.v1.5.0: this distribution is using APIs which were deprecated and removed in v1.22. More info: https://kubernetes.io/docs/reference/using-api/deprecation-guide/#v1-22. Migrate the API(s) for CRD: (["backups.velero.io" "backupstoragelocations.velero.io" "deletebackuprequests.velero.io" "downloadrequests.velero.io" "directimagemigrations.migration.openshift.io" "directimagestreammigrations.migration.openshift.io" "directvolumemigrationprogresses.migration.openshift.io" "directvolumemigrations.migration.openshift.io" "miganalytics.migration.openshift.io" "migclusters.migration.openshift.io" "mighooks.migration.openshift.io" "migmigrations.migration.openshift.io" "migplans.migration.openshift.io" "migstorages.migration.openshift.io" "migrationcontrollers.migration.openshift.io" "podvolumebackups.velero.io" "podvolumerestores.velero.io" "resticrepositories.velero.io" "restores.velero.io" "schedules.velero.io" "serverstatusrequests.velero.io" "volumesnapshotlocations.velero.io"])
  • crane-operator.v1.4.3: this distribution is using APIs which were deprecated and removed in v1.22. More info: https://kubernetes.io/docs/reference/using-api/deprecation-guide/#v1-22. Migrate the API(s) for CRD: (["backups.velero.io" "backupstoragelocations.velero.io" "deletebackuprequests.velero.io" "downloadrequests.velero.io" "directimagemigrations.migration.openshift.io" "directimagestreammigrations.migration.openshift.io" "directvolumemigrationprogresses.migration.openshift.io" "directvolumemigrations.migration.openshift.io" "miganalytics.migration.openshift.io" "migclusters.migration.openshift.io" "mighooks.migration.openshift.io" "migmigrations.migration.openshift.io" "migplans.migration.openshift.io" "migstorages.migration.openshift.io" "migrationcontrollers.migration.openshift.io" "podvolumebackups.velero.io" "podvolumerestores.velero.io" "resticrepositories.velero.io" "restores.velero.io" "schedules.velero.io" "serverstatusrequests.velero.io" "volumesnapshotlocations.velero.io"])

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
Copy link
Author

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant