-
Notifications
You must be signed in to change notification settings - Fork 2.2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: add workspace usage doc. (#4368)
* docs: add workspace usage doc. Signed-off-by: yy <[email protected]> * docs: add workspace usage doc. Signed-off-by: yy <[email protected]> * docs: add workspace usage doc. Signed-off-by: yy <[email protected]> --------- Signed-off-by: yy <[email protected]>
- Loading branch information
Showing
10 changed files
with
101 additions
and
0 deletions.
There are no files selected for viewing
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+1.25 MB
docs/4.0/docs/platform-components/workspace/images/create-workspace.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+602 KB
docs/4.0/docs/platform-components/workspace/images/switch-workspace.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,55 @@ | ||
--- | ||
sidebar_position: 5 | ||
--- | ||
|
||
# Team Collaboration and Workspace | ||
|
||
## Term Definitions | ||
|
||
### Workspace | ||
|
||
Workspace is a core feature of the Sealos Cloud Operating System, implemented based on Kubernetes namespaces. It serves | ||
as a multi-tenant resource isolation mechanism, allowing the partitioning of a Kubernetes cluster into multiple | ||
workspaces. Each workspace has its own resource quotas and permissions, enabling the allocation of different users to | ||
distinct workspaces for resource isolation and permission control. | ||
|
||
Personal workspace is a special form of workspace. Each user has a personal workspace with a name identical to their | ||
username. The resource quotas and permissions of personal workspaces are the same as regular workspaces. However, | ||
personal workspaces cannot be deleted, and other users cannot be added to them. | ||
|
||
### Roles and Permissions | ||
|
||
Users within a workspace can have different roles, each with its own set of permissions. Currently, Sealos Cloud | ||
Operating System includes the following roles: Owner, Manager, and Developer. | ||
|
||
+ Owner: Possesses all permissions within the workspace, including deleting the workspace, viewing/creating/modifying | ||
all resources within the workspace, and inviting users to join the workspace as administrators/developers. | ||
+ Manager: Possesses managerial permissions within the workspace, such as viewing/creating/modifying all resources | ||
within the workspace and inviting users to join as developers. | ||
+ Developer: Possesses development permissions within the workspace, including viewing the status of resources within | ||
the workspace. | ||
|
||
## Quick Start | ||
|
||
### Create Workspace | ||
|
||
![create-workspace.gif](images%2Fcreate-workspace.gif) | ||
|
||
### Switch Workspace | ||
|
||
![switch-workspace.gif](images%2Fswitch-workspace.gif) | ||
|
||
### Invite Users to Join Workspace | ||
|
||
Invite users to join the workspace using their user ID. The invited users can choose to accept or decline the | ||
invitation. If accepted, the invited users become members of the workspace with resource permissions. | ||
|
||
![invite-user.gif](images%2Finvite-user.gif) | ||
|
||
### Accept Invitation | ||
|
||
When a user is invited to join a workspace, they can view the invitation message in the management panel. By clicking on | ||
the invitation message, they can see the details and accept the invitation. After acceptance, the user becomes a member | ||
of the workspace with resource permissions. | ||
|
||
![accept-invite.gif](images%2Faccept-invite.gif) |
Binary file added
BIN
+1.74 MB
docs/4.0/i18n/zh-Hans/platform-components/workspace/images/accept-invite.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+1.35 MB
docs/4.0/i18n/zh-Hans/platform-components/workspace/images/create-workspace.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+1.02 MB
docs/4.0/i18n/zh-Hans/platform-components/workspace/images/invite-user.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+560 KB
docs/4.0/i18n/zh-Hans/platform-components/workspace/images/switch-workspace.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
46 changes: 46 additions & 0 deletions
46
docs/4.0/i18n/zh-Hans/platform-components/workspace/worksapce.md
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,46 @@ | ||
--- | ||
sidebar_position: 5 | ||
--- | ||
|
||
# 团队协作与工作空间 | ||
|
||
## 名词解释 | ||
|
||
### 工作空间 | ||
|
||
工作空间(workspace)是 Sealos 云操作系统的核心功能,基于kubernetes | ||
namespace实现,是一种多租户的资源隔离机制,可以将一个kubernetes集群划分为多个工作空间,每个工作空间都有自己的资源配额和权限,可以将不同的用户划分到不同的工作空间中,实现资源隔离和权限控制。 | ||
|
||
个人空间(personal | ||
workspace)是工作空间的一种特殊形式,每个用户都有一个个人空间,个人空间的名称与用户的用户名相同,个人空间的资源配额和权限与普通工作空间相同,但是个人空间无法删除,也无法将其他用户加入到个人空间中。 | ||
|
||
### 角色与权限 | ||
|
||
工作空间中的用户可以拥有不同的角色,不同的角色拥有不同的权限,目前 Sealos 云操作系统中的角色有以下几种: | ||
所有者(owner)、管理员(manager)、开发者(developer)。 | ||
|
||
+ 所有者(owner):拥有工作空间的所有权限,包括删除工作空间、查看/创建/修改工作空间中的所有资源、邀请用户以管理员/开发者身份加入工作空间等。 | ||
+ 管理员(manager):拥有工作空间的管理权限,包括查看/创建/修改工作空间中的所有资源、邀请用户以开发者身份加入工作空间等。 | ||
+ 开发者(developer):拥有工作空间的开发权限,包括查看工作空间中的资源状态。 | ||
|
||
## 快速开始 | ||
|
||
### 创建工作空间 | ||
|
||
![create-workspace.gif](images%2Fcreate-workspace.gif) | ||
|
||
### 切换工作空间 | ||
|
||
![switch-workspace.gif](images%2Fswitch-workspace.gif) | ||
|
||
### 邀请用户加入工作空间 | ||
|
||
通过用户id邀请用户加入工作空间,被邀请的用户可以选择接受或拒绝邀请,如果接受邀请,被邀请的用户将成为工作空间的成员,拥有工作空间中的资源权限。 | ||
|
||
![invite-user.gif](images%2Finvite-user.gif) | ||
|
||
### 接受邀请 | ||
|
||
当用户被邀请加入工作空间时,可以在管理面板查看到邀请消息,点击邀请消息可以查看邀请详情,点击接受邀请按钮可以接受邀请,接受邀请后,用户将成为工作空间的成员,拥有工作空间中的资源权限。 | ||
|
||
![accept-invite.gif](images%2Faccept-invite.gif) |