This quickstart shows you how to use VM Runtime on Google Distributed Cloud to create a virtual machine (VM) on GKE on Bare Metal. VM Runtime on Google Distributed Cloud uses KubeVirt to orchestrate VMs on clusters, and lets you work with your VM-based apps and workloads in a uniform development environment.
Before you begin
To complete this quickstart, you need access to GKE on Bare Metal version
anthosBareMetalVersion: 1.12) or higher cluster. You can use any
cluster type capable of running workloads. If needed,
try GKE on Bare Metal on Compute Engine
or see the
cluster creation overview.
Enable VM Runtime on Google Distributed Cloud
VM Runtime on Google Distributed Cloud is automatically installed in GKE on Bare Metal version 1.10 or higher, but is disabled by default. Before you can run VM resources in your GKE on Bare Metal, you must enable the VM Runtime on Google Distributed Cloud.
GKE on Bare Metal version 1.11 or higher can use the
bmctl command-line tool:
To enable the runtime, use the
bmctl enable vmruntime --kubeconfig KUBECONFIG_PATH
Provide the path to the kubeconfig file for your cluster. GKE on Bare Metal generates the kubeconfig file on the admin workstation when you create a cluster. By default, the path is
If VM Runtime on Google Distributed Cloud is already enabled, the command returns an error.
GKE on Bare Metal version 1.10 or higher can use a custom resource definition to enable VM Runtime on Google Distributed Cloud. This custom resource is installed by default.
kubectl edit vmruntime
enabled:truein the spec:
apiVersion: vm.cluster.gke.io/v1 kind: VMRuntime metadata: name: vmruntime spec: enabled: true # useEmulation defaults to "false" if not set. useEmulation: true # vmImageFormat defaults to "qcow2" if not set. vmImageFormat: qcow2
In the preceding
specsection, the following values can be set:
enabled: set to true to enable VM Runtime on Google Distributed Cloud
useEmulation: If your node doesn't support hardware virtualization, or you aren't sure, set the value to true. If available, hardware virtualization provides better performance than software emulation. The
useEmulationfield defaults to
false, if it isn't specified.
vmImageFormat: Supports two disk image format values:
qcow2. If you don't set
vmImageFormat, the VM Runtime on Google Distributed Cloud uses the
rawdisk image format to create VMs. The
rawformat may provide improved performance over
qcow2, a copy on write format, but may use more disk. For more information about the image formats for your VM, see Disk image file formats in the QEMU documentation.
Save the custom resource in your editor.
Verify that the
VMRuntimecustom resource is enabled:
kubectl describe vmruntime vmruntime
The details of the
VMRuntimecustom resource include a
Statussection. VM Runtime on Google Distributed Cloud is enabled and working when
virtctl client tool
To create and manage VMs, install the virtctl client tool.
virtctlclient tool as a
export GOOGLE_APPLICATION_CREDENTIALS="PATH_TO_SERVICE_ACCOUNT_KEY/bm-gcr.json" sudo -E bmctl install virtctl
The credentials let you authenticate and download the
virtctlclient tool, then install to
/usr/bin/kubectl-virton your local machine.
Verify that the
virtctlplugin is installed:
kubectl plugin list
kubectl-virtis listed in the response, the plugin is successfully installed.
kubectl-virtis not listed, check the
install-virtctl.logfile as noted in the output of the previous
bmctl installcommand, such as
Create a VM
In this quickstart, you use the
kubectl CLI to create a VM that uses a public
VM image and default credentials.
Create a VM in your cluster. The
virtctlplugin is used with the
kubectl virt create vm VM_NAME \ --image ubuntu20.04 \ --configure-initial-password USERNAME:PASSWORD
This command creates an Ubuntu 20.04 VM and defaults of 2 CPU, 4Gi memory, and a 20Gi boot disk in ReadWriteOnce mode using the local-shared storage class. Replace the following values:
VM_NAME: name for your VM. VM names must contain only lowercase alphanumeric characters or '-', start and end with an alphanumeric character, and contain at most 63 characters. For more information, see RFC 1123 Label Names in the Kubernetes documentation.
USERNAME: user name for the account to create on the VM.
PASSWORD: password for the user account.
If you receive an error about CLI parameters, verify that your cluster is at version
1.11.1or higher and that you have the latest version of the
virtctlclient tool. For more information about CLI errors, consult the console log. For username and password rules, see the documentation for the guest operating system (OS). If something isn't working as expected, check for VM Runtime on Google Distributed Cloud known issues.
It can take a few minutes to create the VM. Check the status of the VM with the
kubectl get gvm
The following example output shows the VM in a
NAME STATUS AGE IP vm-sample1 Running 64s 192.168.2.124
Connect to your VM
When your VM is running, connect to the console of the VM.
To access a VM from the console, use
kubectl virt console VM_NAME
When prompted, enter the user credentials you specified to create the VM.
After you have successfully connected to the console of the VM, exit the VM session and console:
Ctrl + ]
To clean up the resources created in this quickstart, follow these steps.
To delete the VM and associated DataVolume, use
kubectl virt delete vm VM_NAME --all
- Manage the power state of a VM in GKE on Bare Metal.
- Edit a VM in GKE on Bare Metal.
- View VM console logs in GKE on Bare Metal.