Skip to content

Commit

Permalink
add intro to README
Browse files Browse the repository at this point in the history
Signed-off-by: Sven Pfennig <[email protected]>
  • Loading branch information
0xE282B0 committed Oct 20, 2022
1 parent a458ff8 commit ad48a03
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 3 deletions.
10 changes: 8 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,14 @@
# kwasm-operator
This Kubernetes Operators installs WebAssembly support on your Kubernetes Nodes
This Kubernetes Operators uses [KWasm/kwasm-node-installer](https://github.com/KWasm/kwasm-node-installer) to add WebAssembly support to your Kubernetes Nodes. It works with local and managed cloud K8s distributions based on Ubuntu/Debian with Containerd, including [MiniKube, MicroK8s, AKS, GKE, and EKS](https://github.com/KWasm/kwasm-node-installer#supported-kubernetes-distributions).

> **Warning**
> Only for development or evaluation purpose. Your nodes may get damaged!
> **Note**
> If you are searching for a production ready WebAssembly integration for your Kubernetes cluster, reach out to [Liquid Reply](https://www.reply.com/liquid-reply/en/)
## Example
With the KWasm Operator it is possile to have a more fine grained controll on the node provisioning. In this example we create a KinD cluster with three nodes and install the KWasm Operator. A single node will be provisioned and a wasm pod will be scheduled on exactly that node.
With the KWasm Operator it is possile to have a more fine grained controll on the node provisioning in contrast of using the node-installer with a DaemonSet. In this example we create a KinD cluster with three nodes and install the KWasm Operator. A single node will be provisioned and a wasm pod will be scheduled on exactly that node.
```bash
# Create cluster
kind create cluster --config examples/kind/cluster.yaml
Expand Down
2 changes: 1 addition & 1 deletion examples/kind/pod.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -15,5 +15,5 @@ spec:
name: wasi-demo
restartPolicy: Never
nodeSelector:
kwasm.sh/kwasm-provisioned: kind-worker
kwasm.sh/kwasm-provisioned: kind-worker2
runtimeClassName: crun

0 comments on commit ad48a03

Please sign in to comment.