diff --git a/content/en/docs/workspace-administration/what-is-workspace.md b/content/en/docs/workspace-administration/what-is-workspace.md deleted file mode 100644 index 696f6a626..000000000 --- a/content/en/docs/workspace-administration/what-is-workspace.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "What is Workspace" -keywords: "kubernetes, helm, kubesphere, workspace, openpitrix, application" -description: "What is Workspace" - -linkTitle: "What is Workspace" -weight: 48 ---- - -Workspace is a logical unit to organize your [projects](../../project-administration/), [DevOps projects](../../devops-user-guide/) and [application management](../upload-helm-based-application/). It is the place for you to manage resource access and share resources within your team in a secure way. - -It is a best practice to create a new workspace for a tenant (non-cluster admin). A tenant can work in multiple workspaces, while a workspace allows multiple tenants to acces in different access modes. diff --git a/content/en/docs/workspace-administration/workspace-overview.md b/content/en/docs/workspace-administration/workspace-overview.md new file mode 100644 index 000000000..a2423fc34 --- /dev/null +++ b/content/en/docs/workspace-administration/workspace-overview.md @@ -0,0 +1,68 @@ +--- +title: "Workspace Overview" +keywords: "Kubernetes, KubeSphere, workspace" +description: "This tutorial introduces the concept of workspace and demonstrates how to create and delete a workspace." + +linkTitle: "Workspace Overview" +weight: 48 +--- + +A workspace is a logical unit to organize your [projects](../../project-administration/) and [DevOps projects](../../devops-user-guide/) and manage [app templates](../upload-helm-based-application/) and app repositories. It is the place for you to control resource access and share resources within your team in a secure way. + +It is a best practice to create a new workspace for tenants (excluding cluster administrators). A same tenant can work in multiple workspaces, while a workspace allows multiple tenants to access it in different ways. + +This tutorial demonstrates how to create and delete a workspace. + +## Prerequisites + +You have an account granted the role of `workspaces-manager`, such as `ws-manager` in [Create Workspace, Project, Account and Role](../../quick-start/create-workspace-and-project/). + +## Create a Workspace + +1. Log in the web console of KubeSphere as `ws-manager`. On the **Access Control** page, you can see all workspaces on the platform. By default, you have at least one workspace `system-workspace` in the list which contains all system projects. + +2. Click **Create**. + + ![workspace-list](/images/docs/workspace-administration/workspace-overview/workspace-list.jpg) + +3. On the **Basic Info** page, specify a name for the workspace and select a workspace manager from the list. Click **Create** to continue. + + ![provide-workspace-info](/images/docs/workspace-administration/workspace-overview/provide-workspace-info.jpg) + + - **Workspace Name**: Set a name for the workspace which serves as a unique identifier. + - **Alias**: An alias name for the workspace. + - **Workspace Manager**: The person who administrates the workspace. + - **Description**: A brief introduction of the workspace. + +4. A newly-created workspace displays in the list as below. + + ![created-workspace](/images/docs/workspace-administration/workspace-overview/created-workspace.jpg) + +5. Click the workspace and you can see resource status in the workspace on the **Overview** page. + + ![workspace-overview](/images/docs/workspace-administration/workspace-overview/workspace-overview.jpg) + +## Delete a Workspace + +1. In your workspace, go to **Basic Info** under **Workspace Settings**. On the **Basic Info** page, you can see the general information of the workspace, such as the number of projects and members. + + ![workspace-basic-info](/images/docs/workspace-administration/workspace-overview/workspace-basic-info.jpg) + + {{< notice note >}} + + On this page, you can click **Edit Info** to change the basic information of the workspace (excluding the workspace name) and turn on/off [Network Isolation](../../workspace-administration/workspace-network-isolation/). + + {{}} + +2. To delete the workspace, check **Sure to delete the workspace** and click **Delete**. + + ![delete-workspace](/images/docs/workspace-administration/workspace-overview/delete-workspace.jpg) + + {{< notice warning >}} + + A workspace cannot be restored after it is deleted and resources in the workspace will also be removed. + + {{}} + + + diff --git a/static/images/docs/workspace-administration/workspace-overview/created-workspace.jpg b/static/images/docs/workspace-administration/workspace-overview/created-workspace.jpg new file mode 100644 index 000000000..eaa1ace82 Binary files /dev/null and b/static/images/docs/workspace-administration/workspace-overview/created-workspace.jpg differ diff --git a/static/images/docs/workspace-administration/workspace-overview/delete-workspace.jpg b/static/images/docs/workspace-administration/workspace-overview/delete-workspace.jpg new file mode 100644 index 000000000..5cb53bef1 Binary files /dev/null and b/static/images/docs/workspace-administration/workspace-overview/delete-workspace.jpg differ diff --git a/static/images/docs/workspace-administration/workspace-overview/provide-workspace-info.jpg b/static/images/docs/workspace-administration/workspace-overview/provide-workspace-info.jpg new file mode 100644 index 000000000..bfc702079 Binary files /dev/null and b/static/images/docs/workspace-administration/workspace-overview/provide-workspace-info.jpg differ diff --git a/static/images/docs/workspace-administration/workspace-overview/workspace-basic-info.jpg b/static/images/docs/workspace-administration/workspace-overview/workspace-basic-info.jpg new file mode 100644 index 000000000..42743ad06 Binary files /dev/null and b/static/images/docs/workspace-administration/workspace-overview/workspace-basic-info.jpg differ diff --git a/static/images/docs/workspace-administration/workspace-overview/workspace-list.jpg b/static/images/docs/workspace-administration/workspace-overview/workspace-list.jpg new file mode 100644 index 000000000..24d5af43b Binary files /dev/null and b/static/images/docs/workspace-administration/workspace-overview/workspace-list.jpg differ diff --git a/static/images/docs/workspace-administration/workspace-overview/workspace-overview.jpg b/static/images/docs/workspace-administration/workspace-overview/workspace-overview.jpg new file mode 100644 index 000000000..914b039a3 Binary files /dev/null and b/static/images/docs/workspace-administration/workspace-overview/workspace-overview.jpg differ