Skip to content

docs(orchestrator): provider plugins, build services, and cloud providers#779

Closed
frostebite wants to merge 2 commits intomainfrom
document-provider-plugins
Closed

docs(orchestrator): provider plugins, build services, and cloud providers#779
frostebite wants to merge 2 commits intomainfrom
document-provider-plugins

Conversation

@frostebite
Copy link
Member

@frostebite frostebite commented Mar 5, 2026

Summary

Full documentation for the orchestrator provider plugin system, build services, and experimental cloud providers.

Files

Document Covers
docs/orchestrator/provider-plugins.md Built-in providers, CLI protocol, dynamic loading, ProviderInterface
docs/orchestrator/build-services.md Submodule profiles, local caching, LFS agents, git hooks
docs/orchestrator/cloud-providers.md GCP Cloud Run and Azure ACI with multi-storage backends

Provider Plugins

  • Built-in provider table (AWS, K8s, local, Docker, test, GCP, Azure)
  • CLI provider protocol: JSON-over-stdin/stdout, subcommands, streaming output, timeouts, shell example
  • Dynamic provider loading from GitHub, NPM, local paths
  • ProviderInterface contract (7 methods)

Build Services

  • Submodule profiles: YAML format, glob patterns, variant overlays, auth
  • Local build caching: Library + LFS, cache key scheme, restore/save lifecycle
  • Custom LFS transfer agents: git config setup, elastic-git-storage example
  • Git hooks: lefthook/husky detection, skip lists, disable mechanism

Cloud Providers

  • GCP Cloud Run Jobs: 4 storage types (gcs-fuse, gcs-copy, nfs, in-memory) with trade-offs, inputs, examples
  • Azure ACI: 4 storage types (azure-files, blob-copy, azure-files-nfs, in-memory) with trade-offs, inputs, examples

Dependencies

Documents features from these code PRs:

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Added comprehensive orchestrator documentation covering build services, including submodule profiles, variant overlays, local caching strategies, LFS configuration, and Git hooks integration.
    • Introduced documentation for experimental cloud providers (GCP Cloud Run Jobs and Azure Container Instances) with prerequisites, storage backends, and usage examples.
    • Added provider plugins documentation detailing built-in providers, CLI protocol specifications, dynamic provider loading, and implementation examples.

frostebite and others added 2 commits March 5, 2026 07:12
…s documentation

Documents the provider plugin system including:
- Built-in provider list and selection
- CLI provider protocol (JSON-over-stdin/stdout, subcommands, streaming, timeouts)
- Dynamic provider loading (GitHub, NPM, local path)
- ProviderInterface contract
- Shell example of a minimal CLI provider

Documents orchestrator build services:
- Submodule profiles (YAML format, glob patterns, variant overlays)
- Local build caching (Library + LFS, cache key scheme, restore/save)
- Custom LFS transfer agents (git config setup, elastic-git-storage)
- Git hooks (lefthook/husky detection, skip lists, disable)

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
…entation

Documents experimental cloud providers including:
- GCP Cloud Run Jobs: prerequisites, 4 storage types (gcs-fuse, gcs-copy, nfs,
  in-memory) with trade-off comparison, inputs table, usage examples
- Azure Container Instances: prerequisites, 4 storage types (azure-files,
  blob-copy, azure-files-nfs, in-memory) with trade-off comparison, inputs
  table, usage examples
- Cross-links to provider-plugins.md and build-services.md

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@coderabbitai
Copy link

coderabbitai bot commented Mar 5, 2026

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

Run ID: 3d2a7c7b-6c15-4fb3-8203-9b67de568143

📥 Commits

Reviewing files that changed from the base of the PR and between 9d47543 and 88b9b19.

📒 Files selected for processing (3)
  • docs/orchestrator/build-services.md
  • docs/orchestrator/cloud-providers.md
  • docs/orchestrator/provider-plugins.md

📝 Walkthrough

Walkthrough

Three documentation files added for orchestrator infrastructure: build services covering submodule profiles, caching, and git hooks; cloud providers detailing GCP Cloud Run Jobs and Azure Container Instances; and provider plugins documenting the CLI protocol, built-in providers, and dynamic provider loading.

Changes

Cohort / File(s) Summary
Orchestrator Documentation
docs/orchestrator/build-services.md, docs/orchestrator/cloud-providers.md, docs/orchestrator/provider-plugins.md
Added comprehensive documentation for orchestrator build services (submodule profiles, variant overlays, caching, git hooks detection), experimental cloud providers (GCP Cloud Run Jobs, Azure Container Instances with storage backends), and provider plugins (CLI protocol, built-in/dynamic providers, common interface definitions).

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Poem

🐰 From docs we build our orchestration dreams,
Cloud providers dance in automated streams,
Build services cache what matters most,
Git hooks guide us, coast to coast,
A framework of knowledge, comprehensive and bright! ✨

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch document-provider-plugins

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.

@frostebite frostebite changed the title docs(orchestrator): provider plugins, CLI protocol, and build services docs(orchestrator): provider plugins, build services, and cloud providers Mar 5, 2026
@frostebite
Copy link
Member Author

Splitting into 3 separate documentation PRs

@frostebite frostebite closed this Mar 5, 2026
@frostebite frostebite deleted the document-provider-plugins branch March 5, 2026 07:22
@codecov
Copy link

codecov bot commented Mar 5, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 31.25%. Comparing base (9d47543) to head (88b9b19).

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##             main     #779   +/-   ##
=======================================
  Coverage   31.25%   31.25%           
=======================================
  Files          84       84           
  Lines        4563     4563           
  Branches     1103     1103           
=======================================
  Hits         1426     1426           
  Misses       3137     3137           
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@github-actions
Copy link

github-actions bot commented Mar 5, 2026

Cat Gif

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