Skip to content

Commit

Permalink
doc(examples/cloudretro): Fix minor issues
Browse files Browse the repository at this point in the history
- use FQ docker image name to make it work with podman
- fix external_ip query command
- add stunner install instruction due to non-default namespace
- detail testing by mentioning the URL to visit
  • Loading branch information
levaitamas committed May 28, 2024
1 parent bd4199c commit af70f3d
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 9 deletions.
12 changes: 9 additions & 3 deletions docs/examples/cloudretro/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ the exposed service of the Coordinator, which clients will connect to. Running
command will result the IP address assigned by the Kubernetes load-balancer:

```console
export EXTERNAL_IP=$(kubectl get service -n cloudretro coordinator-lb-svc -o jsonpath='{.status.loadBalancer.ingress[0].ip})'
export EXTERNAL_IP=$(kubectl get service -n cloudretro coordinator-lb-svc -o jsonpath='{.status.loadBalancer.ingress[0].ip}')
```

If Kubernetes refuses to assign an external IP to your service after a couple of minutes, you will
Expand All @@ -79,7 +79,13 @@ the CloudRetro servers running on a private pod IP address. That is where STUNne

### STUNner

You will need to install Stunner on Your cluster, you can do this by following the official [installation guide](../../INSTALL.md#installation).
First we install STUNner gateway operator with helm ([more info](https://github.com/l7mp/stunner-helm)):
```console
helm repo add stunner https://l7mp.io/stunner
helm repo update
helm install stunner-gateway-operator stunner/stunner-gateway-operator --create-namespace --namespace=stunner
```

Wait until all the necessary resources are up and running, then you are ready to continue.

Next, register STUNner with the Kubernetes Gateway API.
Expand Down Expand Up @@ -148,7 +154,7 @@ the CloudRetro config accordingly and restart CloudRetro to pick up the new conf

### Test

At this point, you should be able to play SuperMario on CloudRetro installed in Kubernetes.
At this point, you can play SuperMario on CloudRetro installed in Kubernetes by navigating to `http://${EXTERNAL-IP}:8000` in your web browser.

![Supre Maro let's go](mario-super.gif)

Expand Down
6 changes: 3 additions & 3 deletions docs/examples/cloudretro/cloudretro-setup-coordinator.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
# The following yaml script will install a cloud-retro setup in your Kubernetes cluster
# with the needed services. With an invalid configuration of course, for this to properly work
# You need the apply-config.sh minimalistic shell script to update the config with the unclear addresses.
#
#
#
# In short, no touching.
#
Expand Down Expand Up @@ -39,7 +39,7 @@ spec:
spec:
containers:
- name: coordinator
image: valniae/snekyrepo:crdi
image: docker.io/valniae/snekyrepo:crdi
envFrom:
- configMapRef:
name: cloudretro-config-c
Expand All @@ -61,4 +61,4 @@ spec:
- port: 8000
targetPort: 8000
#nodePort: 30001
type: LoadBalancer
type: LoadBalancer
6 changes: 3 additions & 3 deletions docs/examples/cloudretro/cloudretro-setup-workers.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
# The following yaml script will install a cloud-retro setup in your Kubernetes cluster
# with the needed services. With an invalid configuration of course, for this to properly work
# You need the apply-config.sh minimalistic shell script to update the config with the unclear addresses.
#
#
# Please not that this will only install the workers. For them to work, you will need a coordinator deployment as well.
#
# In short, no touching.
Expand Down Expand Up @@ -42,7 +42,7 @@ spec:
spec:
containers:
- name: worker
image: valniae/snekyrepo:crdi
image: docker.io/valniae/snekyrepo:crdi
envFrom:
- configMapRef:
name: cloudretro-config-w
Expand Down Expand Up @@ -80,4 +80,4 @@ spec:
- protocol: UDP
port: 8443
targetPort: 8443
type: ClusterIP
type: ClusterIP

0 comments on commit af70f3d

Please sign in to comment.