Skip to content

Commit a2b6a7b

Browse files
committed
switch from spinkube to spinframework
Signed-off-by: Matthew Fisher <[email protected]>
1 parent b3e0c0c commit a2b6a7b

File tree

21 files changed

+58
-58
lines changed

21 files changed

+58
-58
lines changed

content/en/_index.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,9 @@ deploying, and operating WebAssembly (Wasm) workloads in Kubernetes - resulting
1313

1414
{{% blocks/lead color="secondary" %}}
1515

16-
SpinKube combines the <a href="https://github.com/spinkube/spin-operator">Spin operator</a>, <a
17-
href="https://github.com/spinkube/containerd-shim-spin">containerd shim Spin</a>, and the <a
18-
href="https://github.com/spinkube/runtime-class-manager">runtime class manager</a> (formerly <a
16+
SpinKube combines the <a href="https://github.com/spinframework/spin-operator">Spin operator</a>, <a
17+
href="https://github.com/spinframework/containerd-shim-spin">containerd shim Spin</a>, and the <a
18+
href="https://github.com/spinframework/runtime-class-manager">runtime class manager</a> (formerly <a
1919
href="https://kwasm.sh/">KWasm</a>) open source projects with contributions from Microsoft, SUSE,
2020
Liquid Reply, and Fermyon. By running applications at the Wasm abstraction layer, SpinKube gives
2121
developers a more powerful, efficient and scalable way to optimize application delivery on
@@ -29,22 +29,22 @@ Kubernetes.
2929

3030
### Overview
3131

32-
[**Spin Operator**](https://github.com/spinkube/spin-operator/) is a Kubernetes operator that enables
32+
[**Spin Operator**](https://github.com/spinframework/spin-operator/) is a Kubernetes operator that enables
3333
deploying and running Spin applications in Kubernetes. It houses the SpinApp and SpinAppExecutor CRDs
3434
which are used for configuring the individual workloads and workload execution configuration such as
3535
runtime class. Spin Operator introduces a host of functionality such as resource-based scaling,
3636
event-driven scaling and much more.
3737

38-
[**Containerd Shim Spin**](https://github.com/spinkube/containerd-shim-spin) provides a shim for running Spin
38+
[**Containerd Shim Spin**](https://github.com/spinframework/containerd-shim-spin) provides a shim for running Spin
3939
workloads managed by containerd. The Spin workload uses this shim as a runtime class within Kubernetes enabling
4040
these workloads to function similarly to container workloads in Pods in Kubernetes.
4141

42-
[**Runtime Class Manager**](https://github.com/spinkube/runtime-class-manager) is an operator that
42+
[**Runtime Class Manager**](https://github.com/spinframework/runtime-class-manager) is an operator that
4343
automates and manages the lifecycle of containerd shims in a Kubernetes environment. This includes tasks
4444
like installation, update, removal, and configuration of shims, reducing manual errors and improving
4545
reliability in managing WebAssembly (Wasm) workloads and other containerd extensions.
4646

47-
[**Spin Kube Plugin**](https://github.com/spinkube/spin-plugin-kube) is a plugin for the [Spin](https://developer.fermyon.com/spin/v3/index) CLI
47+
[**Spin Kube Plugin**](https://github.com/spinframework/spin-plugin-kube) is a plugin for the [Spin](https://developer.fermyon.com/spin/v3/index) CLI
4848
that aims to ease the experience for scaffolding, deploying and inspecting Spin workloads in Kubernetes.
4949

5050
### Get Involved

content/en/about/index.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ SpinKube comprises the following open source projects.
1818

1919
<u>**Containerd Shim Spin**</u>
2020

21-
The [Containerd Shim Spin repository](https://github.com/spinkube/containerd-shim-spin) provides
21+
The [Containerd Shim Spin repository](https://github.com/spinframework/containerd-shim-spin) provides
2222
shim implementations for running WebAssembly ([Wasm](https://webassembly.org/)) / Wasm System
2323
Interface ([WASI](https://github.com/WebAssembly/WASI)) workloads using
2424
[runwasi](https://github.com/deislabs/runwasi) as a library, whereby workloads built using the [Spin
@@ -30,7 +30,7 @@ Kubernetes environment.
3030
<u>**Runtime Class Manager**</u>
3131

3232
The [Runtime Class Manager, also known as the Containerd Shim Lifecycle
33-
Operator](https://github.com/spinkube/runtime-class-manager), is designed to automate and manage the
33+
Operator](https://github.com/spinframework/runtime-class-manager), is designed to automate and manage the
3434
lifecycle of containerd shims in a Kubernetes environment. This includes tasks like installation,
3535
update, removal, and configuration of shims, reducing manual errors and improving reliability in
3636
managing WebAssembly (Wasm) workloads and other containerd extensions.
@@ -39,7 +39,7 @@ managing WebAssembly (Wasm) workloads and other containerd extensions.
3939

4040
<u>**Spin Plugin for Kubernetes**</u>
4141

42-
The [Spin plugin for Kubernetes](https://github.com/spinkube/spin-plugin-kube), known as `spin
42+
The [Spin plugin for Kubernetes](https://github.com/spinframework/spin-plugin-kube), known as `spin
4343
kube`, faciliates the translation of existing [Spin
4444
applications](https://developer.fermyon.com/spin) into the Kubernetes custom resource that will be
4545
deployed and managed on your cluster. This plugin works by taking your spin application manifest and
@@ -50,7 +50,7 @@ Kubernetes to manage and run Wasm workloads in a way similar to traditional cont
5050

5151
<u>**Spin Operator**</u>
5252

53-
The [Spin Operator](https://github.com/spinkube/spin-operator/) enables deploying Spin applications
53+
The [Spin Operator](https://github.com/spinframework/spin-operator/) enables deploying Spin applications
5454
to Kubernetes. The foundation of this project is built using the
5555
[kubebuilder](https://github.com/kubernetes-sigs/kubebuilder) framework. Spin Operator defines Spin
5656
App Custom Resource Definitions (CRDs). Spin Operator watches SpinApp Custom Resources e.g. Spin app

content/en/blog/community/spinkube-kind-rd/index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -226,16 +226,16 @@ the steps below will only include short descriptions:
226226
kubectl apply -f https://github.com/cert-manager/cert-manager/releases/download/v1.14.3/cert-manager.yaml
227227

228228
# Install the Runtime Class
229-
kubectl apply -f https://github.com/spinkube/spin-operator/releases/download/v0.1.0/spin-operator.runtime-class.yaml
229+
kubectl apply -f https://github.com/spinframework/spin-operator/releases/download/v0.1.0/spin-operator.runtime-class.yaml
230230

231231
# Install the CRD
232-
kubectl apply -f https://github.com/spinkube/spin-operator/releases/download/v0.1.0/spin-operator.crds.yaml
232+
kubectl apply -f https://github.com/spinframework/spin-operator/releases/download/v0.1.0/spin-operator.crds.yaml
233233

234234
# Deploy SpinKube
235235
helm install spin-operator --namespace spin-operator --create-namespace --version 0.1.0 --wait oci://ghcr.io/spinframework/charts/spin-operator
236236

237237
# Install the App Executor
238-
kubectl apply -f https://github.com/spinkube/spin-operator/releases/download/v0.1.0/spin-operator.shim-executor.yaml
238+
kubectl apply -f https://github.com/spinframework/spin-operator/releases/download/v0.1.0/spin-operator.shim-executor.yaml
239239
```
240240

241241
SpinKube is now deployed and you can run your first application as described below.

content/en/blog/news/first-post/index.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -85,9 +85,9 @@ Applications are primarily distributed as OCI Artifacts, rather than traditional
8585
meaning that you only ship your compiled application and its assets - without system dependencies.
8686

8787
To execute those applications we have a [runwasi](https://github.com/containerd/runwasi) based
88-
[containerd-shim-spin](https://github.com/spinkube/containerd-shim-spin/) that takes a Spin app,
88+
[containerd-shim-spin](https://github.com/spinframework/containerd-shim-spin/) that takes a Spin app,
8989
[pre-compiles it for the specific
90-
architecture](https://github.com/spinkube/containerd-shim-spin/pull/32) (caching the result in the
90+
architecture](https://github.com/spinframework/containerd-shim-spin/pull/32) (caching the result in the
9191
containerd content store), and is then ready to service requests with [sub-millisecond startup
9292
times](https://fermyon.github.io/spin-benchmarks/criterion/reports/spin-executor_sleep-1ms/index.html)
9393
- no matter how long your application has been sitting idle.
@@ -124,7 +124,7 @@ Or in practice:
124124
This leaves one major area that can be painful when deploying applications to Kubernetes today: the
125125
developer and deployment experience.
126126

127-
This is where [Spin][spin], [the `spin kube` plugin](https://github.com/spinkube/spin-plugin-kube),
127+
This is where [Spin][spin], [the `spin kube` plugin](https://github.com/spinframework/spin-plugin-kube),
128128
and [`spin-operator`][spin-operator] start to shine.
129129

130130
![Architecture diagram of the SpinKube project](spinkube-diagram.png)
@@ -161,9 +161,9 @@ kubectl apply -f app.yaml
161161
If you want to try things out yourself, the easiest way is to follow the [quickstart
162162
guide][quickstart] - we can’t wait to see what you build.
163163

164-
[spin-operator]: https://github.com/spinkube/spin-operator
165-
[containerd-shim-spin]: https://github.com/spinkube/containerd-shim-spin
166-
[runtime-class-manager]: https://github.com/spinkube/runtime-class-manager
164+
[spin-operator]: https://github.com/spinframework/spin-operator
165+
[containerd-shim-spin]: https://github.com/spinframework/containerd-shim-spin
166+
[runtime-class-manager]: https://github.com/spinframework/runtime-class-manager
167167
[spin]: https://github.com/fermyon/spin
168168
[quickstart]: https://www.spinkube.dev/docs/spin-operator/quickstart/
169169
[kwasm]: https://kwasm.sh/

content/en/blog/news/five-new-things/index.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,11 @@ resources:
1010
title: "Image #:counter"
1111
---
1212

13-
Since we publicly [released](/blog/2024/03/13/introducing-spinkube/) SpinKube in March we've been hard at work steadily making it better. Spin Operator [`v0.4.0`](https://github.com/spinkube/spin-operator/releases/tag/v0.4.0), Containerd shim for Spin [`v0.17.0`](https://github.com/spinkube/containerd-shim-spin/releases/tag/v0.17.0), and `spin kube` plugin [`v0.3.0`](https://github.com/spinkube/spin-plugin-kube/releases/tag/v0.3.0) have all just been released. To celebrate that, here's five new things in SpinKube you should know about.
13+
Since we publicly [released](/blog/2024/03/13/introducing-spinkube/) SpinKube in March we've been hard at work steadily making it better. Spin Operator [`v0.4.0`](https://github.com/spinframework/spin-operator/releases/tag/v0.4.0), Containerd shim for Spin [`v0.17.0`](https://github.com/spinframework/containerd-shim-spin/releases/tag/v0.17.0), and `spin kube` plugin [`v0.3.0`](https://github.com/spinframework/spin-plugin-kube/releases/tag/v0.3.0) have all just been released. To celebrate that, here's five new things in SpinKube you should know about.
1414

1515
## Selective Deployments
1616

17-
SpinKube now supports selectively deploying a subset of a Spin apps components. Consider this simple example Spin application (named salutation in the [example repo](https://github.com/spinkube/spin-operator/tree/main/apps/salutations)) composed of two HTTP-triggered components: `hello` and `goodbye`. In the newly added `components` field you can select which components you would like to be a part of the deployment. Here's an example of what the YAML for a selectively deployed app might look like:
17+
SpinKube now supports selectively deploying a subset of a Spin apps components. Consider this simple example Spin application (named salutation in the [example repo](https://github.com/spinframework/spin-operator/tree/main/apps/salutations)) composed of two HTTP-triggered components: `hello` and `goodbye`. In the newly added `components` field you can select which components you would like to be a part of the deployment. Here's an example of what the YAML for a selectively deployed app might look like:
1818

1919
```yaml
2020
apiVersion: core.spinkube.dev/v1alpha1
@@ -59,7 +59,7 @@ Now any Spin apps using this executor will send telemetry to the collector at `o
5959

6060
## MQTT Trigger Support
6161

62-
The Containerd Shim for Spin has added support for [MQTT triggers](https://github.com/spinkube/spin-trigger-mqtt). [MQTT](https://mqtt.org/) is a lightweight, publish-subscribe messaging protocol that enables devices to send and receive messages through a broker. It's used all over the place to enable Internet of Things (IoT) designs.
62+
The Containerd Shim for Spin has added support for [MQTT triggers](https://github.com/spinframework/spin-trigger-mqtt). [MQTT](https://mqtt.org/) is a lightweight, publish-subscribe messaging protocol that enables devices to send and receive messages through a broker. It's used all over the place to enable Internet of Things (IoT) designs.
6363

6464
If you want to learn more about how to use this new trigger checkout this [blog post](https://www.fermyon.com/blog/mqtt_trigger_spinkube) by Kate Goldenring.
6565

@@ -111,4 +111,4 @@ One more example of SpinKube's growing stability is the domain migration we've c
111111

112112
We hope this has gotten you as excited about SpinKube as we are. Stay tuned as we continue to make SpinKube better. If you'd like to get involved in the community we'd love to have you — check out our [community page](https://www.spinkube.dev/community/).
113113

114-
[^1]: This was also a great opportunity to exercise the [SKIP](https://github.com/spinkube/skips/tree/main/proposals/004-crd-domains) (SpinKube Improvement Proposal) process.
114+
[^1]: This was also a great opportunity to exercise the [SKIP](https://github.com/spinframework/skips/tree/main/proposals/004-crd-domains) (SpinKube Improvement Proposal) process.

content/en/docs/contrib/troubleshooting.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ might assist you with your work.
1111

1212
## SpinKube Support Policy
1313

14-
SpinKube provides support on a best-effort basis. For users who installed SpinKube manually following the documentation, please report issues in the [Spin Operator repository](https://github.com/spinframework/spin-operator/issues/new). For installations via the Azure Marketplace, please open an issue in the [Azure repository](https://github.com/spinkube/azure/issues/new) for assistance. If your issue is urgent, feel free to raise it in [Slack](https://cloud-native.slack.com/archives/C06PC7JA1EE).
14+
SpinKube provides support on a best-effort basis. For users who installed SpinKube manually following the documentation, please report issues in the [Spin Operator repository](https://github.com/spinframework/spin-operator/issues/new). For installations via the Azure Marketplace, please open an issue in the [Azure repository](https://github.com/spinframework/azure/issues/new) for assistance. If your issue is urgent, feel free to raise it in [Slack](https://cloud-native.slack.com/archives/C06PC7JA1EE).
1515

1616
## Failure downloading the Helm chart
1717

content/en/docs/contrib/writing-code.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ use to the widest audience.
2929
## Code of Conduct
3030

3131
As a contributor, you can help us keep the SpinKube community open and inclusive. Please read and
32-
follow our [Code of Conduct](https://github.com/spinkube/governance/blob/main/CODE_OF_CONDUCT.md).
32+
follow our [Code of Conduct](https://github.com/spinframework/governance/blob/main/CODE_OF_CONDUCT.md).
3333

3434
## Install git
3535

@@ -48,8 +48,8 @@ installed) by typing `git help` into the command line.
4848
SpinKube is hosted on GitHub, and you'll need a GitHub account to contribute. If you don't have one,
4949
you can sign up for free at [GitHub](https://github.com).
5050

51-
SpinKube's repositories are organized under the [spinkube GitHub
52-
organization](https://github.com/spinkube). Once you have an account, fork one of the repositories
51+
SpinKube's repositories are organized under the [spinframework GitHub
52+
organization](https://github.com/spinframework). Once you have an account, fork one of the repositories
5353
by visiting the repository's page and clicking "Fork" in the upper right corner.
5454

5555
Then, from the command line, clone your fork of the repository. For example, if you forked the

content/en/docs/install/compatibility-matrices.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,13 @@ tags: [reference]
88

99
## `containerd-shim-spin` Executor
1010

11-
The [Spin containerd shim](https://github.com/spinkube/containerd-shim-spin) project is a containerd shim implementation for Spin.
11+
The [Spin containerd shim](https://github.com/spinframework/containerd-shim-spin) project is a containerd shim implementation for Spin.
1212

1313
### Spin Operator and Shim Feature Map
1414

1515
If a feature is configured in a `SpinApp` that is not supported in the version of the shim being
1616
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`
17+
containerd shim](https://github.com/spinframework/containerd-shim-spin), Spin Operator, and `spin kube`
1818
plugin that have support for specific features.
1919

2020
| Feature | SpinApp field | Shim Version | Spin Operator Version | `spin kube` plugin version |
@@ -28,7 +28,7 @@ plugin that have support for specific features.
2828

2929
For tracking the availability of Spin features and compatibility of Spin SDKs, the following
3030
indicates which versions of the Spin runtime the [Spin containerd
31-
shim](https://github.com/spinkube/containerd-shim-spin) uses.
31+
shim](https://github.com/spinframework/containerd-shim-spin) uses.
3232

3333
| **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 |
3434
|------------------|---------------------------------------------------------------|---------------------------------------------------------------|---------------------------------------------------------------|---------------------------------------------------------------|---------------------------------------------------------------|---------------------------------------------------------------|---------------------------------------------------------------|---------------------------------------------------------------|-------------------------------|

content/en/docs/install/quickstart.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ For this Quickstart guide, you will need:
2525
### Set up Your Kubernetes Cluster
2626

2727
1. Create a Kubernetes cluster with a k3d image that includes the
28-
[containerd-shim-spin](https://github.com/spinkube/containerd-shim-spin) prerequisite already
28+
[containerd-shim-spin](https://github.com/spinframework/containerd-shim-spin) prerequisite already
2929
installed:
3030

3131
```console { data-plausible="copy-quick-create-k3d" }
@@ -47,7 +47,7 @@ kubectl wait --for=condition=available --timeout=300s deployment/cert-manager-we
4747
```
4848

4949
3. Apply the [Runtime
50-
Class](https://github.com/spinkube/spin-operator/blob/main/config/samples/spin-runtime-class.yaml)
50+
Class](https://github.com/spinframework/spin-operator/blob/main/config/samples/spin-runtime-class.yaml)
5151
used for scheduling Spin apps onto nodes running the shim:
5252

5353
> Note: In a production cluster you likely want to customize the Runtime Class with a `nodeSelector`

content/en/docs/install/spin-kube-plugin.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,5 +52,5 @@ installation is commonly used to test in-flight changes. For a user, installing
5252
Spin's plugin manager is better.
5353

5454
Please refer to the [spin-plugin-kube GitHub
55-
repository](https://github.com/spinkube/spin-plugin-kube) for instructions on how to compile the
55+
repository](https://github.com/spinframework/spin-plugin-kube) for instructions on how to compile the
5656
plugin from source.

0 commit comments

Comments
 (0)