From e93aed2d5b30d2c220289572acc80b3dc4e4a448 Mon Sep 17 00:00:00 2001 From: Kate Goldenring Date: Wed, 30 Oct 2024 08:00:34 -0700 Subject: [PATCH 1/2] Add SpinKube projects feature map Signed-off-by: Kate Goldenring --- content/en/docs/install/_index.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/content/en/docs/install/_index.md b/content/en/docs/install/_index.md index fa83b554..40b043b9 100644 --- a/content/en/docs/install/_index.md +++ b/content/en/docs/install/_index.md @@ -3,3 +3,22 @@ title: Installation 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. weight: 20 --- + +## SpinKube Project Compatibility Matrix + +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. + +## Spin Operator and Shim Feature Map + +At time, features are added to the Spin Runtime that are added to the shim and can be enabled through the Spin Operator. + +| 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.4.0 | + +## Shim and Spin Version Map + +| **shim version** | v0.12.0 | v0.13.0 | v0.14.0 | v0.14.1 | v0.15.0 | v0.15.1 | v0.16.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) | From f961bedce10483f62edb802f1a14433d0063f236 Mon Sep 17 00:00:00 2001 From: Kate Goldenring Date: Thu, 31 Oct 2024 14:13:19 -0700 Subject: [PATCH 2/2] Move compatibility matrix to a separate page Signed-off-by: Kate Goldenring --- content/en/docs/install/_index.md | 19 ------------ .../compatibility-matrices.md} | 31 +++++++++++++++++-- 2 files changed, 29 insertions(+), 21 deletions(-) rename content/en/docs/{reference/shim-spin-version-map.md => install/compatibility-matrices.md} (52%) diff --git a/content/en/docs/install/_index.md b/content/en/docs/install/_index.md index 40b043b9..fa83b554 100644 --- a/content/en/docs/install/_index.md +++ b/content/en/docs/install/_index.md @@ -3,22 +3,3 @@ title: Installation 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. weight: 20 --- - -## SpinKube Project Compatibility Matrix - -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. - -## Spin Operator and Shim Feature Map - -At time, features are added to the Spin Runtime that are added to the shim and can be enabled through the Spin Operator. - -| 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.4.0 | - -## Shim and Spin Version Map - -| **shim version** | v0.12.0 | v0.13.0 | v0.14.0 | v0.14.1 | v0.15.0 | v0.15.1 | v0.16.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) | diff --git a/content/en/docs/reference/shim-spin-version-map.md b/content/en/docs/install/compatibility-matrices.md similarity index 52% rename from content/en/docs/reference/shim-spin-version-map.md rename to content/en/docs/install/compatibility-matrices.md index 21456e95..f1255626 100644 --- a/content/en/docs/reference/shim-spin-version-map.md +++ b/content/en/docs/install/compatibility-matrices.md @@ -1,8 +1,35 @@ --- -title: Shim and Spin Version Map -description: A table of the shims and the the most recent versions of the shims that are supported by this project. +title: Executor Compatibility Matrices +description: A set of compatibility matrices for each SpinKube executor +date: 2024-10-31 +categories: [Spin Operator] +tags: [reference] --- +## `containerd-shim-spin` Executor + +The [Spin containerd shim](https://github.com/spinkube/containerd-shim-spin) project is a containerd shim implementation for Spin. + +### Spin Operator and Shim Feature Map + +If a feature is configured in a `SpinApp` that is not supported in the version of the shim being +used, the application may not execute as expected. The following maps out the versions of the [Spin +containerd shim](https://github.com/spinkube/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 | + +> NA indicates that the feature in not available yet in that project + +### Spin and Spin Containerd Shim Version Map + +For tracking the availability of Spin features and compatibility of Spin SDKs, the following +indicates which versions of the Spin runtime the [Spin containerd +shim](https://github.com/spinkube/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 | |------------------|---------------------------------------------------------------|---------------------------------------------------------------|---------------------------------------------------------------|---------------------------------------------------------------|---------------------------------------------------------------|---------------------------------------------------------------|---------------------------------------------------------------| | **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) |