Skip to content

docs: Add unified authbridge documentation and deprecation notices#314

Merged
huang195 merged 2 commits into
rossoctl:mainfrom
huang195:docs/unified-authbridge
Apr 15, 2026
Merged

docs: Add unified authbridge documentation and deprecation notices#314
huang195 merged 2 commits into
rossoctl:mainfrom
huang195:docs/unified-authbridge

Conversation

@huang195

Copy link
Copy Markdown
Member

Summary

Adds documentation for the unified authbridge binary and marks old components as deprecated.

Depends on: #313 (Phase 4), #312 (Phase 3), #311 (Phase 2), #310 (Phase 1)

New docs

  • authbridge/cmd/authbridge/README.md — config reference with YAML examples for all 3 modes, build/run instructions, URL derivation rules, credential file waiting behavior
  • authbridge/authlib/README.md — package reference table, usage example, module info

Updated docs

  • authbridge/README.md — added "Unified AuthBridge Binary" section at the top with mode table and links; restructured existing content under "Classic Architecture (Operator-Injected)"
  • authbridge/CLAUDE.md — added unified binary section pointing to new docs, notes that go-processor is deprecated
  • authbridge/authproxy/README.md — added deprecation banner pointing to cmd/authbridge
  • Component Documentation section updated with unified binary and authlib links

Related issue(s)

Ref #279

Assisted-By: Claude (Anthropic AI) noreply@anthropic.com

@huang195
huang195 force-pushed the docs/unified-authbridge branch 5 times, most recently from 134df07 to 7e803ac Compare April 15, 2026 12:38
…ase 4)

CI changes:
- Add Go CI jobs for authlib and cmd/authbridge modules
- Add authbridge-unified image to build.yaml matrix

Documentation:
- Update CLAUDE.md with unified binary architecture, Go modules, and modes
- Mark authbridge-unified as recommended image
- Mark envoy-with-processor and old authbridge as deprecated

Deprecation markers:
- go-processor/main.go: deprecated in favor of cmd/authbridge
- Dockerfile.envoy: deprecated in favor of cmd/authbridge/Dockerfile
- entrypoint-envoy.sh: deprecated in favor of cmd/authbridge/entrypoint.sh

Follow-up (separate repos):
- kagenti-operator: add authbridge-unified to image config
- kagenti: add authbridge-unified-config ConfigMap to Helm chart

Ref: rossoctl#279

Assisted-By: Claude (Anthropic AI) <noreply@anthropic.com>
Signed-off-by: Hai Huang <huang195@gmail.com>
New documentation:
- cmd/authbridge/README.md: config reference, build instructions, 3 modes
- authlib/README.md: package reference and usage example

Updated documentation:
- authbridge/README.md: added "Unified AuthBridge Binary" section at top,
  restructured existing content under "Classic Architecture"
- authbridge/CLAUDE.md: added unified binary section pointing to new docs
- authbridge/authproxy/README.md: added deprecation banner

Assisted-By: Claude (Anthropic AI) <noreply@anthropic.com>
Signed-off-by: Hai Huang <huang195@gmail.com>
@huang195
huang195 force-pushed the docs/unified-authbridge branch from 7e803ac to 76be706 Compare April 15, 2026 14:44

@esnible esnible left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. It might be good to document that "klaviger" means https://github.com/grs/klaviger ; it took me a while to figure that out.

@huang195
huang195 merged commit 2ddc220 into rossoctl:main Apr 15, 2026
17 checks passed
@huang195
huang195 deleted the docs/unified-authbridge branch April 15, 2026 15:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants