Skip to content

docs(opencode): unify deployment documentation#277

Draft
hmoghani wants to merge 2 commits into
red-hat-data-services:mainfrom
hmoghani:RHAIENG-6261-opencode-docs-reorg
Draft

docs(opencode): unify deployment documentation#277
hmoghani wants to merge 2 commits into
red-hat-data-services:mainfrom
hmoghani:RHAIENG-6261-opencode-docs-reorg

Conversation

@hmoghani

@hmoghani hmoghani commented Jul 20, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Consolidates three disconnected doc entry points (README.md, DEPLOYMENT.md, docs/mlflow-tracing-setup.md) into a single unified guide at agents/opencode/README.md
  • Replaces deployment/README.md (was OpenShell-only) with a short file index pointing back to the unified guide
  • Adds deprecation headers to DEPLOYMENT.md and docs/mlflow-tracing-setup.md (kept for existing bookmarks)

All content comes from existing OpenCode files — no fabricated steps. OpenShell-on-RHOAI and OpenShell+MLflow sections have TODO placeholders pending cluster testing.

What's left (cluster work, not in this PR yet)

  • OpenShell on RHOAI deployment walkthrough (needs cluster testing)
  • MLflow tracing for OpenShell path (egress, env vars, combined image)
  • End-to-end manual verification on RHOAI

Test plan

  • All internal doc links resolve correctly
  • Doc structure matches agents/claude-code/ pattern (root README = unified guide, deployment/README.md = file index)
  • Markdownlint CI passes
  • Manual: OpenCode runs in OpenShell on RHOAI with MLflow traces (pending)

Consolidate three separate doc entry points into a single unified
README at agents/opencode/README.md. Content from DEPLOYMENT.md
(configuration, session persistence, skills, security, architecture)
and docs/mlflow-tracing-setup.md (MLflow setup) is merged into the
root README. deployment/README.md is replaced with a file index.

OpenShell-on-RHOAI and OpenShell+MLflow sections are placeholders
pending cluster testing.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@coderabbitai

coderabbitai Bot commented Jul 20, 2026

Copy link
Copy Markdown
Contributor

Important

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Enterprise

Run ID: dde2dfa0-f8cd-45a0-b458-54fe2ee7bf37

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
✨ 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

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

@hmoghani hmoghani changed the title docs(opencode): unify deployment documentation (RHAIENG-6261) docs(opencode): unify deployment documentation Jul 20, 2026
…IENG-6261)

Replace the placeholder TODO section with step-by-step instructions
tested on OpenShift 4.21 with OpenShell gateway v0.0.86 and OpenCode
1.17.1 against a vLLM endpoint.

- Add deployment/openshell/ with RBAC, gateway config, StatefulSet,
  and TokenReview ClusterRole manifests (consistent with repo pattern
  of separate manifest files referenced from docs)
- Document all 7 steps: namespace, RBAC, JWT keys, gateway deploy,
  image build, sandbox create, configure + test
- Add troubleshooting for the 4 failure modes discovered during testing
  (TokenReview forbidden, EACCES on home dir, missing git init,
  supervisor relay timeout)

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@mpk-droid mpk-droid self-assigned this Jul 21, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants