Migrating to Operator SDK v0.1.0

This guide describes how to migrate an Operator project built using Operator SDK v0.0.x to the project structure required by Operator SDK v0.1.0.

The recommended method for migrating your project is to:

  1. Initialize a new v0.1.0 project.

  2. Copy your code into the new project.

  3. Modify the new project as described for v0.1.0.

This guide uses the memcached-operator, the example project from Getting started with the Operator SDK, to illustrate the migration steps. See the v0.0.7 memcached-operator and v0.1.0 memcached-operator project structures for pre- and post-migration examples, respectively.

Creating a new Operator SDK v0.1.0 project

Rename your Operator SDK v0.0.x project and create a new v0.1.0 project in its place.

Prerequisites

  • Operator SDK v0.1.0 CLI installed on the development workstation

  • memcached-operator project previously deployed using an earlier version of Operator SDK

Procedure

  1. Ensure the SDK version is v0.1.0:

    1. $ operator-sdk --version
    2. operator-sdk version 0.1.0

  2. Create a new project:

    1. $ mkdir -p $GOPATH/src/github.com/example-inc/
    2. $ cd $GOPATH/src/github.com/example-inc/
    3. $ mv memcached-operator old-memcached-operator
    4. $ operator-sdk new memcached-operator --skip-git-init
    5. $ ls
    6. memcached-operator old-memcached-operator

  3. Copy over .git from old project:

    1. $ cp -rf old-memcached-operator/.git memcached-operator/.git

Migrating custom types from pkg/apis

Migrate your project’s custom types to the updated Operator SDK v0.1.0 usage.

Prerequisites

  • Operator SDK v0.1.0 CLI installed on the development workstation

  • memcached-operator project previously deployed using an earlier version of Operator SDK

  • New project created using Operator SDK v0.1.0

Procedure

  1. Create the scaffold API for custom types.

    1. Create the API for your custom resource (CR) in the new project with operator-sdk add api --api-version=<apiversion> --kind=<kind>:

      1. $ cd memcached-operator
      2. $ operator-sdk add api --api-version=cache.example.com/v1alpha1 --kind=Memcached
      4. $ tree pkg/apis
      5. pkg/apis/
      6. ├── addtoscheme_cache_v1alpha1.go
      7. ├── apis.go
      8. └── cache
      9.     └── v1alpha1
      10.         ├── doc.go
      11.         ├── memcached_types.go
      12.         ├── register.go
      13.         └── zz_generated.deepcopy.go

    2. Repeat the previous command for as many custom types as you had defined in your old project. Each type will be defined in the file pkg/apis/<group>/<version>/<kind>_types.go.

  2. Copy the contents of the type.

    1. Copy the Spec and Status contents of the pkg/apis/<group>/<version>/types.go file from the old project to the new project’s pkg/apis/<group>/<version>/<kind>_types.go file.

    2. Each <kind>_types.go file has an init() function. Be sure not to remove that since that registers the type with the Manager’s scheme:

      1. func init() {
      2.     SchemeBuilder.Register(&Memcached{}, &MemcachedList{})

Migrating reconcile code

Migrate your project’s reconcile code to the update Operator SDK v0.1.0 usage.

Prerequisites

  • Operator SDK v0.1.0 CLI installed on the development workstation

  • memcached-operator project previously deployed using an earlier version of Operator SDK

  • Custom types migrated from pkg/apis/

Procedure

  1. Add a controller to watch your CR.

    In v0.0.x projects, resources to be watched were previously defined in cmd/<operator-name>/main.go:

    1. sdk.Watch("cache.example.com/v1alpha1", "Memcached", "default", time.Duration(5)*time.Second)

    For v0.1.0 projects, you must define a Controller to watch resources:

    1. Add a controller to watch your CR type with operator-sdk add controller --api-version=<apiversion> --kind=<kind>.

      1. $ operator-sdk add controller --api-version=cache.example.com/v1alpha1 --kind=Memcached
      3. $ tree pkg/controller
      4. pkg/controller/
      5. ├── add_memcached.go
      6. ├── controller.go
      7. └── memcached
      8.     └── memcached_controller.go

    2. Inspect the add() function in your pkg/controller/<kind>/<kind>_controller.go file:

      1. import (
      2.     cachev1alpha1 "github.com/example-inc/memcached-operator/pkg/apis/cache/v1alpha1"
      3.     ...
      4. )
      6. func add(mgr manager.Manager, r reconcile.Reconciler) error {
      7.     c, err := controller.New("memcached-controller", mgr, controller.Options{Reconciler: r})
      9.     // Watch for changes to the primary resource Memcached
      10.     err = c.Watch(&source.Kind{Type: &cachev1alpha1.Memcached{}}, &handler.EnqueueRequestForObject{})
      12.     // Watch for changes to the secondary resource pods and enqueue reconcile requests for the owner Memcached
      13.     err = c.Watch(&source.Kind{Type: &corev1.Pod{}}, &handler.EnqueueRequestForOwner{
      14.         IsController: true,
      15.         OwnerType:    &cachev1alpha1.Memcached{},
      16.     })
      17. }

      Remove the second Watch() or modify it to watch a secondary resource type that is owned by your CR.

      Watching multiple resources lets you trigger the reconcile loop for multiple resources relevant to your application. See the watching and eventhandling documentation and the Kubernetes controller conventions documentation for more details.

      If your operator is watching more than one CR type, you can do one of the following depending on your application:

      • If the CR is owned by your primary CR, watch it as a secondary resource in the same controller to trigger the reconcile loop for the primary resource.

        1. // Watch for changes to the primary resource Memcached
        2.     err = c.Watch(&source.Kind{Type: &cachev1alpha1.Memcached{}}, &handler.EnqueueRequestForObject{})
        4.     // Watch for changes to the secondary resource AppService and enqueue reconcile requests for the owner Memcached
        5.     err = c.Watch(&source.Kind{Type: &appv1alpha1.AppService{}}, &handler.EnqueueRequestForOwner{
        6.         IsController: true,
        7.         OwnerType:    &cachev1alpha1.Memcached{},
        8.     })

      • Add a new controller to watch and reconcile the CR independently of the other CR.

        1. $ operator-sdk add controller --api-version=app.example.com/v1alpha1 --kind=AppService
        1.   // Watch for changes to the primary resource AppService
        2.     err = c.Watch(&source.Kind{Type: &appv1alpha1.AppService{}}, &handler.EnqueueRequestForObject{})

  1. Copy and modify reconcile code from pkg/stub/handler.go.

    In a v0.1.0 project, the reconcile code is defined in the Reconcile() method of a controller’s Reconciler. This is similar to the Handle() function in the older project. Note the difference in the arguments and return values:

    • Reconcile:

      1.     func (r *ReconcileMemcached) Reconcile(request reconcile.Request) (reconcile.Result, error)

    • Handle:

      1.     func (h *Handler) Handle(ctx context.Context, event sdk.Event) error

    Instead of receiving an sdk.Event (with the object), the Reconcile() function receives a Request (Name/Namespace key) to lookup the object.

    If the Reconcile() function returns an error, the controller will requeue and retry the Request. If no error is returned, then depending on the Result, the controller will either not retry the Request, immediately retry, or retry after a specified duration.

    1. Copy the code from the old project’s Handle() function over the existing code in your controller’s Reconcile() function. Be sure to keep the initial section in the Reconcile() code that looks up the object for the Request and checks to see if it is deleted.

      1. import (
      2.     apierrors "k8s.io/apimachinery/pkg/api/errors"
      3.     cachev1alpha1 "github.com/example-inc/memcached-operator/pkg/apis/cache/v1alpha1"
      4.     ...
      5. )
      6. func (r *ReconcileMemcached) Reconcile(request reconcile.Request) (reconcile.Result, error) {
      7.     // Fetch the Memcached instance
      8.     instance := &cachev1alpha1.Memcached{}
      9.     err := r.client.Get(context.TODO()
      10.     request.NamespacedName, instance)
      11.     if err != nil {
      12.         if apierrors.IsNotFound(err) {
      13.             // Request object not found, could have been deleted after reconcile request.
      14.             // Owned objects are automatically garbage collected.
      15.             // Return and don't requeue
      16.             return reconcile.Result{}, nil
      17.         }
      18.         // Error reading the object - requeue the request.
      19.         return reconcile.Result{}, err
      20.     }
      22.     // Rest of your reconcile code goes here.
      23.     ...
      24. }

    2. Change the return values in your reconcile code:

      1. Replace return err with return reconcile.Result{}, err.

      2. Replace return nil with return reconcile.Result{}, nil.

    3. In order to periodically reconcile a CR in your controller, you can set the RequeueAfter field for reconcile.Result. This will cause the controller to requeue the Request and trigger the reconcile after the desired duration. Note that the default value of 0 means no requeue.

      1. reconcilePeriod := 30 * time.Second
      2. reconcileResult := reconcile.Result{RequeueAfter: reconcilePeriod}
      3. ...
      5. // Update the status
      6. err := r.client.Update(context.TODO(), memcached)
      7. if err != nil {
      8.     log.Printf("failed to update memcached status: %v", err)
      9.     return reconcileResult, err
      10. }
      11. return reconcileResult, nil

    4. Replace the calls to the SDK client (Create, Update, Delete, Get, List) with the reconciler’s client.

      See the examples below and the controller-runtime client API documentation in the operator-sdk project for more details:

      1. // Create
      2. dep := &appsv1.Deployment{...}
      3. err := sdk.Create(dep)
      4. // v0.0.1
      5. err := r.client.Create(context.TODO(), dep)
      7. // Update
      8. err := sdk.Update(dep)
      9. // v0.0.1
      10. err := r.client.Update(context.TODO(), dep)
      12. // Delete
      13. err := sdk.Delete(dep)
      14. // v0.0.1
      15. err := r.client.Delete(context.TODO(), dep)
      17. // List
      18. podList := &corev1.PodList{}
      19. labelSelector := labels.SelectorFromSet(labelsForMemcached(memcached.Name))
      20. listOps := &metav1.ListOptions{LabelSelector: labelSelector}
      21. err := sdk.List(memcached.Namespace, podList, sdk.WithListOptions(listOps))
      22. // v0.1.0
      23. listOps := &client.ListOptions{Namespace: memcached.Namespace, LabelSelector: labelSelector}
      24. err := r.client.List(context.TODO(), listOps, podList)
      26. // Get
      27. dep := &appsv1.Deployment{APIVersion: "apps/v1", Kind: "Deployment", Name: name, Namespace: namespace}
      28. err := sdk.Get(dep)
      29. // v0.1.0
      30. dep := &appsv1.Deployment{}
      31. err = r.client.Get(context.TODO(), types.NamespacedName{Name: name, Namespace: namespace}, dep)

    5. Copy and initialize any other fields that you may have had in your Handler struct into the Reconcile<Kind> struct:

      1. // newReconciler returns a new reconcile.Reconciler
      2. func newReconciler(mgr manager.Manager) reconcile.Reconciler {
      3.     return &ReconcileMemcached{client: mgr.GetClient(), scheme: mgr.GetScheme(), foo: "bar"}
      4. }
      6. // ReconcileMemcached reconciles a Memcached object
      7. type ReconcileMemcached struct {
      8.     client client.Client
      9.     scheme *runtime.Scheme
      10.     // Other fields
      11.     foo string
      12. }

  2. Copy changes from main.go.

    The main function for a v0.1.0 operator in cmd/manager/main.go sets up the Manager, which registers the custom resources and starts all the controllers.

    There is no requirement to migrate the SDK functions sdk.Watch(),sdk.Handle(), and sdk.Run() from the old main.go since that logic is now defined in a controller.

    However, if there are any Operator-specific flags or settings defined in the old main.go file, copy those over.

    If you have any third party resource types registered with the SDK’s scheme, see Advanced Topics in the operator-sdk project for how to register those with the Manager’s scheme in the new project.

  3. Copy user defined files.

    If there are any user defined pkgs, scripts, or documentation in the older project, copy these files into the new project.

  4. Copy changes to deployment manifests.

    For any updates made to the following manifests in the old project, copy over the changes to their corresponding files in the new project. Be careful not to directly overwrite the files, but inspect and make any changes necessary:

    • tmp/build/Dockerfile to build/Dockerfile

      • There is no tmp directory in the new project layout

    • RBAC rules updates from deploy/rbac.yaml to deploy/role.yaml and deploy/role_binding.yaml

    • deploy/cr.yaml to deploy/crds/<group>_<version>_<kind>_cr.yaml

    • deploy/crd.yaml to deploy/crds/<group>_<version>_<kind>_crd.yaml

  5. Copy user defined dependencies.

    For any user defined dependencies added to the old project’s Gopkg.toml, copy and append them to the new project’s Gopkg.toml. Run dep ensure to update the vendor in the new project.

  6. Confirm your changes.

    At this point, you should be able to build and run your Operator to verify that it works.