Skip to content

docs: demo scenarios for skill-equipped agents#31

Merged
pavelanni merged 1 commit into
mainfrom
docs/demo-scenarios
Apr 24, 2026
Merged

docs: demo scenarios for skill-equipped agents#31
pavelanni merged 1 commit into
mainfrom
docs/demo-scenarios

Conversation

@pavelanni
Copy link
Copy Markdown
Collaborator

@pavelanni pavelanni commented Apr 22, 2026

Summary

  • Two specialized agents (Executive Assistant, HR Analyst) deployed side-by-side on OpenShift with skills delivered as OCI image volumes from quay.io/skillimage/
  • Custom SCC (restricted-with-image-volumes) for image volume support on OpenShift
  • Three demo scenarios mapped to user stories: executive briefing, resume screening, policy review
  • Tested end-to-end on OpenShift 4.20 in panni-docsclaw namespace using a2a CLI

Test plan

  • Deploy executive-assistant with document-summarizer skill
  • Deploy hr-analyst with document-reviewer skill
  • Verify skill discovery in pod logs
  • Test scenario 1: executive briefing via a2a send
  • Test scenario 2: resume screening via a2a send
  • Test scenario 3: policy review via a2a send

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Added comprehensive end-to-end demo guide with step-by-step deployment instructions, runnable demo scenarios, and verification steps.
    • Added ready-to-deploy configurations for executive assistant and HR analyst demo agents with system prompts and skill integrations.
    • Added OpenShift security setup manifest for image volume support.
    • Added LLM API key secret configuration template.

Two specialized agents deployed side-by-side on OpenShift with
OCI image volumes delivering skills from quay.io/skillimage/:
- Executive Assistant (document-summarizer skill)
- HR Analyst (document-reviewer skill)

Includes SCC setup for image volume support, test commands
using the a2a CLI, and three demo scenarios mapped to user
stories from the business user requirements.

Assisted-By: Claude (Anthropic AI) <noreply@anthropic.com>
Signed-off-by: Pavel Anni <panni@redhat.com>
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Apr 22, 2026

📝 Walkthrough

Walkthrough

Adds a complete demo documentation package for deploying DocsClaw + SkillImage agents on OpenShift, including a detailed README with deployment procedures, configurations for two agent deployments, OpenShift security context constraints setup, and LLM credentials template.

Changes

Cohort / File(s) Summary
Demo Documentation
docs/demo/README.md
Comprehensive guide covering end-to-end demo setup, OpenShift SCC configuration, oc deployment commands, three runnable demo scenarios, skill discovery verification, cleanup procedures, and fallback deployment patterns.
Agent Deployments
docs/demo/executive-assistant.yaml, docs/demo/hr-analyst.yaml
Kubernetes manifests for two DocsClaw agents with ConfigMaps (system prompts, agent metadata, tool settings), hardened Deployments mounting SkillImage volumes, Services, and OpenShift Routes with TLS termination and HAProxy timeouts.
Infrastructure Setup
docs/demo/image-volume-scc.yaml, docs/demo/llm-secret.yaml
OpenShift SecurityContextConstraints allowing image volumes with restricted security protections, ServiceAccount, ClusterRole, and RoleBinding for agent access; Kubernetes Secret for LLM API credentials.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~25 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The PR title 'docs: demo scenarios for skill-equipped agents' directly and accurately summarizes the main purpose of the changeset, which adds comprehensive documentation and deployment manifests for demo scenarios featuring agents with skills.
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.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/demo-scenarios

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

Comment @coderabbitai help to get the list of available commands and usage tips.

@pavelanni pavelanni marked this pull request as ready for review April 22, 2026 22:19
Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@docs/demo/executive-assistant.yaml`:
- Line 12: The image reference strings are inconsistent: some headers/README
entries use quay.io/skillimage/document-summarizer:1.0.0-testing while the
volume uses quay.io/skillimage/business/document-summarizer:1.0.0-testing (same
for document-reviewer in the other demo); pick the correct registry path and
make them identical across the demo files by updating the header comment, README
mentions, and the volume image field so all occurrences of
quay.io/skillimage/document-summarizer:1.0.0-testing and
quay.io/skillimage/business/document-summarizer:1.0.0-testing (and the analogous
document-reviewer variants) use the same exact string.
🪄 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: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: aa0898fc-388c-44eb-9392-15b5c9a65625

📥 Commits

Reviewing files that changed from the base of the PR and between 1de1d02 and d83c327.

📒 Files selected for processing (5)
  • docs/demo/README.md
  • docs/demo/executive-assistant.yaml
  • docs/demo/hr-analyst.yaml
  • docs/demo/image-volume-scc.yaml
  • docs/demo/llm-secret.yaml

# - Budget variance explanation (Finance)
# - Capacity planning report (IT Ops)
#
# Skill image: quay.io/skillimage/document-summarizer:1.0.0-testing
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟠 Major

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
# Confirm which registry path(s) actually exist and which references are used in the repo.
rg -n 'quay\.io/skillimage/[^"[:space:]]*document-summarizer[^"[:space:]]*'
rg -n 'quay\.io/skillimage/[^"[:space:]]*document-reviewer[^"[:space:]]*'

Repository: redhat-et/docsclaw

Length of output: 1093


Skill image references are inconsistent across headers, README, and actual volume references.

The documentation header comment on line 12 and README entries specify quay.io/skillimage/document-summarizer:1.0.0-testing, but the actual volume reference on line 170 uses quay.io/skillimage/business/document-summarizer:1.0.0-testing (includes business/ path segment). The same pattern appears in hr-analyst.yaml (lines 12 vs. 177) with document-reviewer. Only one path will successfully pull from the registry—align all references (headers, README, and volume references) so users copying from the docs don't encounter image-pull failures.

Also applies to: 168–171, and docs/demo/hr-analyst.yaml lines 12 and 177.

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@docs/demo/executive-assistant.yaml` at line 12, The image reference strings
are inconsistent: some headers/README entries use
quay.io/skillimage/document-summarizer:1.0.0-testing while the volume uses
quay.io/skillimage/business/document-summarizer:1.0.0-testing (same for
document-reviewer in the other demo); pick the correct registry path and make
them identical across the demo files by updating the header comment, README
mentions, and the volume image field so all occurrences of
quay.io/skillimage/document-summarizer:1.0.0-testing and
quay.io/skillimage/business/document-summarizer:1.0.0-testing (and the analogous
document-reviewer variants) use the same exact string.

@pavelanni pavelanni merged commit 58ee255 into main Apr 24, 2026
4 checks passed
@pavelanni pavelanni deleted the docs/demo-scenarios branch April 24, 2026 20:28
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