docs: added image

spectrocloud · Mar 25, 2024 · c6cff54 · c6cff54
1 parent c3c1357
commit c6cff54
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -84,6 +84,12 @@ When deploying the Hello Universe application into a Kubernetes cluster, set the
 > [!NOTE]
 > The `QUERY_K8S_API` environment variable is only used when deploying the Hello Universe application into a Kubernetes cluster. Enabling this environment variable will query the Kubernetes API for the service hostname. You can review the script in the `scripts/service-ip.sh`.
 
+![K8s diagram](./static/img/k8s-diagram.png)
+
+Inside the Hello Universe container, [Caddy](https://caddyserver.com/) is used as a reverse proxy to route requests to the API server. The API server is expected to be listening on port `3000`.
+
+If the Hello Universe API is enabled for authorization, provide the `TOKEN` environment variable with the API authorization token. The default anonymous token is `"931A3B02-8DCC-543F-A1B2-69423D1A0B94"`. The reverse proxy will include the token when forwarding requests to the API server.
+
 ## Image Verification
 
 We sign our images through [Cosign](https://docs.sigstore.dev/signing/quickstart/). Review the [Image Verification](./docs/image-verification.md) page to learn more.

diff --git a/static/img/k8s-diagram.png b/static/img/k8s-diagram.png