Merge pull request #10 from knawd/polish

docs: finalize schema for v1 release

README.md

@@ -13,17 +13,17 @@ See https://knawd.dev for more information.
 
 ## Overview
 
-This project creates a build of the latest [WASMEdge](https://github.com/WasmEdge/WasmEdge) enabled [crun release](https://github.com/containers/crun).
+This project creates a build of the latest [crun release](https://github.com/containers/crun) with [WASMEdge](https://github.com/WasmEdge/WasmEdge)/[wasmtime](https://wasmtime.dev/)/[wasm-nodejs](https://github.com/mhdawson/crun/tree/node-wasm-experiment) support and provides a helm chart and executable to assist with the deployment onto public cloud.
 
 This build is then bundled into a vendored container along with an executable to help with the deployment.
 
 Finally there is a helm chart to deploy it into managed kubernetes services.
 
 The deployment is performed copying files to 3 locations on each node:
 
-1. The `/lib` folder to copy the shared objects `libwasmedge.so.0`
+1. The `/lib` folder to copy the shared objects `libwasmedge.so.0` or `libwasmtime.so` or `libnode.so`
 
-2. The `/usr/local/sbin` folder to deploy the `crun` executable
+2. The `/usr/local/sbin` folder to deploy the OCI executable e.g. `crun`
 
 3. The additional runtime is added to either the `crio.conf` or the containerd `config.toml`
 
@@ -33,12 +33,7 @@ The deployment is performed copying files to 3 locations on each node:
 
 |Release|WASMEdge|WASMtime|node-wasm|crun|Ubuntu|OpenShift|
 |---|---|---|---|---|---|---|
-|v1.0.0-iota|0.11.2|5.0.0|[experiment](https://github.com/mhdawson/crun/commit/23f346e3bc15ec7e6188b405df895aef5a5cbcdd)|[1.8](https://github.com/containers/crun/releases/tag/1.8)|18.04, 20.04|4.10, 4.11|
-|v1.0.0-theta|0.11.2|5.0.0|N/A|[main](https://github.com/containers/crun/commit/26fe1383a05279935e67ee31e7ff10c43e7d87ea)|18.04, 20.04|4.10, 4.11|
-|v1.0.0-gamma|0.11.2|5.0.0|N/A|[main](https://github.com/containers/crun/commit/26fe1383a05279935e67ee31e7ff10c43e7d87ea)|18.04, 20.04|4.10, 4.11|
-|v1.0.0-beta|0.11.2|N/A|N/A|[main](https://github.com/containers/crun/commit/26fe1383a05279935e67ee31e7ff10c43e7d87ea)|18.04, 20.04|4.10, 4.11|
-|v1.0.0-alpha|0.11.2|N/A|N/A|[main](https://github.com/containers/crun/commit/26fe1383a05279935e67ee31e7ff10c43e7d87ea)|18.04, 20.04|4.10, 4.11|
-
+|v1.0.0|0.11.2|5.0.0|[experiment](https://github.com/mhdawson/crun/commit/23f346e3bc15ec7e6188b405df895aef5a5cbcdd)|[1.8](https://github.com/containers/crun/releases/tag/1.8)|18.04, 20.04|4.10, 4.11|
 
 N.B. Red Hat Core OS based instances have still to be tested and we expect some issues modifying the crio config and copying the WASM libs to the host.
 
@@ -64,6 +59,3 @@ We pledge to act and interact in ways that contribute to an open, welcoming,
 diverse, inclusive, and healthy community.
 
 [The full code of conduct is available here](./code-of-conduct.md)
-
-)
-

charts/knawd-deployer/Chart.yaml

@@ -11,9 +11,9 @@ sources:
 
 type: application
 
-version: v1.0.0-mu
+version: v1.0.0
 
-appVersion: "v1.0.0-mu"
+appVersion: "v1.0.0"
 
 # icon: https://raw.githubusercontent.com/No9/core-dump-handler/master/assets/handle-with-care-svgrepo-com.svg
 
@@ -25,13 +25,13 @@ maintainers:
 annotations:
   artifacthub.io/changes: |
     - kind: added
-      description:  Streamline builds and support for wasm nodejs
+      description:  Schema alignment
       links:
         - name: GitHub PR
-          url: https://github.com/knawd/deployer/pull/8
+          url: https://github.com/knawd/deployer/pull/10
   artifacthub.io/images: |
     - name: knawd-deployer
-      image: quay.io/knawd/deployer:v1.0.0-mu
+      image: quay.io/knawd/deployer:v1.0.0
   artifacthub.io/license: MIT
   artifacthub.io/signKey: |
     fingerprint: BED079E67FD431E45301B1C9949E671B46AC8A34

charts/knawd-deployer/values.schema.json

@@ -7,6 +7,7 @@
             "additionalProperties": false,
             "properties": {
                 "target": {
+                    "description": "The type of kubernetes cluster to be configured.",
                     "type": "string",
                     "enum": [
                         "rhel8",
@@ -17,20 +18,17 @@
                     "default": "rhel8"
                 },
                 "tag": {
+                    "description": "The tag in the repository where the image is located used to specifiy a custom image.",
                     "type": "string",
-                    "enum": [
-                        "v1.0.0-gamma",
-                        "v1.0.0-theta",
-                        "v1.0.0-iota",
-                        "v1.0.0-mu",
-                        "latest"
-                    ],
-                    "default": "latest"
+                    "default": "v1.0.0"
                 },
                 "autoRestart": {
-                    "type": "boolean"
+                    "description": "Flag for the deployer to automatically restart the CRI service. Required for the config to be applied",
+                    "type": "boolean",
+                    "default": true
                 },
                 "logLevel": {
+                    "description": "The log level for the daemonset",
                     "type": "string",
                     "enum": [
                         "info",
@@ -40,18 +38,19 @@
                     "default": "info"
                 },
                 "ociType": {
-                    "items": {
-                        "type": "string",
-                        "enum": [
-                            "crun-wasmedge",
-                            "crun-wasmtime",
-                            "crun-wasm-nodejs"
-                        ]
-                    },
+                    "description": "The type of the OCI Runtime and WASM Runtime to deploy",
+                    "type": "string",
+                    "enum": [
+                        "crun-wasmedge",
+                        "crun-wasmtime",
+                        "crun-wasm-nodejs"
+                    ],
                     "default": "crun-wasmedge"
                 },
                 "patchKnative": {
-                    "type": "boolean"
+                    "description": "Runs the patch to enable setting the `runtimeClassName` in a knative service definition",
+                    "type": "boolean",
+                    "default": true
                 }
             },
             "required": [

charts/knawd-deployer/values.yaml

@@ -1,5 +1,5 @@
 target: rhel8
-tag: v1.0.0-mu
+tag: v1.0.0
 autoRestart: true
 logLevel: "info"
 ociType: "crun-wasmedge"