Upgrade the operator to use Operator SDK v1.33.0

[edif2008]

Summary

This PR migrates the operator from version Operator SDK v1.29.0 to v1.33.0.

Previously we were using go/v4-alpha. With the latest changes, this went to stable (i.e. go/v4). This brought a couple of key changes:

• Project restructure
• Use Kustomize 4.x instead of 3.x

In addition, we've updated dependencies and adjusted the code based on the breaking changes present in the sigs.k8s.io/controller-runtime package from v0.14.5 to v0.16.3.

Resolves: #180

Details

The changes present in this PR can be divided into four parts:

• Project restructure
  • Move files in controllers to internal/controller directory
  • Move main.go from project's root directory to cmd
• Config scaffolding -> Most of the changes here are made to use Kustomize 4.x instead of Kustomize 3.x. These don't affect the image users use to deploy the operator in their infrastructure, as well as their configurations.
• Go updates
  • Update package dependencies
  • Update Go version to 1.21
• Code changes
  • There is only one code change that was made to achieve the same thing with the latest functions and structures available in the sigs.k8s.io/controller-runtime package. From a customer's experience, this shouldn't be a breaking change.

⚠️ With the latest changes in the Kubernetes, it seems that the Connect images require root privileges, which is not allowed by the Connect-related yaml files due to having securityContext -> runAsNonRoot: true. This also affects previous versions of the operator. It looks like we haven't noticed this concern (or my environment is weird and it shouldn't be an issue).

How to test

Requirements

• Kubernetes installed
• Docker installed
• A kubernetes cluster to use for testing. For local testing, you can use minikube
• Connect credentials (1password-credentials.json file) and a Connect token. Follow this documentation to create them.

Testing steps

1. Checkout this branch:

   git checkout feat/upgrade-operator-sdk-1.33.0

2. Enter the cluster's environment and build the operator's image inside with make docker-build. The steps below show how to do this with minikube:

   eval $(minikube docker-env) && make docker-build

3. Adjust the config/manager/manager.yaml with the following:
   • Add imagePullPolicy: Never so that it uses the image of the operator you've just built:

     image: 1password/onepassword-operator:latest
     imagePullPolicy: Never

   • change the value of the WATCH_NAMESPACE environment variable with the name of the namespace you want to use:

     - name: WATCH_NAMESPACE
        value: "<your-namespace>"

   • Deploy Connect alongside the operator and enable auto-restarting:

     - name: AUTO_RESTART
        value: "true"
     - name: MANAGE_CONNECT
        value: "true"

4. Create a new namespace in which you will deploy the operator:

   kubectl create namespace <your-namespace>

5. To simplify the next steps, change the Kubernetes configuration to set the newly created namespace as the default one. Below is an example of doing that for minikube:

   kubectl config set-context minikube --namespace=<your-namespace>

6. Create the op-credentials and the onepassword-token Kubernetes secrets in the namespace:

   # Create 'op-credentials' Kubernetes secret
   cat 1password-credentials.json | base64 | \
       tr '/+' '_-' | tr -d '=' | tr -d '\n' > op-session && \
       kubectl create secret generic op-credentials --from-file=op-session
   
   # Create 'onepassword-token' Kubernetes secret
   kubectl create secret generic connect-token --from-literal=token="<your-Connect-token>"

7. Deploy the operator in that namespace:

   make deploy

8. Start playing around with the operator. No changes should be present in the operator's behavior.

Check for any missed changes in the migration

These steps require to install the operator-sdk.

The steps below are adapted based on the Migration steps from go/v3 to go/v4 with the key change of creating the project and API using the operator-sdk command instead of kubebuilder.

1. Create a separate directory in which you will create the scaffolding of the operator using version v1.33.0:

   mkdir tst-migrated-operator/onepassword-operator && cd tst-migrated-operator/onepassword-operator

2. Initialize the operator:

   operator-sdk init --plugins go/v4 --domain onepassword.com  --repo github.com/1Password/onepassword-operator --license=none

3. Create the OnePasswordItem API:

   operator-sdk create api --version v1 --kind OnePasswordItem --resource --controller

4. Copy from this branch the following:
   • cmd/main.go
   • api/v1/onepassworditem_types.go
   • internal/controller directory
   • pkg directory
5. Build the operator:

   make all

6. Compare this branch against the directory in which you created the operator. The following differences that may be present can be ignored:
   • Newer Go package dependencies
   • Newer tools used in Makefile (e.g. ENVTEST_K8S_VERSION, KUSTOMIZE_VERSION, CONTROLLER_TOOLS_VERSION)
   • Dockerfile adjustments to copy additional files needed, as well as adding our custom flags for building the operator.

Reference

• Steps to upgrade to Operator SDK v1.33.0
• go/v3 vs go/v4
• Migration steps from go/v3 to go/v4
• Migrating to go/v4 by updating the files manually

[volodymyrZotov]

Functional review: ✅

Confirm that the operator works fine after migration.

---

Code review: ✅

Most of the changes here are because of updating dependencies in vendor folder, but the rest looks good to me.
Approve this PR, but before merging, please resolve the last comment on Dockerfile

[ScubaDrew]

THANK YOU 1P TEAM!