Create operator-sdk update guidelines

[mateusoliveira43]

Problem

Currently, we do not have any strategy to update operator-sdk version used by the project. Last time we updated it, for example, was to fix problem fixed in newer releases. Reference #1398

But we only updated the executable version, without any updates to project structure, which can cause operator-sdk commands and functionalities not work properly.

Currently, some of operator-sdk functionalities are broken in the project.

Example

These lines are wrong, pointing to an object that does not exist (buckets.oadp.openshift.io)

oadp-operator/controllers/bucket_controller.go

Lines 44 to 47 in 5b0b9fc

	//+kubebuilder:rbac:groups=oadp.openshift.io,resources=buckets,verbs=get;list;watch;create;update;patch;delete
	//+kubebuilder:rbac:groups=corev1,resources=secrets,verbs=get;list;watch;create;update;patch;delete
	//+kubebuilder:rbac:groups=oadp.openshift.io,resources=buckets/status,verbs=get;update;patch
	//+kubebuilder:rbac:groups=oadp.openshift.io,resources=buckets/finalizers,verbs=update

If we update it and run make bundle, config/rbac/role.yaml is not updated.

oadp-operator/config/rbac/role.yaml

Line 51 in 5b0b9fc

- buckets

operator-sdk uses kubebuilder under the hood

Solution

As proposed previously in #1250 and already being applied in NAC project (references https://github.com/migtools/oadp-non-admin/blob/master/docs/CONTRIBUTING.md#upgrade-kubebuilder-version https://github.com/migtools/oadp-non-admin/blob/master/docs/architecture.md#kubebuilde), we should update all necessary places when updating operator-sdk version.

To avoid human mistakes of forgetting to apply a change describe in operator-sdk documentation, we should do this update following these instructions:

Download both current and new version of operator-sdk from https://github.com/operator-framework/operator-sdk/releases and run

mkdir current
mkdir new
cd current
# Run operator-sdk commands pointing to operator-sdk executable with the current version
cd ..
cd new
# Run operator-sdk commands pointing to operator-sdk executable with the new version
cd ..
diff -ruN current new > operator-sdk-upgrade.diff
patch -p1 --verbose -d ./ -i operator-sdk-upgrade.diff
# Resolve possible conflicts

Because last step can fail, needing human intervention, do not know if it is necessary to create a script

Pros

• Ensures each update does not break any operator-sdk commands or functionalities
• Get updates from newer versions (Example: if we already followed these steps, we could change between docker and podman in Makefile)
• Avoid things getting (very) outdated
  

  oadp-operator/bundle/tests/scorecard/config.yaml

  Line 11 in 5b0b9fc

  image: quay.io/operator-framework/scorecard-test:v1.10.0

Cons

• Not just a string change

[kaovilai]

diff -ruN current new > operator-sdk-upgrade.diff
patch -p1 --verbose -d ./ -i operator-sdk-upgrade.diff

This is a blind patch albeit still better than before.

The full steps for each new operator-sdk upgrade is already outlined in docs at https://sdk.operatorframework.io/docs/upgrading-sdk-version/

The intent by operator-sdk authors per my understanding is for you to follow every step there.

For example, when upgrading to https://sdk.operatorframework.io/docs/upgrading-sdk-version/v1.34.0/ you are expected to make changes to your makefile.