Skip to content

docs: update README and docs for dev preview readiness - #353

Merged
pdettori merged 1 commit into
rossoctl:mainfrom
varshaprasad96:docs/dev-preview-readiness
May 20, 2026
Merged

docs: update README and docs for dev preview readiness#353
pdettori merged 1 commit into
rossoctl:mainfrom
varshaprasad96:docs/dev-preview-readiness

Conversation

@varshaprasad96

@varshaprasad96 varshaprasad96 commented May 12, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Rewrite README to cover AgentRuntime, AuthBridge webhook, MLflow integration, and all operator controllers
  • Update architecture diagram to show full component set (AgentRuntime controller, AuthBridge webhook, MLflow controller)
  • Fix broken doc links (a2a-signature-verification.mdagentcard-signature-verification.md, identity-binding-quickstart.mdagentcard-identity-binding.md)
  • Add all docs to the documentation table (AuthBridge, controller-webhook interaction, MLflow, client registration)
  • Add AgentRuntime Quick Start alongside manual label path
  • Fix protocol label requirement: clarify that Deployments need protocol.kagenti.io/a2a for AgentCard auto-creation (was incorrectly stated as "no kagenti labels required")
  • Remove hardcoded Helm chart version from install instructions

Test plan

  • Verify all doc links in the Documentation table resolve correctly
  • Verify Mermaid architecture diagram renders on GitHub
  • Verify sample YAML links in Examples section resolve
  • Cross-reference protocol label requirement against agentcardsync_controller.go shouldSyncWorkload()

Signed-off-by: @varshaprasad96 varshaprasad96@gmail.com
🤖 Generated with Claude Code

- Rewrite README to cover AgentRuntime, AuthBridge webhook, MLflow
  integration, and all operator controllers
- Update architecture diagram to show full component set
- Fix broken doc links (signature verification, identity binding)
- Add all docs to the documentation table (AuthBridge, controller-webhook
  interaction, MLflow, client registration)
- Add AgentRuntime Quick Start alongside manual label path
- Fix protocol label requirement: clarify that Deployments need
  protocol.kagenti.io/a2a for AgentCard auto-creation
- Remove hardcoded Helm chart version

Assisted-By: Claude (Anthropic AI) <noreply@anthropic.com>
Signed-off-by: Varsha Prasad Narsing <varshaprasad96@gmail.com>

@r3v5 r3v5 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, Varsha! LGTM

@varshaprasad96

Copy link
Copy Markdown
Contributor Author

cc: @pdettori @cwiklik can we get a review on this please. It is just to ensure that README is updated, when customers from RH summit visit this repo. Thanks!

@ChristianZaccaria ChristianZaccaria left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/lgtm, thank you!!

@zanetworker

Copy link
Copy Markdown

@pdettori can you have a look?

@pdettori pdettori left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Docs update is accurate — all claims about controller label behavior, config hash, and rolling updates verified against source (agentcardsync_controller.go, agentcard_controller.go, agentruntime_controller.go). All doc links and sample YAML references resolve.

A few wording suggestions inline — nothing blocking.

Assisted-By: Claude Code

Comment thread README.md
- **Dynamic Agent Discovery** — Automatic indexing of agent metadata via the A2A protocol
- **Signature Verification** — JWS-based cryptographic verification of agent cards (RSA, ECDSA)
- **Identity Binding** — SPIFFE-based workload identity binding with allowlist enforcement
- **Declarative Agent Enrollment** — Create an `AgentRuntime` CR pointing to a clean Deployment; the operator applies labels, injects sidecars, and manages rolling updates automatically

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

suggestion: "pointing to a clean Deployment" — the Deployment isn't fully clean since it carries the protocol.kagenti.io/a2a label. Consider "pointing to your Deployment" for consistency with the updated GETTING_STARTED.md heading ("Deploy a Deployment with Protocol Label").

Comment thread README.md

#### Option 1: AgentRuntime (Recommended)

Deploy a clean Deployment and create an AgentRuntime CR:

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

suggestion: "Deploy a clean Deployment" contradicts the fact that users must add protocol.kagenti.io/a2a (shown a few lines below). Consider: "Deploy a Deployment with a protocol label and create an AgentRuntime CR:" — consistent with GETTING_STARTED.md which was correctly updated.

Comment thread README.md
```

The operator will automatically create an AgentCard for the workload and begin syncing agent metadata.
The operator will apply `kagenti.io/type: agent` labels and inject AuthBridge sidecars. The `protocol.kagenti.io/a2a` label on the Deployment triggers automatic AgentCard creation for agent discovery.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

suggestion (accuracy/clarity): This could be read as "the protocol label alone triggers AgentCard creation." Since shouldSyncWorkload() requires both kagenti.io/type=agent (applied by AgentRuntime) and a protocol label, consider:

The operator will apply kagenti.io/type: agent labels and inject AuthBridge sidecars. Together with the protocol.kagenti.io/a2a label on the Deployment, this triggers automatic AgentCard creation for agent discovery.

@pdettori
pdettori merged commit 4fb1f76 into rossoctl:main May 20, 2026
16 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

6 participants