hanzoai/ingress

Fork 0

mirror of https://github.com/hanzoai/ingress.git synced 2026-10-26 02:47:15 +00:00

Files

T

zeekayandHanzo Dev 15d100931d

Hanzo CI/CD / cicd (push) Failing after 9m46s

CI/CD / cicd (push) Failing after 10m4s

Name the ingress in the docs, and fix what that exposed

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]>

2026-09-16 13:01:19 -07:00

2.6 KiB

Raw Permalink Blame History

title, description

title	description
Hanzo Ingress Ping Documentation	In Hanzo Ingress, 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 }

Configuration Examples

To enable the API handler:

ping: {}

[ping]

--ping=true

Configuration Options

The /ping health-check URL is enabled with the command-line --ping or config file option [ping].

The entryPoint where the /ping is active can be customized with the entryPoint option, whose default value is ingress (port 8080).

Path	Method	Description
`/ping`	`GET`, `HEAD`	An endpoint to check for Hanzo Ingress process liveness. Return a code `200` with the content: `OK`

!!! note The cli comes with a healthcheck command which can be used for calling this endpoint.

`entryPoint`

Optional, Default="ingress"

Enabling /ping on a dedicated EntryPoint.

entryPoints:
  ping:
    address: ":8082"

ping:
  entryPoint: "ping"

[entryPoints]
  [entryPoints.ping]
    address = ":8082"

[ping]
  entryPoint = "ping"

--entryPoints.ping.address=:8082
--ping.entryPoint=ping

`manualRouting`

Optional, Default=false

If manualRouting is true, it disables the default internal router in order to allow one to create a custom router for the ping@internal service.

ping:
  manualRouting: true

[ping]
  manualRouting = true

--ping.manualrouting=true

`terminatingStatusCode`

Optional, Default=503

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

2.6 KiB Raw Permalink Blame History