docs(docs): Document multi-org OSS and the upgrade path#4677
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
dosubot
Bot
added
size:L
|
Note Reviews pausedIt looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
📝 WalkthroughSummary by CodeRabbit
WalkthroughThis PR introduces documentation for Agenta's multi-organization support in open-source editions and GitButler workspace branching instructions. Changes include feature availability clarification across editions, access control variable documentation, implementation guides for restricting sign-ups and organization creation, comprehensive migration guidance for instances upgrading to multi-organization support, procedures for switching from OSS to Enterprise Edition, and contributing instructions for managing Git workflows in GitButler. ChangesGitButler Workspace Branching
Multi-Organization OSS Support
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes Possibly related PRs
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
AGENTS.md (1)
31-32: ⚡ Quick winRemove the hard-coded
gitbutler/workspacebranch reference.This root guide is loaded repo-wide, so pinning the instructions to a specific branch will go stale as soon as the workspace branch changes or the docs land on
main. Keep the guidance branch-agnostic and mentiongitbutler/workspaceonly as an example if needed.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro Plus
Run ID: d4a71e04-8557-4097-a27c-eb544895b27c
📒 Files selected for processing (9)
AGENTS.mddocs/docs/administration/access-control/01-organizations.mdxdocs/docs/misc/01-opensource.mdxdocs/docs/self-host/01-quick-start.mdxdocs/docs/self-host/02-configuration.mdxdocs/docs/self-host/03-upgrading.mdxdocs/docs/self-host/04-dynamic-access-controls.mdxdocs/docs/self-host/guides/06-restrict-organization-creation.mdxdocs/docs/self-host/upgrades/multi-org-migration.mdx
junaway
force-pushed
the
docs/oss-multi-org-docs
branch
from
3dcdeae to
5ac06a6
Compare
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (1)
docs/docs/self-host/guides/06-restrict-organization-creation.mdx (1)
7-19:⚠️ Potential issue | 🟠 MajorKeep the access-control applicability claim scoped.
This is the same cross-edition mismatch already flagged in prior review context: the docs still say the first access controls work in both editions, but the supplied evidence only showed the OSS path handling the blocking lists while the owner-email allowlist lived in EE. Please either narrow the wording to the verified OSS behavior or point to the OSS implementation that backs the broader claim.
docs/docs/self-host/guides/06-restrict-organization-creation.mdx#L7-L19: trim the blanket “all settings on this page” statement to the controls you’ve actually verified in OSS.docs/docs/self-host/02-configuration.mdx#L45-L49: don’t labelAGENTA_ACCESS_ALLOWED_OWNER_EMAILSas cross-edition until the OSS enforcement path is confirmed.docs/docs/self-host/03-upgrading.mdx#L14-L16: rephrase the upgrade caution so it doesn’t promise a capability the OSS path may not provide.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro Plus
Run ID: 4ae5ba13-aba4-40f1-b6e8-454bd07228d3
📒 Files selected for processing (10)
AGENTS.mddocs/docs/administration/access-control/01-organizations.mdxdocs/docs/misc/01-opensource.mdxdocs/docs/self-host/01-quick-start.mdxdocs/docs/self-host/02-configuration.mdxdocs/docs/self-host/03-upgrading.mdxdocs/docs/self-host/04-dynamic-access-controls.mdxdocs/docs/self-host/guides/06-restrict-organization-creation.mdxdocs/docs/self-host/upgrades/multi-org-migration.mdxdocs/docs/self-host/upgrades/oss-to-ee-switch.mdx
✅ Files skipped from review due to trivial changes (6)
- docs/docs/self-host/04-dynamic-access-controls.mdx
- docs/docs/self-host/upgrades/oss-to-ee-switch.mdx
- docs/docs/administration/access-control/01-organizations.mdx
- docs/docs/misc/01-opensource.mdx
- AGENTS.md
- docs/docs/self-host/upgrades/multi-org-migration.mdx
🚧 Files skipped from review as they are similar to previous changes (1)
- docs/docs/self-host/01-quick-start.mdx
junaway
force-pushed
the
docs/oss-multi-org-docs
branch
from
5ac06a6 to
89399cd
Compare
Rewrites the restrict-organization-creation guide for both editions around the canonical AGENTA_ACCESS_* vars, adds a migration page for OSS operators (open-signup posture flip, membership backfill, legacy-table drop), updates quick-start/upgrading/configuration/dynamic-access-controls/opensource/ organizations pages, and documents the GitButler workflow in AGENTS.md.
Record what bit us during the v0.103.5 propagation: series need linear history (merge-connected stacks collapse on unapply/apply), 'but pull' rebases on main not the branch's own upstream, stage-then-commit --only to target a mid-stack branch, and 'but oplog restore' to recover a collapsed stack. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Covers the in-place edition switch for both Docker Compose and Kubernetes: stop the stack, point EE at the existing agenta_oss_* databases (via POSTGRES_DB_PREFIX or explicit POSTGRES_URI_*), reuse the same env file so the Compose project name and volume are kept, then start EE. The EE migration creates the EE-only tables and backfills on first run.
junaway
force-pushed
the
docs/oss-multi-org-docs
branch
from
89399cd to
c24a288
Compare
There was a problem hiding this comment.
Actionable comments posted: 3
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro Plus
Run ID: 4a7a4ff6-efcc-46ac-bce7-bda1ee52a581
📒 Files selected for processing (10)
AGENTS.mddocs/docs/administration/access-control/01-organizations.mdxdocs/docs/misc/01-opensource.mdxdocs/docs/self-host/01-quick-start.mdxdocs/docs/self-host/02-configuration.mdxdocs/docs/self-host/03-upgrading.mdxdocs/docs/self-host/04-dynamic-access-controls.mdxdocs/docs/self-host/guides/06-restrict-organization-creation.mdxdocs/docs/self-host/upgrades/multi-org-migration.mdxdocs/docs/self-host/upgrades/oss-to-ee-switch.mdx
✅ Files skipped from review due to trivial changes (5)
- docs/docs/self-host/04-dynamic-access-controls.mdx
- docs/docs/self-host/01-quick-start.mdx
- AGENTS.md
- docs/docs/self-host/upgrades/oss-to-ee-switch.mdx
- docs/docs/self-host/upgrades/multi-org-migration.mdx
🚧 Files skipped from review as they are similar to previous changes (2)
- docs/docs/administration/access-control/01-organizations.mdx
- docs/docs/misc/01-opensource.mdx
1 participant
Context
The multi-org convergence PRs (#4671, #4673, #4674, #4675, #4676) change what self-hosted OSS operators experience: open signup replaces invite-only, organizations can be created and managed in OSS, and the
AGENTA_ACCESS_*variables are now enforced in both editions. The docs still describe organization-creation restriction as an Enterprise feature under a legacy variable name, and nothing warns operators about the signup posture flip.Changes
self-host/guides/06-restrict-organization-creation.mdx: rewritten as "Restrict Sign-ups and Organization Creation" (URL unchanged). Drops the Enterprise-only banner, uses the canonicalAGENTA_ACCESS_ALLOWED_OWNER_EMAILS(legacy aliases noted), and now also covers sign-up restriction via allowed/blocked domains and emails, how restricted users join, and a reference table of the four variables.self-host/upgrades/multi-org-migration.mdx: migration page for OSS operators. What to set before upgrading (the posture flip), what the migration does to existing data (membership backfill, constraint tightening, legacy-table drop), what changes day to day, and a rollback note.self-host/03-upgrading.mdx: pre-upgrade caution pointing at the migration page.self-host/01-quick-start.mdx: note that sign-ups are open by default, with a link to the restriction guide.self-host/02-configuration.mdx: the four access vars are marked as applying to both editions; plan/role vars stay Enterprise-only.self-host/04-dynamic-access-controls.mdx: clarifies the split between Enterprise-only plan/role overrides and the both-editions access vars.misc/01-opensource.mdx: feature table gains "Multiple Organizations" as available in OSS; the commercial-only list now reads RBAC, SSO, domain verification.administration/access-control/01-organizations.mdx: notes multi-org applies to self-hosted OSS; RBAC and domain verification stay plan-gated. The sso/rbac/domain-verification pages needed no change.AGENTS.md: new "Branching and PRs with GitButler" section (workspace mode, lanes and stacks, hook behavior,but push+gh pr createflow, absorb).Notes
🤖 Generated with Claude Code