-
Notifications
You must be signed in to change notification settings - Fork 23
make project descriptions more beginner friendly #272
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.
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
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -5,7 +5,8 @@ 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> | ||||||
| <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> | ||||||
| <p class="lead mt-5">SpinKube is an open source, Kubernetes native project that streamlines developing, | ||||||
| deploying, and operating WebAssembly (Wasm) workloads in Kubernetes - resulting in delivering smaller, more portable applications with exciting compute performance benefits.</p> | ||||||
| {{< blocks/link-down color="info" >}} | ||||||
| {{< /blocks/cover >}} | ||||||
|
|
||||||
|
|
@@ -28,36 +29,26 @@ Kubernetes. | |||||
|
|
||||||
| ### 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 | ||||||
| [**Containerd Shim Spin**](https://github.com/spinkube/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 | ||||||
| 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 Operator**](https://github.com/spinkube/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. | ||||||
|
|
||||||
| **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. | ||||||
| [**Spin Kube Plugin**](https://github.com/spinkube/spin-plugin-kube) is a plugin for the [Spin](https://developer.fermyon.com/spin/v3/index) CLI | ||||||
| thats aim to ease the experience for scaffolding, deploying and inspecting Spin workloads in Kubernetes. | ||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
|
|
||||||
| [**Spin Trigger MQTT**](https://github.com/spinkube/spin-trigger-mqtt/) trigger enables seamless integration | ||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I personally find it confusing to list this trigger since there are more triggers than this one that the shim supports. Yes, this trigger lives in the SK org but i dont think we need to document it here |
||||||
| between Spin and MQTT-based systems, allowing you to automate workflows and trigger actions based on MQTT | ||||||
| messages. | ||||||
|
|
||||||
| {{% /blocks/lead %}} | ||||||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Option to use the word stack if folks like that better.