Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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 CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# How to Contribute

We'd love to see contributions from you. Please visit the [contribution section](https://github.com/spinkube/documentation/blob/f4e640e7093f737e634b2a43ee2220ca7760570c/content/en/docs/contribution-guidelines/_index.md) for more information about contributing to individual SpinKube projects and overarching documentation.
We'd love to see contributions from you. Please visit the [contribution section](https://github.com/spinframework/spinkube-docs/blob/f4e640e7093f737e634b2a43ee2220ca7760570c/content/en/docs/contribution-guidelines/_index.md) for more information about contributing to individual SpinKube projects and overarching documentation.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# spinkube.dev

![Status badge: Deploy to Github Pages](https://github.com/spinkube/documentation/actions/workflows/deploy.yaml/badge.svg)
![Status badge: Deploy to Github Pages](https://github.com/spinframework/spinkube-docs/actions/workflows/deploy.yaml/badge.svg)

This project contains the source code for spinkube.dev.

Expand Down
14 changes: 7 additions & 7 deletions content/en/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,9 @@ deploying, and operating WebAssembly (Wasm) workloads in Kubernetes - resulting

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

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

### Overview

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

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

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

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

### Get Involved
Expand Down
8 changes: 4 additions & 4 deletions content/en/about/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ SpinKube comprises the following open source projects.

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

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

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

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

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

<u>**Spin Operator**</u>

The [Spin Operator](https://github.com/spinkube/spin-operator/) enables deploying Spin applications
The [Spin Operator](https://github.com/spinframework/spin-operator/) enables deploying Spin applications
to Kubernetes. The foundation of this project is built using the
[kubebuilder](https://github.com/kubernetes-sigs/kubebuilder) framework. Spin Operator defines Spin
App Custom Resource Definitions (CRDs). Spin Operator watches SpinApp Custom Resources e.g. Spin app
Expand Down
10 changes: 5 additions & 5 deletions content/en/blog/community/spinkube-kind-rd/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -226,16 +226,16 @@ the steps below will only include short descriptions:
kubectl apply -f https://github.com/cert-manager/cert-manager/releases/download/v1.14.3/cert-manager.yaml

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

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

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

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

SpinKube is now deployed and you can run your first application as described below.
Expand All @@ -246,7 +246,7 @@ Same as the SpinKube deployment, you can follow the quickstart:

```shell
# Deploy the application
kubectl apply -f https://raw.githubusercontent.com/spinkube/spin-operator/main/config/samples/simple.yaml
kubectl apply -f https://raw.githubusercontent.com/spinframework/spin-operator/main/config/samples/simple.yaml

# Port forwarding
kubectl port-forward svc/simple-spinapp 8083:80
Expand Down
12 changes: 6 additions & 6 deletions content/en/blog/news/first-post/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,9 +85,9 @@ Applications are primarily distributed as OCI Artifacts, rather than traditional
meaning that you only ship your compiled application and its assets - without system dependencies.

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

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

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

[spin-operator]: https://github.com/spinkube/spin-operator
[containerd-shim-spin]: https://github.com/spinkube/containerd-shim-spin
[runtime-class-manager]: https://github.com/spinkube/runtime-class-manager
[spin-operator]: https://github.com/spinframework/spin-operator
[containerd-shim-spin]: https://github.com/spinframework/containerd-shim-spin
[runtime-class-manager]: https://github.com/spinframework/runtime-class-manager
[spin]: https://github.com/fermyon/spin
[quickstart]: https://www.spinkube.dev/docs/spin-operator/quickstart/
[kwasm]: https://kwasm.sh/
8 changes: 4 additions & 4 deletions content/en/blog/news/five-new-things/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,11 @@ resources:
title: "Image #:counter"
---

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.
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.

## Selective Deployments

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:
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:

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

## MQTT Trigger Support

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.
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.

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.

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

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/).

[^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.
[^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.
20 changes: 10 additions & 10 deletions content/en/docs/contrib/troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,30 +11,30 @@ might assist you with your work.

## SpinKube Support Policy

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/spinkube/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).
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).

## Failure downloading the Helm chart

While the [Spin Operator Helm chart](https://github.com/spinkube/spin-operator/pkgs/container/charts%2Fspin-operator) is public and can be fetched anonymously, you may run into errors pulling the chart if you've previously authenticated with the ghcr.io registry but the authentication token has since expired.
While the [Spin Operator Helm chart](https://github.com/spinframework/spin-operator/pkgs/container/charts%2Fspin-operator) is public and can be fetched anonymously, you may run into errors pulling the chart if you've previously authenticated with the ghcr.io registry but the authentication token has since expired.

The error would look something like the following:

```console
helm install spin-operator \
--namespace spin-operator --create-namespace --version 0.4.0 --wait oci://ghcr.io/spinkube/charts/spin-operator
Error: INSTALLATION FAILED: failed to download "oci://ghcr.io/spinkube/charts/spin-operator" at version "0.4.0"
--namespace spin-operator --create-namespace --version 0.5.0 --wait oci://ghcr.io/spinframework/charts/spin-operator
Error: INSTALLATION FAILED: failed to download "oci://ghcr.io/spinframework/charts/spin-operator" at version "0.5.0"
```

To fix, either re-authenticate with the registry with a valid token (e.g. `docker login ghcr.io`) or log out of the registry and pull the chart anonymously (e.g. `docker logout ghcr.io`).

## No endpoints available for service "spin-operator-webhook-service"

When following the quickstart guide the following error can occur when running the `kubectl apply -f
https://github.com/spinkube/spin-operator/releases/download/v0.4.0/spin-operator.shim-executor.yaml`
https://github.com/spinframework/spin-operator/releases/download/v0.5.0/spin-operator.shim-executor.yaml`
command:

```console
Error from server (InternalError): error when creating "https://github.com/spinkube/spin-operator/releases/download/v0.4.0/spin-operator.shim-executor.yaml": Internal error occurred: failed calling webhook "mspinappexecutor.kb.io": failed to call webhook: Post "https://spin-operator-webhook-service.spin-operator.svc:443/mutate-core-spinkube-dev-v1alpha1-spinappexecutor?timeout=10s": no endpoints available for service "spin-operator-webhook-service"
Error from server (InternalError): error when creating "https://github.com/spinframework/spin-operator/releases/download/v0.5.0/spin-operator.shim-executor.yaml": Internal error occurred: failed calling webhook "mspinappexecutor.kb.io": failed to call webhook: Post "https://spin-operator-webhook-service.spin-operator.svc:443/mutate-core-spinkube-dev-v1alpha1-spinappexecutor?timeout=10s": no endpoints available for service "spin-operator-webhook-service"
```

To address the error above, first look to see if Spin Operator is running:
Expand Down Expand Up @@ -80,13 +80,13 @@ To resolve this issue, please try to install the Spin Operator again. Except thi
helm upgrade --install spin-operator \
--namespace spin-operator \
--create-namespace \
--version 0.4.0 \
--version 0.5.0 \
--wait \
oci://ghcr.io/spinkube/charts/spin-operator
oci://ghcr.io/spinframework/charts/spin-operator
```

Once the Spin Operator is installed you can try and run the `kubectl apply -f
https://github.com/spinkube/spin-operator/releases/download/v0.4.0/spin-operator.shim-executor.yaml`
https://github.com/spinframework/spin-operator/releases/download/v0.5.0/spin-operator.shim-executor.yaml`
command again. The issue should be resolved now.

## Error Validating Data: Connection Refused
Expand Down Expand Up @@ -223,7 +223,7 @@ TEST SUITE: None
## error: requires go version

When building apps like the
[cpu-load-gen](https://github.com/spinkube/spin-operator/tree/main/apps/cpu-load-gen) Spin app, you
[cpu-load-gen](https://github.com/spinframework/spin-operator/tree/main/apps/cpu-load-gen) Spin app, you
may get the following error if your TinyGo is not up to date. The error requires go version `1.18`
through `1.20` but this is not necessarily the case. It **is** recommended that you have the latest
go installed e.g. `1.21` and downgrading is unnecessary. Instead please go ahead and [install the
Expand Down
Loading