Skip to content

Quickstart

This page walks through the quickest way to try out VM Operator!

Requirements

Currently VM Operator is only available with VMware vSphere 7.0+ and VM Service on Supervisor. Please refer to the following documentation for getting started with Supervisor and VM Service:

  • Configuring and Managing a Supervisor (7.0, 8.0)
  • Deploying and Managing Virtual Machines (7.0, 8.0)

The following steps will also assume there is a Namespace (7.0, 8.0) named my-namespace and:

  • You have write permissions in this namespace
  • There is an NSX-T network or vSphere Distributed network available to this namespace
  • There is a VM Class named small available to this namespace
  • There is a VM Image named photon4 available to this namespace
  • There is a storage class named iscsi available to this namespace

Create a VM

Once you are logged into the Supervisor with, a new VM may be realized using the following YAML:

vm-example.yaml
apiVersion: vmoperator.vmware.com/v1alpha5
kind: VirtualMachine
metadata:
  name: my-vm
spec:
  className:    my-vm-class
  imageName:    vmi-0a0044d7c690bcbea
  storageClass: my-storage-class
  bootstrap:
    cloudInit:
      cloudConfig: {}

Create the new VM with the following command:

kubectl apply -n my-namespace -f https://raw.githubusercontent.com/vmware-tanzu/vm-operator/main/docs/concepts/workloads/vm-example.yaml

And that's it! Use kubectl to watch the VM until it is powered on with an IP address, at which point you have successfully deployed a workload on Kubernetes with VM Operator.