Skip to content
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions content/en/blog/community/spinkube-kind-rd/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -232,7 +232,7 @@ kubectl apply -f https://github.com/spinkube/spin-operator/releases/download/v0.
kubectl apply -f https://github.com/spinkube/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
Expand All @@ -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
Expand Down
20 changes: 10 additions & 10 deletions content/en/docs/contrib/troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,30 +11,30 @@ 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/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).

## 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`).

## 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:
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
12 changes: 6 additions & 6 deletions content/en/docs/install/azure-kubernetes-service.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand All @@ -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
Expand Down
22 changes: 11 additions & 11 deletions content/en/docs/install/installing-with-helm.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,23 +61,23 @@ 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`
handler called `wasmtime-spin-v2`. If you are deploying to a production cluster that only has a shim
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
"glossary#spin-app-executor-crd" >}}). This tells the Spin Operator to use the RuntimeClass we
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
Expand All @@ -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
Expand All @@ -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:
Expand All @@ -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
Expand All @@ -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
```
10 changes: 5 additions & 5 deletions content/en/docs/install/microk8s.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -89,15 +89,15 @@ $ 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

```

Now we have the main operator installed. There is just one more step. We need to install the shim
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

```

Expand All @@ -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:
Expand Down
12 changes: 6 additions & 6 deletions content/en/docs/install/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand All @@ -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:
Expand Down
Loading