Install the SonataFlow Operator

To install the operator on OpenShift refer to the "Adding Operators to a cluster" from the OpenShift’s documentation.

When searching for the operator in the Filter by keyword field, use the word sonataflow. If you’re installing from the CLI, the operator’s catalog name is sonataflow-operator.

To remove the operator on OpenShift refer to the "Deleting Operators from a cluster" from the OpenShift’s documentation.

To install the operator on Kubernetes refer to the "How to install an Operator from OperatorHub.io" from the OperatorHub’s documentation.

When searching for the operator in the Search OperatorHub field, use the word sonataflow.

To remove the operator on Kubernetes follow the document "Uninstall your operator" from the OLM’s documentation.

When searching for the subscription to remove, use the word my-sonataflow-operator.

To install the SonataFlow Operator, you can use the following command:

Replace main with specific version if needed:

<version> could be 1.44.1 for instance.

You can follow the deployment of the SonataFlow Operator:

A successful installation should have an output like this:

You can also follow the operator’s log:

Once the operator is running, it will watch for instances of the SonataFlow Custom Resources (CR). Using CRs, you can configure your SonataFlow environment and define Workflows and builds to be handled by the operator.

To uninstall the SonataFlow Operator, first, you must delete all the SonataFlow Custom Resources (CR) instances managed by it. Once the CRs are deleted, you can then delete all resources created during the operator installation.

To delete every CR managed by the operator in your cluster, you can run these series of commands:

Alternatively, if you created everything under the same Namespace, deleting the given namespace has the same outcome.

To uninstall the correct version of the operator, first you must get the current version by running: