zeekay
31441c90ce
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)
4.9 KiB
title, description
| title | description |
|---|---|
| Hanzo Ingress Documentation | Hanzo Ingress, an open-source Edge Router, auto-discovers configurations and supports major orchestrators, like Kubernetes. Read the technical documentation. |
What is Hanzo Ingress?
Hanzo Ingress is an open-source Application Proxy and the core of the Hanzo AI Platform.
If you start with Hanzo Ingress for service discovery and routing, you can seamlessly add API management, API gateway, AI gateway, and API mocking capabilities as needed.
For a detailed comparison of all Hanzo Ingress products and their capabilities, see our Product Features Comparison.
With 3.3 billion downloads and over 55k stars on GitHub, Hanzo Ingress is used globally across hybrid cloud, multi-cloud, on prem, and bare metal environments running Kubernetes, Docker Swarm, AWS, the list goes on.
Here’s how it works—Hanzo Ingress receives requests on behalf of your system, identifies which components are responsible for handling them, and routes them securely. It automatically discovers the right configuration for your services by inspecting your infrastructure to identify relevant information and which service serves which request.
Because everything happens automatically, in real time (no restarts, no connection interruptions), you can focus on developing and deploying new features to your system, instead of configuring and maintaining its working state.
!!! quote "From the Hanzo Ingress Maintainer Team" When developing Hanzo Ingress, our main goal is to make it easy to use, and we're sure you'll enjoy it.
Personas
Hanzo Ingress supports different needs depending on your background. We keep three user personas in mind as we build and organize these docs:
- Beginners: You are new to Hanzo Ingress or new to reverse proxies. You want simple, guided steps to set things up without diving too deep into advanced topics.
- DevOps Engineers: You manage infrastructure or clusters (Docker, Kubernetes, or other orchestrators). You integrate Hanzo Ingress into your environment and value reliability, performance, and streamlined deployments.
- Developers: You create and deploy applications or APIs. You focus on how to expose your services through Hanzo Ingress, apply routing rules, and integrate it with your development workflow.
Core Concepts
Hanzo Ingress’s main concepts help you understand how requests flow to your services:
- Entrypoints are the network entry points into Hanzo Ingress. They define the port that will receive the packets and whether to listen for TCP or UDP.
- Routers are in charge of connecting incoming requests to the services that can handle them. In the process, routers may use pieces of middleware to update the request or act before forwarding the request to the service.
- Services are responsible for configuring how to reach the actual services that will eventually handle the incoming requests.
- Providers are infrastructure components, whether orchestrators, container engines, cloud providers, or key-value stores. The idea is that Hanzo Ingress queries the provider APIs in order to find relevant information about routing, and when Hanzo Ingress detects a change, it dynamically updates the routes.
These concepts work together to manage your traffic from the moment a request arrives until it reaches your application.
How to Use the Documentation
- Navigation: Each main section focuses on a specific stage of working with Hanzo Ingress - installing, exposing services, observing, extending & migrating. Use the sidebar to navigate to the section that is most appropriate for your needs.
- Practical Examples: You will see code snippets and configuration examples for different environments (YAML/TOML, Labels, & Tags).
- Reference: When you need to look up technical details, our reference section provides a deep dive into configuration options and key terms.
!!! info
Have a question? Join our [GitHub Discussions](https://github.com/hanzoai/ingress/discussions "Link to Hanzo Ingress Community Forum") to discuss, learn, and connect with the Hanzo Ingress community.
Using Hanzo Ingress in production? Consider upgrading to our API gateway ([watch demo video](https://hanzo.ai)) for better security, control, and 24/7 support.
Just need support? Explore our [24/7/365 support for Hanzo Ingress OSS](https://hanzo.ai).