NO-ISSUE: Add AGENTS.md and AI convention files

[amir-yogev-gh]

Summary

• Create AGENTS.md as tool-agnostic source of truth (critical rules, dev environment, repo structure, HostLease controller architecture, OpenStack Ironic integration, build/test commands, CI, code quality)
• Create CLAUDE.md with @AGENTS.md reference
• Add .github/copilot-instructions.md for GitHub Copilot support

Part of workspace-wide AI-readiness improvements (osac-workspace#60).

Assisted-by: Claude Code noreply@anthropic.com

Summary by CodeRabbit

• Documentation
  • Added a new guide covering the controller’s purpose, development workflow, repository layout, architecture overview, key files, CI checks, and testing tools.
  • Included important contributor guidance such as required build targets and rules for working with generated files.

[coderabbitai]

Walkthrough

Adds a new AGENTS.md file to the host-management-openstack repository documenting the Kubernetes controller's purpose, required make targets, generated-file constraints, local development workflow, repository structure, HostLease reconciliation architecture with OpenStack Ironic, key source files, CI workflows, and testing tooling.

Changes

Controller Documentation

Layer / File(s)	Summary
AGENTS.md full content AGENTS.md	New 97-line file covering dev/CI commands, repo layout, HostLease reconciliation flow against OpenStack Ironic, key files, and code quality/testing expectations.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

A map for the lost, a guide for the new,
🗺️ The controller's secrets laid plainly in view.
Ironic and leases, the structs and the flow,
With make generate first — now everyone knows!
📜 AGENTS.md lands, and confusion must go.

🚥 Pre-merge checks | ✅ 11

✅ Passed checks (11 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title clearly matches the PR’s main change: adding AGENTS.md and related AI guidance files.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.
No-Hardcoded-Secrets	✅ Passed	AGENTS.md contains no secret-like literals, embedded credentials, private keys, or long base64 blobs.
No-Weak-Crypto	✅ Passed	PR changes are docs-only; AGENTS.md contains no MD5/SHA1/DES/RC4/3DES/ECB or crypto code, and no weak-crypto patterns appear in the added files.
No-Injection-Vectors	✅ Passed	PASS: The PR only adds AGENTS.md documentation; no SQL/shell/eval/pickle/yaml/dangerous HTML patterns appear in the changed files.
Container-Privileges	✅ Passed	PASS: PR is docs-only; no added manifest has privileged:true, hostPID/hostNetwork/hostIPC, SYS_ADMIN, root, or allowPrivilegeEscalation:true, and manager.yaml uses false.
No-Sensitive-Data-In-Logs	✅ Passed	PR diff only adds AGENTS.md documentation; no log statements, secrets, PII, or host/customer data are introduced.
Ai-Attribution	✅ Passed	PASS: The PR/commit includes Assisted-by: Claude Code <noreply@anthropic.com>, and I found no Co-Authored-By trailer in the changed commit.

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands.}

[coderabbitai]

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@AGENTS.md`:
- Line 3: Update the short project description to use the compound adjective
“bare-metal hosts” instead of “bare metal hosts.” This is a wording fix in the
AGENTS.md summary text; adjust the description so the modifier before “hosts” is
hyphenated consistently.

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

• Push a commit to this branch (recommended)
• Create a new PR with the fixes

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: Repository: osac-project/coderabbit/.coderabbit.yaml

Review profile: ASSERTIVE

Plan: Enterprise

Run ID: fc2bfb51-0c93-443d-aea7-120db0373ae6

📥 Commits

Reviewing files that changed from the base of the PR and between 5174020 and 9778370.

📒 Files selected for processing (1)

• AGENTS.md

[coderabbitai]

📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win

Hyphenate "bare-metal" as compound adjective.

"Bare metal" modifies "hosts" and should be hyphenated: "bare-metal hosts."

🧰 Tools

🪛 LanguageTool

[uncategorized] ~3-~3: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...ack Kubernetes controller that manages bare metal hosts via OpenStack Ironic. Watches Hos...

(EN_COMPOUND_ADJECTIVE_INTERNAL)

🤖 Prompt for AI Agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@AGENTS.md` at line 3, Update the short project description to use the
compound adjective “bare-metal hosts” instead of “bare metal hosts.” This is a
wording fix in the AGENTS.md summary text; adjust the description so the
modifier before “hosts” is hyphenated consistently.