Forklift Operator installs a suite of migration tools that facilitate the migration of VM workloads to OpenShift Virtualization or KubeVirt.

• OpenShift 4.9+ or k8s v1.22+
• OpenShift Virtualization 4.9+ or KubeVirt
• Operator Lifecycle Manager (OLM) support

OpenShift Virtualization/KubeVirt is required and must be installed prior attempting to deploy Forklift, see the table below for supported configurations:

Note: Please keep in mind Forklift will not deploy in unsupported configurations.

The operator will install all the necessary components which Forklift needs to operate. The projects and a description of each are detailed below:

• Forklift UI, The Forklift UI is based on Patternfly 4.
• Forklift Controller, The Forklift Controller orchestrates the migration.
• Forklift Validation, The Forklift Validation service checks the VMs for possible issues before migration. This service is based on Open Policy Agent.
• Forklift Must Gather, Support tool for gathering information about the Forklift environment.

See development.md for details in how to contribute to Forklift operator.

The method used for these instructions relies on OKD/OCP Web Console, it is also possible to automate the deployment in OpenShift using manifests if needed, please check the k8s deployment manifest for details.

Released (or public betas) of Forklift are installable via community operators which appear in OCP and OKD marketplace.

1. Visit the OpenShift Web Console.
2. Navigate to Operators => OperatorHub.
3. Search for Forklift Operator.
4. Install the desired Forklift Operator version.

Installing latest is almost an identical procedure to released versions but requires creating a new catalog source.

1. oc create -f forklift-operator-catalog.yaml
2. Follow the same procedure as released versions until the Search for Forklift Operator step.
3. There should be two Forklift Operator available for installation now.
4. Select the Forklift Operator without the community tag.
5. Proceed to install latest using the development channel in the subscription step.

Note: Installing latest may also include OLM channels for other released versions.

Once you have successfully installed the operator, proceed to deploy components by creating the ForkliftController CR.

1. Visit OpenShift Web Console, navigate to Operators => Installed Operators.
2. Select Forklift Operator.
3. Locate ForkliftController on the top menu and click on it.
4. Adjust settings if desired and click Create instance.

Once the CR is created, the operator will deploy the controller, UI and configure the rest of required components.

See k8s.md for details.

Custom deployment settings can be applied by editing the ForkliftController CR.

oc edit forkliftcontroller -n konveyor-forklift

Use the Forklift cleanup script, this is the recommended method to delete operator, CRDs and all related objects. It supports OpenShift and Kubernetes environments.

forklift-cleanup.sh -o

See the Forklift Documentation for detailed installation instructions as well as how to use Forklift.