nvcf / worker-callback-proxy
AGENTS.md268 starsChanged 3 days agoApache-2.0View on GitHub
This chart deploys upstream Envoy to route NVCF worker callbacks to the grpc-proxy or invocation-service pod that holds the request. It has no service source in src/. appVersion is the Envoy version and is bumped by hand. Run from this directory: workerCallbackProxy.workerDomain and the frontend issuer have no default, so the targets use tools/ci/helm-validate-values/worker-callback-proxy.yaml. verify-render.sh checks how resources fit together: Service ports and selectors against the pod, Envoy listeners against container ports, and SDS paths against mounts. Extend it when…
Where files are headingNew AGENTS.md files have more rules about keeping secrets out of the code, and fewer about code style.
Of the AGENTS.md files we read, the 31,439 first seen in the last six months, against the older ones: the kind of rule that gained most share, and the kind that lost most. About files like this in general, not this one, and an estimate, since a kind is a pattern in the words.
In this repository136 other files it gives its agents.
- AGENTS.mdAGENTS.md
- ai-tooling/AGENTS.mdAGENTS.md
- deploy/helm/cassandra/AGENTS.mdAGENTS.md
- deploy/helm/cert-manager/AGENTS.mdAGENTS.md
- deploy/helm/cloud-functions/AGENTS.mdAGENTS.md
- deploy/helm/cloud-tasks/AGENTS.mdAGENTS.md
- deploy/helm/encrypted-secret-store/AGENTS.mdAGENTS.md
- deploy/helm/icms/AGENTS.mdAGENTS.md
- deploy/helm/llm-request-router/AGENTS.mdAGENTS.md
- deploy/helm/nats/AGENTS.mdAGENTS.md
- deploy/helm/notary/AGENTS.mdAGENTS.md
- deploy/helm/nvcf-pki/AGENTS.mdAGENTS.md
- deploy/helm/openbao/AGENTS.mdAGENTS.md
- deploy/helm/vanity-gateway/AGENTS.mdAGENTS.md
- deploy/releases/AGENTS.mdAGENTS.md
- deploy/stacks/AGENTS.mdAGENTS.md
- deploy/stacks/observability/AGENTS.mdAGENTS.md
- deploy/stacks/stargate-dev/AGENTS.mdAGENTS.md
- deploy/stacks/stargate-dev/benchmark/AGENTS.mdAGENTS.md
- docs/AGENTS.mdAGENTS.md
- docs/overview/samples/scripts/AGENTS.mdAGENTS.md
- examples/AGENTS.mdAGENTS.md
- infra/cassandra/AGENTS.mdAGENTS.md
- infra/openbao/AGENTS.mdAGENTS.md
- infra/openbao/plugins/vault-plugin-secrets-jwt/AGENTS.mdAGENTS.md
- infra/openbao/tests/AGENTS.mdAGENTS.md
- migrations/cassandra/AGENTS.mdAGENTS.md
- migrations/openbao/AGENTS.mdAGENTS.md
- src/compute-plane-services/byoo-otel-collector/AGENTS.mdAGENTS.md
- src/compute-plane-services/ess-agent/AGENTS.mdAGENTS.md
- src/compute-plane-services/image-credential-helper/AGENTS.mdAGENTS.md
- src/compute-plane-services/nvca/AGENTS.mdAGENTS.md
- src/compute-plane-services/nvsnap/docs/AGENTS.mdAGENTS.md
- src/compute-plane-services/nvstor/AGENTS.mdAGENTS.md
- src/compute-plane-services/request-trace-uploader/AGENTS.mdAGENTS.md
- src/control-plane-services/admin-token-issuer-proxy/AGENTS.mdAGENTS.md
- src/control-plane-services/api-keys/AGENTS.mdAGENTS.md
- src/control-plane-services/cloud-functions/AGENTS.mdAGENTS.md
- src/control-plane-services/cloud-tasks/AGENTS.mdAGENTS.md
- src/control-plane-services/encrypted-secret-store/AGENTS.mdAGENTS.md
- src/control-plane-services/function-autoscaler/AGENTS.mdAGENTS.md
- src/control-plane-services/function-autoscaler/local_env/AGENTS.mdAGENTS.md
- src/control-plane-services/instance-cluster-management/AGENTS.mdAGENTS.md
- src/control-plane-services/nats-auth-callout/AGENTS.mdAGENTS.md
- src/control-plane-services/notary/AGENTS.mdAGENTS.md
- src/invocation-plane-services/grpc-proxy/AGENTS.mdAGENTS.md
- src/invocation-plane-services/http-invocation/AGENTS.mdAGENTS.md
- src/invocation-plane-services/llm-api-gateway/AGENTS.mdAGENTS.md
- src/invocation-plane-services/ratelimiter/AGENTS.mdAGENTS.md
- src/invocation-plane-services/vanity-gateway/AGENTS.mdAGENTS.md
- src/libraries/go/lib/AGENTS.mdAGENTS.md
- src/libraries/go/worker/AGENTS.mdAGENTS.md
- src/libraries/java/nv-boot-parent/AGENTS.mdAGENTS.md
- src/libraries/python/nv-cloud-function-helpers/AGENTS.mdAGENTS.md
- src/libraries/rust/nvcf-info/AGENTS.mdAGENTS.md
- src/libraries/rust/stargate/AGENTS.mdAGENTS.md
- src/uis/nvcf-ui/AGENTS.mdAGENTS.md
- src/uis/nvcf-ui/helm/AGENTS.mdAGENTS.md
- tests/bdd/AGENTS.mdAGENTS.md
- tools/AGENTS.mdAGENTS.md
- The first 60 shown.
The file
We split this AGENTS.md into the rules it gives an agent
8 rules. About 0 are common, 4 are distinctive, and 4 are very specific to this project.
≈0
Common · estimate
Many files like this have a rule of this kind.
≈4
Distinctive · estimate
This author's own choices. Worth a look.
4
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Distinctive: line 10
Run from this directory:
- Distinctive: line 30
Follow the repository root AGENTS.md for repository-wide code style and public snapshot rules.
- Distinctive: line 33
Use two-space indentation in YAML.
- Very specific: line 34
Keep the Envoy configuration in templates/_envoy.tpl.
- Very specific: line 37
Put checks that span several values in workerCallbackProxy.validate, and keep values.schema.json in step with values.yaml.
- Distinctive: line 39
Keep the container non-root with a read-only root filesystem.
- Very specific: line 47
Keep the admin API on 127.0.0.1.
- Very specific: line 64
Never commit certificates or private keys.
≈ “Common” is an estimate: at least 1 in 5 of the 40,246 AGENTS.md files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.
Files
AGENTS.md - worker-callback-proxy chart
This chart deploys upstream Envoy to route NVCF worker callbacks to the
grpc-proxy or invocation-service pod that holds the request. It has no
service source in src/. appVersion is the Envoy version and is bumped by
hand.
Validate
Run from this directory:
make test # helm lint and tests/chart-render/verify-render.sh
make validate # kubeconform with CRD schemas; needs kubeconform
make validate-envoy # tests/chart-render/validate-envoy.sh; needs DockerworkerCallbackProxy.workerDomain and the frontend issuer have no default,
so the targets use tools/ci/helm-validate-values/worker-callback-proxy.yaml.
verify-render.sh checks how resources fit together: Service ports and
selectors against the pod, Envoy listeners against container ports, and SDS
paths against mounts. Extend it when adding a port, listener, or mount.
validate-envoy.sh runs the rendered config in the appVersion Envoy image
and rotates the grpc-proxy CA to prove it reloads without a restart. It also
runs a worker curl through the TLS invocation listener to a TLS upstream.
Style
Follow the repository root AGENTS.md for repository-wide code style and
public snapshot rules.
- Use two-space indentation in YAML.
- Keep the Envoy configuration in
templates/_envoy.tpl. Other templates only include it. - Validate required values with
requiredand quote rendered strings. Put checks that span several values inworkerCallbackProxy.validate, and keepvalues.schema.jsonin step withvalues.yaml. - Keep the container non-root with a read-only root filesystem. Envoy writes nothing to disk.
Safety
- The grpc-proxy route accepts any
Hostunder*.<workerDomain>. It is safe only because upstream TLS requires the grpc-proxy pod certificate. Do not relaxmatch_typed_subject_alt_namesor thegrpc_proxy_caSDS secret. - Keep the admin API on
127.0.0.1. It can stop Envoy and dump its config; only/readyand/stats/prometheusare exposed, on their own listeners. - The invocation route must keep the authority regex. Without it the listener
is an open forward proxy. Keep
invocation.tls.enabled,invocation.upstream.tls.enabledand the 8443invocation.portas defaults. Plaintext, on either side, is for trusted networks and test setups only. - The
invocation_pods_tlscluster takes the pod name from the request authority. It is safe only because the route's authority regex limits it to invocation-service pod names andauto_san_validationchecks the pod certificate against that name. Do not setallow_insecure_cluster_optionson it or remove theinvocation_pod_caSDS secret. - The forward-proxy route matches the exact path
/v2/nvcf/worker/request-attach. The pod's worker port also serves the rest of the invocation API, so do not widen it to a prefix. - A CONNECT tunnel is a raw TCP tunnel that Envoy cannot read or restrict.
invocation.connect.enableddefaults to true so older workers keep working; the stack turns it off. Keep it that way. - Never commit certificates or private keys.
bin/is ignored for local renders.
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
No reviews yet
People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.
- It worked
- Partly
- It didn't
Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

