Skip to content

Commit 3037710

Browse files
committed
docs(deploy/helm): update README.md
Signed-off-by: Vaughn Dice <[email protected]>
1 parent 412d164 commit 3037710

File tree

1 file changed

+40
-0
lines changed

1 file changed

+40
-0
lines changed

deploy/helm/README.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# runtime-class-manager
2+
3+
runtime-class-manager is a Kubernetes operator that manages installation of Wasm shims onto nodes and related Runtimeclasses via [Shim custom resources](../../config/crd/bases/runtime.kwasm.sh_shims.yaml).
4+
5+
## Prerequisites
6+
7+
- [Kubernetes v1.20+](https://kubernetes.io/docs/setup/)
8+
- [Helm v3](https://helm.sh/docs/intro/install/)
9+
10+
## Installing the chart
11+
12+
The following installs the runtime-class-manager chart with the release name `rcm`:
13+
14+
```shell
15+
helm upgrade --install \
16+
--namespace rcm \
17+
--create-namespace \
18+
--wait \
19+
rcm .
20+
```
21+
22+
## Post-installation
23+
24+
With runtime-class-manager running, you're ready to create one or more Wasm Shims. See the samples in the [config/samples directory](../../config/samples/).
25+
26+
> Note: Ensure that the `location` for the specified shim binary points to the correct architecture for your Node(s)
27+
28+
For example, here we install the Spin shim:
29+
30+
```shell
31+
kubectl apply -f ../../config/samples/test_shim_spin.yaml
32+
```
33+
34+
Now when you annotate one or more nodes with a label corresponding to the `nodeSelector` declared in the Shim, runtime-class-manager will install the shim as well as create the corresponding Runtimeclass:
35+
36+
```shell
37+
kubectl label node --all spin=true
38+
```
39+
40+
You are now ready to deploy your Wasm workloads.

0 commit comments

Comments
 (0)