zeekay
d466241d15
Comprehensive audit and cleanup of all upstream (Traefik/Containous) references in public-facing files across the repository. Changes: - .github/FUNDING.yml: traefik -> hanzoai - .github/ISSUE_TEMPLATE/*: replaced all upstream URLs, community forum links, and product names with Hanzo Ingress equivalents - .github/PULL_REQUEST_TEMPLATE.md: updated doc URLs - .github/workflows/release.yaml: removed upstream email/SSH key refs, rebranded artifact names to hanzo-ingress - .github/workflows/test-integration.yaml: artifact name traefik -> hanzo-ingress to match new BIN_NAME - .github/workflows/sync-docker-images.yaml: cleaned comment - .github/workflows/documentation.yaml: cleaned comment - .goreleaser.yml.tmpl: project_name and binary -> hanzo-ingress - CODE_OF_CONDUCT.md: [email protected] -> [email protected] - CONTRIBUTING.md: upstream doc URLs -> GitHub repo links - SECURITY.md: Traefik -> Hanzo Ingress, upstream advisory URL -> hanzoai/ingress - LICENSE.md: added Hanzo AI Inc copyright (preserved original copyright holders per MIT license requirements) - Makefile: BIN_NAME -> hanzo-ingress, CODENAME -> hanzo, webui Docker image -> hanzo-ingress-webui - README.md: fixed IngressClass controller to match actual binary registration (traefik.io/ingress-controller) - webui/readme.md: Traefik Web UI -> Hanzo Ingress Web UI - docs/readme.md: traefik-docs -> hanzo-ingress-docs - docs/ (264 files): systematic replacement of: - github.com/traefik/traefik -> github.com/hanzoai/ingress - community.traefik.io -> github.com/hanzoai/ingress/discussions - doc.traefik.io -> github.com/hanzoai/ingress/blob/main/docs/ - traefik.io commercial/blog URLs -> hanzo.ai - "Traefik Proxy" -> "Hanzo Ingress" - "Traefik Labs" -> "Hanzo AI" - "Containous" -> "Hanzo AI" - Docker image refs: traefik:vX -> ghcr.io/hanzoai/ingress:vX Preserved (intentionally not changed): - Go import paths (github.com/traefik/traefik/v3) in ldflags - ./cmd/traefik Go package path - traefik.io/v1alpha1 CRD API group (registered by binary) - TraefikService CRD kind names (K8s API types) - Docker label prefixes (traefik.http.*, traefik.tcp.*, etc.) - Config default values (rootKey: "traefik", entryPoint: "traefik") - CHANGELOG.md (historical record) - update.traefik.io (hardcoded endpoint in Go binary) - Test fixture data (cert passwords, service labels)
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. |
traefik | 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