containerd-shim-spin - GitLite

KO | EN

gitlite — search

#javascript #hacktoberfest #react #ai #llm #golang #android #machine-learning #nodejs #macos #cli #pytorch #ios #open-source

containerd-shim-spin

(★ 138)

A containerd shim for running Spin Applications.

파일 탐색기

최종 버전 다운로드 (.zip)

- config.toml
- bootstrap.sh
- devcontainer.json
- - action-build.yaml
  - action-check.yml
  - action-docker-build-push.yaml
  - action-node-installer.yaml
  - action-test.yml
  - ci.yaml
  - release.yaml
- CODEOWNERS
- dependabot.yml
- - main.rs
- Cargo.toml
- README.md
- - constants.rs
  - engine.rs
  - main.rs
  - source.rs
  - trigger.rs
  - utils.rs
- Cargo.toml
- quickstart.md
- Dockerfile
- - all-in-one-demo.yaml
- - Dockerfile
  - DockerSetup.md
  - README.md
- - runtime.yaml
  - workload.yaml
- README.md
- - Cargo.lock
  - Cargo.toml
  - Dockerfile
  - spin.toml
- - .dockerignore
  - .gitignore
  - Cargo.lock
  - Cargo.toml
  - deploy.yaml
  - Dockerfile
  - README.md
  - spin.toml
- - Cargo.lock
  - Cargo.toml
  - Dockerfile
  - runtime-config.toml
  - spin.toml
- - .gitignore
  - Cargo.lock
  - Cargo.toml
  - Dockerfile
  - README
  - spin.toml
- - Dockerfile
  - spin.toml
- - Cargo.lock
  - Cargo.toml
  - Dockerfile
  - spin.toml
- - Dockerfile
  - spin.toml
- - .gitignore
  - Dockerfile
  - Handler.cs
  - Project.csproj
  - spin.toml
- .gitignore
- - installer.sh
- - Dockerfile.minikube-custom
  - integration-test-k3s.sh
  - integration-test-kind.sh
  - integration-test-microk8s.sh
  - integration-test-minikube.sh
- Dockerfile
- Makefile
- README.md
- check-bins.sh
- collect-debug-logs.sh
- deploy-workloads.sh
- down.sh
- extract-changelog.sh
- free-disk.sh
- generate-shim-resource.sh
- move-bins.sh
- pod-status-check.sh
- pod-terminates-test.sh
- run-integration-tests.sh
- setup-linux.sh
- teardown-workloads.sh
- up.sh
- version.sh
- - docker-integration-test.sh
  - Dockerfile.dind-containerd-spin-shim
- - integration_test.rs
  - lib.rs
- - mqtt-broker.yaml
  - redis-conf.yaml
  - redis-pod.yaml
  - runtime.yaml
  - spin-runtime-config.yaml
- - README.md
  - workloads.yaml
- - README.md
  - workloads.yaml
- - README.md
  - workloads.yaml
- Cargo.toml
- README.md
.dockerignore
.gitignore
Cargo.lock
Cargo.toml
CHANGELOG.md
Cross.toml
LICENSE
Makefile
README.md
release.md
rust-toolchain.toml
rustfmt.toml
SECURITY.md

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Containerd Shim Spin

This project aims to provide the [containerd shim](https://github.com/containerd/containerd/blob/main/core/runtime/v2/README.md#runtime-shim) implementation for [Spin](https://developer.fermyon.com/spin), which enables running Spin workloads on Kubernetes via [runwasi](https://github.com/deislabs/runwasi). This means that by installing this shim onto Kubernetes nodes, we can add a [runtime class](https://kubernetes.io/docs/concepts/containers/runtime-class/) to Kubernetes and schedule Spin workloads on those nodes. Your Spin apps can act just like container workloads!

[runwasi](https://github.com/deislabs/runwasi) is a project that aims to run WASI workloads managed by [containerd](https://containerd.io/).

## Table of Contents

- [Shim and Spin Version Map](#shim-and-spin-version-map)
- [Documentation](#documentation)
- [Building and running the shim on host](#building-and-running-the-containerd-shim-spin-on-host)
- [Installing the shim on Kubernetes Nodes](#installing-the-containerd-shim-spin-on-kubernetes-nodes)
- [Locating build artifacts](#locating-build-artifacts)
- [Feedback](#feedback)
- [Contributing](#contributing)

## Shim and Spin Version Map

Below is a table for referencing the version of the Spin runtime used in each `containerd-shim-spin` release.

| **shim version** | v0.12.0                                                       | v0.13.0                                                       | v0.14.0                                                       | v0.14.1                                                       | v0.15.0                                                       | v0.15.1                                                       | v0.16.0                                                       | v0.17.0                                                       | v0.18.0                                                       | v0.19.0                                                       | v0.20.0                                                       | v0.21.0                                                       | v0.22.0                                                       | v0.23.0                                                       | v0.24.0   | v0.25.0     | v0.25.1 |                                               
|----|------------------|---------------------------------------------------------------|---------------------------------------------------------------|---------------------------------------------------------------|---------------------------------------------------------------|---------------------------------------------------------------|---------------------------------------------------------------|---------------------------------------------------------------|---------------------------------------------------------------|---------------------------------------------------------------|---------------------------------------------------------------|---------------------------------------------------------------|---------------------------------------------------------------|---------------------------------------------------------------|---------------------------------------------------------------|---|---|
| **spin**         | [v2.2.0](https://github.com/fermyon/spin/releases/tag/v2.2.0) | [v2.3.1](https://github.com/fermyon/spin/releases/tag/v2.3.1) | [v2.4.2](https://github.com/fermyon/spin/releases/tag/v2.4.2) | [v2.4.3](https://github.com/fermyon/spin/releases/tag/v2.4.3) | [v2.6.0](https://github.com/fermyon/spin/releases/tag/v2.6.0) | [v2.6.0](https://github.com/fermyon/spin/releases/tag/v2.6.0) | [v2.6.0](https://github.com/fermyon/spin/releases/tag/v2.6.0) | [v3.0.0](https://github.com/fermyon/spin/releases/tag/v3.0.0) | [v3.1.2](https://github.com/fermyon/spin/releases/tag/v3.1.2) | [v3.2.0](https://github.com/fermyon/spin/releases/tag/v3.2.0) | [v3.3.1](https://github.com/fermyon/spin/releases/tag/v3.3.1) | [v3.4.0](https://github.com/fermyon/spin/releases/tag/v3.4.0) | [v3.5.0](https://github.com/fermyon/spin/releases/tag/v3.5.0) | [v3.6.2](https://github.com/spinframework/spin/releases/tag/v3.6.2) | [v3.6.3](https://github.com/spinframework/spin/releases/tag/v3.6.3) | [v4.0.1](https://github.com/spinframework/spin/releases/tag/v4.0.1) | [v4.0.1](https://github.com/spinframework/spin/releases/tag/v4.0.1) |

## Documentation

To learn more about the Containerd Shim Spin, please visit [the official Containerd Shim Spin documentation](https://www.spinkube.dev/docs/topics/architecture/#containerd-shim-spin).

## Building and running the `containerd-shim-spin` on host

Make sure you have installed dependencies:
```bash
make setup # setup linux environment
```

Build, install, and run the shim binary:

```bash
make run # run the shim binary
```

You may open another terminal and run the following command to test the shim:
```bash
curl 0.0.0.0:80/hello
```

## Installing the `containerd-shim-spin` on Kubernetes Nodes

In order to run Spin applications on your cluster, you must complete the following three steps:

1. Install the shim on each Node that should support Spin apps
2. Update the containerd configuration to recognize the shim
3. Apply the Kubernetes `RuntimeClass` for the shim

Repeating these steps for each node on a cluster can be a time-consuming and manual process. For this reason, SpinKube provides a [`runtime-class-manager`](https://www.spinkube.dev/docs/topics/architecture/#runtime-class-manager) (previously the `kwasm` operator) that automates all of the steps. See the [SpinKube installation guide](https://www.spinkube.dev/docs/install/installing-with-helm/) for more information on installing with Helm.

To carry out the installation step-by-step, do the following:

1. Install the shim on each Node that should support Spin apps

Install a [release of the shim](https://github.com/spinkube/containerd-shim-spin/releases) on the `PATH` of your Kubernetes worker nodes. For example, copy `containerd-shim-spin-v2` to `/bin`. Shims are additive, so once the `containerd-shim-spin` is installed on a Node, it can support Spin WebAssembly apps alongside Linux containers.

2. Add the following to the containerd `config.toml` that maps the runtime type to the shim binary from step 1.

If you are using containerd 2 or later, add:

```toml
    [plugins."io.containerd.cri.v1.runtime".containerd.runtimes.spin]
      runtime_type = "io.containerd.spin.v2"
    [plugins."io.containerd.cri.v1.runtime".containerd.runtimes.spin.options]
      SystemdCgroup = true
    ```

Otherwise, add:

```toml
    [plugins."io.containerd.grpc.v1.cri".containerd.runtimes.spin]
      runtime_type = "io.containerd.spin.v2"
    [plugins."io.containerd.grpc.v1.cri".containerd.runtimes.spin.options]
      SystemdCgroup = true
    ```

The deprecated [Node Installer script](./node-installer/script/installer.sh) that was used by the [`kwasm-operator`](https://github.com/kwasm/kwasm-operator) (now superseded by [`runtime-class-manager`](https://www.spinkube.dev/docs/topics/architecture/#runtime-class-manager) which has its own installation logic) is a good reference to understand the common paths to the containerd configuration file for popular Kubernetes distributions.

3. Apply a runtime class that contains a handler that matches the "spin" config runtime name from step 2.

This ensures that the image is executed with the correct runtime, namely the `containerd-shim-spin`.

> Note: You likely want to customize the Runtime Class with a [`nodeSelector`](https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#nodeselector) to ensure Pods are only scheduled to Nodes where the shim has been installed.

```yaml
    apiVersion: node.k8s.io/v1
    handler: spin
    kind: RuntimeClass
    metadata:
      name: wasmtime-spin-v2
    ```

4. Deploy a Spin app to your cluster with the specified `RuntimeClass` name matching the "wasmtime-spin-v2" runtime class from step 3. The [Spin Operator](../spin-operator/_index.md) does this for you, translating `SpinApp` custom resources into Kubernetes deployments.

```yaml
    apiVersion: apps/v1
    kind: Deployment
    metadata:
      name: wasm-spin
    spec:
      replicas: 1
      selector:
        matchLabels:
          app: wasm-spin
      template:
        metadata:
          labels:
            app: wasm-spin
        spec:
          runtimeClassName: wasmtime-spin-v2
          containers:
            - name: spin-hello
              image: ghcr.io/spinframework/containerd-shim-spin/examples/spin-rust-hello:v0.20.0
              command: ["/"]
    ```

## Locating build artifacts

### Versioned releases

A GitHub release is created for each versioned release with build artifacts attached, including shim binaries for all supported architectures. See the [Releases page](https://github.com/spinkube/containerd-shim-spin/releases) for the full listing.

In addition, container images for Kind, node-installer and example apps are published using the release version for their tags, eg [ghcr.io/spinkube/containerd-shim-spin:v0.15.1](https://github.com/spinkube/containerd-shim-spin/pkgs/container/containerd-shim-spin%2Fnode-installer/240852005?tag=v0.15.1). A listing of all images and their tags can be seen from the [packages page](https://github.com/orgs/spinkube/packages?repo_name=containerd-shim-spin).

### Canary builds

On every push to the `main` branch, the [release workflow](https://github.com/spinkube/containerd-shim-spin/actions/workflows/release.yaml) will run and attach shim binary artifacts once finished.

Container images for Kind, node-installer and example apps are also published, using a unique tag of the form `$(date +%Y%m%d-%H%M%S)-g$(git rev-parse --short HEAD)`. A listing of all images and their tags can be seen from the [packages page](https://github.com/orgs/spinkube/packages?repo_name=containerd-shim-spin).

### Branch builds

For every push to a feature branch with a corresponding PR, the [ci workflow](https://github.com/spinkube/containerd-shim-spin/actions/workflows/ci.yaml) will run and attach shim binary artifacts once finished.

If the feature branch is created from the origin repo, the [node-installer image](https://github.com/spinkube/containerd-shim-spin/pkgs/container/containerd-shim-spin%2Fnode-installer) will be published with a tag following the same convention as `main` builds. You can locate the tag corresponding to your branch via the commit string portion.

> Note: A node-installer image won't be pushed for feature branches on forks, as they don't have access to the credentials needed to publish to the ghcr.io container registry.

## Feedback

For questions or support, please visit our [Slack channel](https://cloud-native.slack.com/archives/C06PC7JA1EE): #spinkube.

## Contributing

If you would like to contribute, please visit this [contributing](https://www.spinkube.dev/docs/contrib/) page.