Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/spinkube/spin-plugin-kube

A Spin plugin for interacting with Kubernetes.
https://github.com/spinkube/spin-plugin-kube

kubernetes plugin spin webassembly

Last synced: 3 months ago
JSON representation

A Spin plugin for interacting with Kubernetes.

Awesome Lists containing this project

README 

        
# spin kube plugin



A [Spin plugin](https://github.com/fermyon/spin-plugins) for interacting with Kubernetes.



## Install



Install the stable release:



```sh

spin plugins update

spin plugins install kube

```



### Compiling from source



As an alternative to the plugin manager, you can download and manually install the plugin. Manual installation is

commonly used to test in-flight changes. For a user, it's better to install the plugin using Spin's plugin manager.



Ensure the `pluginify` plugin is installed:



```sh

spin plugins update

spin plugins install pluginify --yes

```



Fetch the plugin:



```sh

git clone [email protected]:spinkube/spin-plugin-kube.git

cd spin-plugin-kube

```



Compile and install the plugin:



```sh

make

make install

```



## Prerequisites



Ensure SpinKube is installed in your Kubernetes cluster. See the [SpinKube Quickstart

Guide](https://www.spinkube.dev/docs/install/quickstart/).



## Usage



Install the wasm32-wasi target for Rust:



```sh

rustup target add wasm32-wasi

```



Create a Spin application:



```sh

spin new --accept-defaults -t http-rust hello-rust

cd hello-rust

```



Compile the application:



```sh

spin build

```



Publish your application:



```sh

docker login

spin registry push bacongobbler/hello-rust:latest

```



Deploy to Kubernetes:



```sh

spin kube scaffold --from bacongobbler/hello-rust:latest | kubectl create -f -

```



View your application:



```sh

kubectl get spinapps

```



`spin kube scaffold` deploys two replicas by default. You can change this with the `--replicas` flag:



```sh

spin kube scaffold --from bacongobbler/hello-rust:latest --replicas 3 | kubectl apply -f -

```



Delete the app:



```sh

kubectl delete spinapp hello-rust

```



### Autoscaler support



Autoscaler support can be enabled by setting `--autoscaler` and by setting a CPU limit and a memory limit.



```sh

spin kube scaffold --from bacongobbler/hello-rust:latest --autoscaler hpa --cpu-limit 100m --memory-limit 128Mi

```



Setting min/max replicas:



```sh

spin kube scaffold --from bacongobbler/hello-rust:latest --autoscaler hpa --cpu-limit 100m --memory-limit 128Mi --replicas 1 --max-replicas 10

```



CPU/memory limits and CPU/memory requests can be set together:



```sh

spin kube scaffold --from bacongobbler/hello-rust:latest --autoscaler hpa --cpu-limit 100m --memory-limit 128Mi --cpu-request 50m --memory-request 64Mi

```



```text

IMPORTANT!

    CPU/memory requests are optional and will default to the CPU/memory limit if not set.

    CPU/memory requests must be lower than their respective CPU/memory limit.

```



Setting the target CPU utilization:



```sh

spin kube scaffold --from bacongobbler/hello-rust:latest --autoscaler hpa --cpu-limit 100m --memory-limit 128Mi --autoscaler-target-cpu-utilization 50

```



Setting the target memory utilization:



```sh

spin kube scaffold --from bacongobbler/hello-rust:latest --autoscaler hpa --cpu-limit 100m --memory-limit 128Mi --autoscaler-target-memory-utilization 50

```



KEDA support:



```sh

spin kube scaffold --from bacongobbler/hello-rust:latest --autoscaler keda --cpu-limit 100m --memory-limit 128Mi

```



### Working with images from private registries



Support for pulling images from private registries can be enabled by using `--image-pull-secret ` flag, where `` is a secret of type [`docker-registry`](https://kubernetes.io/docs/concepts/configuration/secret/#docker-config-secrets) in same namespace as your SpinApp.



To enable multiple private registries, you can provide the flag `--image-pull-secret` multiple times with secret for each registry that you wish to use.



Create a secret with credentials for private registry



```sh

$) kubectl create secret docker-registry registry-credentials \

  --docker-server=ghcr.io \

  --docker-username=bacongobbler \

  --docker-password=github-token



secret/registry-credentials created

```



Verify that the secret is created



```sh

$) kubectl get secret registry-credentials -o yaml



apiVersion: v1

data:

  .dockerconfigjson: eyJhdXRocyI6eyJnaGNyLmlvIjp7InVzZXJuYW1lIjoiYmFjb25nb2JibGVyIiwicGFzc3dvcmQiOiJnaXRodWItdG9rZW4iLCJhdXRoIjoiWW1GamIyNW5iMkppYkdWeU9tZHBkR2gxWWkxMGIydGxiZz09In19fQ==

kind: Secret

metadata:

  creationTimestamp: "2024-02-27T02:18:53Z"

  name: registry-credentials

  namespace: default

  resourceVersion: "162287"

  uid: 2e12ddd1-919d-44b5-b6cc-c3cd5c09fcec

type: kubernetes.io/dockerconfigjson

```



Use the secret when scaffolding the SpinApp



```sh

$) spin kube scaffold --from bacongobbler/hello-rust:latest --image-pull-secret registry-credentials



apiVersion: core.spinoperator.dev/v1alpha1

kind: SpinApp

metadata:

  name: hello-rust

spec:

  image: "bacongobbler/hello-rust:latest"

  executor: containerd-shim-spin

  replicas: 2

  imagePullSecrets:

    - name: registry-credentials

```