Skip to content

Commit 312bd61

Browse files
authored
Merge branch 'spinkube:main' into spinkube-support-policy
2 parents d97a13c + 0b10e26 commit 312bd61

24 files changed

+388
-232
lines changed

content/en/docs/contrib/troubleshooting.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Troubleshooting
33
description: Troubleshooting common errors and issues with SpinKube.
44
weight: 13
55
aliases:
6-
- /docs/spin-operator/support/troubleshooting
6+
- /docs/spin-operator/support/troubleshooting
77
---
88

99
The following is a list of common error messages and potential troubleshooting suggestions that
@@ -16,11 +16,11 @@ SpinKube provides support on best effort basis. Please file an issue under the a
1616
## No endpoints available for service "spin-operator-webhook-service"
1717

1818
When following the quickstart guide the following error can occur when running the `kubectl apply -f
19-
https://github.com/spinkube/spin-operator/releases/download/v0.3.0/spin-operator.shim-executor.yaml`
19+
https://github.com/spinkube/spin-operator/releases/download/v0.4.0/spin-operator.shim-executor.yaml`
2020
command:
2121

2222
```console
23-
Error from server (InternalError): error when creating "https://github.com/spinkube/spin-operator/releases/download/v0.3.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-spinoperator-dev-v1alpha1-spinappexecutor?timeout=10s": no endpoints available for service "spin-operator-webhook-service"
23+
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"
2424
```
2525

2626
To address the error above, first look to see if Spin Operator is running:
@@ -66,13 +66,13 @@ To resolve this issue, please try to install the Spin Operator again. Except thi
6666
helm upgrade --install spin-operator \
6767
--namespace spin-operator \
6868
--create-namespace \
69-
--version 0.3.0 \
69+
--version 0.4.0 \
7070
--wait \
7171
oci://ghcr.io/spinkube/charts/spin-operator
7272
```
7373

7474
Once the Spin Operator is installed you can try and run the `kubectl apply -f
75-
https://github.com/spinkube/spin-operator/releases/download/v0.3.0/spin-operator.shim-executor.yaml`
75+
https://github.com/spinkube/spin-operator/releases/download/v0.4.0/spin-operator.shim-executor.yaml`
7676
command again. The issue should be resolved now.
7777

7878
## Error Validating Data: Connection Refused

content/en/docs/glossary.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ SpinApp CRD consists of several key fields that define the desired state of a Sp
7474
Here's an example of a SpinApp custom resource that uses the SpinApp CRD schema:
7575

7676
```yaml
77-
apiVersion: core.spinoperator.dev/v1alpha1
77+
apiVersion: core.spinkube.dev/v1alpha1
7878
kind: SpinApp
7979
metadata:
8080
name: simple-spinapp
@@ -91,7 +91,7 @@ You can modify the example above to customize the SpinApp via a YAML file. Here'
9191
file with additional customization options:
9292
9393
```yaml
94-
apiVersion: core.spinoperator.dev/v1alpha1
94+
apiVersion: core.spinkube.dev/v1alpha1
9595
kind: SpinApp
9696
metadata:
9797
name: simple-spinapp

content/en/docs/install/azure-kubernetes-service.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ date: 2024-02-16
55
categories: [Spin Operator]
66
tags: [Tutorials]
77
aliases:
8-
- /docs/spin-operator/tutorials/deploy-on-azure-kubernetes-service
8+
- /docs/spin-operator/tutorials/deploy-on-azure-kubernetes-service
99
---
1010

1111
In this tutorial, you install Spin Operator on an Azure Kubernetes Service (AKS) cluster and deploy
@@ -84,10 +84,10 @@ installed.
8484

8585
```shell
8686
# Install the CRDs
87-
kubectl apply -f https://github.com/spinkube/spin-operator/releases/download/v0.3.0/spin-operator.crds.yaml
87+
kubectl apply -f https://github.com/spinkube/spin-operator/releases/download/v0.4.0/spin-operator.crds.yaml
8888

8989
# Install the Runtime Class
90-
kubectl apply -f https://github.com/spinkube/spin-operator/releases/download/v0.3.0/spin-operator.runtime-class.yaml
90+
kubectl apply -f https://github.com/spinkube/spin-operator/releases/download/v0.4.0/spin-operator.runtime-class.yaml
9191
```
9292

9393
The following installs [cert-manager](https://github.com/cert-manager/cert-manager) which is
@@ -130,6 +130,7 @@ helm install \
130130
# Provision Nodes
131131
kubectl annotate node --all kwasm.sh/kwasm-node=true
132132
```
133+
133134
To verify `containerd-wasm-shim` installation, you can inspect the logs from the Kwasm Operator:
134135

135136
```shell
@@ -148,15 +149,15 @@ namespace:
148149
helm install spin-operator \
149150
--namespace spin-operator \
150151
--create-namespace \
151-
--version 0.3.0 \
152+
--version 0.4.0 \
152153
--wait \
153154
oci://ghcr.io/spinkube/charts/spin-operator
154155
```
155156

156157
Lastly, create the [shim executor]({{< ref "glossary#spin-app-executor-crd" >}})::
157158

158159
```console
159-
kubectl apply -f https://github.com/spinkube/spin-operator/releases/download/v0.3.0/spin-operator.shim-executor.yaml
160+
kubectl apply -f https://github.com/spinkube/spin-operator/releases/download/v0.4.0/spin-operator.shim-executor.yaml
160161
```
161162

162163
## Deploying a Spin App to AKS

content/en/docs/install/installing-with-helm.md

Lines changed: 12 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ description: This guide walks you through the process of installing SpinKube usi
44
date: 2024-02-16
55
tags: [Installation]
66
aliases:
7-
- /docs/spin-operator/installation/installing-with-helm
7+
- /docs/spin-operator/installation/installing-with-helm
88
---
99

1010
## Prerequisites
@@ -61,36 +61,35 @@ here we install the defaults.
6161
representing Spin applications to be scheduled on the cluster.
6262

6363
```shell
64-
kubectl apply -f https://github.com/spinkube/spin-operator/releases/download/v0.3.0/spin-operator.crds.yaml
64+
kubectl apply -f https://github.com/spinkube/spin-operator/releases/download/v0.4.0/spin-operator.crds.yaml
6565
```
6666

6767
- Next we create a [RuntimeClass]({{< ref "glossary#runtime-class" >}}) that points to the `spin`
68-
handler called `wasmtime-spin-v2`. If you are deploying to a production cluster that only has a shim
69-
on a subset of nodes, you'll need to modify the RuntimeClass with a `nodeSelector:`:
68+
handler called `wasmtime-spin-v2`. If you are deploying to a production cluster that only has a shim
69+
on a subset of nodes, you'll need to modify the RuntimeClass with a `nodeSelector:`:
7070

7171
```shell
72-
kubectl apply -f https://github.com/spinkube/spin-operator/releases/download/v0.3.0/spin-operator.runtime-class.yaml
72+
kubectl apply -f https://github.com/spinkube/spin-operator/releases/download/v0.4.0/spin-operator.runtime-class.yaml
7373
```
7474

7575
- Finally, we create a `containerd-spin-shim` [SpinAppExecutor]({{< ref
7676
"glossary#spin-app-executor-crd" >}}). This tells the Spin Operator to use the RuntimeClass we
7777
just created to run Spin Apps:
7878

7979
```shell
80-
kubectl apply -f https://github.com/spinkube/spin-operator/releases/download/v0.3.0/spin-operator.shim-executor.yaml
80+
kubectl apply -f https://github.com/spinkube/spin-operator/releases/download/v0.4.0/spin-operator.shim-executor.yaml
8181
```
8282

8383
### Installing the Spin Operator Chart
8484

8585
The following installs the chart with the release name `spin-operator`:
8686

87-
8887
```shell
8988
# Install Spin Operator with Helm
9089
helm install spin-operator \
9190
--namespace spin-operator \
9291
--create-namespace \
93-
--version 0.3.0 \
92+
--version 0.4.0 \
9493
--wait \
9594
oci://ghcr.io/spinkube/charts/spin-operator
9695
```
@@ -101,7 +100,7 @@ Note that you may also need to upgrade the spin-operator CRDs in tandem with upg
101100
release:
102101

103102
```shell
104-
kubectl apply -f https://github.com/spinkube/spin-operator/releases/download/v0.3.0/spin-operator.crds.yaml
103+
kubectl apply -f https://github.com/spinkube/spin-operator/releases/download/v0.4.0/spin-operator.crds.yaml
105104
```
106105

107106
To upgrade the `spin-operator` release, run the following:
@@ -110,7 +109,7 @@ To upgrade the `spin-operator` release, run the following:
110109
# Upgrade Spin Operator using Helm
111110
helm upgrade spin-operator \
112111
--namespace spin-operator \
113-
--version 0.3.0 \
112+
--version 0.4.0 \
114113
--wait \
115114
oci://ghcr.io/spinkube/charts/spin-operator
116115
```
@@ -130,7 +129,7 @@ To completely uninstall all resources related to spin-operator, you may want to
130129
corresponding CRD resources and the RuntimeClass:
131130

132131
```shell
133-
kubectl delete -f https://github.com/spinkube/spin-operator/releases/download/v0.3.0/spin-operator.shim-executor.yaml
134-
kubectl delete -f https://github.com/spinkube/spin-operator/releases/download/v0.3.0/spin-operator.runtime-class.yaml
135-
kubectl delete -f https://github.com/spinkube/spin-operator/releases/download/v0.3.0/spin-operator.crds.yaml
132+
kubectl delete -f https://github.com/spinkube/spin-operator/releases/download/v0.4.0/spin-operator.shim-executor.yaml
133+
kubectl delete -f https://github.com/spinkube/spin-operator/releases/download/v0.4.0/spin-operator.runtime-class.yaml
134+
kubectl delete -f https://github.com/spinkube/spin-operator/releases/download/v0.4.0/spin-operator.crds.yaml
136135
```

content/en/docs/install/linode-kubernetes-engine.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,7 @@ $ spin kube scaffold --from ghcr.io/spinkube/containerd-shim-spin/examples/spin-
114114
This will write the following to `hello-world.yaml`:
115115

116116
```yaml
117-
apiVersion: core.spinoperator.dev/v1alpha1
117+
apiVersion: core.spinkube.dev/v1alpha1
118118
kind: SpinApp
119119
metadata:
120120
name: spin-rust-hello
@@ -128,7 +128,7 @@ Using `kubectl apply`, we can deploy that app:
128128

129129
```console
130130
$ kubectl apply -f hello-world.yaml
131-
spinapp.core.spinoperator.dev/spin-rust-hello created
131+
spinapp.core.spinkube.dev/spin-rust-hello created
132132
```
133133

134134
With SpinKube, SpinApps will be deployed as `Pod` resources, so we can see the app using `kubectl
@@ -157,7 +157,7 @@ metadata:
157157
annotations:
158158
service.beta.kubernetes.io/linode-loadbalancer-throttle: "4"
159159
labels:
160-
core.spinoperator.dev/app-name: spin-rust-hello
160+
core.spinkube.dev/app-name: spin-rust-hello
161161
spec:
162162
type: LoadBalancer
163163
ports:
@@ -166,7 +166,7 @@ spec:
166166
protocol: TCP
167167
targetPort: 80
168168
selector:
169-
core.spinoperator.dev/app.spin-rust-hello.status: ready
169+
core.spinkube.dev/app.spin-rust-hello.status: ready
170170
sessionAffinity: None
171171
```
172172

@@ -209,7 +209,7 @@ To delete this sample app, we will first delete the NodeBalancer, and then delet
209209
$ kubectl delete service spin-rust-hello-nodebalancer
210210
service "spin-rust-hello-nodebalancer" deleted
211211
$ kubectl delete spinapp spin-rust-hello
212-
spinapp.core.spinoperator.dev "spin-rust-hello" deleted
212+
spinapp.core.spinkube.dev "spin-rust-hello" deleted
213213
```
214214

215215
> If you delete the NodeBalancer out of the Linode console, it will not automatically delete the

content/en/docs/install/microk8s.md

Lines changed: 16 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -61,15 +61,15 @@ Now we’re ready to install the SpinKube environment for running Spin applicati
6161

6262
### Installing SpinKube
6363

64-
SpinKube provides the entire toolkit for running Spin serverless apps. You may want to familiarize
64+
SpinKube provides the entire toolkit for running Spin serverless apps. You may want to familiarize
6565
yourself with the [SpinKube quickstart](https://www.spinkube.dev/docs/install/quickstart/) guide
6666
before proceeding.
6767

6868
First, we need to apply a runtime class and a CRD for SpinKube:
6969

7070
```console { data-plausible="copy-quick-deploy-sample" }
71-
$ microk8s kubectl apply -f https://github.com/spinkube/spin-operator/releases/download/v0.3.0/spin-operator.runtime-class.yaml
72-
$ microk8s kubectl apply -f https://github.com/spinkube/spin-operator/releases/download/v0.3.0/spin-operator.crds.yaml
71+
$ microk8s kubectl apply -f https://github.com/spinkube/spin-operator/releases/download/v0.4.0/spin-operator.runtime-class.yaml
72+
$ microk8s kubectl apply -f https://github.com/spinkube/spin-operator/releases/download/v0.4.0/spin-operator.crds.yaml
7373
```
7474

7575
Both of these should apply immediately.
@@ -89,15 +89,15 @@ $ microk8s kubectl annotate node --all kwasm.sh/kwasm-node=true
8989
Next, we need to install SpinKube’s operator using Helm (which is included with Microk8s).
9090

9191
```console { data-plausible="copy-quick-deploy-sample" }
92-
$ microk8s helm install spin-operator --namespace spin-operator --create-namespace --version 0.3.0 --wait oci://ghcr.io/spinkube/charts/spin-operator
92+
$ microk8s helm install spin-operator --namespace spin-operator --create-namespace --version 0.4.0 --wait oci://ghcr.io/spinkube/charts/spin-operator
9393

9494
```
9595

9696
Now we have the main operator installed. There is just one more step. We need to install the shim
9797
executor, which is a special CRD that allows us to use multiple executors for WebAssembly.
9898

9999
```console { data-plausible="copy-quick-deploy-sample" }
100-
$ microk8s kubectl apply -f https://github.com/spinkube/spin-operator/releases/download/v0.3.0/spin-operator.shim-executor.yaml
100+
$ microk8s kubectl apply -f https://github.com/spinkube/spin-operator/releases/download/v0.4.0/spin-operator.shim-executor.yaml
101101

102102
```
103103

@@ -113,10 +113,11 @@ is by creating a simple `SpinApp` resource. Let's use the simple example from Sp
113113
```console { data-plausible="copy-quick-deploy-sample" }
114114
$ microk8s kubectl apply -f https://raw.githubusercontent.com/spinkube/spin-operator/main/config/samples/simple.yaml
115115
```
116+
116117
The above installs a simple `SpinApp` YAML that looks like this:
117118

118119
```yaml
119-
apiVersion: core.spinoperator.dev/v1alpha1
120+
apiVersion: core.spinkube.dev/v1alpha1
120121
kind: SpinApp
121122
metadata:
122123
name: simple-spinapp
@@ -192,15 +193,15 @@ metadata:
192193
name: http-ingress
193194
spec:
194195
rules:
195-
- http:
196-
paths:
197-
- path: /
198-
pathType: Prefix
199-
backend:
200-
service:
201-
name: simple-spinapp
202-
port:
203-
number: 80
196+
- http:
197+
paths:
198+
- path: /
199+
pathType: Prefix
200+
backend:
201+
service:
202+
name: simple-spinapp
203+
port:
204+
number: 80
204205
```
205206

206207
Install the above with `microk8s kubectl -f ingress.yaml`. After a moment or two, you should be able

content/en/docs/install/quickstart.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@ title: Quickstart
33
description: Learn how to setup a Kubernetes cluser, install SpinKube and run your first Spin App.
44
weight: 2
55
aliases:
6-
- /docs/quickstart
7-
- /docs/spin-operator/quickstart
6+
- /docs/quickstart
7+
- /docs/spin-operator/quickstart
88
---
99

1010
This Quickstart guide demonstrates how to set up a new Kubernetes cluster, install the SpinKube and
@@ -28,7 +28,7 @@ For this Quickstart guide, you will need:
2828
[containerd-shim-spin](https://github.com/spinkube/containerd-shim-spin) prerequisite already
2929
installed:
3030

31-
```console { data-plausible="copy-quick-create-k3d" }
31+
```console { data-plausible="copy-quick-create-k3d" }
3232
k3d cluster create wasm-cluster \
3333
--image ghcr.io/spinkube/containerd-shim-spin/k3d:v0.16.0 \
3434
--port "8081:80@loadbalancer" \
@@ -55,14 +55,14 @@ kubectl wait --for=condition=available --timeout=300s deployment/cert-manager-we
5555
> every node.
5656
5757
```console { data-plausible="copy-quick-apply-runtime-class" }
58-
kubectl apply -f https://github.com/spinkube/spin-operator/releases/download/v0.3.0/spin-operator.runtime-class.yaml
58+
kubectl apply -f https://github.com/spinkube/spin-operator/releases/download/v0.4.0/spin-operator.runtime-class.yaml
5959
```
6060

6161
4. Apply the [Custom Resource Definitions]({{< ref "glossary#custom-resource-definition-crd" >}})
6262
used by the Spin Operator:
6363

6464
```console { data-plausible="copy-quick-apply-crd" }
65-
kubectl apply -f https://github.com/spinkube/spin-operator/releases/download/v0.3.0/spin-operator.crds.yaml
65+
kubectl apply -f https://github.com/spinkube/spin-operator/releases/download/v0.4.0/spin-operator.crds.yaml
6666
```
6767

6868
## Deploy the Spin Operator
@@ -77,15 +77,15 @@ and pods are spinning up.
7777
helm install spin-operator \
7878
--namespace spin-operator \
7979
--create-namespace \
80-
--version 0.3.0 \
80+
--version 0.4.0 \
8181
--wait \
8282
oci://ghcr.io/spinkube/charts/spin-operator
8383
```
8484

8585
Lastly, create the [shim executor]({{< ref "glossary#spin-app-executor-crd" >}}):
8686

8787
```console { data-plausible="copy-quick-create-shim-executor" }
88-
kubectl apply -f https://github.com/spinkube/spin-operator/releases/download/v0.3.0/spin-operator.shim-executor.yaml
88+
kubectl apply -f https://github.com/spinkube/spin-operator/releases/download/v0.4.0/spin-operator.shim-executor.yaml
8989
```
9090

9191
## Run the Sample Application

content/en/docs/install/rancher-desktop.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ Replace `ttl.sh/hello-k3s:0.1.0` with your registry URL and tag.
9191
```bash
9292
$ spin kube scaffold --from ttl.sh/hello-k3s:0.1.0
9393

94-
apiVersion: core.spinoperator.dev/v1alpha1
94+
apiVersion: core.spinkube.dev/v1alpha1
9595
kind: SpinApp
9696
metadata:
9797
name: hello-k3s

0 commit comments

Comments
 (0)