docs: refines ingress docs for local testing (#103)

Signed-off-by: ChrisJBurns <29541485+ChrisJBurns@users.noreply.github.com>

Author: ChrisJBurns

.gitignore

@@ -30,3 +30,5 @@ go.work
 
 .roo/
 thv
+
+kconfig.yaml

Taskfile.yml

@@ -56,10 +56,21 @@ tasks:
       IMAGE:
         sh: ko build --platform linux/amd64 --local -B ./cmd/thv | tail -n 1
     cmds:
+      # gets the local kind kubeconfig
+      - kind get kubeconfig > kconfig.yaml
       # Load the image into kind
       - echo "Loading image {{.IMAGE}} into kind..."
       - kind load docker-image {{.IMAGE}}
       # Apply the Kubernetes manifest
       - echo "Applying Kubernetes manifest..."
-      - kubectl apply -f <(KO_DOCKER_REPO=kind.local ko resolve --platform linux/amd64 -f deploy/k8s/thv.yml)
-      # Wait for the deployment to be available
+      - kubectl apply -f <(KO_DOCKER_REPO=kind.local ko resolve --platform linux/amd64 -f deploy/k8s/thv.yaml) --kubeconfig kconfig.yaml
+      # Create RoleBinding for ToolHive until (TODO: https://github.com/StacklokLabs/toolhive/issues/102) is done
+      - kubectl create clusterrolebinding default-view --clusterrole=cluster-admin --serviceaccount=default:default --kubeconfig kconfig.yaml
+      - echo "Applying Kubernetes Ingress manifest..."
+      - kubectl apply -f https://kind.sigs.k8s.io/examples/ingress/deploy-ingress-nginx.yaml --kubeconfig kconfig.yaml
+      # we want to wait until the nginx controlle is ready before we apply our ingress object
+      - kubectl wait --namespace=ingress-nginx --for=condition=ready pod --selector=app.kubernetes.io/instance=ingress-nginx,app.kubernetes.io/component=controller --timeout=120s --kubeconfig kconfig.yaml
+      - kubectl apply -f deploy/k8s/ingress.yaml --kubeconfig kconfig.yaml
+      # We do the below commands because of some inconsistency between the secret and webhook caBundle. ref: https://github.com/kubernetes/ingress-nginx/issues/5968#issuecomment-849772666
+      - CA=$(kubectl -n ingress-nginx get secret ingress-nginx-admission -ojsonpath='{.data.ca}' --kubeconfig kconfig.yaml)
+      - kubectl patch validatingwebhookconfigurations ingress-nginx-admission --type='json' --patch='[{"op":"add","path":"/webhooks/0/clientConfig/caBundle","value":"'$CA'"}]' --kubeconfig kconfig.yaml

deploy/k8s/ingress.yaml

@@ -0,0 +1,24 @@
+---
+apiVersion: networking.k8s.io/v1
+kind: Ingress
+metadata:
+  name: example-ingress
+spec:
+  ingressClassName: nginx
+  rules:
+  - http:
+      paths:
+      - pathType: Prefix
+        path: /sse
+        backend:
+          service:
+            name: toolhive
+            port:
+              number: 8080
+      - pathType: Prefix
+        path: /messages
+        backend:
+          service:
+            name: toolhive
+            port:
+              number: 8080

deploy/k8s/thv.yml renamed to deploy/k8s/thv.yaml

@@ -22,6 +22,9 @@ spec:
       - name: toolhive
         image: ko://github.com/stacklok/toolhive/cmd/thv
         args: ["run", "--foreground=true", "--port=8080", "--name=mcp-fetch", "docker.io/mcp/fetch"]
+        env:
+        - name: UNSTRUCTURED_LOGS
+          value: "false"
         resources:
           limits:
             cpu: "100m"

docs/ingress.md

@@ -2,52 +2,40 @@
 
 > Disclaimer: ChrisB to refine when back home.
 
-Prereqs:
-- have a local kind cluster running and working, and running an MCP server with the proxy workload fronting it
+Prerequisites:
+- Have a local Kind Cluster running
+- Have an MCP server with the proxy workload fronting it (this can be achieved by running the `test-k8s-apply` Taskfile task. `task test-k8s-apply`)
 
-Run the local Kind Go binary that acts as a small LoadBalancer that gives IPs to ingress controllers inside of the cluster. This mimicks the behaviour of Cloud LBs
+There should now be a local Kind cluster with an MCP server running and a ToolHive proxy running, in addition to an Nginx Ingress controller running and pending an ExternalIP.
+
+To give the ingress controller an IP, we will run a local Kind Go binary that acts as a small LoadBalancer that gives IPs to ingress controllers inside of the Kind Cluster. This binary mimicks Cloud Providers LoadBalancers functionality for local Kind setups.
 
 ```
 go install sigs.k8s.io/cloud-provider-kind@latest
 sudo ~/go/bin/cloud-provider-kind
 ```
 
-Install the Nginx controller
-```
-kubectl apply -f https://kind.sigs.k8s.io/examples/ingress/deploy-ingress-nginx.yaml
-```
-
-When the ingress controller is running, you should have an external IP set for it. Take not of this IP.
-
-Add the following Ingress yaml that points to your toolhive service:
-```yaml
----
-apiVersion: networking.k8s.io/v1
-kind: Ingress
-metadata:
-  name: example-ingress
-spec:
-  ingressClassName: nginx
-  rules:
-  - http:
-      paths:
-      - pathType: Prefix
-        path: /sse
-        backend:
-          service:
-            name: toolhive
-            port:
-              number: 8080
-      - pathType: Prefix
-        path: /messages
-        backend:
-          service:
-            name: toolhive
-            port:
-              number: 8080
-```
-
-Now, you _should_ be able to curl the endpoint via `curl http://$EXTERNAL_IP/sse` and see a connection.
-
-## Chris To Do
-- adds the docs for the addition of a host name to make it look more ingressy, this avoids the IP requirement.g
+After a few moments, the ingress controller should be running and the service should have an external IP set for it. Run the below to get the IP and store it in a variable, and then curl the MCP server endpoint to see a connection.
+
+```
+$ LB_IP=$(kubectl get svc/ingress-nginx-controller -n ingress-nginx -o=jsonpath='{.status.loadBalancer.ingress[0].ip}')
+$ curl $LB_IP/sse
+event: endpoint
+data: http://172.20.0.3/messages?session_id=637d766e-354a-45b6-bc91-e153a35bc49f
+```
+
+## Ingress with Local Hostname
+
+In order to avoid using of the IP you can use a hostname instead of preferred. This can be achieved by modifying the `/etc/hosts` file to include a mapping for the load balancer IP to a friendly hostname.
+
+```
+sudo sh -c "echo '$LB_IP mcp-server.dev' >> /etc/hosts"
+```
+
+Now when you curl that endpoint, it should connect as it did with the IP
+
+```
+$ curl mcp-server.dev/sse
+event: endpoint
+data: http://mcp-server.dev/messages?session_id=337e4d34-5fb0-4ccc-9959-fc382d5b4800
+```