Skip to content

refine the project overview #297

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 1, 2025
Merged

refine the project overview #297

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
22 changes: 12 additions & 10 deletions content/en/docs/overview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,11 @@ tags: []

# Project Overview

[SpinKube](https://github.com/spinframework) is a new open source project that streamlines the experience
of developing, deploying, and operating Wasm workloads on Kubernetes, using
[Spin](https://github.com/fermyon/spin) in tandem with the
[SpinKube](https://github.com/spinframework) is an open source project that streamlines the
experience of deploying and operating Wasm workloads on Kubernetes, using [Spin
Operator](https://github.com/spinframework/spin-operator) in tandem with
[runwasi](https://github.com/containerd/runwasi) and [runtime class
manager](https://github.com/spinframework/runtime-class-manager) (formerly [KWasm](https://kwasm.sh/))
open source projects.
manager](https://github.com/spinframework/runtime-class-manager).

With SpinKube, you can leverage the advantages of using WebAssembly (Wasm) for your workloads:

Expand All @@ -23,13 +22,16 @@ With SpinKube, you can leverage the advantages of using WebAssembly (Wasm) for y
workloads).
- Substantially fewer resources are required during idle times.

Thanks to Spin Operator, we can do all of this while integrating with Kubernetes primitives (DNS,
probes, autoscaling, metrics, and many more cloud native and CNCF projects).
Thanks to SpinKube, we can do all of this while integrating with Kubernetes primitives including
DNS, probes, autoscaling, metrics, and many more cloud native and CNCF projects.

![SpinKube Project Overview Diagram](../spinkube-overview-diagram.png)

Spin Operator watches [Spin App Custom Resources]({{< ref "glossary#spinapp-manifest" >}}) and
realizes the desired state in the Kubernetes cluster. The foundation of this project was built using
the kubebuilder framework and contains a Spin App Custom Resource Definition (CRD) and controller.
SpinKube watches [Spin App Custom Resources]({{< ref "glossary#spinapp-manifest" >}}) and realizes
the desired state in the Kubernetes cluster. The foundation of this project was built using the
[kubebuilder](https://github.com/kubernetes-sigs/kubebuilder) framework and contains a Spin App
Custom Resource Definition (CRD) and controller.

SpinKube is a [Cloud Native Computing Foundation](https://www.cncf.io/) sandbox project.

To get started, check out our [Quickstart guide]({{< ref "quickstart" >}}).