Getting started with Operator SDK for Java-based Operators

Java-based Operator SDK is a Technology Preview feature only. Technology Preview features are not supported with Red Hat production service level agreements (SLAs) and might not be functionally complete. Red Hat does not recommend using them in production. These features provide early access to upcoming product features, enabling customers to test functionality and provide feedback during the development process.

For more information about the support scope of Red Hat Technology Preview features, see Technology Preview Features Support Scope.

To demonstrate the basics of setting up and running a Java-based Operator using tools and libraries provided by the Operator SDK, Operator developers can build an example Java-based Operator for Memcached, a distributed key-value store, and deploy it to a cluster.

Prerequisites

  • Operator SDK CLI installed

  • OpenShift CLI (oc) 4+ installed

  • Java 11+

  • Maven 3.6.3+

  • Logged into an OKD 4 cluster with oc with an account that has cluster-admin permissions

  • To allow the cluster to pull the image, the repository where you push your image must be set as public, or you must configure an image pull secret

Additional resources

Creating and deploying Java-based Operators

You can build and deploy a simple Java-based Operator for Memcached by using the Operator SDK.

Procedure

  1. Create a project.

    1. Create your project directory:

      1. $ mkdir memcached-operator

    2. Change into the project directory:

      1. $ cd memcached-operator

    3. Run the operator-sdk init command with the quarkus plugin to initialize the project:

      1. $ operator-sdk init \
      2.     --plugins=quarkus \
      3.     --domain=example.com \
      4.     --project-name=memcached-operator

  2. Create an API.

    Create a simple Memcached API:

    1. $ operator-sdk create api \
    2.     --plugins quarkus \
    3.     --group cache \
    4.     --version v1 \
    5.     --kind Memcached

  3. Build and push the Operator image.

    Use the default Makefile targets to build and push your Operator. Set IMG with a pull spec for your image that uses a registry you can push to:

    1. $ make docker-build docker-push IMG=<registry>/<user>/<image_name>:<tag>

  4. Run the Operator.

    1. Install the CRD:

      1. $ make install

    2. Deploy the project to the cluster. Set IMG to the image that you pushed:

      1. $ make deploy IMG=<registry>/<user>/<image_name>:<tag>

  5. Create a sample custom resource (CR).

    1. Create a sample CR:

      1. $ oc apply -f config/samples/cache_v1_memcached.yaml \
      2.     -n memcached-operator-system

    2. Watch for the CR to reconcile the Operator:

      1. $ oc logs deployment.apps/memcached-operator-controller-manager \
      2.     -c manager \
      3.     -n memcached-operator-system

  6. Delete a CR.

    Delete a CR by running the following command:

    1. $ oc delete -f config/samples/cache_v1_memcached -n memcached-operator-system

  7. Clean up.

    Run the following command to clean up the resources that have been created as part of this procedure:

    1. $ make undeploy

Next steps