huawei-cloud-cloudrobo-workspace

Windows / PowerShell: Examples use bash syntax. To run on Windows PowerShell:

• Flatten \ line continuations to a single line, or end lines with a backtick.
• Set env vars with $env:NAME="value" instead of export NAME="value".
• Single-quoted JSON '{"a":"b"}' works as-is.

Overview 概述

The cloudrobo-workspace skill manages the full lifecycle of CloudRobo workspaces. A workspace is the foundational resource container — all other CloudRobo operations (dataset processing, model training, evaluation, inference, etc.) require a valid workspace_id. This skill covers workspace CRUD, member management (add/list/update-role/delete), workspace overview statistics, and workspace context switching (use/current).

Applicable scenarios:

• Workspace management — Create, list, show, update, or delete workspaces
• Member management — Add members, list members, update member roles, delete members
• Context switching — Switch active workspace via use, verify current via current; all other skills (dataset, train, eval, infer) read the active workspace from ~/.cloudrobo/workspace.json
• Overview & quota — View workspace capacity, used count, available count, member count
• Onboarding — First-time setup: create workspace → switch to it → start using other skills

Architecture:

Agent / LLM
    │
    ├── CLI  →  cloudrobo workspace <command>
    ├── SDK  →  WorkspaceClient (Python)
                    │
                    ▼
              cloudrobo-service (REST API)
              /v1/workspaces/*
              /v1/workspaces/{workspace_id}/members/*
              /v1/workspaces/statistic/overview

All operations target the cloudrobo-service backend. Workspace is a domain-level (account-level) resource — no --workspace-id override needed for workspace operations themselves. The active workspace context is stored in ~/.cloudrobo/workspace.json and consumed by all other skills.

Prerequisites 前置条件

See references/cli-installation-guide.md for CLI installation, AK/SK authentication, and initial configuration. Workspace is the first skill to use during onboarding — create a workspace and run cloudrobo workspace use before using any other cloudrobo skill.

Workflow 工作流

Onboarding Workflow (First-Time Setup) 首次设置

1. Verify credentials — Ensure HUAWEI_CLOUD_AK/HUAWEI_CLOUD_SK are set
2. List existing workspaces — cloudrobo workspace list (a default workspace may already exist)
3. Create a workspace (if needed) — cloudrobo workspace create --name <name> --default-obs-path <obs://...>
4. Switch to workspace — cloudrobo workspace use --workspace-id <id> (validates and saves context)
5. Verify — cloudrobo workspace current (shows active workspace config)
6. Proceed — Other skills (dataset, train, eval, infer) now use the active workspace

Standard Workflow (Workspace CRUD) 工作空间管理

1. Create — cloudrobo workspace create --name <name> --default-obs-path <obs://...> [--description ...] [--tags ...] [--member-list ...]
2. List — cloudrobo workspace list [--limit N] [--offset N] (returns workspaces + page_info + last_count)
3. Show — cloudrobo workspace show --workspace-id <id> (returns full detail including asset_catalog_id)
4. Update — cloudrobo workspace update --workspace-id <id> [--name ...] [--description ...] [--tags ...] [--owner-id ...]
5. Delete — cloudrobo workspace delete --workspace-id <id> (irreversible; triggers async cleanup)

Member Management Workflow 成员管理

1. List members — cloudrobo workspace list-members --workspace-id <id>
2. Add members — cloudrobo workspace add-members --workspace-id <id> --member-list '<json>'
3. Update member role — cloudrobo workspace update-member --workspace-id <id> --user-id <uid> --role-ids <r1,r2>
4. Delete members — cloudrobo workspace delete-members --workspace-id <id> --user-ids <u1,u2>

Overview Workflow 概览统计

1. Get overview — cloudrobo workspace overview (returns workspace_capacity, workspace_used, workspace_available, member_capacity, member_count)

Context Switching Workflow 工作空间切换

1. Switch — cloudrobo workspace use --workspace-id <id> (validates workspace, saves to ~/.cloudrobo/workspace.json)
2. Verify — cloudrobo workspace current (displays saved workspace config)

CLI Command Format Standard CLI命令格式标准

cloudrobo workspace <command> [OPTIONS]

Core Commands 核心命令

Workspace Management 工作空间管理

Create a workspace

cloudrobo workspace create --name <workspace-name> --default-obs-path <obs://bucket/path> [--description <description>] [--tags <tag1,tag2>] [--member-list '<json>'] [--dry-run]

• SDK: client.create_workspace(req: dict)
• API: POST /v1/workspaces

Required fields: name (3-64 chars, pattern: ^[\u4e00-\u9fa5a-zA-Z0-9-_./]{3,64}$), default_obs_path (obs:// protocol, max 512 chars). Optional: description (max 512), tags (max 10, each 1-16 chars), member_list (max 100 members). See references/workspace-config-catalog.md for full field mapping and validation rules.

Server-side actions on create: check name uniqueness → check workspace quota → create Workspace entity → bind OBS bucket policy → create asset catalog → insert DB → add administrator (if non-root user) → create default quota → add members (if provided).

List workspaces

cloudrobo workspace list [--limit <n>] [--offset <n>]

• SDK: client.list_workspaces(limit=..., offset=...)
• API: GET /v1/workspaces?limit=<n>&offset=<n>

Returns: workspaces (list), page_info (total, current_count, offset), last_count (remaining workspace quota). A default workspace named "default" is auto-created on first list if it does not exist.

Show workspace detail

cloudrobo workspace show --workspace-id <workspace-id>

• SDK: client.show_workspace(workspace_id: str)
• API: GET /v1/workspaces/{workspace_id}

Returns: full workspace detail including workspace_id, name, description, asset_catalog_id, default_obs_path, domain_id, owner_id, owner (name), create_at, update_at, tags, role_ids, repository_id.

Update a workspace

cloudrobo workspace update --workspace-id <workspace-id> [--name <new-name>] [--description <new-description>] [--tags <tag1,tag2>] [--owner-id <user-id>] [--default-obs-path <obs://...>] [--bind-obs-policy] [--dry-run]

• SDK: client.update_workspace(workspace_id: str, req: dict)
• API: PUT /v1/workspaces/{workspace_id}

Updatable fields: name, description, tags (full replacement), owner_id (transfer ownership), default_obs_path, bind_obs_policy (boolean flag — binds the OBS bucket policy only, does not update any other workspace field). The default workspace can only set default_obs_path once (first time); other updates to the default workspace are rejected.

Delete a workspace

cloudrobo workspace delete --workspace-id <workspace-id> [--dry-run]

• SDK: client.delete_workspace(workspace_id: str)
• API: DELETE /v1/workspaces/{workspace_id}

Deletion is irreversible. Only root user or workspace owner can delete. The default workspace cannot be deleted. Server creates async cleanup tasks on deletion.

Member Management 成员管理

List workspace members

cloudrobo workspace list-members --workspace-id <workspace-id>

• SDK: client.list_workspace_members(workspace_id: str)
• API: GET /v1/workspaces/{workspace_id}/members

Returns: members (list with workspace_id, user_id, username, roles (role_id + role_name), is_owner), remain_count (remaining member quota). The root user is always listed as super_administrator.

Add workspace members

cloudrobo workspace add-members --workspace-id <workspace-id> --member-list '<json>'

• SDK: client.add_workspace_members(workspace_id: str, req: dict)
• API: POST /v1/workspaces/{workspace_id}/members

Required: member_list JSON array, each entry has user_id (32-char hex, IAM project ID format) and role_ids (UUID list, max 10). Root users cannot be added as members. Duplicate members are rejected. The default workspace does not support member operations.

Update a member's roles

cloudrobo workspace update-member --workspace-id <workspace-id> --user-id <user-id> --role-ids <role-id-1,role-id-2>

• SDK: client.update_workspace_member(workspace_id: str, req: dict)
• API: PUT /v1/workspaces/{workspace_id}/members

Required: user_id and role_ids. The workspace owner's role cannot be updated. The default workspace does not support member operations.

Delete workspace members

cloudrobo workspace delete-members --workspace-id <workspace-id> --user-ids <user-id-1,user-id-2>

• SDK: client.delete_workspace_members(workspace_id: str, user_ids: list)
• API: DELETE /v1/workspaces/{workspace_id}/members?user_ids=<ids>

The workspace owner cannot be deleted. The default workspace does not support member operations. Max 20 user IDs per request (API constraint) / 100 per request (CLI constraint).

Overview & Statistics 概览统计

Get workspace overview

cloudrobo workspace overview

• SDK: client.get_workspace_overview()
• API: GET /v1/workspaces/statistic/overview

Returns: workspace_capacity (max workspaces), workspace_used (current count), workspace_available (remaining), member_capacity (max members, requires BASIC resource SKU), member_count (current member count including root user).

Workspace Context 工作空间上下文

Switch active workspace

cloudrobo workspace use --workspace-id <workspace-id>

Validates the workspace exists and is accessible, then saves to ~/.cloudrobo/workspace.json: workspace_id, name, asset_catalog_id, default_obs_path. All other skills read this file to determine the active workspace.

Show current workspace

cloudrobo workspace current

Displays the saved workspace config from ~/.cloudrobo/workspace.json. If no workspace is configured, outputs "未配置工作空间".

Reference Documents 参考文档

• CLI Installation Guide — cloudrobo CLI installation and configuration
• IAM Policies — Least-privilege credential model
• API Paths — REST API paths discovered via SDK source
• Workspace Config Reference — Field mapping, validation rules, role system, member format
• Dataflow Diagram — Mermaid data flow diagram
• Verification Method — Verification method details
• Acceptance Criteria — Acceptance criteria

Edge Cases 边界情况

Verification Method 验证方法

Specification Compliance Verification 规范合规验证

bash scripts/test-cli-commands.sh -s . -e cli

Functional Testing 功能测试

# CLI / SDK (read-only cases TC-01..TC-10 / TC-19..TC-22 run automatically)
bash scripts/test-cli-commands.sh -s . -e {cli|sdk}

# Include mutation cases (TC-11..TC-18, TC-23..TC-28) — each prompts for confirmation
bash scripts/test-cli-commands.sh -s . -e {cli|sdk} -m

API-level verification is manual — replay the paths in references/api-paths.md in API Explorer.

Test Cases 测试用例

See templates/test-vars.json for the full test case list covering workspace CRUD, member management, overview, and context switching scenarios.

Verification Checklist 验证清单

• After creating a workspace, verify via show --workspace-id <id> that asset_catalog_id is populated
• After use --workspace-id <id>, verify current outputs the correct workspace config
• After adding members, verify via list-members that new members appear with correct roles
• After deleting a workspace, verify it no longer appears in list
• Verify overview returns consistent workspace_used count with list results

Best Practices 最佳实践

• Always run workspace list first to check existing workspaces before creating a new one
• Use --dry-run with create/update/delete to preview operations before executing
• After creating a workspace, immediately run workspace use --workspace-id <id> to switch context
• Before deleting a workspace, confirm the workspace ID to avoid irreversible deletion
• When adding members, use list-members first to check existing members and avoid duplicates
• The default workspace ("default") has special restrictions — prefer creating a named workspace for production use
• Check workspace overview periodically to monitor workspace and member quota usage
• workspace current is a quick way to verify the active workspace before running other cloudrobo commands
• Transfer ownership with caution — the new owner gains full control of the workspace
• Tags are fully replaced on update, not merged — include all desired tags in the update command