Update registry operator docs to mention required operator-sdk version

[dharmit]

/kind bug

Which area this bug is related to?

/area registry

What versions of software are you using?

Operating System: Fedora 34

Go Pkg Version: How do I find this? Which go package's version are you asking for?

Bug Summary

Describe the bug:
On minikube 1.23.2 or OCP 4.9, make install && make deploy command to install the Registry Operator fails with below error:

$ make install && make deploy
/home/dshah/go/bin/controller-gen "crd:trivialVersions=true" rbac:roleName=manager-role webhook paths="./..." output:crd:artifacts:config=config/crd/bases
/home/dshah/go/bin/kustomize build config/crd | kubectl apply -f -
error: unable to recognize "STDIN": no matches for kind "CustomResourceDefinition" in version "apiextensions.k8s.io/v1beta1"
make: *** [Makefile:63: install] Error 1

To Reproduce:
Get a latest minikube or CRC and try running make install && make deploy for Registry Operator on it.

Expected behavior

Registry Operator installation to succeed.

Additional context

https://kubernetes.io/docs/reference/using-api/deprecation-guide/#v1-22

Target Date: 05-30-2023

[johnmcollier]

Hi @dharmit

Can you check the version of controller-gen on your system? It should be 0.6.x I believe.

This issue should’ve already been fixed by devfile/registry-operator#16, so I’m wondering if an older version of controller-gen is overwriting the v1 CRD version to v1beta1

[dharmit]

Can you check the version of controller-gen on your system? It should be 0.6.x I believe.

I didn't hear/know of controller-gen till this comment of yours. So bear with me.

I found controller-gen v0.3.0 on my system. I don't know how I had it; I'm sure it must have been pulled as a dependency for something. So I did go get sigs.k8s.io/controller-tools/cmd/[email protected] to pull this version on my system and then make install && make deploy worked fine.

I'm fine by closing this issue. Do you think it makes sense to document this on registry-operator repo? (it's a genuine question, not a rhetoric where I expect the answer to be "yes".) 😄

Thanks for your help @johnmcollier 👍🏾

[johnmcollier]

Yeah it should be documented.

FYI, for clusters with olm installed, we recommend installing the operator via its olm bundle. But I’m realizing that we don’t have those instructions in the registry readme, so I’ll add that to the readme as well.

[kim-tsao]

We should get this updated as part of epic #1007

[michael-valdron]

Requirements for #1092 to close (changes being made in devfile/registry-operator#42) might resolve this issue. Operator SDK version requirement should be listed alongside the cluster version requirement.

[michael-valdron]

devfile/registry-operator#42 has the required changes to close this issue, taking over this issue.

[michael-valdron]

Using this issue to track the addition of version requirements to the registry operator documentation.

These version requirements include:

• OpenShift
• Kubernetes
• Operator SDK
• Go Runtime

Please comment on this if anything additional should be added to this list.

[michael-valdron]

Describe the bug: On minikube 1.23.2 or OCP 4.9, make install && make deploy command to install the

The registry operator will now only support OCP 4.12 at the time of writing. Further support for newer OCP versions will be updated in the documentation.

We plan on adding a matrix document to best illustrate our version support of OCP and Kubernetes going forward.

[michael-valdron]

Extended target date due to other priority tasks and to provide additional time for review.

[michael-valdron]

A matrix document has been created to illustrate the registry operator support of container orchestration systems. The PR for this issue is now ready for re-review: devfile/registry-operator#42

[michael-valdron]

Changes done to the documentation to tie in the Operator SDK versioning with the Kubernetes API versioning. The PR for this issue is now ready for re-review: devfile/registry-operator#42

[michael-valdron]

Changes done to the documentation to tie in the Operator SDK versioning with the Kubernetes API versioning. The PR for this issue is now ready for re-review: devfile/registry-operator#42

Waiting on re-review of this PR, will extend into next sprint to provide more time for this.