Skip to content

Docs: one map of the ownership and manager fields - #2344

Merged
nadaverell merged 4 commits into
mainfrom
docs/ownership-coherence
Oct 26, 2026
Merged

nadaverell merged 4 commits into
mainfrom
docs/ownership-coherence

Conversation

@nadaverell

Copy link
Copy Markdown
Contributor

Docs-only. Merge after #2343: the field map describes resourceContext.managedBy as it behaves with that PR.

Problem

Read together, the ownership and manager docs didn't add up:

  • Four fields are called managedBy (relationships.managedBy, resourceContext.managedBy, list rows' summaryContext.managedBy, rightsizing's managedBy), and nothing said which answers what.
  • Finding "which field do I read for X" meant piecing together docs/ownership.md, docs/gitops.md and docs/mcp.md.
  • docs/ownership.md was titled and introduced around "which GitOps manager records it", from before the manager answer.
  • The Related Resources bullet in docs/gitops.md was ~330 words in one bullet and repeated the chip rules.
  • Two review follow-ups had no doc: a restricted user's manager answer covers only what they can read (a manager they can't see may still revert a change), and REST and MCP judge manager readability differently.

Change

  • docs/ownership.md: retitled to owners, dependents and managers; a Which field answers what table (question, field, evidence) covering owner, membership, the manager answer and all four managedBy fields; a paragraph on answers being the caller's (narrowed, REST vs MCP).
  • docs/gitops.md: the Related Resources bullet cut to what the group shows (~330 → ~200 words), linking ownership.md; one sentence in the write-warning section on narrowed answers.
  • docs/authentication.md: ownership answers follow the namespace rule in the UI; MCP checks manager kinds exactly.
  • CLAUDE.md: the ownership row mentions the manager answer and field map; Key Patterns says to read ownership.manager rather than deciding management from labels again.

ownership.md now says what manages an object, not only what records it,
and maps each wire field to the question it answers, including the four
different managedBy fields. The Related Resources bullet in gitops.md is
cut to what the group shows. Restricted users: the manager answer is
the caller's, narrowed means a hidden manager may still revert a change,
and REST and MCP judge manager readability differently
(authentication.md, ownership.md). CLAUDE.md points at the manager
answer instead of deciding management from labels again.
@nadaverell
nadaverell requested a review from hisco as a code owner October 26, 2026 17:12
@cursor

cursor Bot commented Oct 26, 2026

Copy link
Copy Markdown

Bugbot needs on-demand usage enabled

Bugbot uses usage-based billing for this team and requires on-demand usage to be enabled.

A team admin can enable on-demand usage in the Cursor dashboard.

@qodo-free-for-open-source-projects

Copy link
Copy Markdown

Code Review by Qodo

🐞 Bugs (0) 📘 Rule violations (0) 📎 Requirement gaps (0)

Grey Divider

Great, no issues found!

Qodo reviewed your code and found no material issues that require review

Grey Divider

Tip of the day
💡 Did you know, you can type 'qodo, fix this' on a finding and the fix lands right on your PR

More tips ↗ | Customize Qodo ↗ | Qodo docs ↗

Grey Divider

Qodo Logo

@qodo-free-for-open-source-projects

Copy link
Copy Markdown

PR Summary by Qodo

Document ownership and manager field meanings in one map

📝 Documentation 🕐 10-20 Minutes

Grey Divider

AI Description

• Map ownership, manager answers, and four distinct managedBy fields to the questions they answer.
• Clarify that restricted callers may receive narrowed manager answers and that REST and MCP check
 readability differently.
• Shorten GitOps drawer guidance and point contributors to the canonical field map.
Diagram

graph TD
  A["Ownership field map"] --> B["Owner fields"] --> C["Related Resources"]
  A --> D["Manager answer"] --> E["Chip and warning"]
  A --> F["ManagedBy variants"] --> G["AI and lists"]
  A --> H["Caller visibility"]
Loading
High-Level Assessment

Keep the field map in the existing ownership reference and link to it from narrower guidance. Repeating the distinctions in each GitOps, authentication, and contributor document would make them harder to keep consistent.

Files changed (4) +31 / -10

Documentation (4) +31 / -10
CLAUDE.mdDirect contributors to the manager answer and field map +2/-2

Direct contributors to the manager answer and field map

• Expands the ownership reference to include the field map and manager answer. Tells contributors to use 'ownership.manager' rather than infer management again from labels.

CLAUDE.md

authentication.mdExplain caller visibility for ownership answers +2/-0

Explain caller visibility for ownership answers

• Documents namespace-level UI visibility, MCP's exact checks for each manager kind, and the 'narrowed' answer when a manager cannot be read.

docs/authentication.md

gitops.mdCondense drawer guidance and qualify write warnings +2/-2

Condense drawer guidance and qualify write warnings

• Shortens the Related Resources explanation and links to the ownership evidence model. Clarifies that a narrowed manager answer cannot rule out a hidden manager reverting a change.

docs/gitops.md

ownership.mdAdd a canonical ownership and manager field map +25/-6

Add a canonical ownership and manager field map

• Retitles the page to cover managers and maps owner, membership, manager-answer, and four 'managedBy' fields to their questions and evidence. Explains caller-scoped manager answers, hidden managers, and the difference between REST and MCP readability.

docs/ownership.md

relationships.managedBy is metadata-first, then the topmost object its
manages edges reach, not a controller-owner answer; the agent and row
pointers are filtered forms of it. A hidden manager contributes no
evidence, but a name in the object's own metadata stays as a withheld
claim, and narrowed means scoped, not proof of a hidden manager. The
Related Resources bullet is split into short bullets and keeps the
no-coverage-note and hint-only conditions.
@nadaverell
nadaverell merged commit a0694c7 into main Oct 26, 2026
11 checks passed
@nadaverell
nadaverell deleted the docs/ownership-coherence branch October 26, 2026 22:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant