Skip to content

Commit

Permalink
Merge pull request spinkube#225 from spinkube/wrap-100-characters
Browse files Browse the repository at this point in the history
hard wrap at 100 characters
  • Loading branch information
bacongobbler committed Aug 19, 2024
2 parents 2ececb0 + 8bb77ec commit d8217e9
Show file tree
Hide file tree
Showing 31 changed files with 1,146 additions and 615 deletions.
5 changes: 5 additions & 0 deletions .vscode/extensions.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"recommendations": [
"stkb.rewrap"
]
}
3 changes: 2 additions & 1 deletion .vscode/settings.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
{
"rewrap.wrappingColumn": 100,
"cSpell.words": [
"SpinKube"
]
}
}
60 changes: 41 additions & 19 deletions content/en/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,23 @@
title: SpinKube
---

{{< blocks/cover title="Hyper-efficient serverless on Kubernetes, powered by WebAssembly." image_anchor="top" height="full" >}}
<a class="btn btn-lg btn-primary me-3 mb-4" href="/docs">
Get Started <i class="fas fa-arrow-alt-circle-right ms-2"></i>
</a>
{{< blocks/cover title="Hyper-efficient serverless on Kubernetes, powered by WebAssembly."
image_anchor="top" height="full" >}} <a class="btn btn-lg btn-primary me-3 mb-4" href="/docs"> Get
Started <i class="fas fa-arrow-alt-circle-right ms-2"></i> </a>
<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>
{{< blocks/link-down color="info" >}}
{{< /blocks/cover >}}


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


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

### Overview

**Containerd Shim Spin**
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.

**Runtime Class Manager**
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.

**Spin Plugin for Kubernetes**
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.

**Spin Operator**
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.

**Spin Trigger MQTT**
[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.
**Containerd Shim Spin** 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.

**Runtime Class Manager** 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.

**Spin Plugin for Kubernetes** 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.

**Spin Operator** 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.

**Spin Trigger MQTT** [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.

{{% /blocks/lead %}}
47 changes: 31 additions & 16 deletions content/en/about/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,9 @@
title: SpinKube
---

{{< blocks/cover title="Welcome to SpinKube" image_anchor="top" height="full" >}}
<a class="btn btn-lg btn-primary me-3 mb-4" href="{{< relref "/docs" >}}">
SpinKube Documentation <i class="fas fa-arrow-alt-circle-right ms-2"></i>
</a>
{{< blocks/cover title="Welcome to SpinKube" image_anchor="top" height="full" >}} <a class="btn
btn-lg btn-primary me-3 mb-4" href="{{< relref "/docs" >}}"> SpinKube Documentation <i class="fas
fa-arrow-alt-circle-right ms-2"></i> </a>
<p class="lead mt-5">A new open source project that streamlines the experience of developing, deploying, and operating Wasm workloads on Kubernetes.</p>
{{< blocks/link-down color="info" >}}
{{< /blocks/cover >}}
Expand All @@ -15,32 +14,48 @@ title: SpinKube

SpinKube comprises the following open source projects.

<br />
<br />
<br /> <br />

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

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

<br />
<br />
<br /> <br />

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

<br />
<br />
<br /> <br />

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

The [Spin plugin for Kubernetes](https://github.com/spinkube/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 scaffolding it into a Kubernetes yaml, which can be deployed and managed with `kubectl`. This allows Kubernetes to manage and run Wasm workloads in a way similar to traditional container workloads.
The [Spin plugin for Kubernetes](https://github.com/spinkube/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
scaffolding it into a Kubernetes yaml, which can be deployed and managed with `kubectl`. This allows
Kubernetes to manage and run Wasm workloads in a way similar to traditional container workloads.

<br />
<br />
<br /> <br />

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

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

{{% /blocks/lead %}}
Loading

0 comments on commit d8217e9

Please sign in to comment.