zeekayandHanzo Dev
15d100931d
Most of it was stale, not cosmetic: the docs taught `TRAEFIK_*` env, `traefik.http.*` labels, `traefik.ingress.kubernetes.io/` annotations, `.traefik.yml` plugins and `traefik_*` metrics. This binary answers to `INGRESS_*`, `ingress.http.*`, `ingress.kubernetes.io/`, `.ingress.yml` and `ingress.*` — a reader following the old text configured nothing. Two were worse than stale. Gateway API examples gave `group: traefik.io` for an IngressService backendRef, which kubernetes.go:1265 refuses against hanzo.ai. The contributing guide built with `github.com/traefik/ingress` ldflags against a module that is `github.com/hanzoai/ingress/v3`. script/code-gen.sh globs `hanzo.ai_*.yaml` and matched nothing — the per-CRD dumps had been deleted and never regenerated, so `cat` failed the script under `set -e`. controller-gen v0.19.0 restores all ten; they concatenate byte-for-byte into the committed definition and fixture. CHANGELOG.md is untouched: 6,789 lines of imported release history, where a rewrite would falsify the record rather than rebrand it. `@traefiklabs/faency`, `traefik/whoami`, k3s's `--disable=traefik`, the `traefik.io` CRD group and the MIT attribution stay — upstream's addresses, not our brand. Co-authored-by: Hanzo Dev <[email protected]>
2.5 KiB
title, description
| title | description |
|---|---|
| Hanzo Ingress Ping Option Documentation | In Hanzo Ingress, the option Ping lets you check the health of your Hanzo Ingress instances. Read the technical documentation for configuration examples and options. |
Ping
Checking the Health of your Hanzo Ingress Instances {: .subtitle }
The ping options allows you to enable the ping endpoint to check Hanzo Ingress liveness.
The ping endpoint is reachable using the path /ping and the methods GETand HEAD.
If the Hanzo Ingress instance is alive, it returns the 200 HTTP code with the content: OK.
Configuration Example
To enable the API handler:
ping: {}
[ping]
--ping=true
Configuration Options
The ping option is defined in the install (static) configuration.
You can define it using the same configuration methods as Hanzo Ingress.
| Field | Description | Default | Required |
|---|---|---|---|
ping.entryPoint |
Enables /ping on a dedicated EntryPoint. |
ingress | No |
ping.manualRouting |
Disables the default internal router in order to allow one to create a custom router for the ping@internal service when set to true. |
false | No |
ping.terminatingStatusCode |
Defines the status code for the ping handler during a graceful shut down. See more information here | 503 | No |
terminatingStatusCode
During the period in which Hanzo Ingress is gracefully shutting down, the ping handler
returns a 503 status code by default.
If Hanzo Ingress is behind, for example a load-balancer
doing health checks (such as the Kubernetes LivenessProbe), another code might
be expected as the signal for graceful termination.
In that case, the terminatingStatusCode can be used to set the code returned by the ping
handler during termination.
ping:
terminatingStatusCode: 204
[ping]
terminatingStatusCode = 204
--ping.terminatingStatusCode=204