Skip to content

Commit 0b20273

Browse files
committed
hard wrap at 100 characters
This conforms with SKIP 00x - Documenting Spinkube Signed-off-by: Matthew Fisher <[email protected]>
1 parent 2ececb0 commit 0b20273

26 files changed

+988
-541
lines changed

content/en/_index.md

Lines changed: 41 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -2,18 +2,23 @@
22
title: SpinKube
33
---
44

5-
{{< blocks/cover title="Hyper-efficient serverless on Kubernetes, powered by WebAssembly." image_anchor="top" height="full" >}}
6-
<a class="btn btn-lg btn-primary me-3 mb-4" href="/docs">
7-
Get Started <i class="fas fa-arrow-alt-circle-right ms-2"></i>
8-
</a>
5+
{{< blocks/cover title="Hyper-efficient serverless on Kubernetes, powered by WebAssembly."
6+
image_anchor="top" height="full" >}} <a class="btn btn-lg btn-primary me-3 mb-4" href="/docs"> Get
7+
Started <i class="fas fa-arrow-alt-circle-right ms-2"></i> </a>
98
<p class="lead mt-5">SpinKube is an open source project that streamlines developing, deploying and operating WebAssembly workloads in Kubernetes - resulting in delivering smaller, more portable applications and incredible compute performance benefits.</p>
109
{{< blocks/link-down color="info" >}}
1110
{{< /blocks/cover >}}
1211

1312

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

16-
SpinKube combines the <a href="https://github.com/spinkube/spin-operator">Spin operator</a>, <a href="https://github.com/spinkube/containerd-shim-spin">containerd Spin shim</a>, and the <a href="https://github.com/spinkube/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 Kubernetes.
15+
SpinKube combines the <a href="https://github.com/spinkube/spin-operator">Spin operator</a>, <a
16+
href="https://github.com/spinkube/containerd-shim-spin">containerd Spin shim</a>, and the <a
17+
href="https://github.com/spinkube/runtime-class-manager">runtime class manager</a> (formerly <a
18+
href="https://kwasm.sh/">KWasm</a>) open source projects with contributions from Microsoft, SUSE,
19+
Liquid Reply, and Fermyon. By running applications at the Wasm abstraction layer, SpinKube gives
20+
developers a more powerful, efficient and scalable way to optimize application delivery on
21+
Kubernetes.
1722

1823

1924
### Made with Contributions from:
@@ -23,19 +28,36 @@ SpinKube combines the <a href="https://github.com/spinkube/spin-operator">Spin o
2328

2429
### Overview
2530

26-
**Containerd Shim Spin**
27-
The [Containerd Shim Spin repository](https://github.com/spinkube/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 framework](https://github.com/fermyon/spin) can function similarly to container workloads in a Kubernetes environment.
28-
29-
**Runtime Class Manager**
30-
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 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.
31-
32-
**Spin Plugin for Kubernetes**
33-
The [Spin plugin for Kubernetes](https://github.com/spinkube/spin-plugin-kube) is designed to enhance Kubernetes by enabling the execution of Wasm modules directly within a Kubernetes cluster. This plugin works by integrating with containerd shims, allowing Kubernetes to manage and run Wasm workloads in a way similar to traditional container workloads.
34-
35-
**Spin Operator**
36-
The [Spin Operator](https://github.com/spinkube/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 image, replicas, schedulers and other user-defined values and realizes the desired state in the Kubernetes cluster. Spin Operator introduces a host of functionality such as resource-based scaling event-driven scaling and much more.
37-
38-
**Spin Trigger MQTT**
39-
[Spin Trigger MQTT](https://github.com/spinkube/spin-trigger-mqtt/) is an MQTT trigger designed specifically for Spin. It enables seamless integration between Spin and MQTT-based systems, allowing you to automate workflows and trigger actions based on MQTT messages.
31+
**Containerd Shim Spin** The [Containerd Shim Spin
32+
repository](https://github.com/spinkube/containerd-shim-spin) provides shim implementations for
33+
running WebAssembly ([Wasm](https://webassembly.org/)) / Wasm System Interface
34+
([WASI](https://github.com/WebAssembly/WASI)) workloads using
35+
[runwasi](https://github.com/deislabs/runwasi) as a library, whereby workloads built using the [Spin
36+
framework](https://github.com/fermyon/spin) can function similarly to container workloads in a
37+
Kubernetes environment.
38+
39+
**Runtime Class Manager** The [Runtime Class Manager, also known as the Containerd Shim Lifecycle
40+
Operator](https://github.com/spinkube/runtime-class-manager), is designed to automate and manage the
41+
lifecycle of containerd shims in a Kubernetes environment. This includes tasks like installation,
42+
update, removal, and configuration of shims, reducing manual errors and improving reliability in
43+
managing WebAssembly (Wasm) workloads and other containerd extensions.
44+
45+
**Spin Plugin for Kubernetes** The [Spin plugin for
46+
Kubernetes](https://github.com/spinkube/spin-plugin-kube) is designed to enhance Kubernetes by
47+
enabling the execution of Wasm modules directly within a Kubernetes cluster. This plugin works by
48+
integrating with containerd shims, allowing Kubernetes to manage and run Wasm workloads in a way
49+
similar to traditional container workloads.
50+
51+
**Spin Operator** The [Spin Operator](https://github.com/spinkube/spin-operator/) enables deploying
52+
Spin applications to Kubernetes. The foundation of this project is built using the
53+
[kubebuilder](https://github.com/kubernetes-sigs/kubebuilder) framework. Spin Operator defines Spin
54+
App Custom Resource Definitions (CRDs). Spin Operator watches SpinApp Custom Resources e.g. Spin app
55+
image, replicas, schedulers and other user-defined values and realizes the desired state in the
56+
Kubernetes cluster. Spin Operator introduces a host of functionality such as resource-based scaling
57+
event-driven scaling and much more.
58+
59+
**Spin Trigger MQTT** [Spin Trigger MQTT](https://github.com/spinkube/spin-trigger-mqtt/) is an MQTT
60+
trigger designed specifically for Spin. It enables seamless integration between Spin and MQTT-based
61+
systems, allowing you to automate workflows and trigger actions based on MQTT messages.
4062

4163
{{% /blocks/lead %}}

content/en/docs/_index.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -17,10 +17,11 @@ where to look for certain things.
1717

1818
- [Installation guides]({{< relref "install" >}}) cover how to install SpinKube on various
1919
platforms.
20-
- [Topic guides]({{< relref "topics" >}}) discuss key topics and concepts at a fairly high level and provide useful background
21-
information and explanation.
22-
- [Reference guides]({{< relref "reference" >}}) contain technical reference for APIs and other aspects of SpinKube's machinery.
23-
They describe how it works and how to use it but assume that you have a basic understanding of key
24-
concepts.
20+
- [Topic guides]({{< relref "topics" >}}) discuss key topics and concepts at a fairly high level and
21+
provide useful background information and explanation.
22+
- [Reference guides]({{< relref "reference" >}}) contain technical reference for APIs and other
23+
aspects of SpinKube's machinery. They describe how it works and how to use it but assume that you
24+
have a basic understanding of key concepts.
2525
- [Contributing guides]({{< relref "contrib" >}}) show how to contribute to the SpinKube project.
26-
- [Miscellaneous guides]({{< relref "misc" >}}) cover topics that don't fit neatly into either of the above categories.
26+
- [Miscellaneous guides]({{< relref "misc" >}}) cover topics that don't fit neatly into either of
27+
the above categories.

content/en/docs/contrib/troubleshooting.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -82,8 +82,8 @@ $ kubectl apply -f https://github.com/cert-manager/cert-manager/releases/downloa
8282
error: error validating "https://github.com/cert-manager/cert-manager/releases/download/v1.14.3/cert-manager.yaml": error validating data: failed to download openapi: Get "https://127.0.0.1:6443/openapi/v2?timeout=32s": dial tcp 127.0.0.1:6443: connect: connection refused; if you choose to ignore these errors, turn validation off with --validate=false
8383
```
8484

85-
This is because no cluster exists. You can create a cluster following the
86-
[Quickstart guide]({{< ref "quickstart" >}}).
85+
This is because no cluster exists. You can create a cluster following the [Quickstart guide]({{< ref
86+
"quickstart" >}}).
8787

8888
## Installation Failed
8989

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -161,4 +161,5 @@ See the guide on [writing documentation]({{< ref "writing-documentation" >}}) fo
161161
Congratulations! You've made a contribution to SpinKube.
162162

163163
After a pull request has been submitted, it needs to be reviewed by a maintainer. Reach out on the
164-
`#spinkube` channel on the [CNCF Slack](https://cloud-native.slack.com/archives/C06PC7JA1EE) to ask for a review.
164+
`#spinkube` channel on the [CNCF Slack](https://cloud-native.slack.com/archives/C06PC7JA1EE) to ask
165+
for a review.

0 commit comments

Comments
 (0)