Skip to content

docs: remove hard-coded private IPs and fix the agent gateway hostname - #236

Merged
amenegola merged 1 commit into
mainfrom
docs/no-hardcoded-ips
Nov 17, 2026
Merged

amenegola merged 1 commit into
mainfrom
docs/no-hardcoded-ips

Conversation

@amenegola

Copy link
Copy Markdown
Collaborator

The README, several docs pages and llms.txt hard-coded private IPs for the entry point, the partner front door and the Central Agent Gateway. None of them matched what Terraform creates:

  • The entry point VIP is picked by GCP in the core subnet unless entrypoint_ip_address pins it.
  • partner.esmeralda.internal is a host rule on that same VIP; there is no separate partner IP or forwarding rule.
  • The Agent Gateway is Google-managed and reaches the VPC through its PSC attachment agw-egress-na-<env>.

Changes:

  • Replace the literals with <entrypoint-ip> or a description. Point to the layer-2 output that reports the VIP: uv run esmeralda status --env <env> --unit layer-2-networking --output entrypoint_address.
  • Fix the Agent Gateway hostname in the capability-based governance page (*.esmeralda.internal, as configured in the connectivity template's DNS peering).
  • Correct the Apigee page: no dedicated partner forwarding rule; the ALB label now uses ilb-esmeralda-rule-<env>. Drop the stale internal.gateway. zone note.
  • Document that the subnet CIDRs and the Secure Web Proxy address are design values set in infrastructure/modules/2-networking/main.tf.
  • Add tests/guards/test_docs_private_ips.py (runs in make test-guards). It fails on private IPv4 literals in tracked Markdown and docs/. A small allowlist covers the subnet CIDRs and the SWP address; each entry names its source file and reason, and is checked to still be set there and still be cited.

Testing: make test-guards, make docs-build (strict) and make test pass. Docs and a static guard only, so no dev deployment test is needed.

Closes #193

Replace the entry point, partner and Agent Gateway IP literals in the README, docs and llms.txt with the layer-2 output that reports the entry point VIP (esmeralda status --unit layer-2-networking --output entrypoint_address). partner.esmeralda.internal is a host rule on the same VIP, and the Agent Gateway is Google-managed and enters the VPC through its PSC attachment, so neither has its own address. Fix the specialist hostname in the capability governance page, drop the stale internal.gateway zone note and the nonexistent partner forwarding rule. Add tests/guards/test_docs_private_ips.py, which fails on private IPv4 literals in docs, with an allowlist for the subnet CIDRs and the SWP address that the networking module sets.

Closes #193
@amenegola
amenegola merged commit 34df2cf into main Nov 17, 2026
9 checks passed
@amenegola
amenegola deleted the docs/no-hardcoded-ips branch November 17, 2026 01:38
@amenegola amenegola mentioned this pull request Nov 17, 2026
4 tasks
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.

docs: remove hard-coded private IPs and fix a mismatched hostname

1 participant