# hello-kubernetes

> A small web app to deploy on a Kubernetes cluster. Its page shows the message, and the namespace, pod and node that answered. It comes as a container image, a Helm chart and a release file.

These are the docs for hello-kubernetes 1.11.0, the latest release. The docs for older releases are in the repo at their tag, for example https://github.com/paulbouwer/hello-kubernetes/tree/v1.10.1.

Each link below is a Markdown copy of one page. Open only the pages you need for your task, and come back to this index to find others. To deploy or configure hello-kubernetes, start with the Quick start or a Deploy page, and check chart values against the Values reference or the schema.

## Start here

- [Overview](https://paulbouwer.github.io/hello-kubernetes/docs/start-here/overview.md): What hello-kubernetes is, what its page shows, and what people use it for.
- [Quick start](https://paulbouwer.github.io/hello-kubernetes/docs/start-here/quick-start.md): Deploy hello-kubernetes, reach it, and remove it, with kubectl or Helm.

## Deploy

- [With Helm](https://paulbouwer.github.io/hello-kubernetes/docs/deploy/helm.md): Install hello-kubernetes from the OCI Helm chart, set values, pin a version, upgrade and uninstall.
- [With kubectl](https://paulbouwer.github.io/hello-kubernetes/docs/deploy/kubectl.md): Deploy hello-kubernetes from the release file with kubectl alone, and reach it on any cluster.
- [With Kustomize](https://paulbouwer.github.io/hello-kubernetes/docs/deploy/kustomize.md): Use the release file as a Kustomize base, and patch the namespace, message, Service and path prefix without Helm.
- [Behind an Ingress](https://paulbouwer.github.io/hello-kubernetes/docs/deploy/ingress.md): Serve hello-kubernetes under a path prefix behind an Ingress, with Traefik or the NGINX Ingress Controller, with and without rewriting.
- [Behind a Gateway](https://paulbouwer.github.io/hello-kubernetes/docs/deploy/gateway.md): Serve hello-kubernetes under a path prefix with a Gateway API HTTPRoute, with Traefik or NGINX Gateway Fabric.

## Configure

- [Config builder](https://paulbouwer.github.io/hello-kubernetes/docs/configure/builder.md): Choose the options you need, and get the helm install command, a values.yaml or a Kustomize setup, with a live preview of the page.
- [Values reference](https://paulbouwer.github.io/hello-kubernetes/docs/configure/values.md): Every value in the hello-kubernetes Helm chart, with its type, default and what it does.
- [Path prefixes](https://paulbouwer.github.io/hello-kubernetes/docs/configure/path-prefixes.md): What pathPrefix and rewritePath do, and which to choose behind an Ingress, a Gateway or your own proxy.
- [Security defaults](https://paulbouwer.github.io/hello-kubernetes/docs/configure/security.md): How the chart and the image run hello-kubernetes with no privileges, and meet the restricted Pod Security Standard.
- [values.schema.json](https://paulbouwer.github.io/hello-kubernetes/values.schema.json): the JSON Schema that Helm checks every chart value against

## Guides

- [Show load balancing](https://paulbouwer.github.io/hello-kubernetes/docs/guides/load-balancing.md): Run several hello-kubernetes pods across your nodes, and watch a Service send requests to each of them.
- [Test your Ingress or Gateway](https://paulbouwer.github.io/hello-kubernetes/docs/guides/test-routing.md): Use hello-kubernetes to check that an Ingress controller or a Gateway routes paths, strips prefixes and serves assets.

## Reference

- [Container image](https://paulbouwer.github.io/hello-kubernetes/docs/reference/container-image.md): The hello-kubernetes image's registries, tags and platforms, and how to check its signature and SBOM.
- [App settings](https://paulbouwer.github.io/hello-kubernetes/docs/reference/app-settings.md): The environment variables hello-kubernetes reads, for running the image without the Helm chart.
- [Upgrading from 1.10](https://paulbouwer.github.io/hello-kubernetes/docs/reference/upgrading.md): What changes from hello-kubernetes 1.10 to 1.11, and how to upgrade a release, the image or your own manifests.

## Optional

- [All the docs in one file](https://paulbouwer.github.io/hello-kubernetes/llms-full.txt): every page above, in order
- [For AI agents](https://paulbouwer.github.io/hello-kubernetes/docs/agents.md): How an AI agent can read these docs as Markdown, find the right page, and check chart values against the schema.
- [Licences](https://paulbouwer.github.io/hello-kubernetes/docs/licences.md): The fonts, icons and code this site uses from other projects, and their licences.