From 7ddf9c39112d38282bf3bdeb39a37aadf1798ea8 Mon Sep 17 00:00:00 2001 From: Manohar Castelino Date: Fri, 4 Jan 2019 10:01:53 -0800 Subject: [PATCH] Firecracker: Update README Update README to call out how to try firecracker workloads. Signed-off-by: Manohar Castelino --- clr-k8s-examples/README.md | 19 ++++++++++++++++++- 1 file changed, 18 insertions(+), 1 deletion(-) diff --git a/clr-k8s-examples/README.md b/clr-k8s-examples/README.md index 96d4816..d54b70f 100644 --- a/clr-k8s-examples/README.md +++ b/clr-k8s-examples/README.md @@ -20,10 +20,18 @@ This script ensures the following * Customizes the system to ensure correct defaults are setup (IP Forwarding, Swap off,...) * Ensures all the dependencies are loaded on boot (kernel modules) +> NOTE: This step is done automatically if using vagrant. + +### Enabling experimental firecracker support + > EXPERIMENTAL: Optionally run [`setup_firecracker.sh`](setup_firecracker.sh) to be able to use firecracker VMM with Kata. -> NOTE: These steps are already done if using vagrant +The firecracker setup switches the setup to use a sparse file backed loop device for +devicemapper storage. This should not be used for production. + +> NOTE: This step is done automatically if using vagrant. + ## Bring up the master @@ -67,6 +75,15 @@ An example is `kubectl apply -f tests/test-deploy-kata.yaml` +### Running Kata Workloads with Firecracker + +> EXPERIMENTAL: If firecracker setup has been enabled, runtime class set to "fire" will launch the POD/Deployment +with firecracker as the isolation mechanism for Kata. + +An example is + +`kubectl apply -f tests/test-deploy-fire.yaml` + ## Making Kata the default runtime Today in `crio.conf` runc is the default runtime when a user does not specify