agentleFS
NVIDIAKnown publisherNVIDIA/nvcf/deploy/helm/cloud-functions/AGENTS.md

nvcf / cloud-functions

AGENTS.md261 starsChanged 9 days agoApache-2.0View on GitHub

Scope: deploy/helm/cloud-functions, the Helm chart for the NVCF API service. The chart publishes as helm-nvcf-api. Its Chart.yaml name is the published OCI name and must not be renamed to match the directory or the service. The release lane is registered as cloud-functions-helm in tools/ci/github-release-subprojects.json. Run these from this directory. lint, template, and validate read tools/ci/helm-validate-values/cloud-functions.yaml. The chart leaves api.image.registry and api.image.repository empty on purpose, so it does not render without those values. The account-bootstrap image defaults to its public upstream…

The file

We split this AGENTS.md into the rules it gives an agent

1 rule. About 0 are common, 1 is distinctive, and 0 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈1

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 0

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Run these from this directory.

    line 12

≈ “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.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
AGENTS.md

AGENTS.md - NVCF API Helm chart

Scope: deploy/helm/cloud-functions, the Helm chart for the NVCF API service.

The chart publishes as helm-nvcf-api. Its Chart.yaml name is the published OCI name and must not be renamed to match the directory or the service. The release lane is registered as cloud-functions-helm in tools/ci/github-release-subprojects.json.

Commands

Run these from this directory.

make lint       # helm lint with the shared CI values
make template   # render to bin/manifest.yaml
make validate   # template, then kubeconform
make test       # focused shell tests under tests/

lint, template, and validate read tools/ci/helm-validate-values/cloud-functions.yaml. The chart leaves api.image.registry and api.image.repository empty on purpose, so it does not render without those values. The account-bootstrap image defaults to its public upstream image and can be overridden independently.

make install, make uninstall, and make status default to release api in namespace nvcf.

Conventions

Chart.yaml keeps version: 0.0.0. The release pipeline sets the real version from the deploy/helm/cloud-functions/v* tag. appVersion tracks the API service image and is bumped by hand.

Match the conventional commit type to the intended version bump, because the tag generation pipeline reads it:

  • fix(<scope>): for a patch bump
  • feat(<scope>): for a minor bump
  • feat(<scope>)!: or a BREAKING CHANGE: footer for a major bump

A chore commit skips tag creation entirely.

Adjacent subtrees

  • src/control-plane-services/cloud-functions builds the image this chart deploys.
  • Sidecar image references in api.remoteConfig.configData.nvcf.sidecars use Spring placeholders resolved at runtime. The worker references are composed from api.remoteConfig.workerImageTags, which the deploys entries in tools/ci/github-release-subprojects.json let tools/chart-version-bumper move on each worker release. tests/sidecar_release_artifacts_test.sh guards the composed references and the release-artifact-*-image annotations that surface them to stack release tooling, so run it after changing any sidecar entry or worker tag.

Download now (ZIP)

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
What did you use it for? e.g. Reviewing pull requests in a Rails app

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.