Merge pull request #100 from sanposhiho/doc

doc: add a simple tutorial to guide users

Author: k8s-ci-robot

README.md

@@ -9,12 +9,10 @@ scheduler, and loading custom scheduler plugin via configuration.
 
 This project contains everything needed to extend the scheduler:
 - Documentation describing what type of actions are possible, e.g. `Filter`.
-- Language SDKs used to build scheduler plugins, compiled to wasm.
-- The scheduler plugin which loads and runs wasm plugins
+- [Language SDKs](./guest/) used to build scheduler plugins, compiled to wasm.
+- [The scheduler plugin](./scheduler/) which loads and runs wasm plugins
 
-## Example
-
-You can learn how you build your wasm plugins by trying [./examples](./examples/).
+You can learn how you build your wasm plugins by referring to [the tutorial](./docs/tutorial.md).
 
 ## Motivation
 

docs/tutorial.md

@@ -0,0 +1,48 @@
+## Tutorial
+
+This is the basic tutorial describing the basic flow you can follow to build your scheduler plugins made of wasm.
+
+### Build your wasm binary via SDK
+
+[Go SDK](../guest/) is the only language SDK that we support for now.
+
+Like [Scheduling Framework](https://kubernetes.io/docs/concepts/scheduling-eviction/scheduling-framework/), 
+the Go SDK provides [the interfaces](../guest/api/types.go) so that you can develop your own scheduling 
+via a similar experience to Go scheduler plugin.
+
+Some of them look different from [the interfaces in Scheduling Framework](https://github.com/kubernetes/kubernetes/blob/master/pkg/scheduler/framework/interface.go) though, 
+it's the same how they're called by the scheduler.
+
+You can learn how you can implement your wasm plugins by referring to [./examples](./examples/).
+
+Currently, Go SDK uses TinyGo for its compile, you can refer to [Makefile](../Makefile) to see how we build example implementations.
+Each example takes a different approach to build them, as README in them describes.
+
+### Integrate your wasm binary into your scheduler
+
+We have [a scheduler plugin](../scheduler/) which loads and runs wasm plugins.
+For now, you have to build [the scheduler with the plugin](../scheduler/cmd/scheduler/main.go) by yourself though, 
+we'll provide an official docker image after our first release.
+
+You have to enable the scheduler plugin with your wasm binary in `KubeSchedulerConfiguration`, as following.
+
+```yaml
+apiVersion: kubescheduler.config.k8s.io/v1
+kind: KubeSchedulerConfiguration
+profiles:
+  - plugins:
+      multipoint:
+        enabled:
+           - name: wasmplugin1
+           - name: wasmplugin2
+     pluginConfig:
+       - name: wasmplugin1
+          args:
+            guestPath: "/path/to/wasm-plugin1"
+       - name: wasmplugin2
+          args:
+            guestPath: "/path/to/wasm-plugin2"
+```
+
+- A wasm plugin **must** be enabled via `multiPoint` even if your wasm plugin only uses some of extension points.
+- All plugins with the plugin config matching [the wasm config format](../scheduler/plugin/config.go) are considered to be wasm plugins. 

examples/README.md

@@ -1,12 +1,7 @@
 ## Examples
 
 These examples help you understand how you build your wasm plugins with our Go SDK (which is the only language SDK supported for now).
+Each example takes a different approach, refer to README in them for the details.
 
 - [NodeNumber Plugin](./nodenumber/): The simple example plugin in which you can simply get how the wasm plugin looks like.
 - [Adbanced NodeNumber Plugin](./advanced/): The example plugin one step advanced, which is more complicated than the first one, but more efficient and testable.
-
-### Go SDK Interfaces
-
-Like [Scheduling Framework](https://kubernetes.io/docs/concepts/scheduling-eviction/scheduling-framework/), the Go SDK provides [the interfaces](../guest/api/types.go).
-
-Some of them look different from [the interfaces in Scheduling Framework](https://github.com/kubernetes/kubernetes/blob/master/pkg/scheduler/framework/interface.go) though, it's the same how they're called by the scheduler.