Skip to content

Commit

Permalink
some improvements to the neonvm README.md (#622)
Browse files Browse the repository at this point in the history
  • Loading branch information
problame authored Nov 20, 2023
1 parent 0e67b15 commit 4c9defe
Showing 1 changed file with 19 additions and 1 deletion.
20 changes: 19 additions & 1 deletion neonvm/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ kubectl delete neonvm vm-debian
#### 1. Create local cluster (with 3 nodes)

```sh
make local-cluster
make k3d-setup
```

#### 2. Build Linux kernel for Guests
Expand All @@ -91,6 +91,16 @@ make local-cluster
make kernel
```

(Alternatively, pull & extract it from Dockerhub)

To adjust the kernel config:

```
docker build --build-arg KERNEL_VERSION=5.15.80 --platform linux/x86_64 --target build-deps -t kernel-build-deps -f Dockerfile.kernel-builder .
docker run --rm -v $PWD:/host --name kernel-build -it kernel-build-deps bash
# inside that bash shell, do the menuconfig, then copy-out the config to /host
```

#### 3. Build and deploy controller and VXLAN overlay network to local cluster

```sh
Expand All @@ -99,12 +109,20 @@ make deploy

### Manage Virtual Machines

#### 0. Build & load example images into the k8s cluster

```
make example-vms
```

#### 1. Run virtual machine

```console
kubectl apply -f samples/vm-example.yaml
```

NB: on machines without `/dev/kvm` (e.g., on EC2 non-bare-metal), set `.spec.enableAcceleration = false`.

#### 2. Check VM running

```sh
Expand Down

0 comments on commit 4c9defe

Please sign in to comment.