What is opendatahub-operator AGENTS.md?

Contributor instructions for OpenDataHub Operator, a Kubernetes operator that deploys and manages an AI and machine-learning platform on OpenShift. It covers component controllers, builds, tests, and required quality checks.

Use it when building the operator, adding components, changing controllers, or running unit and end-to-end tests.

It makes the required preparation, code generation, testing, and validation steps clear before changes are submitted.

How opendatahub-io/opendatahub-operator configures Codex and OpenCode

Reuse

Borrowing it

Nothing to install: this file belongs to opendatahub-io/opendatahub-operator. 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/opendatahub-io/opendatahub-operator/main/AGENTS.md

Clone the repo

git clone --depth 1 https://github.com/opendatahub-io/opendatahub-operator

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.

README.md

[![agentmods](https://agentmods.dev/badge/instructions/opendatahub-io/opendatahub-operator/agents-md/github.svg)](https://agentmods.dev/instructions/opendatahub-io/opendatahub-operator/agents-md)

Your own site

<a href="https://agentmods.dev/instructions/opendatahub-io/opendatahub-operator/agents-md"><img src="https://agentmods.dev/badge/instructions/opendatahub-io/opendatahub-operator/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.

Your own site · 80×15

<a href="https://agentmods.dev/instructions/opendatahub-io/opendatahub-operator/agents-md"><img src="https://agentmods.dev/badge/instructions/opendatahub-io/opendatahub-operator/agents-md.svg" alt="Reviewed on agentmods" width="80" height="20"></a>

Per session 789 This file is loaded in full into every session.

When invoked 789 The same file — it is already loaded in full.

Security scan A 0 findings. 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.

Model	Per session	Once invoked
Fable 5.1	$0.00789	$0.00789
Opus 5	$0.00394	$0.00394
Sonnet 5	$0.00158	$0.00158
Haiku 4.5	$0.00079	$0.00079

Measured 6d ago against content hash 46f1736dac0b, method: parsed. Prices are Anthropic first-party input rates as of 2026-09-10, from the pricing page.

Security

Grade A, and why

opendatahub-operator AGENTS.md scanned grade A with 0 findings 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 6d 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.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

AGENTS.md · 69 lines

How it starts

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

opendatahub-operator

Kubernetes operator deploying AI/ML platform on OpenShift. Manages 16 components via DataScienceCluster (DSC) and DSCInitialization (DSCI) CRs with dedicated per-component controllers.

Required Reading

Read before starting work:

CONTRIBUTING.md — PR workflow, quality gates, code style
docs/DESIGN.md — Architecture, CRDs, reconciliation design
docs/COMPONENT_INTEGRATION.md — New component integration guide

Build & Test

make build                         # Build binary
make unit-test                     # Unit tests
make e2e-test                      # E2E tests (requires cluster)
make lint                          # golangci-lint
make run-nowebhook                 # Run locally (dev)
make new-component COMPONENT=name  # Scaffold new component

Quality Gates (MANDATORY)

Run after every code change. Fix all failures before finishing:

make generate manifests api-docs   # Codegen
make fmt                           # Format
make lint                          # Lint

Include any generated diff in your changes.

Conventions

Wrap errors: fmt.Errorf("context: %w", err). Use k8serr.IsNotFound() etc.
Use go-multierror for collecting multiple errors.
Commits: conventional format type(scope): description.
Platform builds: -tags=odh or -tags=rhoai. ODH_PLATFORM_TYPE=OpenDataHub|rhoai.
OpenShift resources (Routes, OAuth, ConsoleLinks) may not exist on vanilla K8s — always handle with three-way branch (found / IsNotFound|IsNoMatchError / other error).

Critical Rules

GC action MUST be last in action chain
Management states: Managed (deployed), Removed (cleaned up), empty = Removed

Before Writing Code

Read existing files in same area. File locations follow pattern <component> = dashboard, kserve, ray, etc:

API types: api/components/v1alpha1/<component>_types.go
Controller: internal/controller/components/<component>/<component>_controller.go
Actions: internal/controller/components/<component>/<component>_controller_actions.go
Tests: internal/controller/components/<component>/*_test.go, tests/e2e/
Reconciler builder: pkg/controller/reconciler/
Component handler interface: internal/controller/components/registry/registry.go

Read the full file on GitHub · 69 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.

6d ago First seen · 69 lines · 789 tokens per session scan A 46f1736dac0b

Subscribe to this mod's changes

opendatahub-operator AGENTS.md is an instructions file published in the GitHub repository opendatahub-io/opendatahub-operator (109 stars, last pushed today), licensed Apache-2.0. It adds 789 tokens to every session, about $0.0039 per session on Opus 5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-09-03.

Cloud DevOps and cloud E2E testing Testing

next.js AGENTS.md

AGENTS.md instructions for vercel/next.js, covering next.js development guide, codebase structure, monorepo overview, core package: packages/next and other important packages.

vercel/next.js · 7,296 tokens

codex AGENTS.md

AGENTS.md instructions for openai/codex, covering rust/codex-rs, the codex-core crate, code review rules, crate api surface and model visible context.

openai/codex · 5,153 tokens

vscode buildNext.instructions.md

Working notes and architecture documentation for the new esbuild-based build system in build/next. Use when making changes to the new build pipeline (transpile/bundle commands, NLS plugin, source-map handling, resource copying, or self-hosting watch tasks).

microsoft/vscode · 6,785 tokens

opendatahub-operator: Instructions file for Codex