Spin Operator

To upgrade the spin-operator release, use helm upgrade. Note that you may also need to upgrade the CRDs in tandem with the Helm release to ensure compatibility:

1. Upgrade CRDs:

$ kubectl apply -f https://raw.githubusercontent.com/spinframework/spin-operator/main/config/crd/bases/core.spinkube.dev_spinapps.yaml
$ kubectl apply -f https://raw.githubusercontent.com/spinframework/spin-operator/main/config/crd/bases/core.spinkube.dev_spinappexecutors.yaml

2. Upgrade Helm release:

$ helm upgrade spin-operator \
  --namespace spin-operator \
  --version {{ CHART_VERSION }} \
  oci://ghcr.io/spinframework/charts/spin-operator

To make the cpu-load-gen image available for use by SpinApp within spin-operator, you must push the built image to a container registry. Use the spin registry push command followed by the desired image tag (e.g., using a TTL-based tag like ttl.sh).

spin registry push ttl.sh/cpu-load-gen:1h

To remove the spin-operator release and its associated Kubernetes resources, run:

$ helm delete spin-operator --namespace spin-operator

To perform a complete uninstallation including the SpinAppExecutor and the CRDs, run the following commands:

$ kubectl delete -f https://raw.githubusercontent.com/spinframework/spin-operator/main/config/samples/spin-shim-executor.yaml
$ kubectl delete -f https://raw.githubusercontent.com/spinframework/spin-operator/main/config/crd/bases/core.spinkube.dev_spinapps.yaml
$ kubectl delete -f https://raw.githubusercontent.com/spinframework/spin-operator/main/config/crd/bases/core.spinkube.dev_spinappexecutors.yaml

The end-to-end (e2e) test suite for the spin operator uses the Kubernetes e2e-framework to validate the project. You can execute the tests using the standard Go test command from the repository root.

go test ./e2e -v

After deploying both the Spin app and Redis, expose the Spin app locally using kubectl port-forward svc/redis-spinapp 3000:80. You can then interact with Redis using curl commands by passing the desired key in the x-key header.

Place a key-value pair

Use a PUT request with --data-binary to store a value.

Retrieve a value

Perform a standard GET request (default) to fetch the value associated with the key.

Delete a value

Use a DELETE request to remove the key.

# 1. Port-forward the service
kubectl port-forward svc/redis-spinapp 3000:80

# 2. In a new terminal, perform operations:

# Place a key-value pair
curl --request PUT --data-binary "Hello, world\!" -H 'x-key: helloKey' localhost:3000

# Retrieve a value
curl -H 'x-key: helloKey' localhost:3000

# Delete a value
curl --request DELETE -H 'x-key: helloKey' localhost:3000

Use the provided Makefile to manage the build and testing lifecycle of the Spin Operator.

• Run tests: Execute make test to run the test suite.
• Build binary: Execute make to build the Spin Operator binary.

To deploy the Spin application that demonstrates Redis interaction, create a Kubernetes manifest named redis_client.yaml using the SpinApp resource type. Ensure the redis_endpoint variable is set to the correct Redis service address (e.g., redis://redis.default.svc.cluster.local:6379).

Apply the manifest using kubectl apply -f redis_client.yaml.

apiVersion: core.spinkube.dev/v1alpha1
kind: SpinApp
metadata:
  name: redis-spinapp
spec:
  image: "ghcr.io/spinkube/redis-sample"
  replicas: 1
  executor: containerd-shim-spin
  variables:
    - name: redis_endpoint
      value: redis://redis.default.svc.cluster.local:6379

Deploy a Redis instance by creating a Kubernetes manifest named redis_db.yaml containing both a Deployment and a Service. The service must expose port 6379 to allow the Spin app to connect.

Apply the manifest using kubectl apply -f redis_db.yaml.

apiVersion: apps/v1
kind: Deployment
metadata:
  name: redis
  labels:
    app: redis
spec:
  replicas: 1
  selector:
    matchLabels:
      app: redis
  template:
    metadata:
      labels:
        app: redis
    spec:
      containers:
        - name: redis
          image: redis
          ports:
            - containerPort: 6379

---
apiVersion: v1
kind: Service
metadata:
  name: redis
spec:
  selector:
    app: redis
  ports:
    - protocol: TCP
      port: 6379
      targetPort: 6379

The cpu-load-gen application is a Spin application designed to generate CPU load by calculating the Fibonacci sequence. You can build and run it locally using the Spin CLI.

To build the application:

spin build

To run the application locally:

spin up