Skip to content

Commit

Permalink
Merge pull request #231 from calebschoepp/update-to-v0.3.0
Browse files Browse the repository at this point in the history
Update docs to point at v0.3.0
  • Loading branch information
calebschoepp authored Sep 6, 2024
2 parents 373b9d5 + 73b4faf commit 1170ceb
Show file tree
Hide file tree
Showing 8 changed files with 30 additions and 30 deletions.
8 changes: 4 additions & 4 deletions content/en/docs/contrib/troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,11 @@ might assist you with your work.
## 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.2.0/spin-operator.shim-executor.yaml`
https://github.com/spinkube/spin-operator/releases/download/v0.3.0/spin-operator.shim-executor.yaml`
command:

```console
Error from server (InternalError): error when creating "https://github.com/spinkube/spin-operator/releases/download/v0.2.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"
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"
```

To address the error above, first look to see if Spin Operator is running:
Expand Down Expand Up @@ -62,13 +62,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.2.0 \
--version 0.3.0 \
--wait \
oci://ghcr.io/spinkube/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.2.0/spin-operator.shim-executor.yaml`
https://github.com/spinkube/spin-operator/releases/download/v0.3.0/spin-operator.shim-executor.yaml`
command again. The issue should be resolved now.

## Error Validating Data: Connection Refused
Expand Down
6 changes: 3 additions & 3 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.2.0/spin-operator.crds.yaml
kubectl apply -f https://github.com/spinkube/spin-operator/releases/download/v0.3.0/spin-operator.crds.yaml

# Install the Runtime Class
kubectl apply -f https://github.com/spinkube/spin-operator/releases/download/v0.2.0/spin-operator.runtime-class.yaml
kubectl apply -f https://github.com/spinkube/spin-operator/releases/download/v0.3.0/spin-operator.runtime-class.yaml
```

The following installs [cert-manager](https://github.com/cert-manager/cert-manager) which is
Expand Down Expand Up @@ -156,7 +156,7 @@ helm install 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.2.0/spin-operator.shim-executor.yaml
kubectl apply -f https://github.com/spinkube/spin-operator/releases/download/v0.3.0/spin-operator.shim-executor.yaml
```

## Deploying a Spin App to AKS
Expand Down
14 changes: 7 additions & 7 deletions content/en/docs/install/installing-with-helm.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,23 +62,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.2.0/spin-operator.crds.yaml
kubectl apply -f https://github.com/spinkube/spin-operator/releases/download/v0.3.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.2.0/spin-operator.runtime-class.yaml
kubectl apply -f https://github.com/spinkube/spin-operator/releases/download/v0.3.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.2.0/spin-operator.shim-executor.yaml
kubectl apply -f https://github.com/spinkube/spin-operator/releases/download/v0.3.0/spin-operator.shim-executor.yaml
```

### Installing the Spin Operator Chart
Expand All @@ -102,7 +102,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.2.0/spin-operator.crds.yaml
kubectl apply -f https://github.com/spinkube/spin-operator/releases/download/v0.3.0/spin-operator.crds.yaml
```

To upgrade the `spin-operator` release, run the following:
Expand Down Expand Up @@ -131,7 +131,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.2.0/spin-operator.shim-executor.yaml
kubectl delete -f https://github.com/spinkube/spin-operator/releases/download/v0.2.0/spin-operator.runtime-class.yaml
kubectl delete -f https://github.com/spinkube/spin-operator/releases/download/v0.2.0/spin-operator.crds.yaml
kubectl delete -f https://github.com/spinkube/spin-operator/releases/download/v0.3.0/spin-operator.shim-executor.yaml
kubectl delete -f https://github.com/spinkube/spin-operator/releases/download/v0.3.0/spin-operator.runtime-class.yaml
kubectl delete -f https://github.com/spinkube/spin-operator/releases/download/v0.3.0/spin-operator.crds.yaml
```
6 changes: 3 additions & 3 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.2.0/spin-operator.runtime-class.yaml
$ microk8s kubectl apply -f https://github.com/spinkube/spin-operator/releases/download/v0.2.0/spin-operator.crds.yaml
$ microk8s kubectl apply -f https://github.com/spinkube/spin-operator/releases/download/v0.3.0/spin-operator.runtime-class.yaml
$ microk8s kubectl apply -f https://github.com/spinkube/spin-operator/releases/download/v0.3.0/spin-operator.crds.yaml
```

Both of these should apply immediately.
Expand Down Expand Up @@ -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.2.0/spin-operator.shim-executor.yaml
$ microk8s kubectl apply -f https://github.com/spinkube/spin-operator/releases/download/v0.3.0/spin-operator.shim-executor.yaml

```

Expand Down
8 changes: 4 additions & 4 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.2.0/spin-operator.runtime-class.yaml
kubectl apply -f https://github.com/spinkube/spin-operator/releases/download/v0.3.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.2.0/spin-operator.crds.yaml
kubectl apply -f https://github.com/spinkube/spin-operator/releases/download/v0.3.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.2.0 \
--version 0.3.0 \
--wait \
oci://ghcr.io/spinkube/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.2.0/spin-operator.shim-executor.yaml
kubectl apply -f https://github.com/spinkube/spin-operator/releases/download/v0.3.0/spin-operator.shim-executor.yaml
```

## Run the Sample Application
Expand Down
8 changes: 4 additions & 4 deletions content/en/docs/topics/autoscaling/scaling-with-hpa.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,10 +74,10 @@ Next, run the following commands to install the Spin [Runtime Class]({{<ref "glo
```console
# Install the RuntimeClass
kubectl apply -f https://github.com/spinkube/spin-operator/releases/download/v0.2.0/spin-operator.runtime-class.yaml
kubectl apply -f https://github.com/spinkube/spin-operator/releases/download/v0.3.0/spin-operator.runtime-class.yaml

# Install the CRDs
kubectl apply -f https://github.com/spinkube/spin-operator/releases/download/v0.2.0/spin-operator.crds.yaml
kubectl apply -f https://github.com/spinkube/spin-operator/releases/download/v0.3.0/spin-operator.crds.yaml
```

Lastly, install Spin Operator using `helm` and the [shim executor]({{< ref
Expand All @@ -88,12 +88,12 @@ Lastly, install Spin Operator using `helm` and the [shim executor]({{< ref
helm install spin-operator \
--namespace spin-operator \
--create-namespace \
--version 0.2.0 \
--version 0.3.0 \
--wait \
oci://ghcr.io/spinkube/charts/spin-operator

# Install the shim executor
kubectl apply -f https://github.com/spinkube/spin-operator/releases/download/v0.2.0/spin-operator.shim-executor.yaml
kubectl apply -f https://github.com/spinkube/spin-operator/releases/download/v0.3.0/spin-operator.shim-executor.yaml
```

Great, now you have Spin Operator up and running on your cluster. This means you’re set to create
Expand Down
8 changes: 4 additions & 4 deletions content/en/docs/topics/autoscaling/scaling-with-keda.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,10 +74,10 @@ Next, run the following commands to install the Spin [Runtime Class]({{<ref "glo
```console
# Install the RuntimeClass
kubectl apply -f https://github.com/spinkube/spin-operator/releases/download/v0.2.0/spin-operator.runtime-class.yaml
kubectl apply -f https://github.com/spinkube/spin-operator/releases/download/v0.3.0/spin-operator.runtime-class.yaml

# Install the CRDs
kubectl apply -f https://github.com/spinkube/spin-operator/releases/download/v0.2.0/spin-operator.crds.yaml
kubectl apply -f https://github.com/spinkube/spin-operator/releases/download/v0.3.0/spin-operator.crds.yaml
```

Lastly, install Spin Operator using `helm` and the [shim executor]({{< ref
Expand All @@ -88,12 +88,12 @@ Lastly, install Spin Operator using `helm` and the [shim executor]({{< ref
helm install spin-operator \
--namespace spin-operator \
--create-namespace \
--version 0.2.0 \
--version 0.3.0 \
--wait \
oci://ghcr.io/spinkube/charts/spin-operator

# Install the shim executor
kubectl apply -f https://github.com/spinkube/spin-operator/releases/download/v0.2.0/spin-operator.shim-executor.yaml
kubectl apply -f https://github.com/spinkube/spin-operator/releases/download/v0.3.0/spin-operator.shim-executor.yaml
```

Great, now you have Spin Operator up and running on your cluster. This means you’re set to create
Expand Down
2 changes: 1 addition & 1 deletion crd-reference/generate.sh
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ root_dir=$(dirname ${script_dir})

cd $script_dir

SPIN_OPERATOR_RELEASE=${SPIN_OPERATOR_RELEASE:-v0.2.0}
SPIN_OPERATOR_RELEASE=${SPIN_OPERATOR_RELEASE:-v0.3.0}

echo "Installing crdoc"
go install fybrik.io/crdoc@latest
Expand Down

0 comments on commit 1170ceb

Please sign in to comment.