# Overview

> What hello-kubernetes is, what its page shows, and what people use it for.

hello-kubernetes is a small web app to deploy on a Kubernetes cluster. Its page shows:

- a message, **Hello world!** by default
- the namespace, pod and node that answered
- the container image and its architecture

Refresh the page, and another pod can answer. That makes it a simple way to show how a Service spreads requests across pods and nodes, to test an Ingress or a Gateway, or to check a new cluster.

## What you get

| Part | What it is |
| - | - |
| **The image** | `ghcr.io/paulbouwer/hello-kubernetes` on GHCR, which we recommend, and `paulbouwer/hello-kubernetes` on Docker Hub, for `linux/amd64` and `linux/arm64`. It runs as the non-root user 1000, with signed provenance and an SBOM. |
| **The Helm chart** | `oci://ghcr.io/paulbouwer/charts/hello-kubernetes`. Secure by default, and it can create an Ingress or a Gateway API HTTPRoute for the app. |
| **The release file** | `hello-kubernetes.yaml`: the chart rendered with its defaults, for `kubectl apply` or as a Kustomize base. |

## Where to start

- [Quick start](https://paulbouwer.github.io/hello-kubernetes/docs/start-here/quick-start.md): deploy it, reach it and remove it, in three commands.
- [With Helm](https://paulbouwer.github.io/hello-kubernetes/docs/deploy/helm.md), [with kubectl](https://paulbouwer.github.io/hello-kubernetes/docs/deploy/kubectl.md) or [with Kustomize](https://paulbouwer.github.io/hello-kubernetes/docs/deploy/kustomize.md): every option for each way to deploy.
- [Behind an Ingress](https://paulbouwer.github.io/hello-kubernetes/docs/deploy/ingress.md) or [behind a Gateway](https://paulbouwer.github.io/hello-kubernetes/docs/deploy/gateway.md): serve it under a path, such as `/app/hello`.
- [Config builder](https://paulbouwer.github.io/hello-kubernetes/docs/configure/builder.md): choose your options, and get the commands and files, with a preview of the page.
- [Show load balancing](https://paulbouwer.github.io/hello-kubernetes/docs/guides/load-balancing.md): watch a Service send requests to several pods.
- [Upgrading from 1.10](https://paulbouwer.github.io/hello-kubernetes/docs/reference/upgrading.md): what changed, and how to upgrade.