Skip to content

Commit

Permalink
chore: Update Quickstart & remove instructions for cloning the repo
Browse files Browse the repository at this point in the history
Cloning the repository is not required anymore. This commit updates the quickstart to reflect those changes

Signed-off-by: Thorsten Hans <thorsten.hans@fermyon.com>
  • Loading branch information
ThorstenHans committed Mar 12, 2024
1 parent 6dc2f3d commit eced6bd
Showing 1 changed file with 9 additions and 13 deletions.
22 changes: 9 additions & 13 deletions content/en/docs/spin-operator/quickstart/_index.md
Expand Up @@ -17,13 +17,7 @@ For this Quickstart in particular, you will need:
- [kubectl]({{< ref "prerequisites#kubectl" >}}) - the Kubernetes CLI
- [Docker]({{< ref "prerequisites#docker" >}}) - for running k3d
- [k3d]({{< ref "prerequisites#k3d" >}}) - a lightweight Kubernetes distribution that runs on Docker

Also, ensure you have cloned the Spin Operator repository and have navigated to the root of the project:

```shell
git clone git@github.com:spinkube/spin-operator.git
cd spin-operator
```
- [Helm]({{< ref "prerequisites#helm" >}}) - the package manager for Kubernetes

### Set up Your Kubernetes Cluster

Expand All @@ -38,8 +32,6 @@ k3d cluster create wasm-cluster \

> Note: Spin Operator requires a few Kubernetes resources that are installed globally to the cluster. We create these directly through `kubectl` as a best practice, since their lifetimes are usually managed separately from a given Spin Operator installation.
> For now our quickstart relies on `make` tasks within the repository. We will provide Kustomize and Helm instructions in the future.
2. Install cert-manager

```console
Expand All @@ -62,12 +54,16 @@ kubectl apply -f https://github.com/spinkube/spin-operator/releases/download/v0.

## Deploy the Spin Operator

Execute the following command to run the Spin Operator locally. This will create all of the Kubernetes resources required by Spin Operator under the Kubernetes namespace `spin-operator`. It may take a moment for the installation to complete as dependencies are installed and pods are spinning up.
Execute the following command to install the Spin Operator on the K3d cluster using Helm. This will create all of the Kubernetes resources required by Spin Operator under the Kubernetes namespace `spin-operator`. It may take a moment for the installation to complete as dependencies are installed and pods are spinning up.

```console
make docker-build IMG=ghcr.io/spinkube/spin-operator:dev
k3d image import -c wasm-cluster ghcr.io/spinkube/spin-operator:dev
make deploy IMG=ghcr.io/spinkube/spin-operator:dev
# Install Spin Operator with Helm
helm install spin-operator \
--namespace spin-operator \
--create-namespace \
--version 0.0.2 \
--wait \
oci://ghcr.io/spinkube/charts/spin-operator
```

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

0 comments on commit eced6bd

Please sign in to comment.