From a2ba751c8e6f6c4776bbf3c571c0d6723634f670 Mon Sep 17 00:00:00 2001 From: Claudia Beresford Date: Fri, 22 Oct 2021 13:57:53 +0100 Subject: [PATCH] Minor additions to quickstart docs --- docs/quick-start.md | 39 +++++++++++++++++++++++++++++++++++---- 1 file changed, 35 insertions(+), 4 deletions(-) diff --git a/docs/quick-start.md b/docs/quick-start.md index b29ecff78..98f1c69cb 100644 --- a/docs/quick-start.md +++ b/docs/quick-start.md @@ -135,6 +135,9 @@ sudo mkdir -p /run/containerd-dev/ sudo containerd --config /etc/containerd/config-dev.toml ``` +ContainerD will about 100 lines at boot, most will be about loading plugins. +Towards the end you should see `containerd successfully booted in 0.055357s`. + To reach our new dev containerd, we have to specify the `--address` flag, for example: @@ -183,23 +186,51 @@ make build NET_DEVICE=$(ip route show | awk '/default/ {print $5}') -./bin/flintlockd run \ +sudo ./bin/flintlockd run \ --containerd-socket=/run/containerd-dev/containerd.sock \ --parent-iface="${NET_DEVICE}" ``` +You should see it start successfully with similar output: +``` +INFO[0000] reignited, version=undefined, built_on=undefined, commit=undefined +INFO[0000] reignited grpc api server starting +INFO[0000] starting microvm controller +INFO[0000] starting microvm controller with 1 workers controller=microvm +INFO[0000] resyncing microvm specs controller=microvm +INFO[0000] Resyncing specs action=resync controller=microvm namespace=ns +INFO[0000] starting event listener controller=microvm +INFO[0000] Starting workersnum_workers1 controller=microvm +``` + ## BloomRPC [BloomRPC][bloomrpc] is a good tool to test gRPC endpoint. ### Import -Use the "Import Paths" button and add `$repo/api` to the list. All available -endpoints will be visible in a nice tree view. +To import reignite protos into the Bloom GUI: + +1. Click `Import Paths` on the left-hand menu bar and add `/api` to the list +1. Click the import `+` button and select `reignite/api/services/microvm/v1alpha1/microvms.proto` + +All available endpoints will be visible in a nice tree view. ### Example -TODO: Example CreateVM Payload +To create a MircoVM, select the `CreateMicroVM` endpoint in the left-hand menu. +Replace the sample request JSON in the left editor panel with [this example](hack/scripts/payload/CreateMicroVM.json). +Click the green `>` in the centre of the screen. The response should come immediately. + +In the terminal where you started the Reignite server, you should see in the logs that the MircoVM +has started. + +To delete the MircoVM, select the `DeleteMicroVM` endpoint in the left-hand menu. +Replace the sample request JSON in the left editor panel with [this example](hack/scripts/payload/DeleteMicroVM.json). +Take care to ensure the values match those of the MicroVM you created earlier. +Click the green `>` in the centre of the screen. The response should come immediately. + +**Note: there are example payloads for other endpoints, but not all are implemented at present.** [bloomrpc]: https://github.com/uw-labs/bloomrpc