ingress/Makefile at 5cebdab596ba9adc3fbd7555df7ef63818efdedd

hanzoai/ingress

Fork 0

mirror of https://github.com/hanzoai/ingress.git synced 2026-10-20 15:07:40 +00:00

Files

T

41ec6d6f1a rebrand(ingress): finish de-Traefik + own yaegi/grpc-web framework deps (#29 ) (#8 )

* rebrand: strip "traefik" branding from the ingress controller

Removes all "traefik" branding/paths/env/comments from the shipping
surface while keeping load-bearing config schema and external deps intact.

Paths / binary:
- cmd/traefik/ -> cmd/ingress/ (traefik.go->ingress.go, etc.); merged out
  the empty cmd/ingress/generate.go stub. Build refs updated in Dockerfile,
  Makefile, .goreleaser.yml.tmpl, script/crossbinary-default.sh, README.
- contrib/systemd/traefik.service -> ingress.service (Hanzo Ingress unit,
  /etc/ingress paths, hanzo-ingress binary).
- contrib/grafana/traefik*.json -> ingress*.json; metric queries
  traefik_* -> ingress_* (now match the engine's ingress_ prefix) + titles.
- script/gcg/traefik-*.toml -> ingress-*.toml; Owner/Repo -> hanzoai/ingress.

Code/config branding (comments + non-schema strings):
- doc.go, mount.go, client/router.go, zap_backend.go, forward_backend.go,
  register.go: "Traefik" -> "the ingress"/"Hanzo Ingress"; corrected the
  annotation example to ingress.kubernetes.io/.
- ingress.sample.{toml,yml}: header + log + entryPoint example.
- pkg/config/dynamic/fixtures/sample.toml comment.
- pkg/redactor/testdata example+expected: /etc/traefik/traefik.toml ->
  /etc/ingress/ingress.toml, TraefikLogsFile -> IngressLogsFile (both files
  kept identical so the redactor golden test stays green).
- .golangci.yml importas aliases traefik* -> ingress* and the stale
  crd/traefikio path -> crd/hanzoai; unused-var exclude ingressVersion.
- .dockerignore / .gitignore: drop stale /traefik artifacts.
- script/code-gen.sh: PROJECT_MODULE -> github.com/hanzoai/ingress,
  v1alpha1 path -> crd/hanzoai, CRD output -> hanzo.ai_*.yaml /
  01-ingress-crd.yml.
- script/deploy.sh: drop the upstream traefik-library-image push.
- Removed dead, disabled upstream docs-publish workflow
  (.github/workflows/documentation.yaml, pushed to traefik/doc).
- LLM.md: rewrote rebrand notes; documented load-bearing "traefik" that
  stays (external imports, hash-bound realm, upstream issue URL, license
  attribution) and vendored upstream docs/webui/changelog as out of scope.

Load-bearing "traefik" intentionally KEPT (not branding):
- external Go modules github.com/traefik/{oxy,yaegi,grpc-web};
- digest_auth_test.go htdigest realm "traefik" (invalidates the hashes);
- consul_test.go upstream issue URL #8092 (provenance citation);
- LICENSE.md + boilerplate.go.tmpl Containous/Traefik Labs copyright
  (MIT attribution; Hanzo AI appended);
- integration/ test fixtures (traefik/whoami images, rawdata-*.json
  golden entrypoint names, nomad traefik.* tags) — test-only, semantics-
  sensitive; out of scope for this pass.

Verify: `go build $(go list ./... | grep -v /webui)` passes; redactor /
config/dynamic / nomad / server/service tests pass. The webui go:embed
failure and the kubernetes/crd test (ingress.k8s.io group mismatch) are
pre-existing on main, not caused by this rebrand.

* build(ingress): own yaegi + grpc-web via hanzoai source-fork replaces (#29)

Task #29 — own the framework deps (Traefik half). The Traefik engine is
already fully source-forked into github.com/hanzoai/ingress and the
user-facing surface is debranded (cmd/ingress -> hanzo-ingress, CRD group
hanzo.ai, ingress_ metrics, X-Ingress-* headers). The last upstream
traefik/* runtime libraries are now pinned to hanzoai source-forks:

  github.com/traefik/grpc-web => github.com/hanzoai/grpc-web v0.16.0
  github.com/traefik/yaegi    => github.com/hanzoai/yaegi    v0.16.1

Both forks keep the upstream module path at the identical version tag, so
the import lines in pkg/plugins (yaegi Go-interpreter for plugins) and
pkg/middlewares/grpcweb are unchanged — only resolution moves to a path
hanzoai controls (immune to upstream re-tag/deletion; patchable in-house).

oxy has no hanzoai fork yet and stays on the existing traefik/oxy replace —
tracked next-wave (create hanzoai/oxy first).

Proof:
  go list -m github.com/traefik/{yaegi,grpc-web}  -> both => hanzoai/*
  go build ./...                                  -> exit 0 (webui assets staged)
  go test ./pkg/plugins/...                       -> ok (yaegi consumer)
  readonly (CI-mode) build of swapped pkgs        -> exit 0 (go.sum complete)

* docs(ingress): document traefik/* framework-dep ownership boundary (#29)

---------

Co-authored-by: Antje Worring <[email protected]>

Co-authored-by: Hanzo Dev <[email protected]>

2026-07-03 03:34:30 -07:00

211 lines

6.9 KiB

Makefile

Raw Blame History

 SRCS = $(shell git ls-files '*.go' | grep -v '^vendor/')
 TAG_NAME := $(shell git describe --abbrev=0 --tags --exact-match 2>/dev/null)
 SHA := $(shell git rev-parse HEAD)
 VERSION_GIT := $(if $(TAG_NAME),$(TAG_NAME),$(SHA))
 VERSION := $(if $(VERSION),$(VERSION),$(VERSION_GIT))
 BIN_NAME := hanzo-ingress
 CODENAME ?= hanzo
 DATE := $(shell date -u '+%Y-%m-%d_%I:%M:%S%p')
 # Default build target
 GOOS := $(shell go env GOOS)
 GOARCH := $(shell go env GOARCH)
 GOGC ?=
 LINT_EXECUTABLES = misspell shellcheck
 DOCKER_BUILD_PLATFORMS ?= linux/amd64,linux/arm64
 REGISTRY := ghcr.io/hanzoai/ingress
 .PHONY: default
 #? default: Run `make generate` and `make binary`
 default: generate binary
 #? dist: Create the "dist" directory
 dist:
 	mkdir -p dist
 .PHONY: build-webui-image
 #? build-webui-image: Build WebUI Docker image
 build-webui-image:
 	docker build -t hanzo-ingress-webui -f webui/buildx.Dockerfile webui
 .PHONY: clean-webui
 #? clean-webui: Clean WebUI static generated assets
 clean-webui:
 	rm -r webui/static
 	mkdir -p webui/static
 	printf 'For more information see `webui/readme.md`' > webui/static/DONT-EDIT-FILES-IN-THIS-DIRECTORY.md
 webui/static/index.html:
 	$(MAKE) build-webui-image
 	# Run only the production build, NOT `build:prod` (which chains
 	# test+tsc+lint). Tests live in .github/workflows/test-unit.yaml;
 	# coupling them to the image build means every npm flake takes
 	# the image build with it. Decoupled image build / test pipeline.
 	docker run --rm -v "$(PWD)/webui/static":'/src/webui/static' hanzo-ingress-webui pnpm build
 	docker run --rm -v "$(PWD)/webui/static":'/src/webui/static' hanzo-ingress-webui chown -R $(shell id -u):$(shell id -g) ./static
 	printf 'For more information see `webui/readme.md`' > webui/static/DONT-EDIT-FILES-IN-THIS-DIRECTORY.md
 .PHONY: generate-webui
 #? generate-webui: Generate WebUI
 generate-webui: webui/static/index.html
 .PHONY: generate
 #? generate: Generate code (Dynamic and Static configuration documentation reference files)
 generate:
 	go generate
 .PHONY: binary
 #? binary: Build the binary
 binary: generate-webui dist
 	@echo SHA: $(VERSION) $(CODENAME) $(DATE)
 	CGO_ENABLED=0 GOGC=${GOGC} GOOS=${GOOS} GOARCH=${GOARCH} go build ${FLAGS[*]} -ldflags "-s -w \
     -X github.com/hanzoai/ingress/v3/pkg/version.Version=$(VERSION) \
     -X github.com/hanzoai/ingress/v3/pkg/version.Codename=$(CODENAME) \
     -X github.com/hanzoai/ingress/v3/pkg/version.BuildDate=$(DATE)" \
     -installsuffix nocgo -o "./dist/${GOOS}/${GOARCH}/$(BIN_NAME)" ./cmd/ingress
 binary-linux-arm64: export GOOS := linux
 binary-linux-arm64: export GOARCH := arm64
 binary-linux-arm64:
 	@$(MAKE) binary
 binary-linux-amd64: export GOOS := linux
 binary-linux-amd64: export GOARCH := amd64
 binary-linux-amd64:
 	@$(MAKE) binary
 binary-windows-amd64: export GOOS := windows
 binary-windows-amd64: export GOARCH := amd64
 binary-windows-amd64: export BIN_NAME := hanzo-ingress.exe
 binary-windows-amd64:
 	@$(MAKE) binary
 .PHONY: crossbinary-default
 #? crossbinary-default: Build the binary for the standard platforms (linux, darwin, windows)
 crossbinary-default: generate generate-webui
 	$(CURDIR)/script/crossbinary-default.sh
 .PHONY: test
 #? test: Run the unit and integration tests
 test: test-ui-unit test-unit test-integration
 .PHONY: test-unit
 #? test-unit: Run the unit tests
 test-unit:
 	GOOS=$(GOOS) GOARCH=$(GOARCH) go test -cover "-coverprofile=cover.out" -v $(TESTFLAGS) ./pkg/... ./cmd/...
 .PHONY: test-integration
 #? test-integration: Run the integration tests
 test-integration:
 	GOOS=$(GOOS) GOARCH=$(GOARCH) go test ./integration -test.timeout=20m -failfast -v $(TESTFLAGS)
 .PHONY: test-gateway-api-conformance
 #? test-gateway-api-conformance: Run the Gateway API conformance tests
 test-gateway-api-conformance: build-image-dirty
 	GOOS=$(GOOS) GOARCH=$(GOARCH) go test ./integration -v -tags gatewayAPIConformance -test.run GatewayAPIConformanceSuite $(TESTFLAGS)
 .PHONY: test-knative-conformance
 #? test-knative-conformance: Run the Knative conformance tests
 test-knative-conformance: build-image-dirty
 	GOOS=$(GOOS) GOARCH=$(GOARCH) go test ./integration/integration_test.go ./integration/knative_conformance_test.go -v -tags knativeConformance -test.run KnativeConformanceSuite
 .PHONY: test-ui-unit
 #? test-ui-unit: Run the unit tests for the webui
 test-ui-unit:
 	$(MAKE) build-webui-image
 	docker run --rm -v "$(PWD)/webui/static":'/src/webui/static' hanzo-ingress-webui pnpm install --frozen-lockfile
 	docker run --rm -v "$(PWD)/webui/static":'/src/webui/static' hanzo-ingress-webui pnpm test:unit:ci
 .PHONY: pull-images
 #? pull-images: Pull all Docker images to avoid timeout during integration tests
 pull-images:
 	grep --no-filename -E '^\s+image:' ./integration/resources/compose/*.yml \
 		| awk '{print $$2}' \
 		| sort \
 		| uniq \
 		| xargs -P 6 -n 1 docker pull
 .PHONY: lint
 #? lint: Run golangci-lint
 lint:
 	golangci-lint run
 .PHONY: validate-files
 #? validate-files: Validate code and docs
 validate-files:
 	$(foreach exec,$(LINT_EXECUTABLES),\
             $(if $(shell which $(exec)),,$(error "No $(exec) in PATH")))
 	$(CURDIR)/script/validate-vendor.sh
 	$(CURDIR)/script/validate-misspell.sh
 	$(CURDIR)/script/validate-shell-script.sh
 .PHONY: validate
 #? validate: Validate code, docs, and vendor
 validate: lint validate-files
 # Target for building images for multiple architectures.
 .PHONY: multi-arch-image-%
 multi-arch-image-%: binary-linux-amd64 binary-linux-arm64
 	docker buildx build $(DOCKER_BUILDX_ARGS) -t $(REGISTRY):$* --platform=$(DOCKER_BUILD_PLATFORMS) -f Dockerfile .
 .PHONY: build-image
 #? build-image: Clean up static directory and build a Docker image
 build-image: export DOCKER_BUILDX_ARGS := --load
 build-image: export DOCKER_BUILD_PLATFORMS := linux/$(GOARCH)
 build-image: clean-webui
 	@$(MAKE) multi-arch-image-latest
 .PHONY: build-image-dirty
 #? build-image-dirty: Build a Docker image without re-building the webui when it's already built
 build-image-dirty: export DOCKER_BUILDX_ARGS := --load
 build-image-dirty: export DOCKER_BUILD_PLATFORMS := linux/$(GOARCH)
 build-image-dirty:
 	@$(MAKE) multi-arch-image-latest
 .PHONY: docs
 #? docs: Build documentation site
 docs:
 	make -C ./docs docs
 .PHONY: docs-serve
 #? docs-serve: Serve the documentation site locally
 docs-serve:
 	make -C ./docs docs-serve
 .PHONY: docs-pull-images
 #? docs-pull-images: Pull image for doc building
 docs-pull-images:
 	make -C ./docs docs-pull-images
 .PHONY: generate-crd
 #? generate-crd: Generate CRD clientset and CRD manifests
 generate-crd:
 	@$(CURDIR)/script/code-gen.sh
 .PHONY: generate-genconf
 #? generate-genconf: Generate code from dynamic configuration
 generate-genconf:
 	go run ./cmd/internal/gen/
 .PHONY: fmt
 #? fmt: Format the Code
 fmt:
 	gofmt -s -l -w $(SRCS)
 .PHONY: clean
 #? clean: Remove build artifacts
 clean:
 	rm -f $(BIN_NAME)
 	rm -rf dist/
 .PHONY: help
 #? help: Get more info on make commands
 help: Makefile
 	@echo " Choose a command run in hanzo-ingress:"
 	@sed -n 's/^#?//p' $< | column -t -s ':' |  sort | sed -e 's/^/ /'

211 lines 6.9 KiB Makefile Raw Blame History

211 lines

6.9 KiB

Makefile

Raw Blame History