feat: add runtime-class-manager helm chart (#204)

* add helm chart * fix(deploy/helm): update healthz and readyz ports; use 'latest' tag Signed-off-by: Vaughn Dice <[email protected]> * fix(deploy/helm): add necessary RBAC perms to clusterrole.yaml Signed-off-by: Vaughn Dice <[email protected]> * fix(test_shim_spin.yaml): update shim location; update runtimeclass name and handler Signed-off-by: Vaughn Dice <[email protected]> * docs(deploy/helm): update README.md Signed-off-by: Vaughn Dice <[email protected]> * ref(deploy/helm): remove role/rolebinding; update clusterrole Signed-off-by: Vaughn Dice <[email protected]> * nit(deploy/helm): s/DownLoader/Downloader Signed-off-by: Vaughn Dice <[email protected]> * docs(helm): add next steps to NOTES.txt Signed-off-by: Vaughn Dice <[email protected]> * fix(.github): add charts_dir for helm/chart_releaser_action Signed-off-by: Vaughn Dice <[email protected]> * ref(Tiltfile): s/kwasm-operator/runtime-class-manager Signed-off-by: Vaughn Dice <[email protected]> --------- Signed-off-by: Vaughn Dice <[email protected]> Co-authored-by: Christoph Voigt <[email protected]>
spinframework · Sep 30, 2024 · 125f80a · 125f80a
1 parent b826e75
commit 125f80a
Show file tree

Hide file tree

Showing 14 changed files with 618 additions and 11 deletions.
diff --git a/.github/workflows/helm-chart-release.yml b/.github/workflows/helm-chart-release.yml
@@ -1,4 +1,4 @@
-# This action releases the kwasm-operator helm chart
+# This action releases the runtime-class-manager helm chart
 # The action must run on each commit done against main, however
 # a new release will be performed **only** when a change occurs inside
 # of the `charts` directory.
@@ -40,6 +40,8 @@ jobs:
       - name: Run chart-releaser
         if: github.ref == 'refs/heads/main'
         uses: helm/chart-releaser-action@a917fd15b20e8b64b94d9158ad54cd6345335584 # v1.6.0
+        with:
+          charts_dir: deploy/helm
         env:
           CR_TOKEN: "${{ secrets.GITHUB_TOKEN }}"
           CR_RELEASE_NAME_TEMPLATE: "{{ .Name }}-chart-{{ .Version }}"
diff --git a/Tiltfile b/Tiltfile
@@ -9,24 +9,24 @@ kubectl_cmd = "kubectl"
 if str(local("command -v " + kubectl_cmd + " || true", quiet = True)) == "":
     fail("Required command '" + kubectl_cmd + "' not found in PATH")
 
-# Create the kwasm namespace
+# Create the rcm namespace
 # This is required since the helm() function doesn't support the create_namespace flag
 load('ext://namespace', 'namespace_create')
-namespace_create('kwasm')
+namespace_create('rcm')
 
-# Install kwasm-operator helm chart
+# Install runtime-class-manager helm chart
 install = helm(
-    './charts/kwasm-operator/', 
-    name='kwasm-operator', 
-    namespace='kwasm', 
+    './deploy/helm',
+    name='runtime-class-manager',
+    namespace='rcm',
     set=['image.repository=' + settings.get('registry')]
 )
 
 objects = decode_yaml_stream(install)
 for o in objects:
     # Update the root security group. Tilt requires root access to update the
     # running process.
-    if o.get('kind') == 'Deployment' and o.get('metadata').get('name') == 'kwasm-operator':
+    if o.get('kind') == 'Deployment' and o.get('metadata').get('name') == 'runtime-class-manager':
         o['spec']['template']['spec']['securityContext']['runAsNonRoot'] = False
         # Disable the leader election to speed up the startup time.
         o['spec']['template']['spec']['containers'][0]['args'].remove('--leader-elect')

diff --git a/config/samples/test_shim_spin.yaml b/config/samples/test_shim_spin.yaml
@@ -15,11 +15,13 @@ spec:
   fetchStrategy:
     type: anonymousHttp
     anonHttp:
-      location: "https://github.com/spinkube/containerd-shim-spin/releases/download/v0.14.1/containerd-shim-spin-v2-linux-aarch64.tar.gz"
+      location: "https://github.com/spinkube/containerd-shim-spin/releases/download/v0.15.1/containerd-shim-spin-v2-linux-aarch64.tar.gz"
 
   runtimeClass:
-    name: spin-v2
-    handler: spin
+    # Note: this name is used by the Spin Operator project as its default:
+    # https://github.com/spinkube/spin-operator/blob/main/config/samples/spin-shim-executor.yaml
+    name: wasmtime-spin-v2
+    handler: spin-v2
 
   rolloutStrategy:
     type: recreate
diff --git a/deploy/helm/.helmignore b/deploy/helm/.helmignore
@@ -0,0 +1,23 @@
+# Patterns to ignore when building packages.
+# This supports shell glob matching, relative path matching, and
+# negation (prefixed with !). Only one pattern per line.
+.DS_Store
+# Common VCS dirs
+.git/
+.gitignore
+.bzr/
+.bzrignore
+.hg/
+.hgignore
+.svn/
+# Common backup files
+*.swp
+*.bak
+*.tmp
+*.orig
+*~
+# Various IDEs
+.project
+.idea/
+*.tmproj
+.vscode/
diff --git a/deploy/helm/Chart.yaml b/deploy/helm/Chart.yaml
@@ -0,0 +1,24 @@
+apiVersion: v2
+name: runtime-class-manager
+description: A Helm chart for Kubernetes
+
+# A chart can be either an 'application' or a 'library' chart.
+#
+# Application charts are a collection of templates that can be packaged into versioned archives
+# to be deployed.
+#
+# Library charts provide useful utilities or functions for the chart developer. They're included as
+# a dependency of application charts to inject those utilities and functions into the rendering
+# pipeline. Library charts do not define any templates and therefore cannot be deployed.
+type: application
+
+# This is the chart version. This version number should be incremented each time you make changes
+# to the chart and its templates, including the app version.
+# Versions are expected to follow Semantic Versioning (https://semver.org/)
+version: 0.1.0
+
+# This is the version number of the application being deployed. This version number should be
+# incremented each time you make changes to the application. Versions are not expected to
+# follow Semantic Versioning. They should reflect the version the application is using.
+# It is recommended to use it with quotes.
+appVersion: "1.16.0"
diff --git a/deploy/helm/README.md b/deploy/helm/README.md
@@ -0,0 +1,40 @@
+# runtime-class-manager
+
+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).
+
+## Prerequisites
+
+- [Kubernetes v1.20+](https://kubernetes.io/docs/setup/)
+- [Helm v3](https://helm.sh/docs/intro/install/)
+
+## Installing the chart
+
+The following installs the runtime-class-manager chart with the release name `rcm`:
+
+```shell
+helm upgrade --install \
+  --namespace rcm \
+  --create-namespace \
+  --wait \
+  rcm .
+```
+
+## Post-installation
+
+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/).
+
+> Note: Ensure that the `location` for the specified shim binary points to the correct architecture for your Node(s)
+
+For example, here we install the Spin shim:
+
+```shell
+kubectl apply -f ../../config/samples/test_shim_spin.yaml
+```
+
+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:
+
+```shell
+kubectl label node --all spin=true
+```
+
+You are now ready to deploy your Wasm workloads.
diff --git a/deploy/helm/crds/runtime.kwasm.sh_shims.yaml b/deploy/helm/crds/runtime.kwasm.sh_shims.yaml
@@ -0,0 +1,180 @@
+---
+apiVersion: apiextensions.k8s.io/v1
+kind: CustomResourceDefinition
+metadata:
+  annotations:
+    controller-gen.kubebuilder.io/version: v0.13.0
+  name: shims.runtime.kwasm.sh
+spec:
+  group: runtime.kwasm.sh
+  names:
+    kind: Shim
+    listKind: ShimList
+    plural: shims
+    singular: shim
+  scope: Cluster
+  versions:
+  - additionalPrinterColumns:
+    - jsonPath: .spec.runtimeClass.name
+      name: RuntimeClass
+      type: string
+    - jsonPath: .status.nodesReady
+      name: Ready
+      type: integer
+    - jsonPath: .status.nodes
+      name: Nodes
+      type: integer
+    name: v1alpha1
+    schema:
+      openAPIV3Schema:
+        description: Shim is the Schema for the shims API
+        properties:
+          apiVersion:
+            description: 'APIVersion defines the versioned schema of this representation
+              of an object. Servers should convert recognized schemas to the latest
+              internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources'
+            type: string
+          kind:
+            description: 'Kind is a string value representing the REST resource this
+              object represents. Servers may infer this from the endpoint the client
+              submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
+            type: string
+          metadata:
+            type: object
+          spec:
+            description: ShimSpec defines the desired state of Shim
+            properties:
+              fetchStrategy:
+                properties:
+                  anonHttp:
+                    properties:
+                      location:
+                        type: string
+                    required:
+                    - location
+                    type: object
+                  type:
+                    type: string
+                required:
+                - anonHttp
+                - type
+                type: object
+              nodeSelector:
+                additionalProperties:
+                  type: string
+                type: object
+              rolloutStrategy:
+                properties:
+                  rolling:
+                    properties:
+                      maxUpdate:
+                        type: integer
+                    required:
+                    - maxUpdate
+                    type: object
+                  type:
+                    enum:
+                    - rolling
+                    - recreate
+                    type: string
+                required:
+                - type
+                type: object
+              runtimeClass:
+                properties:
+                  handler:
+                    type: string
+                  name:
+                    type: string
+                required:
+                - handler
+                - name
+                type: object
+            required:
+            - fetchStrategy
+            - rolloutStrategy
+            - runtimeClass
+            type: object
+          status:
+            description: ShimStatus defines the observed state of Shim
+            properties:
+              conditions:
+                items:
+                  description: "Condition contains details for one aspect of the current
+                    state of this API Resource. --- This struct is intended for direct
+                    use as an array at the field path .status.conditions.  For example,
+                    \n type FooStatus struct{ // Represents the observations of a
+                    foo's current state. // Known .status.conditions.type are: \"Available\",
+                    \"Progressing\", and \"Degraded\" // +patchMergeKey=type // +patchStrategy=merge
+                    // +listType=map // +listMapKey=type Conditions []metav1.Condition
+                    `json:\"conditions,omitempty\" patchStrategy:\"merge\" patchMergeKey:\"type\"
+                    protobuf:\"bytes,1,rep,name=conditions\"` \n // other fields }"
+                  properties:
+                    lastTransitionTime:
+                      description: lastTransitionTime is the last time the condition
+                        transitioned from one status to another. This should be when
+                        the underlying condition changed.  If that is not known, then
+                        using the time when the API field changed is acceptable.
+                      format: date-time
+                      type: string
+                    message:
+                      description: message is a human readable message indicating
+                        details about the transition. This may be an empty string.
+                      maxLength: 32768
+                      type: string
+                    observedGeneration:
+                      description: observedGeneration represents the .metadata.generation
+                        that the condition was set based upon. For instance, if .metadata.generation
+                        is currently 12, but the .status.conditions[x].observedGeneration
+                        is 9, the condition is out of date with respect to the current
+                        state of the instance.
+                      format: int64
+                      minimum: 0
+                      type: integer
+                    reason:
+                      description: reason contains a programmatic identifier indicating
+                        the reason for the condition's last transition. Producers
+                        of specific condition types may define expected values and
+                        meanings for this field, and whether the values are considered
+                        a guaranteed API. The value should be a CamelCase string.
+                        This field may not be empty.
+                      maxLength: 1024
+                      minLength: 1
+                      pattern: ^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$
+                      type: string
+                    status:
+                      description: status of the condition, one of True, False, Unknown.
+                      enum:
+                      - "True"
+                      - "False"
+                      - Unknown
+                      type: string
+                    type:
+                      description: type of condition in CamelCase or in foo.example.com/CamelCase.
+                        --- Many .condition.type values are consistent across resources
+                        like Available, but because arbitrary conditions can be useful
+                        (see .node.status.conditions), the ability to deconflict is
+                        important. The regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt)
+                      maxLength: 316
+                      pattern: ^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$
+                      type: string
+                  required:
+                  - lastTransitionTime
+                  - message
+                  - reason
+                  - status
+                  - type
+                  type: object
+                type: array
+              nodes:
+                type: integer
+              nodesReady:
+                type: integer
+            required:
+            - nodes
+            - nodesReady
+            type: object
+        type: object
+    served: true
+    storage: true
+    subresources: {}
diff --git a/deploy/helm/templates/NOTES.txt b/deploy/helm/templates/NOTES.txt
@@ -0,0 +1,21 @@
+Welcome to Runtime-Class-Manager.
+
+Next steps:
+
+Create one or more Wasm Shim custom resources. See the samples in https://github.com/spinkube/runtime-class-manager/tree/main/config/samples.
+
+> Note: Ensure that the `location` for the specified shim binary points to the correct architecture for your Node(s)
+
+For example, install the Spin shim:
+
+```shell
+kubectl apply -f https://raw.githubusercontent.com/spinkube/runtime-class-manager/refs/heads/main/config/samples/test_shim_spin.yaml
+```
+
+Next, 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:
+
+```shell
+kubectl label node --all spin=true
+```
+
+You are now ready to deploy your Wasm workloads.