KubeVirt Tekton

KubeVirt Tekton tasks operator (TTO)

Prerequisites

Deploying TTO

TTO is a Golang based operator, which takes care of deploying kubevirt-tekton-tasks and example pipelines.

TTO is shipped as a part of hyperconverged-cluster-operator or it can be deployed by the user as a stand-alone from the latest release.

Note

TTO requires Tekton to work.

Note

TTO does not deploy its resources by default.

The user has to enable deployTektonTaskResources feature gate in HCO CR to deploy all its resources

apiVersion: hco.kubevirt.io/v1beta1
kind: HyperConverged
metadata:
  name: kubevirt-hyperconverged
  namespace: kubevirt-hyperconverged
spec:
  featureGates:
    deployTektonTaskResources: true

or in TTO CR:

apiVersion: tektontasks.kubevirt.io/v1alpha1
kind: TektonTasks
metadata:
  name: tektontasks
  namespace: kubevirt
spec:
  featureGates:
    deployTektonTaskResources: true

User can use this command to enable deployTektonTaskResources feature gate in HCO CR

oc patch hco kubevirt-hyperconverged  --type=merge -p '{"spec":{"featureGates": {"deployTektonTaskResources": true}}}'

or in TTO CR if TTO is deployed as a stand-alone without HCO

oc patch TektonTasks tektontasks  --type=merge -p '{"spec":{"featureGates": {"deployTektonTaskResources": true}}}'

Once spec.featureGates.deployTektonTaskResources is set to true, TTO will not delete any cluster tasks or pipeline examples even if it is reverted back to false.

The user can set in which namespace example pipelines will be deployed by setting spec.tektonPipelinesNamespace in HCO CR:

apiVersion: hco.kubevirt.io/v1beta1
kind: HyperConverged
metadata:
  name: kubevirt-hyperconverged
  namespace: kubevirt-hyperconverged
spec:
  tektonPipelinesNamespace: userNamespace

or in TTO CR by setting spec.pipelines.namespace:

apiVersion: tektontasks.kubevirt.io/v1alpha1
kind: TektonTasks
metadata:
  name: tektontasks
  namespace: kubevirt
spec:
  pipelines:
    namespace: userNamespace

KubeVirt Tekton tasks

What are KubeVirt Tekton tasks?

KubeVirt-specific Tekton tasks, which are focused on:

  • Creating and managing resources (VMs, DataVolumes)
  • Executing commands in VMs
  • Manipulating disk images with libguestfs tools

Existing tasks

Create Virtual Machines

  • create-vm-from-manifest - create a VM from provided manifest.
  • create-vm-from-template - create a VM from template (works only on OpenShift).

Utilize Templates

  • copy-template - Copies the given template and creates a new one (works only on OpenShift).
  • modify-vm-template - Modifies a template with user provided data (works only on OpenShift).

Modify Data Objects

  • modify-data-object - Creates / modifies / deletes a datavolume / datasource

Generate SSH Keys

  • generate-ssh-keys - Generates a private and public key pair, and injects it into a VM.

Execute commands in Virtual Machines

  • execute-in-vm - Execute commands over SSH in a VM.
  • cleanup-vm - Execute commands and/or stop/delete VMs.

Manipulate PVCs with libguestfs tools

  • disk-virt-customize - execute virt-customize commands in PVCs.
  • disk-virt-sysprep- execute virt-sysprep commands in PVCs.

Wait for Virtual Machine Instance Status

  • wait-for-vmi-status - Waits for a VMI to be running.

Example pipeline

All these tasks can be used for creating pipelines. TTO is creating multiple example pipelines, e.g.:

  • Windows 10 installer - Pipeline will prepare a template and Windows 10 datavolume vith virtio drivers installed. User has to provide a link to working Windows 10 iso file. More informations about pipeline can be found here

  • Windows 10 customize - Pipeline will install sql server in windows 10 VM. More informations about pipeline can be found here