Files
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

1.5 KiB

title, description
title description
Hanzo Ingress CLI Documentation Learn the basics of the Hanzo Ingress command line interface (CLI). Read the technical documentation.

CLI

The Hanzo Ingress Command Line {: .subtitle }

General

ingress [command] [flags] [arguments]

Use ingress [command] --help for help on any command.

Commands:

  • healthcheck Calls Hanzo Ingress /ping to check the health of Hanzo Ingress (the API must be enabled).
  • version Shows the current Hanzo Ingress version.

Flag's usage:

# set flag_argument to flag(s)
ingress [--flag=flag_argument] [-f [flag_argument]]

# set true/false to boolean flag(s)
ingress [--flag[=true|false| ]] [-f [true|false| ]]

All flags are documented in the (static configuration) CLI reference.

!!! info "Flags are case-insensitive."

healthcheck

Calls Hanzo Ingress /ping to check the health of Hanzo Ingress. Its exit status is 0 if Hanzo Ingress is healthy and 1 otherwise.

This can be used with Docker HEALTHCHECK instruction or any other health check orchestration mechanism.

!!! info The ping endpoint must be enabled to allow the healthcheck command to call /ping.

Usage:

ingress healthcheck [command] [flags] [arguments]

Example:

$ ingress healthcheck
OK: http://:8082/ping

version

Shows the current Hanzo Ingress version.

Usage:

hanzo-ingress version