diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3b6008a..cd04062 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,3 +1,3 @@ # How to Contribute -We'd love to see contributions from you. Please visit the [contribution section](https://github.com/spinkube/documentation/blob/f4e640e7093f737e634b2a43ee2220ca7760570c/content/en/docs/contribution-guidelines/_index.md) for more information about contributing to individual SpinKube projects and overarching documentation. +We'd love to see contributions from you. Please visit the [contribution section](https://github.com/spinframework/spinkube-docs/blob/f4e640e7093f737e634b2a43ee2220ca7760570c/content/en/docs/contribution-guidelines/_index.md) for more information about contributing to individual SpinKube projects and overarching documentation. diff --git a/README.md b/README.md index b8e2d96..31f83d2 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # spinkube.dev -![Status badge: Deploy to Github Pages](https://github.com/spinkube/documentation/actions/workflows/deploy.yaml/badge.svg) +![Status badge: Deploy to Github Pages](https://github.com/spinframework/spinkube-docs/actions/workflows/deploy.yaml/badge.svg) This project contains the source code for spinkube.dev. diff --git a/content/en/_index.md b/content/en/_index.md index d65c6db..3fcf366 100644 --- a/content/en/_index.md +++ b/content/en/_index.md @@ -13,9 +13,9 @@ deploying, and operating WebAssembly (Wasm) workloads in Kubernetes - resulting {{% blocks/lead color="secondary" %}} -SpinKube combines the Spin operator, containerd shim Spin, and the runtime class manager (formerly Spin operator, containerd shim Spin, and the runtime class manager (formerly KWasm) 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 @@ -29,22 +29,22 @@ Kubernetes. ### Overview -[**Spin Operator**](https://github.com/spinkube/spin-operator/) is a Kubernetes operator that enables +[**Spin Operator**](https://github.com/spinframework/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 +[**Containerd Shim Spin**](https://github.com/spinframework/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 +[**Runtime Class Manager**](https://github.com/spinframework/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 Kube Plugin**](https://github.com/spinkube/spin-plugin-kube) is a plugin for the [Spin](https://developer.fermyon.com/spin/v3/index) CLI +[**Spin Kube Plugin**](https://github.com/spinframework/spin-plugin-kube) is a plugin for the [Spin](https://developer.fermyon.com/spin/v3/index) CLI that aims to ease the experience for scaffolding, deploying and inspecting Spin workloads in Kubernetes. ### Get Involved diff --git a/content/en/about/index.md b/content/en/about/index.md index 39cdcd2..1df50f6 100644 --- a/content/en/about/index.md +++ b/content/en/about/index.md @@ -18,7 +18,7 @@ SpinKube comprises the following open source projects. **Containerd Shim Spin** -The [Containerd Shim Spin repository](https://github.com/spinkube/containerd-shim-spin) provides +The [Containerd Shim Spin repository](https://github.com/spinframework/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 @@ -30,7 +30,7 @@ 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 +Operator](https://github.com/spinframework/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. @@ -39,7 +39,7 @@ managing WebAssembly (Wasm) workloads and other containerd extensions. **Spin Plugin for Kubernetes** -The [Spin plugin for Kubernetes](https://github.com/spinkube/spin-plugin-kube), known as `spin +The [Spin plugin for Kubernetes](https://github.com/spinframework/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 @@ -50,7 +50,7 @@ Kubernetes to manage and run Wasm workloads in a way similar to traditional cont **Spin Operator** -The [Spin Operator](https://github.com/spinkube/spin-operator/) enables deploying Spin applications +The [Spin Operator](https://github.com/spinframework/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 diff --git a/content/en/blog/community/spinkube-kind-rd/index.md b/content/en/blog/community/spinkube-kind-rd/index.md index d92c646..acb8cae 100644 --- a/content/en/blog/community/spinkube-kind-rd/index.md +++ b/content/en/blog/community/spinkube-kind-rd/index.md @@ -226,16 +226,16 @@ the steps below will only include short descriptions: kubectl apply -f https://github.com/cert-manager/cert-manager/releases/download/v1.14.3/cert-manager.yaml # Install the Runtime Class -kubectl apply -f https://github.com/spinkube/spin-operator/releases/download/v0.1.0/spin-operator.runtime-class.yaml +kubectl apply -f https://github.com/spinframework/spin-operator/releases/download/v0.1.0/spin-operator.runtime-class.yaml # Install the CRD -kubectl apply -f https://github.com/spinkube/spin-operator/releases/download/v0.1.0/spin-operator.crds.yaml +kubectl apply -f https://github.com/spinframework/spin-operator/releases/download/v0.1.0/spin-operator.crds.yaml # Deploy SpinKube -helm install spin-operator --namespace spin-operator --create-namespace --version 0.1.0 --wait oci://ghcr.io/spinkube/charts/spin-operator +helm install spin-operator --namespace spin-operator --create-namespace --version 0.1.0 --wait oci://ghcr.io/spinframework/charts/spin-operator # Install the App Executor -kubectl apply -f https://github.com/spinkube/spin-operator/releases/download/v0.1.0/spin-operator.shim-executor.yaml +kubectl apply -f https://github.com/spinframework/spin-operator/releases/download/v0.1.0/spin-operator.shim-executor.yaml ``` SpinKube is now deployed and you can run your first application as described below. @@ -246,7 +246,7 @@ Same as the SpinKube deployment, you can follow the quickstart: ```shell # Deploy the application -kubectl apply -f https://raw.githubusercontent.com/spinkube/spin-operator/main/config/samples/simple.yaml +kubectl apply -f https://raw.githubusercontent.com/spinframework/spin-operator/main/config/samples/simple.yaml # Port forwarding kubectl port-forward svc/simple-spinapp 8083:80 diff --git a/content/en/blog/news/first-post/index.md b/content/en/blog/news/first-post/index.md index a077a43..c6c7f2a 100644 --- a/content/en/blog/news/first-post/index.md +++ b/content/en/blog/news/first-post/index.md @@ -85,9 +85,9 @@ Applications are primarily distributed as OCI Artifacts, rather than traditional meaning that you only ship your compiled application and its assets - without system dependencies. To execute those applications we have a [runwasi](https://github.com/containerd/runwasi) based -[containerd-shim-spin](https://github.com/spinkube/containerd-shim-spin/) that takes a Spin app, +[containerd-shim-spin](https://github.com/spinframework/containerd-shim-spin/) that takes a Spin app, [pre-compiles it for the specific -architecture](https://github.com/spinkube/containerd-shim-spin/pull/32) (caching the result in the +architecture](https://github.com/spinframework/containerd-shim-spin/pull/32) (caching the result in the containerd content store), and is then ready to service requests with [sub-millisecond startup times](https://fermyon.github.io/spin-benchmarks/criterion/reports/spin-executor_sleep-1ms/index.html) - no matter how long your application has been sitting idle. @@ -124,7 +124,7 @@ Or in practice: This leaves one major area that can be painful when deploying applications to Kubernetes today: the developer and deployment experience. -This is where [Spin][spin], [the `spin kube` plugin](https://github.com/spinkube/spin-plugin-kube), +This is where [Spin][spin], [the `spin kube` plugin](https://github.com/spinframework/spin-plugin-kube), and [`spin-operator`][spin-operator] start to shine. ![Architecture diagram of the SpinKube project](spinkube-diagram.png) @@ -161,9 +161,9 @@ kubectl apply -f app.yaml If you want to try things out yourself, the easiest way is to follow the [quickstart guide][quickstart] - we can’t wait to see what you build. -[spin-operator]: https://github.com/spinkube/spin-operator -[containerd-shim-spin]: https://github.com/spinkube/containerd-shim-spin -[runtime-class-manager]: https://github.com/spinkube/runtime-class-manager +[spin-operator]: https://github.com/spinframework/spin-operator +[containerd-shim-spin]: https://github.com/spinframework/containerd-shim-spin +[runtime-class-manager]: https://github.com/spinframework/runtime-class-manager [spin]: https://github.com/fermyon/spin [quickstart]: https://www.spinkube.dev/docs/spin-operator/quickstart/ [kwasm]: https://kwasm.sh/ diff --git a/content/en/blog/news/five-new-things/index.md b/content/en/blog/news/five-new-things/index.md index ebf2877..dc51740 100644 --- a/content/en/blog/news/five-new-things/index.md +++ b/content/en/blog/news/five-new-things/index.md @@ -10,11 +10,11 @@ resources: title: "Image #:counter" --- -Since we publicly [released](/blog/2024/03/13/introducing-spinkube/) SpinKube in March we've been hard at work steadily making it better. Spin Operator [`v0.4.0`](https://github.com/spinkube/spin-operator/releases/tag/v0.4.0), Containerd shim for Spin [`v0.17.0`](https://github.com/spinkube/containerd-shim-spin/releases/tag/v0.17.0), and `spin kube` plugin [`v0.3.0`](https://github.com/spinkube/spin-plugin-kube/releases/tag/v0.3.0) have all just been released. To celebrate that, here's five new things in SpinKube you should know about. +Since we publicly [released](/blog/2024/03/13/introducing-spinkube/) SpinKube in March we've been hard at work steadily making it better. Spin Operator [`v0.4.0`](https://github.com/spinframework/spin-operator/releases/tag/v0.4.0), Containerd shim for Spin [`v0.17.0`](https://github.com/spinframework/containerd-shim-spin/releases/tag/v0.17.0), and `spin kube` plugin [`v0.3.0`](https://github.com/spinframework/spin-plugin-kube/releases/tag/v0.3.0) have all just been released. To celebrate that, here's five new things in SpinKube you should know about. ## Selective Deployments -SpinKube now supports selectively deploying a subset of a Spin apps components. Consider this simple example Spin application (named salutation in the [example repo](https://github.com/spinkube/spin-operator/tree/main/apps/salutations)) composed of two HTTP-triggered components: `hello` and `goodbye`. In the newly added `components` field you can select which components you would like to be a part of the deployment. Here's an example of what the YAML for a selectively deployed app might look like: +SpinKube now supports selectively deploying a subset of a Spin apps components. Consider this simple example Spin application (named salutation in the [example repo](https://github.com/spinframework/spin-operator/tree/main/apps/salutations)) composed of two HTTP-triggered components: `hello` and `goodbye`. In the newly added `components` field you can select which components you would like to be a part of the deployment. Here's an example of what the YAML for a selectively deployed app might look like: ```yaml apiVersion: core.spinkube.dev/v1alpha1 @@ -59,7 +59,7 @@ Now any Spin apps using this executor will send telemetry to the collector at `o ## MQTT Trigger Support -The Containerd Shim for Spin has added support for [MQTT triggers](https://github.com/spinkube/spin-trigger-mqtt). [MQTT](https://mqtt.org/) is a lightweight, publish-subscribe messaging protocol that enables devices to send and receive messages through a broker. It's used all over the place to enable Internet of Things (IoT) designs. +The Containerd Shim for Spin has added support for [MQTT triggers](https://github.com/spinframework/spin-trigger-mqtt). [MQTT](https://mqtt.org/) is a lightweight, publish-subscribe messaging protocol that enables devices to send and receive messages through a broker. It's used all over the place to enable Internet of Things (IoT) designs. If you want to learn more about how to use this new trigger checkout this [blog post](https://www.fermyon.com/blog/mqtt_trigger_spinkube) by Kate Goldenring. @@ -111,4 +111,4 @@ One more example of SpinKube's growing stability is the domain migration we've c We hope this has gotten you as excited about SpinKube as we are. Stay tuned as we continue to make SpinKube better. If you'd like to get involved in the community we'd love to have you — check out our [community page](https://www.spinkube.dev/community/). -[^1]: This was also a great opportunity to exercise the [SKIP](https://github.com/spinkube/skips/tree/main/proposals/004-crd-domains) (SpinKube Improvement Proposal) process. +[^1]: This was also a great opportunity to exercise the [SKIP](https://github.com/spinframework/skips/tree/main/proposals/004-crd-domains) (SpinKube Improvement Proposal) process. diff --git a/content/en/docs/contrib/troubleshooting.md b/content/en/docs/contrib/troubleshooting.md index 9766c78..0d33a8f 100644 --- a/content/en/docs/contrib/troubleshooting.md +++ b/content/en/docs/contrib/troubleshooting.md @@ -11,18 +11,18 @@ might assist you with your work. ## SpinKube Support Policy -SpinKube provides support on a best-effort basis. For users who installed SpinKube manually following the documentation, please report issues in the [Spin Operator repository](https://github.com/spinkube/spin-operator/issues/new). For installations via the Azure Marketplace, please open an issue in the [Azure repository](https://github.com/spinkube/azure/issues/new) for assistance. If your issue is urgent, feel free to raise it in [Slack](https://cloud-native.slack.com/archives/C06PC7JA1EE). +SpinKube provides support on a best-effort basis. For users who installed SpinKube manually following the documentation, please report issues in the [Spin Operator repository](https://github.com/spinframework/spin-operator/issues/new). For installations via the Azure Marketplace, please open an issue in the [Azure repository](https://github.com/spinframework/azure/issues/new) for assistance. If your issue is urgent, feel free to raise it in [Slack](https://cloud-native.slack.com/archives/C06PC7JA1EE). ## Failure downloading the Helm chart -While the [Spin Operator Helm chart](https://github.com/spinkube/spin-operator/pkgs/container/charts%2Fspin-operator) is public and can be fetched anonymously, you may run into errors pulling the chart if you've previously authenticated with the ghcr.io registry but the authentication token has since expired. +While the [Spin Operator Helm chart](https://github.com/spinframework/spin-operator/pkgs/container/charts%2Fspin-operator) is public and can be fetched anonymously, you may run into errors pulling the chart if you've previously authenticated with the ghcr.io registry but the authentication token has since expired. The error would look something like the following: ```console helm install spin-operator \ - --namespace spin-operator --create-namespace --version 0.4.0 --wait oci://ghcr.io/spinkube/charts/spin-operator -Error: INSTALLATION FAILED: failed to download "oci://ghcr.io/spinkube/charts/spin-operator" at version "0.4.0" + --namespace spin-operator --create-namespace --version 0.5.0 --wait oci://ghcr.io/spinframework/charts/spin-operator +Error: INSTALLATION FAILED: failed to download "oci://ghcr.io/spinframework/charts/spin-operator" at version "0.5.0" ``` To fix, either re-authenticate with the registry with a valid token (e.g. `docker login ghcr.io`) or log out of the registry and pull the chart anonymously (e.g. `docker logout ghcr.io`). @@ -30,11 +30,11 @@ To fix, either re-authenticate with the registry with a valid token (e.g. `docke ## No endpoints available for service "spin-operator-webhook-service" When following the quickstart guide the following error can occur when running the `kubectl apply -f -https://github.com/spinkube/spin-operator/releases/download/v0.4.0/spin-operator.shim-executor.yaml` +https://github.com/spinframework/spin-operator/releases/download/v0.5.0/spin-operator.shim-executor.yaml` command: ```console -Error from server (InternalError): error when creating "https://github.com/spinkube/spin-operator/releases/download/v0.4.0/spin-operator.shim-executor.yaml": Internal error occurred: failed calling webhook "mspinappexecutor.kb.io": failed to call webhook: Post "https://spin-operator-webhook-service.spin-operator.svc:443/mutate-core-spinkube-dev-v1alpha1-spinappexecutor?timeout=10s": no endpoints available for service "spin-operator-webhook-service" +Error from server (InternalError): error when creating "https://github.com/spinframework/spin-operator/releases/download/v0.5.0/spin-operator.shim-executor.yaml": Internal error occurred: failed calling webhook "mspinappexecutor.kb.io": failed to call webhook: Post "https://spin-operator-webhook-service.spin-operator.svc:443/mutate-core-spinkube-dev-v1alpha1-spinappexecutor?timeout=10s": no endpoints available for service "spin-operator-webhook-service" ``` To address the error above, first look to see if Spin Operator is running: @@ -80,13 +80,13 @@ To resolve this issue, please try to install the Spin Operator again. Except thi helm upgrade --install spin-operator \ --namespace spin-operator \ --create-namespace \ - --version 0.4.0 \ + --version 0.5.0 \ --wait \ - oci://ghcr.io/spinkube/charts/spin-operator + oci://ghcr.io/spinframework/charts/spin-operator ``` Once the Spin Operator is installed you can try and run the `kubectl apply -f -https://github.com/spinkube/spin-operator/releases/download/v0.4.0/spin-operator.shim-executor.yaml` +https://github.com/spinframework/spin-operator/releases/download/v0.5.0/spin-operator.shim-executor.yaml` command again. The issue should be resolved now. ## Error Validating Data: Connection Refused @@ -223,7 +223,7 @@ TEST SUITE: None ## error: requires go version When building apps like the -[cpu-load-gen](https://github.com/spinkube/spin-operator/tree/main/apps/cpu-load-gen) Spin app, you +[cpu-load-gen](https://github.com/spinframework/spin-operator/tree/main/apps/cpu-load-gen) Spin app, you may get the following error if your TinyGo is not up to date. The error requires go version `1.18` through `1.20` but this is not necessarily the case. It **is** recommended that you have the latest go installed e.g. `1.21` and downgrading is unnecessary. Instead please go ahead and [install the diff --git a/content/en/docs/contrib/writing-code.md b/content/en/docs/contrib/writing-code.md index adc99eb..ba0d621 100644 --- a/content/en/docs/contrib/writing-code.md +++ b/content/en/docs/contrib/writing-code.md @@ -29,7 +29,7 @@ use to the widest audience. ## Code of Conduct As a contributor, you can help us keep the SpinKube community open and inclusive. Please read and -follow our [Code of Conduct](https://github.com/spinkube/governance/blob/main/CODE_OF_CONDUCT.md). +follow our [Code of Conduct](https://github.com/spinframework/governance/blob/main/CODE_OF_CONDUCT.md). ## Install git @@ -48,8 +48,8 @@ installed) by typing `git help` into the command line. SpinKube is hosted on GitHub, and you'll need a GitHub account to contribute. If you don't have one, you can sign up for free at [GitHub](https://github.com). -SpinKube's repositories are organized under the [spinkube GitHub -organization](https://github.com/spinkube). Once you have an account, fork one of the repositories +SpinKube's repositories are organized under the [spinframework GitHub +organization](https://github.com/spinframework). Once you have an account, fork one of the repositories by visiting the repository's page and clicking "Fork" in the upper right corner. Then, from the command line, clone your fork of the repository. For example, if you forked the diff --git a/content/en/docs/contrib/writing-documentation.md b/content/en/docs/contrib/writing-documentation.md index 4466139..7901926 100644 --- a/content/en/docs/contrib/writing-documentation.md +++ b/content/en/docs/contrib/writing-documentation.md @@ -32,7 +32,7 @@ lightly-formatted plain-text documentation is transformed into HTML through a pr If you want to run your own local Hugo server to preview your changes as you work: -1. Fork the [`spinkube/documentation`](https://github.com/spinkube/documentation) repository on +1. Fork the [`spinframework/spinkube-docs`](https://github.com/spinframework/spinkube-docs) repository on GitHub. 1. Clone your fork to your computer. 1. Read the `README.md` file for instructions on how to build the site from source. @@ -53,6 +53,6 @@ a shortcut for you: ## Filing issues If you've found a problem in the documentation, but you're not sure how to fix it yourself, please -file an issue in the [documentation repository](https://github.com/spinkube/documentation/issues). +file an issue in the [documentation repository](https://github.com/spinframework/spinkube-docs/issues). You can also file an issue about a specific page by clicking the **Create Issue** button in the top right-hand corner of the page. diff --git a/content/en/docs/install/azure-kubernetes-service.md b/content/en/docs/install/azure-kubernetes-service.md index b1d9402..17a635d 100644 --- a/content/en/docs/install/azure-kubernetes-service.md +++ b/content/en/docs/install/azure-kubernetes-service.md @@ -84,10 +84,10 @@ installed. ```shell # Install the CRDs -kubectl apply -f https://github.com/spinkube/spin-operator/releases/download/v0.4.0/spin-operator.crds.yaml +kubectl apply -f https://github.com/spinframework/spin-operator/releases/download/v0.5.0/spin-operator.crds.yaml # Install the Runtime Class -kubectl apply -f https://github.com/spinkube/spin-operator/releases/download/v0.4.0/spin-operator.runtime-class.yaml +kubectl apply -f https://github.com/spinframework/spin-operator/releases/download/v0.5.0/spin-operator.runtime-class.yaml ``` The following installs [cert-manager](https://github.com/cert-manager/cert-manager) which is @@ -149,15 +149,15 @@ namespace: helm install spin-operator \ --namespace spin-operator \ --create-namespace \ - --version 0.4.0 \ + --version 0.5.0 \ --wait \ - oci://ghcr.io/spinkube/charts/spin-operator + oci://ghcr.io/spinframework/charts/spin-operator ``` Lastly, create the [shim executor]({{< ref "glossary#spin-app-executor-crd" >}}):: ```console -kubectl apply -f https://github.com/spinkube/spin-operator/releases/download/v0.4.0/spin-operator.shim-executor.yaml +kubectl apply -f https://github.com/spinframework/spin-operator/releases/download/v0.5.0/spin-operator.shim-executor.yaml ``` ## Deploying a Spin App to AKS @@ -168,7 +168,7 @@ previous section: ```shell # Deploy a sample Spin app -kubectl apply -f https://raw.githubusercontent.com/spinkube/spin-operator/main/config/samples/simple.yaml +kubectl apply -f https://raw.githubusercontent.com/spinframework/spin-operator/main/config/samples/simple.yaml ``` ## Verifying the Spin App diff --git a/content/en/docs/install/compatibility-matrices.md b/content/en/docs/install/compatibility-matrices.md index 49c36b6..a107347 100644 --- a/content/en/docs/install/compatibility-matrices.md +++ b/content/en/docs/install/compatibility-matrices.md @@ -8,13 +8,13 @@ tags: [reference] ## `containerd-shim-spin` Executor -The [Spin containerd shim](https://github.com/spinkube/containerd-shim-spin) project is a containerd shim implementation for Spin. +The [Spin containerd shim](https://github.com/spinframework/containerd-shim-spin) project is a containerd shim implementation for Spin. ### Spin Operator and Shim Feature Map If a feature is configured in a `SpinApp` that is not supported in the version of the shim being used, the application may not execute as expected. The following maps out the versions of the [Spin -containerd shim](https://github.com/spinkube/containerd-shim-spin), Spin Operator, and `spin kube` +containerd shim](https://github.com/spinframework/containerd-shim-spin), Spin Operator, and `spin kube` plugin that have support for specific features. | Feature | SpinApp field | Shim Version | Spin Operator Version | `spin kube` plugin version | @@ -28,7 +28,7 @@ plugin that have support for specific features. For tracking the availability of Spin features and compatibility of Spin SDKs, the following indicates which versions of the Spin runtime the [Spin containerd -shim](https://github.com/spinkube/containerd-shim-spin) uses. +shim](https://github.com/spinframework/containerd-shim-spin) uses. | **shim version** | v0.12.0 | v0.13.0 | v0.14.0 | v0.14.1 | v0.15.0 | v0.15.1 | v0.16.0 | v0.17.0 | v0.18.0 | |------------------|---------------------------------------------------------------|---------------------------------------------------------------|---------------------------------------------------------------|---------------------------------------------------------------|---------------------------------------------------------------|---------------------------------------------------------------|---------------------------------------------------------------|---------------------------------------------------------------|-------------------------------| diff --git a/content/en/docs/install/installing-with-helm.md b/content/en/docs/install/installing-with-helm.md index 81b4d62..605ef7b 100644 --- a/content/en/docs/install/installing-with-helm.md +++ b/content/en/docs/install/installing-with-helm.md @@ -61,7 +61,7 @@ here we install the defaults. representing Spin applications to be scheduled on the cluster. ```shell -kubectl apply -f https://github.com/spinkube/spin-operator/releases/download/v0.4.0/spin-operator.crds.yaml +kubectl apply -f https://github.com/spinframework/spin-operator/releases/download/v0.5.0/spin-operator.crds.yaml ``` - Next we create a [RuntimeClass]({{< ref "glossary#runtime-class" >}}) that points to the `spin` @@ -69,7 +69,7 @@ kubectl apply -f https://github.com/spinkube/spin-operator/releases/download/v0. on a subset of nodes, you'll need to modify the RuntimeClass with a `nodeSelector:`: ```shell -kubectl apply -f https://github.com/spinkube/spin-operator/releases/download/v0.4.0/spin-operator.runtime-class.yaml +kubectl apply -f https://github.com/spinframework/spin-operator/releases/download/v0.5.0/spin-operator.runtime-class.yaml ``` - Finally, we create a `containerd-spin-shim` [SpinAppExecutor]({{< ref @@ -77,7 +77,7 @@ kubectl apply -f https://github.com/spinkube/spin-operator/releases/download/v0. just created to run Spin Apps: ```shell -kubectl apply -f https://github.com/spinkube/spin-operator/releases/download/v0.4.0/spin-operator.shim-executor.yaml +kubectl apply -f https://github.com/spinframework/spin-operator/releases/download/v0.5.0/spin-operator.shim-executor.yaml ``` ### Installing the Spin Operator Chart @@ -89,9 +89,9 @@ The following installs the chart with the release name `spin-operator`: helm install spin-operator \ --namespace spin-operator \ --create-namespace \ - --version 0.4.0 \ + --version 0.5.0 \ --wait \ - oci://ghcr.io/spinkube/charts/spin-operator + oci://ghcr.io/spinframework/charts/spin-operator ``` ### Upgrading the Chart @@ -100,7 +100,7 @@ Note that you may also need to upgrade the spin-operator CRDs in tandem with upg release: ```shell -kubectl apply -f https://github.com/spinkube/spin-operator/releases/download/v0.4.0/spin-operator.crds.yaml +kubectl apply -f https://github.com/spinframework/spin-operator/releases/download/v0.5.0/spin-operator.crds.yaml ``` To upgrade the `spin-operator` release, run the following: @@ -109,9 +109,9 @@ To upgrade the `spin-operator` release, run the following: # Upgrade Spin Operator using Helm helm upgrade spin-operator \ --namespace spin-operator \ - --version 0.4.0 \ + --version 0.5.0 \ --wait \ - oci://ghcr.io/spinkube/charts/spin-operator + oci://ghcr.io/spinframework/charts/spin-operator ``` ### Uninstalling the Chart @@ -129,7 +129,7 @@ To completely uninstall all resources related to spin-operator, you may want to corresponding CRD resources and the RuntimeClass: ```shell -kubectl delete -f https://github.com/spinkube/spin-operator/releases/download/v0.4.0/spin-operator.shim-executor.yaml -kubectl delete -f https://github.com/spinkube/spin-operator/releases/download/v0.4.0/spin-operator.runtime-class.yaml -kubectl delete -f https://github.com/spinkube/spin-operator/releases/download/v0.4.0/spin-operator.crds.yaml +kubectl delete -f https://github.com/spinframework/spin-operator/releases/download/v0.5.0/spin-operator.shim-executor.yaml +kubectl delete -f https://github.com/spinframework/spin-operator/releases/download/v0.5.0/spin-operator.runtime-class.yaml +kubectl delete -f https://github.com/spinframework/spin-operator/releases/download/v0.5.0/spin-operator.crds.yaml ``` diff --git a/content/en/docs/install/microk8s.md b/content/en/docs/install/microk8s.md index e360891..144b2aa 100644 --- a/content/en/docs/install/microk8s.md +++ b/content/en/docs/install/microk8s.md @@ -68,8 +68,8 @@ before proceeding. First, we need to apply a runtime class and a CRD for SpinKube: ```console { data-plausible="copy-quick-deploy-sample" } -$ microk8s kubectl apply -f https://github.com/spinkube/spin-operator/releases/download/v0.4.0/spin-operator.runtime-class.yaml -$ microk8s kubectl apply -f https://github.com/spinkube/spin-operator/releases/download/v0.4.0/spin-operator.crds.yaml +$ microk8s kubectl apply -f https://github.com/spinframework/spin-operator/releases/download/v0.5.0/spin-operator.runtime-class.yaml +$ microk8s kubectl apply -f https://github.com/spinframework/spin-operator/releases/download/v0.5.0/spin-operator.crds.yaml ``` Both of these should apply immediately. @@ -89,7 +89,7 @@ $ microk8s kubectl annotate node --all kwasm.sh/kwasm-node=true Next, we need to install SpinKube’s operator using Helm (which is included with Microk8s). ```console { data-plausible="copy-quick-deploy-sample" } -$ microk8s helm install spin-operator --namespace spin-operator --create-namespace --version 0.4.0 --wait oci://ghcr.io/spinkube/charts/spin-operator +$ microk8s helm install spin-operator --namespace spin-operator --create-namespace --version 0.5.0 --wait oci://ghcr.io/spinframework/charts/spin-operator ``` @@ -97,7 +97,7 @@ Now we have the main operator installed. There is just one more step. We need to executor, which is a special CRD that allows us to use multiple executors for WebAssembly. ```console { data-plausible="copy-quick-deploy-sample" } -$ microk8s kubectl apply -f https://github.com/spinkube/spin-operator/releases/download/v0.4.0/spin-operator.shim-executor.yaml +$ microk8s kubectl apply -f https://github.com/spinframework/spin-operator/releases/download/v0.5.0/spin-operator.shim-executor.yaml ``` @@ -111,7 +111,7 @@ While we could write regular deployments or pod specifications, the easiest way is by creating a simple `SpinApp` resource. Let's use the simple example from SpinKube: ```console { data-plausible="copy-quick-deploy-sample" } -$ microk8s kubectl apply -f https://raw.githubusercontent.com/spinkube/spin-operator/main/config/samples/simple.yaml +$ microk8s kubectl apply -f https://raw.githubusercontent.com/spinframework/spin-operator/main/config/samples/simple.yaml ``` The above installs a simple `SpinApp` YAML that looks like this: diff --git a/content/en/docs/install/quickstart.md b/content/en/docs/install/quickstart.md index 19ee392..4f65087 100644 --- a/content/en/docs/install/quickstart.md +++ b/content/en/docs/install/quickstart.md @@ -25,7 +25,7 @@ For this Quickstart guide, you will need: ### Set up Your Kubernetes Cluster 1. Create a Kubernetes cluster with a k3d image that includes the - [containerd-shim-spin](https://github.com/spinkube/containerd-shim-spin) prerequisite already + [containerd-shim-spin](https://github.com/spinframework/containerd-shim-spin) prerequisite already installed: ```console { data-plausible="copy-quick-create-k3d" } @@ -47,7 +47,7 @@ kubectl wait --for=condition=available --timeout=300s deployment/cert-manager-we ``` 3. Apply the [Runtime - Class](https://github.com/spinkube/spin-operator/blob/main/config/samples/spin-runtime-class.yaml) + Class](https://github.com/spinframework/spin-operator/blob/main/config/samples/spin-runtime-class.yaml) used for scheduling Spin apps onto nodes running the shim: > Note: In a production cluster you likely want to customize the Runtime Class with a `nodeSelector` @@ -55,14 +55,14 @@ kubectl wait --for=condition=available --timeout=300s deployment/cert-manager-we > every node. ```console { data-plausible="copy-quick-apply-runtime-class" } -kubectl apply -f https://github.com/spinkube/spin-operator/releases/download/v0.4.0/spin-operator.runtime-class.yaml +kubectl apply -f https://github.com/spinframework/spin-operator/releases/download/v0.5.0/spin-operator.runtime-class.yaml ``` 4. Apply the [Custom Resource Definitions]({{< ref "glossary#custom-resource-definition-crd" >}}) used by the Spin Operator: ```console { data-plausible="copy-quick-apply-crd" } -kubectl apply -f https://github.com/spinkube/spin-operator/releases/download/v0.4.0/spin-operator.crds.yaml +kubectl apply -f https://github.com/spinframework/spin-operator/releases/download/v0.5.0/spin-operator.crds.yaml ``` ## Deploy the Spin Operator @@ -77,15 +77,15 @@ and pods are spinning up. helm install spin-operator \ --namespace spin-operator \ --create-namespace \ - --version 0.4.0 \ + --version 0.5.0 \ --wait \ - oci://ghcr.io/spinkube/charts/spin-operator + oci://ghcr.io/spinframework/charts/spin-operator ``` Lastly, create the [shim executor]({{< ref "glossary#spin-app-executor-crd" >}}): ```console { data-plausible="copy-quick-create-shim-executor" } -kubectl apply -f https://github.com/spinkube/spin-operator/releases/download/v0.4.0/spin-operator.shim-executor.yaml +kubectl apply -f https://github.com/spinframework/spin-operator/releases/download/v0.5.0/spin-operator.shim-executor.yaml ``` ## Run the Sample Application @@ -95,7 +95,7 @@ You are now ready to deploy Spin applications onto the cluster! 1. Create your first application in the same `spin-operator` namespace that the operator is running: ```console { data-plausible="copy-quick-deploy-sample" } -kubectl apply -f https://raw.githubusercontent.com/spinkube/spin-operator/main/config/samples/simple.yaml +kubectl apply -f https://raw.githubusercontent.com/spinframework/spin-operator/main/config/samples/simple.yaml ``` 2. Forward a local port to the application pod so that it can be reached: diff --git a/content/en/docs/install/spin-kube-plugin.md b/content/en/docs/install/spin-kube-plugin.md index a1f0ab6..2444794 100644 --- a/content/en/docs/install/spin-kube-plugin.md +++ b/content/en/docs/install/spin-kube-plugin.md @@ -52,5 +52,5 @@ installation is commonly used to test in-flight changes. For a user, installing Spin's plugin manager is better. Please refer to the [spin-plugin-kube GitHub -repository](https://github.com/spinkube/spin-plugin-kube) for instructions on how to compile the +repository](https://github.com/spinframework/spin-plugin-kube) for instructions on how to compile the plugin from source. diff --git a/content/en/docs/misc/compatibility.md b/content/en/docs/misc/compatibility.md index d6ce15e..eee4f53 100644 --- a/content/en/docs/misc/compatibility.md +++ b/content/en/docs/misc/compatibility.md @@ -8,7 +8,7 @@ aliases: --- See the following list of compatible Kubernetes distributions and platforms for running the [Spin -Operator](https://github.com/spinkube/spin-operator/): +Operator](https://github.com/spinframework/spin-operator/): - [Amazon Elastic Kubernetes Service (EKS)](https://docs.aws.amazon.com/eks/) - [Azure Kubernetes Service (AKS)](https://azure.microsoft.com/en-us/products/kubernetes-service) diff --git a/content/en/docs/misc/upgrading-to-v0.4.0.md b/content/en/docs/misc/upgrading-to-v0.4.0.md index ba2128a..86483c4 100644 --- a/content/en/docs/misc/upgrading-to-v0.4.0.md +++ b/content/en/docs/misc/upgrading-to-v0.4.0.md @@ -43,11 +43,11 @@ Spin Operator v0.4.0 introduces a breaking API change. The SpinApp and SpinAppEx ``` 6. Install the new CRDs. ```sh - kubectl apply -f https://github.com/spinkube/spin-operator/releases/download/v0.4.0/spin-operator.crds.yaml + kubectl apply -f https://github.com/spinframework/spin-operator/releases/download/v0.4.0/spin-operator.crds.yaml ``` 7. Re-install the SpinAppExecutor. ```sh - kubectl apply -f https://github.com/spinkube/spin-operator/releases/download/v0.4.0/spin-operator.shim-executor.yaml + kubectl apply -f https://github.com/spinframework/spin-operator/releases/download/v0.4.0/spin-operator.shim-executor.yaml ``` If you had other executors you'll need to install them too. 8. Install the new Spin Operator. diff --git a/content/en/docs/overview.md b/content/en/docs/overview.md index a2bf761..edf237b 100644 --- a/content/en/docs/overview.md +++ b/content/en/docs/overview.md @@ -8,11 +8,11 @@ tags: [] # Project Overview -[SpinKube](https://github.com/spinkube) is a new open source project that streamlines the experience +[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 [runwasi](https://github.com/containerd/runwasi) and [runtime class -manager](https://github.com/spinkube/runtime-class-manager) (formerly [KWasm](https://kwasm.sh/)) +manager](https://github.com/spinframework/runtime-class-manager) (formerly [KWasm](https://kwasm.sh/)) open source projects. With SpinKube, you can leverage the advantages of using WebAssembly (Wasm) for your workloads: diff --git a/content/en/docs/reference/spin-app.md b/content/en/docs/reference/spin-app.md index f4cefd9..42dd748 100644 --- a/content/en/docs/reference/spin-app.md +++ b/content/en/docs/reference/spin-app.md @@ -169,6 +169,14 @@ cannot be defined if this is enabled. By default EnableAutoscaling is false.
false + + serviceAccountName + string + + ServiceAccountName is the name of the Kubernetes service account to use for the pod. +If not specified, the default service account will be used.
+ + false serviceAnnotations map[string]string @@ -1637,6 +1645,8 @@ More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/nam awsElasticBlockStore represents an AWS Disk resource that is attached to a kubelet's host machine and then exposed to the pod. +Deprecated: AWSElasticBlockStore is deprecated. All operations for the in-tree +awsElasticBlockStore type are redirected to the ebs.csi.aws.com CSI driver. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
false @@ -1644,21 +1654,26 @@ More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockst azureDisk object - azureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.
+ azureDisk represents an Azure Data Disk mount on the host and bind mount to the pod. +Deprecated: AzureDisk is deprecated. All operations for the in-tree azureDisk type +are redirected to the disk.csi.azure.com CSI driver.
false azureFile object - azureFile represents an Azure File Service mount on the host and bind mount to the pod.
+ azureFile represents an Azure File Service mount on the host and bind mount to the pod. +Deprecated: AzureFile is deprecated. All operations for the in-tree azureFile type +are redirected to the file.csi.azure.com CSI driver.
false cephfs object - cephFS represents a Ceph FS mount on the host that shares a pod's lifetime
+ cephFS represents a Ceph FS mount on the host that shares a pod's lifetime. +Deprecated: CephFS is deprecated and the in-tree cephfs type is no longer supported.
false @@ -1666,6 +1681,8 @@ More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockst object cinder represents a cinder volume attached and mounted on kubelets host machine. +Deprecated: Cinder is deprecated. All operations for the in-tree cinder type +are redirected to the cinder.csi.openstack.org CSI driver. More info: https://examples.k8s.io/mysql-cinder-pd/README.md
false @@ -1680,7 +1697,7 @@ More info: https://examples.k8s.io/mysql-cinder-pd/README.md
csi object - csi (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers (Beta feature).
+ csi (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers.
false @@ -1740,14 +1757,16 @@ persistent volumes at the same time.
object flexVolume represents a generic volume resource that is -provisioned/attached using an exec based plugin.
+provisioned/attached using an exec based plugin. +Deprecated: FlexVolume is deprecated. Consider using a CSIDriver instead.
false flocker object - flocker represents a Flocker volume attached to a kubelet's host machine. This depends on the Flocker control service being running
+ flocker represents a Flocker volume attached to a kubelet's host machine. This depends on the Flocker control service being running. +Deprecated: Flocker is deprecated and the in-tree flocker type is no longer supported.
false @@ -1756,6 +1775,8 @@ provisioned/attached using an exec based plugin.
gcePersistentDisk represents a GCE Disk resource that is attached to a kubelet's host machine and then exposed to the pod. +Deprecated: GCEPersistentDisk is deprecated. All operations for the in-tree +gcePersistentDisk type are redirected to the pd.csi.storage.gke.io CSI driver. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
false @@ -1764,7 +1785,7 @@ More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk object gitRepo represents a git repository at a particular revision. -DEPRECATED: GitRepo is deprecated. To provision a container with a git repo, mount an +Deprecated: GitRepo is deprecated. To provision a container with a git repo, mount an EmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir into the Pod's container.
@@ -1774,6 +1795,7 @@ into the Pod's container.
object glusterfs represents a Glusterfs mount on the host that shares a pod's lifetime. +Deprecated: Glusterfs is deprecated and the in-tree glusterfs type is no longer supported. More info: https://examples.k8s.io/volumes/glusterfs/README.md
false @@ -1838,14 +1860,18 @@ More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persis photonPersistentDisk object - photonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine
+ photonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine. +Deprecated: PhotonPersistentDisk is deprecated and the in-tree photonPersistentDisk type is no longer supported.
false portworxVolume object - portworxVolume represents a portworx volume attached and mounted on kubelets host machine
+ portworxVolume represents a portworx volume attached and mounted on kubelets host machine. +Deprecated: PortworxVolume is deprecated. All operations for the in-tree portworxVolume type +are redirected to the pxd.portworx.com CSI driver when the CSIMigrationPortworx feature-gate +is on.
false @@ -1859,7 +1885,8 @@ More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persis quobyte object - quobyte represents a Quobyte mount on the host that shares a pod's lifetime
+ quobyte represents a Quobyte mount on the host that shares a pod's lifetime. +Deprecated: Quobyte is deprecated and the in-tree quobyte type is no longer supported.
false @@ -1867,6 +1894,7 @@ More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persis object rbd represents a Rados Block Device mount on the host that shares a pod's lifetime. +Deprecated: RBD is deprecated and the in-tree rbd type is no longer supported. More info: https://examples.k8s.io/volumes/rbd/README.md
false @@ -1874,7 +1902,8 @@ More info: https://examples.k8s.io/volumes/rbd/README.md
scaleIO object - scaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes.
+ scaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes. +Deprecated: ScaleIO is deprecated and the in-tree scaleIO type is no longer supported.
false @@ -1889,14 +1918,17 @@ More info: https://kubernetes.io/docs/concepts/storage/volumes#secret
storageos object - storageOS represents a StorageOS volume attached and mounted on Kubernetes nodes.
+ storageOS represents a StorageOS volume attached and mounted on Kubernetes nodes. +Deprecated: StorageOS is deprecated and the in-tree storageos type is no longer supported.
false vsphereVolume object - vsphereVolume represents a vSphere volume attached and mounted on kubelets host machine
+ vsphereVolume represents a vSphere volume attached and mounted on kubelets host machine. +Deprecated: VsphereVolume is deprecated. All operations for the in-tree vsphereVolume type +are redirected to the csi.vsphere.vmware.com CSI driver.
false @@ -1909,6 +1941,8 @@ More info: https://kubernetes.io/docs/concepts/storage/volumes#secret
awsElasticBlockStore represents an AWS Disk resource that is attached to a kubelet's host machine and then exposed to the pod. +Deprecated: AWSElasticBlockStore is deprecated. All operations for the in-tree +awsElasticBlockStore type are redirected to the ebs.csi.aws.com CSI driver. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore @@ -1967,6 +2001,8 @@ More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockst azureDisk represents an Azure Data Disk mount on the host and bind mount to the pod. +Deprecated: AzureDisk is deprecated. All operations for the in-tree azureDisk type +are redirected to the disk.csi.azure.com CSI driver.
@@ -2035,6 +2071,8 @@ the ReadOnly setting in VolumeMounts.
azureFile represents an Azure File Service mount on the host and bind mount to the pod. +Deprecated: AzureFile is deprecated. All operations for the in-tree azureFile type +are redirected to the file.csi.azure.com CSI driver.
@@ -2075,7 +2113,8 @@ the ReadOnly setting in VolumeMounts.
[back to parent](#spinappspecvolumesindex) -cephFS represents a Ceph FS mount on the host that shares a pod's lifetime +cephFS represents a Ceph FS mount on the host that shares a pod's lifetime. +Deprecated: CephFS is deprecated and the in-tree cephfs type is no longer supported.
@@ -2176,6 +2215,8 @@ More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/nam cinder represents a cinder volume attached and mounted on kubelets host machine. +Deprecated: Cinder is deprecated. All operations for the in-tree cinder type +are redirected to the cinder.csi.openstack.org CSI driver. More info: https://examples.k8s.io/mysql-cinder-pd/README.md
@@ -2380,7 +2421,7 @@ mode, like fsGroup, and the result can be other mode bits set.
[back to parent](#spinappspecvolumesindex) -csi (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers (Beta feature). +csi (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers.
@@ -3256,6 +3297,7 @@ Either wwids or combination of targetWWNs and lun must be set, but not both simu flexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin. +Deprecated: FlexVolume is deprecated. Consider using a CSIDriver instead.
@@ -3352,7 +3394,8 @@ More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/nam [back to parent](#spinappspecvolumesindex) -flocker represents a Flocker volume attached to a kubelet's host machine. This depends on the Flocker control service being running +flocker represents a Flocker volume attached to a kubelet's host machine. This depends on the Flocker control service being running. +Deprecated: Flocker is deprecated and the in-tree flocker type is no longer supported.
@@ -3388,6 +3431,8 @@ should be considered as deprecated
gcePersistentDisk represents a GCE Disk resource that is attached to a kubelet's host machine and then exposed to the pod. +Deprecated: GCEPersistentDisk is deprecated. All operations for the in-tree +gcePersistentDisk type are redirected to the pd.csi.storage.gke.io CSI driver. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
@@ -3448,7 +3493,7 @@ More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk gitRepo represents a git repository at a particular revision. -DEPRECATED: GitRepo is deprecated. To provision a container with a git repo, mount an +Deprecated: GitRepo is deprecated. To provision a container with a git repo, mount an EmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir into the Pod's container. @@ -3494,6 +3539,7 @@ the subdirectory with the given name.
glusterfs represents a Glusterfs mount on the host that shares a pod's lifetime. +Deprecated: Glusterfs is deprecated and the in-tree glusterfs type is no longer supported. More info: https://examples.k8s.io/volumes/glusterfs/README.md
@@ -3859,7 +3905,8 @@ Default false.
[back to parent](#spinappspecvolumesindex) -photonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine +photonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine. +Deprecated: PhotonPersistentDisk is deprecated and the in-tree photonPersistentDisk type is no longer supported.
@@ -3894,7 +3941,10 @@ Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
[back to parent](#spinappspecvolumesindex) -portworxVolume represents a portworx volume attached and mounted on kubelets host machine +portworxVolume represents a portworx volume attached and mounted on kubelets host machine. +Deprecated: PortworxVolume is deprecated. All operations for the in-tree portworxVolume type +are redirected to the pxd.portworx.com CSI driver when the CSIMigrationPortworx feature-gate +is on.
@@ -4614,7 +4664,8 @@ and must be at least 10 minutes.
[back to parent](#spinappspecvolumesindex) -quobyte represents a Quobyte mount on the host that shares a pod's lifetime +quobyte represents a Quobyte mount on the host that shares a pod's lifetime. +Deprecated: Quobyte is deprecated and the in-tree quobyte type is no longer supported.
@@ -4682,6 +4733,7 @@ Defaults to serivceaccount user
rbd represents a Rados Block Device mount on the host that shares a pod's lifetime. +Deprecated: RBD is deprecated and the in-tree rbd type is no longer supported. More info: https://examples.k8s.io/volumes/rbd/README.md
@@ -4815,6 +4867,7 @@ More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/nam scaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes. +Deprecated: ScaleIO is deprecated and the in-tree scaleIO type is no longer supported.
@@ -5061,6 +5114,7 @@ mode, like fsGroup, and the result can be other mode bits set.
storageOS represents a StorageOS volume attached and mounted on Kubernetes nodes. +Deprecated: StorageOS is deprecated and the in-tree storageos type is no longer supported.
@@ -5157,7 +5211,9 @@ More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/nam [back to parent](#spinappspecvolumesindex) -vsphereVolume represents a vSphere volume attached and mounted on kubelets host machine +vsphereVolume represents a vSphere volume attached and mounted on kubelets host machine. +Deprecated: VsphereVolume is deprecated. All operations for the in-tree vsphereVolume type +are redirected to the csi.vsphere.vmware.com CSI driver.
diff --git a/content/en/docs/topics/architecture.md b/content/en/docs/topics/architecture.md index 834b7b5..cc824ab 100644 --- a/content/en/docs/topics/architecture.md +++ b/content/en/docs/topics/architecture.md @@ -6,7 +6,7 @@ weight: 80 ## spin-operator -[Spin Operator](https://github.com/spinkube/spin-operator/) is a [Kubernetes +[Spin Operator](https://github.com/spinframework/spin-operator/) is a [Kubernetes operator](https://kubernetes.io/docs/concepts/extend-kubernetes/operator/) which empowers platform engineers to deploy [Spin applications](https://developer.fermyon.com/spin) as custom resources to their Kubernetes clusters. Spin Operator provides an elegant solution for platform engineers looking @@ -45,7 +45,7 @@ via the Runtime Class Manager, which you will install as a dependency when setti ## containerd-shim-spin -The [`containerd-shim-spin`](https://github.com/spinkube/containerd-shim-spin) is a [containerd +The [`containerd-shim-spin`](https://github.com/spinframework/containerd-shim-spin) is a [containerd shim](https://github.com/containerd/containerd/blob/main/core/runtime/v2/README.md#runtime-shim) implementation for [Spin](https://developer.fermyon.com/spin), which enables running Spin workloads on Kubernetes via [runwasi](https://github.com/deislabs/runwasi). This means that by installing this @@ -70,7 +70,7 @@ into Kubernetes clusters, enhancing the versatility and capabilities of containe ## 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 +Operator](https://github.com/spinframework/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. @@ -83,7 +83,7 @@ and simplifies the deployment and management of containerd shims in Kubernetes c ## spin-plugin-kube -The [Kubernetes plugin for Spin](https://github.com/spinkube/spin-plugin-kube) is designed to +The [Kubernetes plugin for Spin](https://github.com/spinframework/spin-plugin-kube) is designed to enhance Spin by enabling the execution of Wasm modules directly within a Kubernetes cluster. Specifically a tool designed for Kubernetes integration with the Spin command-line interface. This plugin works by integrating with containerd shims, allowing Kubernetes to manage and run Wasm diff --git a/content/en/docs/topics/assigning-variables.md b/content/en/docs/topics/assigning-variables.md index 074b908..c5452af 100644 --- a/content/en/docs/topics/assigning-variables.md +++ b/content/en/docs/topics/assigning-variables.md @@ -24,7 +24,7 @@ process of assigning variables to your `SpinApp`. We’re going to build the SpinApp and store it inside of a [ttl.sh](http://ttl.sh) registry. Move into the -[apps/variable-explorer](https://github.com/spinkube/spin-operator/blob/main/apps/variable-explorer) +[apps/variable-explorer](https://github.com/spinframework/spin-operator/blob/main/apps/variable-explorer) directory and build the SpinApp we’ve provided: ```bash @@ -39,7 +39,7 @@ indicates how long the image will last e.g. `1h` (1 hour). The maximum is `24h` repush if ttl exceeds 24 hours. For demonstration purposes, we use the [variable -explorer](https://github.com/spinkube/spin-operator/blob/main/apps/variable-explorer) sample app. It +explorer](https://github.com/spinframework/spin-operator/blob/main/apps/variable-explorer) sample app. It reads three different variables (`log_level`, `platform_name` and `db_password`) and prints their values to the `STDOUT` stream as shown in the following snippet: diff --git a/content/en/docs/topics/autoscaling/scaling-with-hpa.md b/content/en/docs/topics/autoscaling/scaling-with-hpa.md index 7dcb596..8c291f7 100644 --- a/content/en/docs/topics/autoscaling/scaling-with-hpa.md +++ b/content/en/docs/topics/autoscaling/scaling-with-hpa.md @@ -31,7 +31,7 @@ Ensure you have the following tools installed: ## Setting Up Kubernetes Cluster Run the following command to create a Kubernetes cluster that has [the -containerd-shim-spin](https://github.com/spinkube/containerd-shim-spin) pre-requisites installed: If +containerd-shim-spin](https://github.com/spinframework/containerd-shim-spin) pre-requisites installed: If you have a Kubernetes cluster already, please feel free to use it: ```console @@ -74,10 +74,10 @@ Next, run the following commands to install the Spin [Runtime Class]({{ Note that if you had an Spin application with more than two components, you could choose to deploy multiple components selectively. +> Note that if you had an Spin application with more than two components, you could choose to deploy multiple components selectively. To Selectively Deploy, we first need to turn our application into a SpinApp Custom Resource with the `spin kube scaffold` command, using the optional `--component` field to specify which component we’d like to deploy: @@ -120,4 +120,4 @@ Next, let’s try the `/bye` route. This should return nothing, confirming that curl localhost:8083/bye ``` -There you have it! You selectively deployed a subset of your Spin application to SpinKube with no modifications to your source code. This approach lets you easily deploy only the components you need, which can improve efficiency in environments where only specific services are required. \ No newline at end of file +There you have it! You selectively deployed a subset of your Spin application to SpinKube with no modifications to your source code. This approach lets you easily deploy only the components you need, which can improve efficiency in environments where only specific services are required. diff --git a/crd-reference/generate.sh b/crd-reference/generate.sh index 4ad7e5e..cf3b7a3 100755 --- a/crd-reference/generate.sh +++ b/crd-reference/generate.sh @@ -9,14 +9,14 @@ script_dir=$(dirname "$0") cd $script_dir -SPIN_OPERATOR_RELEASE=${SPIN_OPERATOR_RELEASE:-v0.4.0} +SPIN_OPERATOR_RELEASE=${SPIN_OPERATOR_RELEASE:-v0.5.0} echo "Installing crdoc" go install fybrik.io/crdoc@latest echo "Downloading Spin Operator CRDs ($SPIN_OPERATOR_RELEASE)" spin_operator_crds_file=$(mktemp) -wget https://github.com/spinkube/spin-operator/releases/download/$SPIN_OPERATOR_RELEASE/spin-operator.crds.yaml -O ${spin_operator_crds_file} +wget https://github.com/spinframework/spin-operator/releases/download/$SPIN_OPERATOR_RELEASE/spin-operator.crds.yaml -O ${spin_operator_crds_file} # Generate SpinAppExecutor Reference Docs echo "Generating CRD reference docs for SpinAppExecutor" diff --git a/go.mod b/go.mod index 5a79c7d..c292bf8 100644 --- a/go.mod +++ b/go.mod @@ -1,4 +1,4 @@ -module github.com/spinkube/documentation +module github.com/spinframework/spinkube-docs go 1.22 diff --git a/hugo.toml b/hugo.toml index 7cef388..93904cb 100644 --- a/hugo.toml +++ b/hugo.toml @@ -108,9 +108,9 @@ version = "0.0.0" url_latest_version = "https://spinkube.dev" # Repository configuration (URLs for in-page links to opening issues and suggesting changes) -github_repo = "https://github.com/spinkube/documentation" +github_repo = "https://github.com/spinframework/spinkube-docs" # An optional link to a related project repo. For example, the sibling repository where your product code lives. -github_project_repo = "https://github.com/spinkube/spin-operator" +github_project_repo = "https://github.com/spinframework/spin-operator" # Specify a value here if your content directory is not in your repo's root directory # github_subdir = "" @@ -156,7 +156,7 @@ sidebar_search_disable = true enable = true # The responses that the user sees after clicking "yes" (the page was helpful) or "no" (the page was not helpful). yes = 'Glad to hear it!' -no = 'Sorry to hear that. Please tell us how we can improve.' +no = 'Sorry to hear that. Please tell us how we can improve.' # Adds a reading time to the top of each doc. # If you want this feature, but occasionally need to remove the Reading time from a single page, @@ -189,7 +189,7 @@ enable = false # Developer relevant links. These will show up on right side of footer and in the community page if you have one. [[params.links.developer]] name = "GitHub" - url = "https://github.com/spinkube" + url = "https://github.com/spinframework" icon = "fab fa-github" desc = "Development takes place here!" [[params.links.developer]] diff --git a/package.json b/package.json index 8c46cdd..4654a80 100644 --- a/package.json +++ b/package.json @@ -3,11 +3,11 @@ "version": "0.1.0", "version.next": "0.1.1-dev.0-unreleased", "description": "Documentation website for SpinKube projects", - "repository": "github:spinkube/documentation", + "repository": "github:spinframework/spinkube-docs", "homepage": "https://spinkube.dev", "author": "SpinKube maintainers", "license": "Apache-2.0", - "bugs": "https://github.com/spinkube/documentation/issues", + "bugs": "https://github.com/spinframework/spinkube-docs/issues", "spelling": "cSpell:ignore HTMLTEST precheck postbuild -", "scripts": { "_build": "npm run _hugo-dev --",