docs: add agent-installable tools guide and sidecar extension patterns#715
Merged
docs: add agent-installable tools guide and sidecar extension patterns#715
Conversation
Explain the philosophy of keeping the Dockerfile lean and letting agents install additional tools (AWS CLI, glab, OpenSSH, etc.) at runtime into ~/bin/ on the PVC. Covers: - What ships in the image vs what's agent-installable - Generic install patterns (tar.gz and .deb) - Concrete examples: OpenSSH, GitLab CLI, AWS CLI v2 - PVC persistence behavior - Guide for contributing new tool docs - Prompt pattern for users
github-actions
Bot
added
the
closing-soon
|
All PRs must reference a prior Discord discussion to ensure community alignment before implementation. Please edit the PR description to include a link like: This PR will be automatically closed in 3 days if the link is not added. |
…, kubectl - Add quick-reference table linking to each tool's install steps - SSH points to existing remote-ssh-debugging.md - Add Cloudflare Wrangler, Terraform, kubectl examples - All examples auto-detect ARM64/AMD64 architecture
…ection - Lead with the one-prompt developer experience: 'per docs/* from OpenAB repo, how to install <TOOL> for my OAB agent' - Explain why this pattern exists (lean image, AI-first, no gatekeeping, no Dockerfile sprawl) - Add Persistence & Portability section showing PVC migration carries everything - Streamline contributing guide
Replace tool-specific install scripts with upstream doc links and agent constraints. Install commands change over time — the agent should look up the latest from upstream and adapt to the constraints (no sudo, ~/bin/, detect arch, verify, clean up).
- docs/sidecar.md: explain init containers and sidecar containers as advanced extension patterns (with Helm values reference) - docs/agent-installable-tools.md: add 'Advanced' section linking to sidecar.md for FYR
Cover 6 common scenarios with deep-dive for each: 1. Cloudflare Tunnel 2. ngrok / Tailscale 3. Pre-install standard toolset (init container) 4. Local database or cache (Redis) 5. Log shipping and observability (Fluent Bit) 6. GPU / ML model serving Each scenario includes: problem statement, solution with complete Helm values.yaml example, and when to use it.
chaodu-agent
changed the title
thepagent
approved these changes
May 3, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Add two new docs that formalize how to extend OpenAB without modifying the Dockerfile or Helm chart:
docs/agent-installable-tools.md— the recommended pattern for installing additional tools (AWS CLI, glab, OpenSSH, wrangler, terraform, kubectl, etc.) at runtime via a single promptdocs/sidecar.md— advanced extension patterns using init containers and sidecar containersMotivation
From the discussion on PR #714: contributors were adding tools directly to the Dockerfile. OpenAB follows a doc-driven, AI-first, lean Dockerfile philosophy — the image stays minimal, and agents install what they need at runtime into
~/bin/on the PVC.These docs formalize that pattern so:
per docs/* from OpenAB repo, how to install <TOOL> for my OAB agentWhat's in
docs/agent-installable-tools.md~/bin/, detect arch, verify, latest version from upstream).debextract pattern for tools without standalone binariesWhat's in
docs/sidecar.mdSix common scenarios with deep-dive Helm examples:
Related
docs/refarch/remote-ssh-debugging.md(existing OpenSSH install pattern)