gateway: Instructions file for Codex

AGENTS.md

gateway AGENTS.md is an instructions file for Codex, OpenCode from varnish/gateway. It costs 6,174 tokens per session, scanned C, original, Apache-2.0.

A development guide for Varnish Gateway Operator, a Kubernetes system that configures Varnish to route web traffic.

In plain words
What is it for?
Use it when developing or maintaining the Kubernetes operator, its route handling, endpoint discovery, TLS support, or Rust routing component.
Why use it?
It gives contributors a shared description of the project's components, status, documentation, and implementation details.

Instructions file for CodexOpenCode

Written for Codex and OpenCode: the file is AGENTS.md. Also seen: mentions CLAUDE.md.

This is varnish/gateway's own configuration. It tells Codex and OpenCode how to work on gateway itself, so it is not a mod to install elsewhere. Copy it as a starting point and replace the rules that are about this project. Everything gateway configures →

Reuse

Borrowing it

Nothing to install: this file belongs to varnish/gateway. Take a copy, put it at the same path in your own repository, and replace the rules that are about this project with yours.

Copy the file
curl -O https://raw.githubusercontent.com/varnish/gateway/main/AGENTS.md
Clone the repo
git clone --depth 1 https://github.com/varnish/gateway

Made for: Codex, OpenCode.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

agentmods badge for gateway AGENTS.md

README.md
[![agentmods](https://agentmods.dev/badge/instructions/varnish/gateway/agents-md/github.svg)](https://agentmods.dev/instructions/varnish/gateway/agents-md)
Your own site
<a href="https://agentmods.dev/instructions/varnish/gateway/agents-md"><img src="https://agentmods.dev/badge/instructions/varnish/gateway/agents-md/github.svg" alt="Measured on agentmods" height="20"></a>

Or the 80×15 button, for a site that already has a row of RSS and ATOM ones. Only the verdict fits; the numbers stay here.

agentmods 80×15 button for gateway AGENTS.md

Your own site · 80×15
<a href="https://agentmods.dev/instructions/varnish/gateway/agents-md"><img src="https://agentmods.dev/badge/instructions/varnish/gateway/agents-md.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 6,174 This file is loaded in full into every session.
When invoked 6,174 The same file — it is already loaded in full.
Security scan C 1 finding. A grade says what 26 rules found in the file — not that it is safe.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5.1 $0.06174 $0.06174
Opus 5.5 $0.02470 $0.02470
Sonnet 5.5 $0.01235 $0.01235
Haiku 4.5 $0.00617 $0.00617

Measured 3d ago against content hash d321429ac507, method: parsed. Prices are Anthropic first-party input rates as of 2026-10-07, from the pricing page.

Security

Grade C, and why

gateway AGENTS.md scanned grade C with 1 finding against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 3d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Reaches for credential fileshighPrivilege escalation

SSH keys, cloud credentials, git-credentials, .npmrc, /etc/shadow: reading these is how a config file becomes a credential leak.

# Run operator locally (uses ~/.kube/config)
AGENTS.md · 628 lines

How it starts

The opening of the file, as written. The whole thing — 628 lines — stays where its author put it; the contents beside it link to each section on GitHub.

Varnish Gateway Operator - Development Guide

Project Overview

Kubernetes Gateway API implementation using Varnish. Three components:

  • operator: watches Gateway API resources, generates ghost.json config, manages deployments
  • chaperone: handles endpoint discovery and triggers ghost reload
  • ghost: Rust VMOD that handles all routing logic internally

Documentation

Current Status

The project passes the Gateway API conformance test suite (make test-conformance). Remaining work is tracked in GitHub issues.

Component Overview

Operator (cmd/operator/main.go):

  • Gateway controller - creates Deployment, Service, ConfigMap, Secret, ServiceAccount
  • HTTPRoute controller - watches routes, regenerates routing.json on changes
  • Status conditions (Accepted/Programmed) on Gateway and HTTPRoute
  • GatewayClassParameters CRD for user VCL injection and varnishd extra args
  • Client-side TLS termination with cert-manager support and hot-reload

Chaperone (cmd/chaperone/main.go):

  • Starts and manages varnishd via vrun package
  • Watches routing.json + EndpointSlices, merges into ghost.json
  • Triggers ghost reload via HTTP, VCL reload via varnishadm
  • TLS cert loading and hot-reload via fsnotify

Ghost VMOD (ghost/):

  • Rust-based VMOD handling all routing inside Varnish
  • Path matching (exact, prefix, regex), method, header, query parameter matching
  • Priority-based route selection with additive specificity bonuses
  • Hot-reload via /.varnish-ghost/reload
  • See ghost/CLAUDE.md and ghost/README.md for details

Key Packages

  • internal/ghost/ - Config types, ghost.json generator, EndpointSlice watcher
  • internal/vcl/ - VCL generator, merge, hot-reload via varnishadm
  • internal/varnishadm/ - Full varnishadm protocol (reverse mode, -M flag)
  • internal/vrun/ - varnishd process lifecycle management
  • internal/reload/ - HTTP client for ghost reload endpoint

Read the full file on GitHub · 628 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 3d ago Changed · +162 tokens per session d321429ac507
  2. 8d ago Changed · -3 tokens per session 84729659786a
  3. 2mo ago First seen · 628 lines · 6,015 tokens per session scan C 1a9bc50327a9

Subscribe to this mod's changes

gateway AGENTS.md is an instructions file published in the GitHub repository varnish/gateway (16 stars, last pushed 4d ago), licensed Apache-2.0. It adds 6,174 tokens to every session, about $0.0247 per session on Opus 5.5. A static security scan graded it C with 1 finding (reaches for credential files). No closer match exists in the catalogue, so it is treated as the original; first seen 2026-09-01.

Related

gateway AGENTS.md compared with instructions from other repositories

gateway AGENTS.md next to 6 instructions from other repositories
ModTypeStarsLast pushLicenceScanTokensWorks with
gateway AGENTS.mdvarnish/gatewayInstructions file164d agoApache-2.0C6,174Codex, OpenCode
plan-forge dapr.instructions.mdsrnichols/plan-forgeInstructions file62d agoMITA4,975GitHub Copilot
vscode buildNext.instructions.mdmicrosoft/vscodeInstructions file195kyesterdayMITA9,719GitHub Copilot
next.js AGENTS.mdvercel/next.jsInstructions file143kyesterdayMITA7,461Codex, OpenCode
langchain AGENTS.mdlangchain-ai/langchainInstructions file149kyesterdayMITA4,680Codex, OpenCode
vscode oss-third-party-notices.instructions.mdmicrosoft/vscodeInstructions file195kyesterdayMITA5,516GitHub Copilot
vscode copilot-instructions.mdmicrosoft/vscodeInstructions file195kyesterdayMITA3,093GitHub Copilot