Update documentation to reflect useEmulation behavior
@@ -5,30 +5,28 @@ This is almost always desirable, however there are a few exceptions where this
approach is problematic. For instance, running KubeVirt on a cluster where the
nodes do not support hardware emulation.
-If `allowEmulation` is enabled, hardware emulation via `/dev/kvm` will still be
-attempted first. Software emulation will only be used if the device is
-unavailable.
+If `useEmulation` is enabled, hardware emulation via `/dev/kvm` will not be
+attempted. `qemu` will be used for software emulation instead.
# Configuration
-Enabling software emulation as a fallback is a cluster-wide setting, and is
-activated using a ConfigMap in the `kube-system` namespace. It can be enabled
-with the following command:
+Enabling software emulation is a cluster-wide setting, and is activated using a
+ConfigMap in the `kube-system` namespace. It can be enabled with the following
+command:
```bash
cluster/kubectl.sh --namespace kube-system create configmap kubevirt-config \
- --from-literal debug.allowEmulation=true
+ --from-literal debug.useEmulation=true
```
If the `kube-system/kubevirt-config` ConfigMap already exists, the above entry
can be added using:
-
```bash
cluster/kubectl.sh --namespace kube-system edit configmap kubevirt-config
```
-In this case, add the `debug.allowEmulation: "true"` setting to `data`:
+In this case, add the `debug.useEmulation: "true"` setting to `data`:
```yaml
apiVersion: v1
@@ -37,7 +35,7 @@ metadata:
name: kubevirt-config
namespace: kube-system
data:
- debug.allowEmulation: "true"
+ debug.useEmulation: "true"
```
