Skip to content

Commit

Permalink
Merge pull request #274 from Mossaka/add-community-call
Browse files Browse the repository at this point in the history
README, content and _index: add community call details and some minor changes to the index page.
  • Loading branch information
Mossaka authored Jan 22, 2025
2 parents 550aad3 + 375e80c commit b355891
Show file tree
Hide file tree
Showing 3 changed files with 33 additions and 8 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ This project contains the source code for spinkube.dev.

## Running Locally

Make sure you have [Node.js](http://nodejs.org/) and [Go](https://golang.org) installed.
Make sure you have [Node.js](http://nodejs.org/) (v14 or later) and [Go](https://golang.org) installed.

Clone this repository and run the following commands:

Expand Down
20 changes: 13 additions & 7 deletions content/en/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ 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 Spin shim</a>, and the <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
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
Expand All @@ -29,6 +29,12 @@ Kubernetes.

### Overview

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

[**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.
Expand All @@ -38,17 +44,17 @@ automates and manages the lifecycle of containerd shims in a Kubernetes environm
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 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.

[**Spin Trigger MQTT**](https://github.com/spinkube/spin-trigger-mqtt/) trigger enables seamless integration
between Spin and MQTT-based systems, allowing you to automate workflows and trigger actions based on MQTT
messages.

### Get Involved

We have bi-weekly [community calls](https://docs.google.com/document/d/10is2YoNC0NpXw4_5lSyTfpPph9_A9wBissKGrpFaIrI/edit?usp=sharing) and a [Slack channel](https://cloud-native.slack.com/archives/C06PC7JA1EE). We would love to have you join us! <br>

Check out the [contribution guidelines](/docs/contrib/) to learn how to get involved with the project.

{{% /blocks/lead %}}
19 changes: 19 additions & 0 deletions content/en/docs/contrib/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,3 +8,22 @@ aliases:

SpinKube is an open source community-driven project. You can contribute in many ways, either to the
project or to the wider community.

## Community Calls

Join our bi-weekly community calls to connect with the team and other contributors. These calls are a great opportunity to listen in, ask questions, or share your ideas!

* When: Bi-weekly at 8:00 am PT / 11:00 am ET / 5:00 pm CET

* Meeting Document: [Community Call Notes](https://docs.google.com/document/d/10is2YoNC0NpXw4_5lSyTfpPph9_A9wBissKGrpFaIrI/edit?usp=sharing)

* Zoom Link: Join [the Zoom Meeting](https://us06web.zoom.us/j/83473056051?pwd=gDFNQCxUG1OMzdBqTNXIQamlvHjhFo.1)

## Slack

Connect with the community on Slack for real-time discussions and updates:

visit the `#spinkube` channel on the [CNCF
Slack](https://cloud-native.slack.com/archives/C06PC7JA1EE).

We look forward to seeing you there!

0 comments on commit b355891

Please sign in to comment.