search

spinkube / documentation

Site and Docs for the SpinKube community project
https://www.spinkube.dev/
Apache License 2.0
13 stars 21 forks source link

docs: remove the Kwasm operator from the installation page? #152

Open peterj opened 2 months ago

peterj commented 2 months ago

In the quickstart, there's no mention of installing the KWasm operator and the docs talk about Kwasm being replaced by the runtime class manager.

The "Installing with Helm" page still references "Kwasm Operator" as a required component to install -- should this section be removed from the page?

radu-matei commented 2 months ago

Hey, @peterj!

A bit of context: the goal of KWasm project is to configure the underlying shim executor of the runtime class. The new runtime class manager project is the new and improved version of KWasm (and tagging @0xE282B0 or @voigt to add more here).

The reason why the quickstart doesn't mention using KWasm is because the image used when setting up the K3s cluster with K3d (ghcr.io/spinkube/containerd-shim-spin/k3d:v0.13.1) already contains the containerd shim executor:

$ k3d cluster create wasm-cluster \
  # this image already contains the containerd shim for Spin
  --image ghcr.io/spinkube/containerd-shim-spin/k3d:v0.13.1 \
  --port "8081:80@loadbalancer" \
  --agents 2

For a cluster created without that base image, you still need to configure the shim — and for a little bit more, that's still done using KWasm — SpinKube will very soon use the new runtime class manager project to configure the shim — here's the milestone for that — https://github.com/spinkube/runtime-class-manager/milestone/1.

Let me know if that makes sense.