Skip to content

Commit f961bed

Browse files
kate-goldenringkate-goldenring
committed
Move compatibility matrix to a separate page
Signed-off-by: Kate Goldenring <[email protected]>
1 parent e93aed2 commit f961bed

File tree

2 files changed

+29
-21
lines changed

2 files changed

+29
-21
lines changed

‎content/en/docs/install/_index.md‎

Lines changed: 0 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -3,22 +3,3 @@ title: Installation
33
description: Before you can use SpinKube, you'll need to get it installed. We have several complete installation guides that covers all the possibilities; these guides will guide you through the process of installing SpinKube on your Kubernetes cluster.
44
weight: 20
55
---
6-
7-
## SpinKube Project Compatibility Matrix
8-
9-
All versions are backwards compatible, so using a new Spin Operator on an older Spin containerd shim should not break the execution of an application; however, not all new features added to the `SpinApp` custom resource may be available to the shim. For example, OTEL support for monitoring Spin applications was added to the shim in `v0.15.0` and the ability to pipe OpenTelemetry parameters to the shim from a `SpinApp` was added in the Spin Operator `v0.3.0`. This means that people using the `v0.3.0` operator with a shim version less than `v0.15.0` may expect OTEL to be configured for their Spin app.
10-
11-
## Spin Operator and Shim Feature Map
12-
13-
At time, features are added to the Spin Runtime that are added to the shim and can be enabled through the Spin Operator.
14-
15-
| Feature | SpinApp field | Shim Version | Spin Operator Version | `spin kube` plugin version |
16-
| -- | -- | -- | -- |
17-
| OTEL Traces | `otel` | v0.15.0 | v0.3.0 | NA |
18-
| Selective Deployment | `components` | v0.17.0 | v0.4.0 | v0.4.0 |
19-
20-
## Shim and Spin Version Map
21-
22-
| **shim version** | v0.12.0 | v0.13.0 | v0.14.0 | v0.14.1 | v0.15.0 | v0.15.1 | v0.16.0 |
23-
|------------------|---------------------------------------------------------------|---------------------------------------------------------------|---------------------------------------------------------------|---------------------------------------------------------------|---------------------------------------------------------------|---------------------------------------------------------------|---------------------------------------------------------------|
24-
| **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) |

‎content/en/docs/reference/shim-spin-version-map.md‎ renamed to ‎content/en/docs/install/compatibility-matrices.md‎

Lines changed: 29 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,35 @@
11
---
2-
title: Shim and Spin Version Map
3-
description: A table of the shims and the the most recent versions of the shims that are supported by this project.
2+
title: Executor Compatibility Matrices
3+
description: A set of compatibility matrices for each SpinKube executor
4+
date: 2024-10-31
5+
categories: [Spin Operator]
6+
tags: [reference]
47
---
58

9+
## `containerd-shim-spin` Executor
10+
11+
The [Spin containerd shim](https://github.com/spinkube/containerd-shim-spin) project is a containerd shim implementation for Spin.
12+
13+
### Spin Operator and Shim Feature Map
14+
15+
If a feature is configured in a `SpinApp` that is not supported in the version of the shim being
16+
used, the application may not execute as expected. The following maps out the versions of the [Spin
17+
containerd shim](https://github.com/spinkube/containerd-shim-spin), Spin Operator, and `spin kube`
18+
plugin that have support for specific features.
19+
20+
| Feature | SpinApp field | Shim Version | Spin Operator Version | `spin kube` plugin version |
21+
| -- | -- | -- | -- | -- |
22+
| OTEL Traces | `otel` | v0.15.0 | v0.3.0 | NA |
23+
| Selective Deployment | `components` | v0.17.0 | v0.4.0 | v0.3.0 |
24+
25+
> NA indicates that the feature in not available yet in that project
26+
27+
### Spin and Spin Containerd Shim Version Map
28+
29+
For tracking the availability of Spin features and compatibility of Spin SDKs, the following
30+
indicates which versions of the Spin runtime the [Spin containerd
31+
shim](https://github.com/spinkube/containerd-shim-spin) uses.
32+
633
| **shim version** | v0.12.0 | v0.13.0 | v0.14.0 | v0.14.1 | v0.15.0 | v0.15.1 | v0.16.0 |
734
|------------------|---------------------------------------------------------------|---------------------------------------------------------------|---------------------------------------------------------------|---------------------------------------------------------------|---------------------------------------------------------------|---------------------------------------------------------------|---------------------------------------------------------------|
835
| **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) |

0 commit comments

Comments
 (0)