Skip to content

chore: update docs for v0.19.0 shim release #283

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Apr 1, 2025
Merged

chore: update docs for v0.19.0 shim release #283

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d133f95
chore: update docs for v0.19.0 shim release
kate-goldenring Mar 31, 2025
0bb11fc
fix the shim version compatibility matrix
Mossaka Apr 1, 2025
6e5aedf
update compatibility matrix to a grid table
Mossaka Apr 1, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion content/en/docs/contrib/troubleshooting.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,7 @@ helm upgrade --install \
kwasm-operator kwasm/kwasm-operator \
--namespace kwasm \
--create-namespace \
--set kwasmOperator.installerImage=ghcr.io/spinkube/containerd-shim-spin/node-installer:v0.18.0
--set kwasmOperator.installerImage=ghcr.io/spinframework/containerd-shim-spin/node-installer:v0.19.0
```

## Cluster Already Exists
Expand Down
4 changes: 2 additions & 2 deletions content/en/docs/glossary.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ kind: SpinApp
metadata:
name: simple-spinapp
spec:
image: "ghcr.io/spinkube/containerd-shim-spin/examples/spin-rust-hello:v0.18.0"
image: "ghcr.io/spinframework/containerd-shim-spin/examples/spin-rust-hello:v0.19.0"
replicas: 1
executor: "containerd-shim-spin"
```
Expand All @@ -96,7 +96,7 @@ kind: SpinApp
metadata:
name: simple-spinapp
spec:
image: 'ghcr.io/spinkube/containerd-shim-spin/examples/spin-rust-hello:v0.18.0'
image: 'ghcr.io/spinframework/containerd-shim-spin/examples/spin-rust-hello:v0.19.0'
replicas: 3
imagePullSecrets:
- name: spin-image-secret
Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/install/azure-kubernetes-service.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,7 @@ helm install \
kwasm-operator kwasm/kwasm-operator \
--namespace kwasm \
--create-namespace \
--set kwasmOperator.installerImage=ghcr.io/spinkube/containerd-shim-spin/node-installer:v0.18.0
--set kwasmOperator.installerImage=ghcr.io/spinframework/containerd-shim-spin/node-installer:v0.19.0

# Provision Nodes
kubectl annotate node --all kwasm.sh/kwasm-node=true
Expand Down
14 changes: 7 additions & 7 deletions content/en/docs/install/compatibility-matrices.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,10 @@ used, the application may not execute as expected. The following maps out the ve
containerd shim](https://github.com/spinframework/containerd-shim-spin), Spin Operator, and `spin kube`
plugin that have support for specific features.

| Feature | SpinApp field | Shim Version | Spin Operator Version | `spin kube` plugin version |
| -- | -- | -- | -- | -- |
| OTEL Traces | `otel` | v0.15.0 | v0.3.0 | NA |
| Selective Deployment | `components` | v0.17.0 | v0.4.0 | v0.3.0 |
| Feature | SpinApp field | Shim Version | Spin Operator Version | `spin kube` plugin version |
| -------------------- | ------------- | ------------ | --------------------- | -------------------------- |
| OTEL Traces | `otel` | v0.15.0 | v0.3.0 | NA |
| Selective Deployment | `components` | v0.17.0 | v0.4.0 | v0.3.0 |

> NA indicates that the feature in not available yet in that project

Expand All @@ -30,6 +30,6 @@ For tracking the availability of Spin features and compatibility of Spin SDKs, t
indicates which versions of the Spin runtime the [Spin containerd
shim](https://github.com/spinframework/containerd-shim-spin) uses.

| **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 |
|------------------|---------------------------------------------------------------|---------------------------------------------------------------|---------------------------------------------------------------|---------------------------------------------------------------|---------------------------------------------------------------|---------------------------------------------------------------|---------------------------------------------------------------|---------------------------------------------------------------|-------------------------------|
| **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) |
| **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 |
Copy link
Member

@Mossaka Mossaka Apr 1, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

v0.19.0 is missing and this table does not render

Copy link
Member

@Mossaka Mossaka Apr 1, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've pushed a commit to update the table and make it more accessible.

| ---------------- | ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- |
| **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) |
2 changes: 1 addition & 1 deletion content/en/docs/install/installing-with-helm.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ helm install \
kwasm-operator kwasm/kwasm-operator \
--namespace kwasm \
--create-namespace \
--set kwasmOperator.installerImage=ghcr.io/spinkube/containerd-shim-spin/node-installer:v0.18.0
--set kwasmOperator.installerImage=ghcr.io/spinframework/containerd-shim-spin/node-installer:v0.19.0

# Provision Nodes
kubectl annotate node --all kwasm.sh/kwasm-node=true
Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/install/microk8s.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ We then need to install KWasm because it is not yet included with Microk8s:

```console { data-plausible="copy-quick-deploy-sample" }
$ microk8s helm repo add kwasm http://kwasm.sh/kwasm-operator/
$ microk8s helm install kwasm-operator kwasm/kwasm-operator --namespace kwasm --create-namespace --set kwasmOperator.installerImage=ghcr.io/spinkube/containerd-shim-spin/node-installer:v0.18.0
$ microk8s helm install kwasm-operator kwasm/kwasm-operator --namespace kwasm --create-namespace --set kwasmOperator.installerImage=ghcr.io/spinframework/containerd-shim-spin/node-installer:v0.19.0
$ microk8s kubectl annotate node --all kwasm.sh/kwasm-node=true

```
Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/install/quickstart.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ For this Quickstart guide, you will need:

```console { data-plausible="copy-quick-create-k3d" }
k3d cluster create wasm-cluster \
--image ghcr.io/spinkube/containerd-shim-spin/k3d:v0.18.0 \
--image ghcr.io/spinframework/containerd-shim-spin/k3d:v0.19.0 \
--port "8081:80@loadbalancer" \
--agents 2
```
Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/topics/autoscaling/scaling-with-hpa.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ you have a Kubernetes cluster already, please feel free to use it:

```console
k3d cluster create wasm-cluster-scale \
--image ghcr.io/spinkube/containerd-shim-spin/k3d:v0.18.0 \
--image ghcr.io/spinframework/containerd-shim-spin/k3d:v0.19.0 \
-p "8081:80@loadbalancer" \
--agents 2
```
Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/topics/autoscaling/scaling-with-keda.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ you have a Kubernetes cluster already, please feel free to use it:

```console
k3d cluster create wasm-cluster-scale \
--image ghcr.io/spinkube/containerd-shim-spin/k3d:v0.18.0 \
--image ghcr.io/spinframework/containerd-shim-spin/k3d:v0.19.0 \
-p "8081:80@loadbalancer" \
--agents 2
```
Expand Down