How-to guides
How-to guides
Each guide solves one task for someone who already knows what they want. Guides assume the operator is installed; if it is not, start with Getting started .
| Page | Task |
|---|---|
| Prepare Headscale | Version, policy entries the operator needs, bootstrap API key, preflight checks |
| Install the operator | Helm or kustomize install, chart vs. site responsibilities, network isolation (Kubernetes and Cilium policies) |
| Egress: reach services at the site | A namespace dials a site database/broker/HTTPS API through a stable Service name; aliases, SNI, status reasons |
| Ingress: publish a TCP service | Tailnet peers reach a cluster Service by name; who may dial it |
| Ingress: publish a web app over HTTPS | TLS terminated on the agent with cert-manager, or passthrough to a shared gateway |
| Serve DNS names with CoreDNS | Turn the operator’s hosts file into a resolvable zone and wire the cluster CoreDNS |
| Let the operator own the policy | Read what the operator renders, review in DryRun, switch to Apply, migrate from file mode |
| Declare a site network (TailnetSite) | Give a LAN a name and a status; block overlapping routes |
| Run the gateway (subnet router + split-DNS) | Prerequisites and order, complete example with LB pool, iBGP, split-DNS and site |
| Upgrade and roll back | Chart and CRD upgrade order, what to verify afterwards, how to roll back |
| Troubleshoot | Symptom → cause → fix table and the diagnosis cheat sheet |
Source: docs/how-to/README.md at v0.18.0 — found a mistake? Tell us.