Installing Veeam KubeVirt Proxy

The Veeam KubeVirt Proxy is a Pod that resides in the protected Red Hat OpenShift Virtualization cluster and processes backup workloads when transferring data to and from backup repositories. Each protected Red Hat OpenShift Virtualization cluster must have one dedicated Veeam KubeVirt Proxy. Veeam Backup & Replication can protect multiple clusters by connecting to multiple proxies.

To install the Veeam KubeVirt Proxy, do the following:

Log in to a local machine that has access to the Red Hat OpenShift Virtualization cluster you plan to protect. Make sure that the machine has the OpenShift CLI 4.20 (or later) and Helm 4.1 (or later) installed.
Open the command line interface and run the following command to connect to the Red Hat OpenShift Virtualization cluster:

oc login --server="URL:PORT" -u USERNAME -p PASSWORD

where:

--server is the cluster API address. You can find it in the Overview section of the Core platform menu in the Red Hat OpenShift Virtualization web console.
-u and -p are credentials of an account that has the permissions to perform administrative operations in the cluster.

Run the following commands to connect to the online Veeam repository where installation-specific Helm charts are stored and to download these charts to your local machine:

helm repo add veeamrepo https://charts.veeam.com/

helm repo update

Run the following command to install the Veeam KubeVirt Proxy and accept the EULA license agreement:

helm install vkp veeamrepo/vkp --namespace=<vkp_name> --set eula.accept=true --create-namespace

where:

--namespace specifies a namespace where the Veeam KubeVirt Proxy will be installed.
--set eula.accept indicates whether you accept the license agreement.

Keep in mind that you will not be able to proceed with installation without providing the --namespace and --set eula.accept parameters.

Tip

If necessary, you can also provide a number of optional parameters (such as --set logging.level). To display the list of all available parameters, run the following command: helm show values vkp/vkp. For more information on Helm commands, see Helm CLI documentation.
If you want to install the Veeam KubeVirt Proxy in an air-gapped environment, provide the following parameters:

--set chartRepo — specifies the URL to your Helm charts.
--set image.registry — specifies the URL to the image that you want to use to install the Veeam KubeVirt Proxy.
--set image.Tag — specifies the tag of the image that you want to use to install the Veeam KubeVirt Proxy.

[Applies only if more than one volume snapshot class is configured for the storage classes of the volumes you plan to protect] Run the following command to specify a volume snapshot class that the Veeam KubeVirt Proxy will use to create snapshots of the protected volumes:

oc annotate storageclass <storage_class> vkp.veeam.com/volume-snapshot-class=<volume_snapshot_class>

where:

<storage_class> specifies the storage class of the volumes you plan to protect.
<volume_snapshot_class> specifies a volume snapshot class that the Veeam KubeVirt Proxy will use to create snapshots of the protected volumes.

If you want to instruct the Veeam KubeVirt Proxy to create all volume snapshots (regardless of their type) using a specific volume snapshot class, run the following command instead:

oc annotate volumesnapshotclass <volume_snapshot_class> vkp.veeam.com/is-snapshot-class=true

Run the following command to retrieve the Veeam KubeVirt Proxy connection details (FQDN and token) using the following commands — you will need these details later when adding the cluster to Veeam Backup & Replication:

oc get route -n vkp

oc get secret vkp-token -n vkp -o jsonpath='{.data.token}' | base64 -d

For more information, see Adding Red Hat OpenShift Virtualization Server to Backup Infrastructure (steps 2 and 3).