refactor: reorganize tenancy documentation and update architecture sections#90
Merged
Merged
Conversation
…ctions - Updated the architecture section to group multi-tenancy and single-tenancy under a new "Tenancy" overview. - Introduced a new "Single-Tenancy" guide detailing deployment in a single namespace. - Enhanced the "Multi-Tenancy" guide with clearer descriptions and removed outdated content. - Adjusted references in the home documentation to reflect the new tenancy structure.
ruivieira
requested review from
gnaulak-redhat,
julpayne,
mariusdanciu,
nbs-rh,
ppadashe-psp and
scheruku-rh
|
Caution Review failedAn error occurred during the review process. Please try again later. ✨ 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
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@src/content/docs/architecture/single-tenancy.mdx`:
- Line 66: The `evalhub-tenant-admin` role description is incomplete because it
only states MLflow read access and omits the `create` verb needed for evaluation
submission. Update the `single-tenancy.mdx` docs near the `evalhub-tenant-admin`
role entry to either include MLflow `create` alongside the existing permissions
or explicitly note that the role is read-only, so the documented namespace
ServiceAccount flow matches the `POST /api/v1/evaluations/jobs` requirements.
🪄 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: defaults
Review profile: CHILL
Plan: Pro
Run ID: b25dfd1f-3646-4b3f-84f1-bc518958b2dd
📒 Files selected for processing (5)
astro.config.mjssrc/content/docs/architecture/multi-tenancy.mdxsrc/content/docs/architecture/single-tenancy.mdxsrc/content/docs/architecture/tenancy.mdxsrc/content/docs/home.mdx
- Updated the `evalhub-tenant-admin` role description to specify MLflow read-only access. - Enhanced the default admin access note to clarify job submission requirements and permissions for `evalhub-user`. - Added details on MLflow submission permissions related to `evaluations` and `experiments`.
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.
What and why
Documents EvalHub's
spec.tenancydeployment modes (multidefault,single) by splitting the former single multi-tenancy page into three focused guides:/architecture/tenancy/) — mode comparison, shared isolation/auth concepts, ClusterRoles reference, common troubleshooting, and mode switching/architecture/multi-tenancy/) — trimmed setup guide for shared control-plane deployments (tenant labels, principals, per-tenant RBAC)/architecture/single-tenancy/) — new setup guide forspec.tenancy: single(convenience Roles,evalhub-userbindings, tenant ConfigMaps)The sidebar is updated to a Tenancy group (Overview / Multi-Tenancy / Single-Tenancy), and the home page feature bullet now links to the overview.
Type
Testing
npm run build— all three pages render successfully (mermaid diagrams, Tabs, Steps).Breaking changes
None. Existing
/architecture/multi-tenancy/URLs are preserved; new pages are additive.Summary by CodeRabbit
New Features
Documentation