Epic: rebuild the Submariner operator using current best practices

[skitt]

Epic Description

The operator was built using an old version of the Operator SDK. This causes a number of problems:

• our code (in particular, metrics setup) relies on an old version of the Operator framework, which is incompatible with current versions of the Kubernetes libraries
• we’re missing out on features supported by newer versions of the SDK (such as healthchecks)

We need to upgrade our operator to use the current Operator SDK, following the migration guide.

Depends on #89

Related changes

stolostron/submariner-addon#318
submariner-io/submariner-operator#1105
submariner-io/submariner-operator#1415
submariner-io/submariner-operator#1824

Acceptance Criteria

The operator’s Operator framework dependencies are up-to-date, and all tests pass.

Definition of Done (Checklist)

• Code complete
• The acceptance criteria met
• Unit/e2e test added & pass
• CI jobs pass
• Deployed using cloud-prepare+subctl
• Deployed using ACM/OCM addon
• Deploy using Helm
• Deployed on supported platforms (for e.g kind, OCP on AWS, OCP on GCP)
• Run subctl verify, diagnose and gather
• [ ] Uninstall
• [ ] Troubleshooting (gather/diagnose) added
• [ ] Documentation added
• [ ] Release notes added

Work Items

An operator was written from scratch following the official operator tutorial. The code was pushed on a fork as a PR. This PR was then used as a reference to make required changes.

The operator-sdk version is upgraded to 1.23.0. Migration guide was followed to pin versions for dependencies.

1. Depends on Make APIs in-line with operator-sdk 1.21.0 submariner-operator#2158
2. Update versions of various dependencies used
   1. Depends on Update operator-lib to 0.11.0 submariner-operator#2210
   2. Depends on Update k8s, prometheus-operator & few other version submariner-operator#2179
3. Depends on Adjust controller logic submariner-operator#2178
4. Depends on Update PROJECT in accordance with operator-sdk 1.23.0 submariner-operator#2211
5. Depends on Remove use of obsolete operator-sdk submariner-operator#2204
6. Depends on Use current operator SDK-style metrics setup submariner-operator#2199
7. Depends on Create all CRDs before initialising the scheme submariner-operator#2180
8. Depends on Add health and readyness probes submariner-operator#2230
9. Update bundle in `operatorHub'(https://github.com/k8s-operatorhub/community-operators)
10. and here? https://github.com/redhat-openshift-ecosystem/community-operators-prod/tree/main/operators

[Jaanki]

NOTE: if #89 is approved, it should be done first.

[dfarrell07]

As Andrew McNamara pointed out on Slack, this will have implications downstream that we shouldn't forget.

[arewm]

I was about to make some changes to this in order to remove the need for a workaround for operator-framework/operator-sdk#5760, but stopped when I realized there may be additional implications of an update in one place.

One change that I was going to make was with PROJECT to have the following contents:

domain: submariner.io
repo: github.com/submariner-io/submariner-operator
projectName: submariner
layout:
- go.kubebuilder.io/v2
plugins:
  go.sdk.operatorframework.io/v2-alpha: {}
version: "3"
multigroup: true

[nyechiel]

@tpantelis @Jaanki so this is no longer planned for 0.13?

[tpantelis]

@tpantelis @Jaanki so this is no longer planned for 0.13?

No there's not enough time to get the PRs pushed and reviewed by Fri.

[github-actions]

This PR/issue depends on:

• Epic: Move subctl to its own repo #89
• Make APIs in-line with operator-sdk 1.21.0 submariner-operator#2158
• Update operator-lib to 0.11.0 submariner-operator#2210
• Update k8s, prometheus-operator & few other version submariner-operator#2179
• Adjust controller logic submariner-operator#2178
• Update PROJECT in accordance with operator-sdk 1.23.0 submariner-operator#2211
• Remove use of obsolete operator-sdk submariner-operator#2204
• Use current operator SDK-style metrics setup submariner-operator#2199
• Create all CRDs before initialising the scheme submariner-operator#2180
• Add health and readyness probes submariner-operator#2230
  By Dependent Issues (🤖). Happy coding!