Skip to content

Commit 4892c49

Browse files
committed
docs(FR-2325): add RBAC Management documentation for all languages (#6534)
Resolves #6046 (FR-2325) ## Summary - Add complete RBAC Management user manual documentation in 4 languages (EN, KO, JA, TH) - Add language-specific screenshots for EN, KO, JA (9 screenshots each, 27 total); TH uses EN placeholders (Thai locale unavailable) - Add RBAC terminology to [TERMINOLOGY.md](http://TERMINOLOGY.md) - Add navigation entries in book.config.yaml - Add RBAC cross-references in admin_menu and overview docs - Fix sidebar label: "Administration" → actual i18n labels (Admin Settings / 관리자 설정 / 管理者設定 / การตั้งค่าผู้ดูแลระบบ) - Fix cross-reference links: use `#rbac-management` anchor links with `<a id>` in rbac_management.md ## Documentation coverage - Role list page with filtering and status tabs - Create / Edit / Delete role workflows - Role detail drawer (source, status, dates, description) - Role Assignments tab (add/remove users) - Permissions tab (add permissions with scope type, target, permission type, permission) ## Screenshots (9 per language) | Screenshot | Description | | --- | --- | | `rbac_role_list_page.png` | Role list with filter and table | | `rbac_create_role_modal.png` | Create Role modal | | `rbac_role_detail_drawer.png` | Role detail drawer | | `rbac_edit_role_modal.png` | Edit Role modal | | `rbac_assignments_tab.png` | Role Assignments tab | | `rbac_add_user_modal.png` | Add User modal | | `rbac_remove_user_dialog.png` | Remove user confirmation | | `rbac_permissions_tab.png` | Permissions tab | | `rbac_add_permission_modal.png` | Add Permission modal | ## Test plan - [ ] Verify screenshots render correctly in built documentation - [ ] Verify cross-reference links work from admin_menu to rbac_management - [ ] Check all 4 language versions have structural parity 🤖 Generated with [Claude Code](https://claude.com/claude-code)
1 parent 1cc59a7 commit 4892c49

75 files changed

Lines changed: 810 additions & 44 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

packages/backend.ai-webui-docs/TERMINOLOGY.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -138,6 +138,19 @@ Backend.AI's GPU virtualization technology that allows sharing a single physical
138138

139139
**Do NOT use** "container" and "kernel" interchangeably. They refer to different concepts.
140140

141+
### RBAC (Role-Based Access Control)
142+
143+
| Term | EN | KO | JA | TH | Description |
144+
|------|----|----|----|----|-------------|
145+
| RBAC | RBAC | RBAC | RBAC | RBAC | Keep as abbreviation across all languages |
146+
| Role | role | 권한 | ロール | บทบาท | A named set of permissions assignable to users |
147+
| Permission | permission | 세부 권한 | 権限 | สิทธิ์ | A fine-grained access rule within a role |
148+
| Role Assignment | role assignment | 권한 할당 | ロール割り当て | การมอบหมายบทบาท | The association of a user to a role |
149+
| Scope Type | scope type | 적용 범위 타입 | スコープタイプ | ประเภทขอบเขต | The level at which a permission applies |
150+
| Permission Type | permission type | 권한 타입 | 権限タイプ | ประเภทสิทธิ์ | The category of resource a permission controls |
151+
152+
**Note**: The Korean i18n uses "권한" for both "Role" and "Permission" in different contexts. "세부 권한" is used specifically for fine-grained permissions within a role. Always check `resources/i18n/ko.json` for the exact UI labels.
153+
141154
## User Roles
142155

143156
| Role | EN | KO | JA | Scope |
@@ -158,6 +171,7 @@ These terms match sidebar menu items. Keep documentation references consistent w
158171
| Model Serving | 모델 서빙 | モデルサービス | model_serving/model_serving.md |
159172
| Statistics | 통계 | 統計 | statistics/statistics.md |
160173
| User Settings | 사용자 설정 | ユーザー設定 | user_settings/user_settings.md |
174+
| RBAC Management | RBAC 관리 | RBAC管理 | rbac_management/rbac_management.md |
161175

162176
**Important**: Always check `resources/i18n/{lang}.json` in the main project for current UI label translations. The i18n files are the source of truth for UI labels.
163177

packages/backend.ai-webui-docs/src/book.config.yaml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,8 @@ navigation:
5757
path: user_settings/user_settings.md
5858
- title: Cluster Session
5959
path: cluster_session/cluster_session.md
60+
- title: RBAC Management
61+
path: rbac_management/rbac_management.md
6062
- title: Admin Menu
6163
path: admin_menu/admin_menu.md
6264
- title: Trouble Shooting
@@ -114,6 +116,8 @@ navigation:
114116
path: user_settings/user_settings.md
115117
- title: クラスターセッション
116118
path: cluster_session/cluster_session.md
119+
- title: RBAC管理
120+
path: rbac_management/rbac_management.md
117121
- title: 管理者メニュー
118122
path: admin_menu/admin_menu.md
119123
- title: FAQ&トラブルシューティング
@@ -171,6 +175,8 @@ navigation:
171175
path: user_settings/user_settings.md
172176
- title: 클러스터 세션
173177
path: cluster_session/cluster_session.md
178+
- title: RBAC 관리
179+
path: rbac_management/rbac_management.md
174180
- title: 관리자 메뉴
175181
path: admin_menu/admin_menu.md
176182
- title: FAQ 및 문제 해결
@@ -228,6 +234,8 @@ navigation:
228234
path: user_settings/user_settings.md
229235
- title: เซสชันคลัสเตอร์
230236
path: cluster_session/cluster_session.md
237+
- title: การจัดการ RBAC
238+
path: rbac_management/rbac_management.md
231239
- title: เมนูผู้ดูแลระบบ
232240
path: admin_menu/admin_menu.md
233241
- title: FAQ และการแก้ไขปัญหา

packages/backend.ai-webui-docs/src/en/admin_menu/admin_menu.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1371,3 +1371,13 @@ This page is only for showing current information.
13711371
:::
13721372

13731373
![](../images/information_page.png)
1374+
1375+
## RBAC Management
1376+
1377+
RBAC (Role-Based Access Control) Management allows superadmins to define roles with fine-grained permissions and assign them to users. You can control which actions specific users are allowed to perform on various resources throughout the Backend.AI system.
1378+
1379+
:::note
1380+
RBAC Management is only available to superadmins and requires Backend.AI Manager version 25.4.0 or later.
1381+
:::
1382+
1383+
For detailed information about managing roles, permissions, and user assignments, refer to the dedicated [RBAC Management](#rbac-management) page.

packages/backend.ai-webui-docs/src/en/overview/overview.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -188,4 +188,5 @@ achieves more intuitive use.
188188
| Resources* | X | O |
189189
| Configurations* | X | O |
190190
| Maintenance* | X | O |
191-
| Information* | X | O |
191+
| Information* | X | O |
192+
| RBAC Management* | X | O (superadmin) |
84 KB
Loading
93.3 KB
Loading
48.8 KB
Loading
110 KB
Loading
95.9 KB
Loading
42.9 KB
Loading

0 commit comments

Comments
 (0)