Operator projects using the removed APIs in k8s 1.22 requires changes

[camilamacedo86]

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 via the Red Hat Connect with the package names as cic-operator, cic-operator-with-crds, cpx-cic-operator and does not contain any version compatible with k8s 1.22/OCP 4.9. Following some findings by checking the distributions published:

• cic-operator.v1.7.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: (["citrixingresscontrollers.charts.helm.k8s.io"])

• citrix-api-gateway-operator.v0.0.1: 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: (["authpolicies.citrix.com" "citrixingresscontrollers.charts.helm.k8s.io" "httproutes.citrix.com" "listeners.citrix.com" "ratelimits.citrix.com" "rewritepolicies.citrix.com" "vips.citrix.com"])

• cpx-cic-operator.v130.36.29: 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: (["citrixcpxingresscontrollers.charts.helm.k8s.io"])

• cpx-cic-operator.v130.47.103: 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: (["citrixcpxingresscontrollers.charts.helm.k8s.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 Red Hat Connect 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 info and tips see the blog.

Thank you for your attention.

[camilamacedo86]

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.

[priyankash-citrix]

@camilamacedo86 We are in process of updating our operators to it latest version. We were not able to update in last 2 days because of outrage in operator pipeline: https://dn6mqn7xvzz3.statuspage.io. We are trying again today.

[camilamacedo86]

That is great news. please, feel free to close this one when it gets published there.

[camilamacedo86]

Hi @priyankash-citrix,

Be aware that: if you do not provide a workable solution via RedHat Connect asap:

• Your package/project will be removed from 4.9 catalog
• You cannot use replaces in your first publication made to add the project again on 4.9 when you publish the compatible version
• Your users cannot upgrade their cluster to use 4.9 with your solution installed then, they will need to stick on 4.8 or stop using your project to be able to move forward.

I would recommend you try to prioritize this one.

[priyankash-citrix]

Openshift 4.x is supported by Citrix ingress controller operator latest version.