diff --git a/content/en/docs/application-store/app-lifecycle-management.md b/content/en/docs/application-store/app-lifecycle-management.md index b97b4eda2..ef4f27b1c 100644 --- a/content/en/docs/application-store/app-lifecycle-management.md +++ b/content/en/docs/application-store/app-lifecycle-management.md @@ -18,7 +18,7 @@ Using [Redis](https://redis.io/) as an example application, this tutorial demons ## Prerequisites - You need to enable [KubeSphere App Store (OpenPitrix)](../../pluggable-components/app-store/). -- You need to create a workspace, a project and an account (`project-regular`). For more information, see [Create Workspace, Project, Account and Role](../../quick-start/create-workspace-and-project/). +- You need to create a workspace, a project and an account (`project-regular`). For more information, see [Create Workspaces, Projects, Accounts and Roles](../../quick-start/create-workspace-and-project/). ## Hands-on Lab diff --git a/content/en/docs/application-store/built-in-apps/etcd-app.md b/content/en/docs/application-store/built-in-apps/etcd-app.md index 9c835c349..2f824a661 100644 --- a/content/en/docs/application-store/built-in-apps/etcd-app.md +++ b/content/en/docs/application-store/built-in-apps/etcd-app.md @@ -13,7 +13,7 @@ This tutorial walks you through an example of deploying etcd from the App Store ## Prerequisites - Please make sure you [enable the OpenPitrix system](https://kubesphere.io/docs/pluggable-components/app-store/). -- You need to create a workspace, a project, and a user account (`project-regular`) for this tutorial. The account needs to be a platform regular user and to be invited as the project operator with the `operator` role. In this tutorial, you log in as `project-regular` and work in the project `demo-project` in the workspace `demo-workspace`. For more information, see [Create Workspace, Project, Account and Role](../../../quick-start/create-workspace-and-project/). +- You need to create a workspace, a project, and a user account (`project-regular`) for this tutorial. The account needs to be a platform regular user and to be invited as the project operator with the `operator` role. In this tutorial, you log in as `project-regular` and work in the project `demo-project` in the workspace `demo-workspace`. For more information, see [Create Workspaces, Projects, Accounts and Roles](../../../quick-start/create-workspace-and-project/). ## Hands-on Lab diff --git a/content/en/docs/application-store/built-in-apps/memcached-app.md b/content/en/docs/application-store/built-in-apps/memcached-app.md index de83fe357..7b815c148 100644 --- a/content/en/docs/application-store/built-in-apps/memcached-app.md +++ b/content/en/docs/application-store/built-in-apps/memcached-app.md @@ -12,7 +12,7 @@ This tutorial walks you through an example of deploying Memcached from the App S ## Prerequisites - Please make sure you [enable the OpenPitrix system](https://kubesphere.io/docs/pluggable-components/app-store/). -- You need to create a workspace, a project, and a user account (`project-regular`) for this tutorial. The account needs to be a platform regular user and to be invited as the project operator with the `operator` role. In this tutorial, you log in as `project-regular` and work in the project `demo-project` in the workspace `demo-workspace`. For more information, see [Create Workspace, Project, Account and Role](../../../quick-start/create-workspace-and-project/). +- You need to create a workspace, a project, and a user account (`project-regular`) for this tutorial. The account needs to be a platform regular user and to be invited as the project operator with the `operator` role. In this tutorial, you log in as `project-regular` and work in the project `demo-project` in the workspace `demo-workspace`. For more information, see [Create Workspaces, Projects, Accounts and Roles](../../../quick-start/create-workspace-and-project/). ## Hands-on Lab diff --git a/content/en/docs/application-store/built-in-apps/minio-app.md b/content/en/docs/application-store/built-in-apps/minio-app.md index 5a4cbf6a7..a2bddbd9c 100644 --- a/content/en/docs/application-store/built-in-apps/minio-app.md +++ b/content/en/docs/application-store/built-in-apps/minio-app.md @@ -12,7 +12,7 @@ This tutorial walks you through an example of deploying MinIO from the App Store ## Prerequisites - Please make sure you [enable the OpenPitrix system](../../../pluggable-components/app-store/). -- You need to create a workspace, a project, and a user account (`project-regular`) for this tutorial. The account needs to be a platform regular user and to be invited as the project operator with the `operator` role. In this tutorial, you log in as `project-regular` and work in the project `demo-project` in the workspace `demo-workspace`. For more information, see [Create Workspace, Project, Account and Role](../../../quick-start/create-workspace-and-project/). +- You need to create a workspace, a project, and a user account (`project-regular`) for this tutorial. The account needs to be a platform regular user and to be invited as the project operator with the `operator` role. In this tutorial, you log in as `project-regular` and work in the project `demo-project` in the workspace `demo-workspace`. For more information, see [Create Workspaces, Projects, Accounts and Roles](../../../quick-start/create-workspace-and-project/). ## Hands-on Lab diff --git a/content/en/docs/application-store/built-in-apps/mongodb-app.md b/content/en/docs/application-store/built-in-apps/mongodb-app.md index f168dd525..6fe07413b 100644 --- a/content/en/docs/application-store/built-in-apps/mongodb-app.md +++ b/content/en/docs/application-store/built-in-apps/mongodb-app.md @@ -13,7 +13,7 @@ This tutorial walks you through an example of deploying MongoDB from the App Sto ## Prerequisites - Please make sure you [enable the OpenPitrix system](../../../pluggable-components/app-store/). -- You need to create a workspace, a project, and a user account (`project-regular`) for this tutorial. The account needs to be a platform regular user and to be invited as the project operator with the `operator` role. In this tutorial, you log in as `project-regular` and work in the project `demo-project` in the workspace `demo-workspace`. For more information, see [Create Workspace, Project, Account and Role](../../../quick-start/create-workspace-and-project/). +- You need to create a workspace, a project, and a user account (`project-regular`) for this tutorial. The account needs to be a platform regular user and to be invited as the project operator with the `operator` role. In this tutorial, you log in as `project-regular` and work in the project `demo-project` in the workspace `demo-workspace`. For more information, see [Create Workspaces, Projects, Accounts and Roles](../../../quick-start/create-workspace-and-project/). ## Hands-on Lab diff --git a/content/en/docs/application-store/built-in-apps/mysql-app.md b/content/en/docs/application-store/built-in-apps/mysql-app.md index c9203d055..dbd009683 100644 --- a/content/en/docs/application-store/built-in-apps/mysql-app.md +++ b/content/en/docs/application-store/built-in-apps/mysql-app.md @@ -13,7 +13,7 @@ This tutorial walks you through an example of deploying MySQL from the App Store ## Prerequisites - Please make sure you [enable the OpenPitrix system](https://kubesphere.io/docs/pluggable-components/app-store/). -- You need to create a workspace, a project, and a user account for this tutorial. The account needs to be a platform regular user and to be invited as the project operator with the `operator` role. In this tutorial, you log in as `project-regular` and work in the project `demo-project` in the workspace `demo-workspace`. For more information, see [Create Workspace, Project, Account and Role](../../../quick-start/create-workspace-and-project/). +- You need to create a workspace, a project, and a user account for this tutorial. The account needs to be a platform regular user and to be invited as the project operator with the `operator` role. In this tutorial, you log in as `project-regular` and work in the project `demo-project` in the workspace `demo-workspace`. For more information, see [Create Workspaces, Projects, Accounts and Roles](../../../quick-start/create-workspace-and-project/). ## Hands-on Lab diff --git a/content/en/docs/application-store/built-in-apps/nginx-app.md b/content/en/docs/application-store/built-in-apps/nginx-app.md index c4350f2cd..5b3161574 100644 --- a/content/en/docs/application-store/built-in-apps/nginx-app.md +++ b/content/en/docs/application-store/built-in-apps/nginx-app.md @@ -13,7 +13,7 @@ This tutorial walks you through an example of deploying NGINX from the App Store ## Prerequisites - Please make sure you [enable the OpenPitrix system](../../../pluggable-components/app-store/). -- You need to create a workspace, a project, and a user account (`project-regular`) for this tutorial. The account needs to be a platform regular user and to be invited as the project operator with the `operator` role. In this tutorial, you log in as `project-regular` and work in the project `demo-project` in the workspace `demo-workspace`. For more information, see [Create Workspace, Project, Account and Role](../../../quick-start/create-workspace-and-project/). +- You need to create a workspace, a project, and a user account (`project-regular`) for this tutorial. The account needs to be a platform regular user and to be invited as the project operator with the `operator` role. In this tutorial, you log in as `project-regular` and work in the project `demo-project` in the workspace `demo-workspace`. For more information, see [Create Workspaces, Projects, Accounts and Roles](../../../quick-start/create-workspace-and-project/). ## Hands-on Lab diff --git a/content/en/docs/application-store/built-in-apps/postgresql-app.md b/content/en/docs/application-store/built-in-apps/postgresql-app.md index 28aa84cb0..265de2b74 100644 --- a/content/en/docs/application-store/built-in-apps/postgresql-app.md +++ b/content/en/docs/application-store/built-in-apps/postgresql-app.md @@ -13,7 +13,7 @@ This tutorial walks you through an example of how to deploy PostgreSQL from the ## Prerequisites - Please make sure you [enable the OpenPitrix system](../../../pluggable-components/app-store/). -- You need to create a workspace, a project, and a user account (`project-regular`) for this tutorial. The account needs to be a platform regular user and to be invited as the project operator with the `operator` role. In this tutorial, you log in as `project-regular` and work in the project `demo-project` in the workspace `demo-workspace`. For more information, see [Create Workspace, Project, Account and Role](../../../quick-start/create-workspace-and-project/). +- You need to create a workspace, a project, and a user account (`project-regular`) for this tutorial. The account needs to be a platform regular user and to be invited as the project operator with the `operator` role. In this tutorial, you log in as `project-regular` and work in the project `demo-project` in the workspace `demo-workspace`. For more information, see [Create Workspaces, Projects, Accounts and Roles](../../../quick-start/create-workspace-and-project/). ## Hands-on Lab diff --git a/content/en/docs/application-store/built-in-apps/rabbitmq-app.md b/content/en/docs/application-store/built-in-apps/rabbitmq-app.md index a298a4ca9..cc53980ca 100644 --- a/content/en/docs/application-store/built-in-apps/rabbitmq-app.md +++ b/content/en/docs/application-store/built-in-apps/rabbitmq-app.md @@ -12,7 +12,7 @@ This tutorial walks you through an example of how to deploy RabbitMQ from the Ap ## Prerequisites - Please make sure you [enable the OpenPitrix system](https://kubesphere.io/docs/pluggable-components/app-store/). -- You need to create a workspace, a project, and a user account for this tutorial. The account needs to be a platform regular user and to be invited as the project operator with the `operator` role. In this tutorial, you log in as `project-regular` and work in the project `demo-project` in the workspace `demo-workspace`. For more information, see [Create Workspace, Project, Account and Role](../../../quick-start/create-workspace-and-project/). +- You need to create a workspace, a project, and a user account for this tutorial. The account needs to be a platform regular user and to be invited as the project operator with the `operator` role. In this tutorial, you log in as `project-regular` and work in the project `demo-project` in the workspace `demo-workspace`. For more information, see [Create Workspaces, Projects, Accounts and Roles](../../../quick-start/create-workspace-and-project/). ## Hands-on Lab diff --git a/content/en/docs/application-store/built-in-apps/redis-app.md b/content/en/docs/application-store/built-in-apps/redis-app.md index b8943de10..1a6c203dd 100644 --- a/content/en/docs/application-store/built-in-apps/redis-app.md +++ b/content/en/docs/application-store/built-in-apps/redis-app.md @@ -13,7 +13,7 @@ This tutorial walks you through an example of deploying Redis from the App Store ## Prerequisites - Please make sure you [enable the OpenPitrix system](../../../pluggable-components/app-store/). -- You need to create a workspace, a project, and a user account (`project-regular`) for this tutorial. The account needs to be a platform regular user and to be invited as the project operator with the `operator` role. In this tutorial, you log in as `project-regular` and work in the project `demo-project` in the workspace `demo-workspace`. For more information, see [Create Workspace, Project, Account and Role](../../../quick-start/create-workspace-and-project/). +- You need to create a workspace, a project, and a user account (`project-regular`) for this tutorial. The account needs to be a platform regular user and to be invited as the project operator with the `operator` role. In this tutorial, you log in as `project-regular` and work in the project `demo-project` in the workspace `demo-workspace`. For more information, see [Create Workspaces, Projects, Accounts and Roles](../../../quick-start/create-workspace-and-project/). ## Hands-on Lab diff --git a/content/en/docs/application-store/built-in-apps/tomcat-app.md b/content/en/docs/application-store/built-in-apps/tomcat-app.md index 95e3e06ae..1e0739134 100644 --- a/content/en/docs/application-store/built-in-apps/tomcat-app.md +++ b/content/en/docs/application-store/built-in-apps/tomcat-app.md @@ -12,7 +12,7 @@ This tutorial walks you through an example of deploying Tomcat from the App Stor ## Prerequisites - Please make sure you [enable the OpenPitrix system](../../../pluggable-components/app-store/). -- You need to create a workspace, a project, and a user account for this tutorial. The account needs to be a platform regular user and to be invited as the project operator with the `operator` role. In this tutorial, you log in as `project-regular` and work in the project `demo-project` in the workspace `demo-workspace`. For more information, see [Create Workspace, Project, Account and Role](../../../quick-start/create-workspace-and-project/). +- You need to create a workspace, a project, and a user account for this tutorial. The account needs to be a platform regular user and to be invited as the project operator with the `operator` role. In this tutorial, you log in as `project-regular` and work in the project `demo-project` in the workspace `demo-workspace`. For more information, see [Create Workspaces, Projects, Accounts and Roles](../../../quick-start/create-workspace-and-project/). ## Hands-on Lab diff --git a/content/en/docs/application-store/external-apps/gitlab-app.md b/content/en/docs/application-store/external-apps/gitlab-app.md index c7e1aa27a..f0a4ef455 100644 --- a/content/en/docs/application-store/external-apps/gitlab-app.md +++ b/content/en/docs/application-store/external-apps/gitlab-app.md @@ -14,7 +14,7 @@ This tutorial shows you how to quickly deploy a [GitLab](https://gitlab.com/gitl ## Prerequisites - You have enabled [OpenPitrix](/docs/pluggable-components/app-store/). -- You have completed the tutorial [Create Workspace, Project, Account and Role](/docs/quick-start/create-workspace-and-project/). The account needs to be a platform regular user and to be invited as the project operator with the `operator` role. In this tutorial, we'll work in the project `apps` of the workspace `apps`. +- You have completed the tutorial [Create Workspaces, Projects, Accounts and Roles](/docs/quick-start/create-workspace-and-project/). The account needs to be a platform regular user and to be invited as the project operator with the `operator` role. In this tutorial, we'll work in the project `apps` of the workspace `apps`. ## Hands-on Lab diff --git a/content/en/docs/cluster-administration/cluster-settings/cluster-visibility-and-authorization.md b/content/en/docs/cluster-administration/cluster-settings/cluster-visibility-and-authorization.md index af33f5fe2..634f83094 100644 --- a/content/en/docs/cluster-administration/cluster-settings/cluster-visibility-and-authorization.md +++ b/content/en/docs/cluster-administration/cluster-settings/cluster-visibility-and-authorization.md @@ -12,7 +12,7 @@ This guide demonstrates how to set cluster visibility. ## Prerequisites * You need to enable the [multi-cluster feature](../../../multicluster-management/). -* You need to have a workspace and an account that has the permission to create workspaces, such as `ws-manager`. For more information, see [Create Workspace, Project, Account and Role](../../../quick-start/create-workspace-and-project/). +* You need to have a workspace and an account that has the permission to create workspaces, such as `ws-manager`. For more information, see [Create Workspaces, Projects, Accounts and Roles](../../../quick-start/create-workspace-and-project/). ## Set Cluster Visibility diff --git a/content/en/docs/devops-user-guide/examples/go-project-pipeline.md b/content/en/docs/devops-user-guide/examples/go-project-pipeline.md index b17fe7e43..d2f7ad03b 100644 --- a/content/en/docs/devops-user-guide/examples/go-project-pipeline.md +++ b/content/en/docs/devops-user-guide/examples/go-project-pipeline.md @@ -10,7 +10,7 @@ weight: 11410 - You need to [enable KubeSphere DevOps System](../../../../docs/pluggable-components/devops/). - You need to have a [Docker Hub](https://hub.docker.com/) account. -- You need to create a workspace, a DevOps project, a project, and an account (`project-regular`). This account needs to be invited to the DevOps project and the project for deploying your workload with the role `operator`. For more information, see [Create Workspace, Project, Account and Role](../../../quick-start/create-workspace-and-project). +- You need to create a workspace, a DevOps project, a project, and an account (`project-regular`). This account needs to be invited to the DevOps project and the project for deploying your workload with the role `operator`. For more information, see [Create Workspaces, Projects, Accounts and Roles](../../../quick-start/create-workspace-and-project). ## Create a Docker Hub Access Token diff --git a/content/en/docs/devops-user-guide/examples/multi-cluster-project-example.md b/content/en/docs/devops-user-guide/examples/multi-cluster-project-example.md index 1c0453108..fd7622247 100644 --- a/content/en/docs/devops-user-guide/examples/multi-cluster-project-example.md +++ b/content/en/docs/devops-user-guide/examples/multi-cluster-project-example.md @@ -11,7 +11,7 @@ weight: 11420 - You need to [enable the multi-cluster feature](../../../../docs/multicluster-management/). - You need to have a [Docker Hub](https://hub.docker.com/) account. - You need to [enable KubeSphere DevOps System](../../../../docs/pluggable-components/devops/) on your host cluster. -- You need to create a workspace with multiple clusters, a DevOps project on your **host** cluster, a multi-cluster project (in this tutorial, this multi-cluster project is created on the host cluster and one member cluster), and an account (`project-regular`). This account needs to be invited to the DevOps project and the multi-cluster project with the role `operator`. For more information, see [Create Workspace, Project, Account and Role](../../../quick-start/create-workspace-and-project), [Multi-cluster Management](../../../multicluster-management) and [Multi-cluster Projects](../../../project-administration/project-and-multicluster-project/#multi-cluster-projects). +- You need to create a workspace with multiple clusters, a DevOps project on your **host** cluster, a multi-cluster project (in this tutorial, this multi-cluster project is created on the host cluster and one member cluster), and an account (`project-regular`). This account needs to be invited to the DevOps project and the multi-cluster project with the role `operator`. For more information, see [Create Workspaces, Projects, Accounts and Roles](../../../quick-start/create-workspace-and-project), [Multi-cluster Management](../../../multicluster-management) and [Multi-cluster Projects](../../../project-administration/project-and-multicluster-project/#multi-cluster-projects). ## Create a Docker Hub Access Token diff --git a/content/en/docs/devops-user-guide/how-to-use/create-a-pipeline-using-graphical-editing-panel.md b/content/en/docs/devops-user-guide/how-to-use/create-a-pipeline-using-graphical-editing-panel.md index 89b969bd6..d63b63be5 100644 --- a/content/en/docs/devops-user-guide/how-to-use/create-a-pipeline-using-graphical-editing-panel.md +++ b/content/en/docs/devops-user-guide/how-to-use/create-a-pipeline-using-graphical-editing-panel.md @@ -14,7 +14,7 @@ This tutorial demonstrates how to create a pipeline through graphical editing pa - You need to [enable the KubeSphere DevOps System](../../../../docs/pluggable-components/devops/). - You need to have a [Docker Hub](http://www.dockerhub.com/) account. -- You need to create a workspace, a DevOps project, and an account (`project-regular`). This account must be invited to the DevOps project with the `operator` role. See [Create Workspace, Project, Account and Role](../../../quick-start/create-workspace-and-project/) if they are not ready. +- You need to create a workspace, a DevOps project, and an account (`project-regular`). This account must be invited to the DevOps project with the `operator` role. See [Create Workspaces, Projects, Accounts and Roles](../../../quick-start/create-workspace-and-project/) if they are not ready. - Set CI dedicated nodes to run the pipeline. For more information, see [Set CI Node for Dependency Cache](../set-ci-node/). - Configure your email server for pipeline notifications (Optional). For more information, see [Set Email Server for KubeSphere Pipelines](../../how-to-use/jenkins-email/). - Configure SonarQube to include code analysis as part of the pipeline (Optional). For more information, see [Integrate SonarQube into Pipelines](../../../devops-user-guide/how-to-integrate/sonarqube/). @@ -65,7 +65,7 @@ This example pipeline includes the following six stages. In this tutorial, the example pipeline will deploy the [sample](https://github.com/kubesphere/devops-java-sample/tree/sonarqube) app to a project. Hence, you must create the project (for example, `kubesphere-sample-dev`) in advance. The Deployment and Service of the app will be created automatically in the project once the pipeline runs successfully. -You can use the account `project-admin` to create the project. Besides, this account is also the reviewer of the CI/CD pipeline. Make sure the account `project-regular` is invited to the project with the role of `operator`. For more information, see [Create Workspace, Project, Account and Role](../../../quick-start/create-workspace-and-project/). +You can use the account `project-admin` to create the project. Besides, this account is also the reviewer of the CI/CD pipeline. Make sure the account `project-regular` is invited to the project with the role of `operator`. For more information, see [Create Workspaces, Projects, Accounts and Roles](../../../quick-start/create-workspace-and-project/). ### Step 3: Create a pipeline diff --git a/content/en/docs/devops-user-guide/how-to-use/create-a-pipeline-using-jenkinsfile.md b/content/en/docs/devops-user-guide/how-to-use/create-a-pipeline-using-jenkinsfile.md index c35cb18d2..67c94821b 100644 --- a/content/en/docs/devops-user-guide/how-to-use/create-a-pipeline-using-jenkinsfile.md +++ b/content/en/docs/devops-user-guide/how-to-use/create-a-pipeline-using-jenkinsfile.md @@ -20,7 +20,7 @@ Two types of pipelines can be created in KubeSphere: Pipelines created based on - You need to have a [Docker Hub](https://hub.docker.com/) account and a [GitHub](https://github.com/) account. - You need to [enable KubeSphere DevOps system](../../../pluggable-components/devops/). -- You need to create a workspace, a DevOps project, and an account (`project-regular`). This account needs to be invited to the DevOps project with the `operator` role. See [Create Workspace, Project, Account and Role](../../../quick-start/create-workspace-and-project/) if they are not ready. +- You need to create a workspace, a DevOps project, and an account (`project-regular`). This account needs to be invited to the DevOps project with the `operator` role. See [Create Workspaces, Projects, Accounts and Roles](../../../quick-start/create-workspace-and-project/) if they are not ready. - You need to set a CI dedicated node for running pipelines. Refer to [Set a CI Node for Dependency Caching](../../how-to-use/set-ci-node/). - You need to install and configure SonarQube. Refer to [Integrate SonarQube into Pipeline](../../../devops-user-guide/how-to-integrate/sonarqube/). If you skip this part, there is no **SonarQube Analysis** below. @@ -110,7 +110,7 @@ You need to create two projects, such as `kubesphere-sample-dev` and `kubesphe {{< notice note >}} -The account `project-admin` needs to be created in advance since it is the reviewer of the CI/CD Pipeline. See [Create Workspace, Project, Account and Role](../../../quick-start/create-workspace-and-project/) for more information. +The account `project-admin` needs to be created in advance since it is the reviewer of the CI/CD Pipeline. See [Create Workspaces, Projects, Accounts and Roles](../../../quick-start/create-workspace-and-project/) for more information. {{}} diff --git a/content/en/docs/devops-user-guide/how-to-use/credential-management.md b/content/en/docs/devops-user-guide/how-to-use/credential-management.md index 984ecf4a6..7c477428d 100644 --- a/content/en/docs/devops-user-guide/how-to-use/credential-management.md +++ b/content/en/docs/devops-user-guide/how-to-use/credential-management.md @@ -24,7 +24,7 @@ This tutorial demonstrates how to create and manage credentials in a DevOps proj ## Prerequisites - You have enabled [KubeSphere DevOps System](../../../pluggable-components/devops/). -- You have a workspace, a DevOps project and an account (`project-regular`) invited to the DevOps project with the `operator` role. If they are not ready yet, see [Create Workspace, Project, Account and Role](../../../quick-start/create-workspace-and-project/). +- You have a workspace, a DevOps project and an account (`project-regular`) invited to the DevOps project with the `operator` role. If they are not ready yet, see [Create Workspaces, Projects, Accounts and Roles](../../../quick-start/create-workspace-and-project/). ## Create Credentials diff --git a/content/en/docs/devops-user-guide/understand-and-manage-devops-projects/devops-project-management.md b/content/en/docs/devops-user-guide/understand-and-manage-devops-projects/devops-project-management.md index 13d276f89..c96c6e1d0 100644 --- a/content/en/docs/devops-user-guide/understand-and-manage-devops-projects/devops-project-management.md +++ b/content/en/docs/devops-user-guide/understand-and-manage-devops-projects/devops-project-management.md @@ -10,7 +10,7 @@ This tutorial demonstrates how to create and manage DevOps projects. ## Prerequisites -- You need to create a workspace and an account (`project-admin`). The account must be invited to the workspace with the role of `workspace-self-provisioner`. For more information, refer to [Create Workspace, Project, Account and Role](../../../quick-start/create-workspace-and-project/). +- You need to create a workspace and an account (`project-admin`). The account must be invited to the workspace with the role of `workspace-self-provisioner`. For more information, refer to [Create Workspaces, Projects, Accounts and Roles](../../../quick-start/create-workspace-and-project/). - You need to enable the [KubeSphere DevOps system](../../../pluggable-components/devops/). ## Create a DevOps Project diff --git a/content/en/docs/project-administration/project-gateway.md b/content/en/docs/project-administration/project-gateway.md index 6ddcd1cac..2285f374d 100644 --- a/content/en/docs/project-administration/project-gateway.md +++ b/content/en/docs/project-administration/project-gateway.md @@ -14,7 +14,7 @@ This tutorial demonstrates how to set a gateway in KubeSphere for the external a ## Prerequisites -You need to create a workspace, a project and an account (`project-admin`). The account must be invited to the project with the role of `admin` at the project level. For more information, see [Create Workspace, Project, Account and Role](../../../docs/quick-start/create-workspace-and-project). +You need to create a workspace, a project and an account (`project-admin`). The account must be invited to the project with the role of `admin` at the project level. For more information, see [Create Workspaces, Projects, Accounts and Roles](../../../docs/quick-start/create-workspace-and-project). ## Set a Gateway diff --git a/content/en/docs/project-administration/project-network-isolation.md b/content/en/docs/project-administration/project-network-isolation.md index e99e4fb18..d172d2d3e 100644 --- a/content/en/docs/project-administration/project-network-isolation.md +++ b/content/en/docs/project-administration/project-network-isolation.md @@ -12,7 +12,7 @@ KubeSphere project network isolation lets project administrators enforce which n ## Prerequisites - You have already enabled Network Policy. Please refer to [network-policy](../../pluggable-components/network-policy) if it is not ready yet. -- Use an account of the `admin` role at the project level. For example, use the account `project-admin` created in [Create Workspace, Project, Account and Role](../../quick-start/create-workspace-and-project/). +- Use an account of the `admin` role at the project level. For example, use the account `project-admin` created in [Create Workspaces, Projects, Accounts and Roles](../../quick-start/create-workspace-and-project/). {{< notice note >}} For the implementation of the Network Policy, you can refer to [kubesphere-network-policy](https://github.com/kubesphere/community/blob/master/sig-network/concepts-and-designs/kubesphere-network-policy.md). diff --git a/content/en/docs/project-administration/role-and-member-management.md b/content/en/docs/project-administration/role-and-member-management.md index f84b00381..46696622e 100644 --- a/content/en/docs/project-administration/role-and-member-management.md +++ b/content/en/docs/project-administration/role-and-member-management.md @@ -20,7 +20,7 @@ In project scope, you can grant the following resources' permissions to a role: ## Prerequisites -At least one project has been created, such as `demo-project`. Besides, you need an account of the `admin` role (e.g. `project-admin`) at the project level. See [Create Workspace, Project, Account and Role](../../quick-start/create-workspace-and-project/) if it is not ready yet. +At least one project has been created, such as `demo-project`. Besides, you need an account of the `admin` role (e.g. `project-admin`) at the project level. See [Create Workspaces, Projects, Accounts and Roles](../../quick-start/create-workspace-and-project/) if it is not ready yet. ## Built-in Roles diff --git a/content/en/docs/project-user-guide/application-workloads/cronjob.md b/content/en/docs/project-user-guide/application-workloads/cronjob.md index b350b029a..82c305139 100644 --- a/content/en/docs/project-user-guide/application-workloads/cronjob.md +++ b/content/en/docs/project-user-guide/application-workloads/cronjob.md @@ -13,7 +13,7 @@ For more information, see [the official documentation of Kubernetes](https://kub ## Prerequisites -You need to create a workspace, a project and an account (`project-regular`). The account must be invited to the project with the role of `operator`. For more information, see [Create Workspace, Project, Account and Role](../../../quick-start/create-workspace-and-project). +You need to create a workspace, a project and an account (`project-regular`). The account must be invited to the project with the role of `operator`. For more information, see [Create Workspaces, Projects, Accounts and Roles](../../../quick-start/create-workspace-and-project). ## Create a CronJob diff --git a/content/en/docs/project-user-guide/application-workloads/daemonsets.md b/content/en/docs/project-user-guide/application-workloads/daemonsets.md index 423a02b95..d925186aa 100644 --- a/content/en/docs/project-user-guide/application-workloads/daemonsets.md +++ b/content/en/docs/project-user-guide/application-workloads/daemonsets.md @@ -20,7 +20,7 @@ DaemonSets are very helpful in cases where you want to deploy ongoing background ## Prerequisites -You need to create a workspace, a project and an account (`project-regular`). The account must be invited to the project with the role of `operator`. For more information, see [Create Workspace, Project, Account and Role](../../../quick-start/create-workspace-and-project). +You need to create a workspace, a project and an account (`project-regular`). The account must be invited to the project with the role of `operator`. For more information, see [Create Workspaces, Projects, Accounts and Roles](../../../quick-start/create-workspace-and-project). ## Create a DaemonSet diff --git a/content/en/docs/project-user-guide/application-workloads/deployments.md b/content/en/docs/project-user-guide/application-workloads/deployments.md index 7435a5d31..81d913197 100644 --- a/content/en/docs/project-user-guide/application-workloads/deployments.md +++ b/content/en/docs/project-user-guide/application-workloads/deployments.md @@ -13,7 +13,7 @@ For more information, see the [official documentation of Kubernetes](https://kub ## Prerequisites -You need to create a workspace, a project and an account (`project-regular`). The account must be invited to the project with the role of `operator`. For more information, see [Create Workspace, Project, Account and Role](../../../quick-start/create-workspace-and-project). +You need to create a workspace, a project and an account (`project-regular`). The account must be invited to the project with the role of `operator`. For more information, see [Create Workspaces, Projects, Accounts and Roles](../../../quick-start/create-workspace-and-project). ## Create a Deployment diff --git a/content/en/docs/project-user-guide/application-workloads/jobs.md b/content/en/docs/project-user-guide/application-workloads/jobs.md index bd059b24f..6b6f4d6f9 100644 --- a/content/en/docs/project-user-guide/application-workloads/jobs.md +++ b/content/en/docs/project-user-guide/application-workloads/jobs.md @@ -15,7 +15,7 @@ The following example demonstrates specific steps of creating a Job (computing ## Prerequisites -You need to create a workspace, a project and an account (`project-regular`). The account must be invited to the project with the role of `operator`. For more information, see [Create Workspace, Project, Account and Role](../../../quick-start/create-workspace-and-project). +You need to create a workspace, a project and an account (`project-regular`). The account must be invited to the project with the role of `operator`. For more information, see [Create Workspaces, Projects, Accounts and Roles](../../../quick-start/create-workspace-and-project). ## Create a Job diff --git a/content/en/docs/project-user-guide/application-workloads/services.md b/content/en/docs/project-user-guide/application-workloads/services.md index d9b283880..4d85eb31f 100644 --- a/content/en/docs/project-user-guide/application-workloads/services.md +++ b/content/en/docs/project-user-guide/application-workloads/services.md @@ -27,7 +27,7 @@ In KubeSphere, stateful and stateless Services are created with a virtual IP by ## Prerequisites -You need to create a workspace, a project and an account (`project-regular`). The account must be invited to the project with the role of `operator`. For more information, see [Create Workspace, Project, Account and Role](../../../quick-start/create-workspace-and-project). +You need to create a workspace, a project and an account (`project-regular`). The account must be invited to the project with the role of `operator`. For more information, see [Create Workspaces, Projects, Accounts and Roles](../../../quick-start/create-workspace-and-project). ## Service Type diff --git a/content/en/docs/project-user-guide/application-workloads/statefulsets.md b/content/en/docs/project-user-guide/application-workloads/statefulsets.md index 4629b6089..4660aa076 100644 --- a/content/en/docs/project-user-guide/application-workloads/statefulsets.md +++ b/content/en/docs/project-user-guide/application-workloads/statefulsets.md @@ -23,7 +23,7 @@ For more information, see the [official documentation of Kubernetes](https://kub ## Prerequisites -You need to create a workspace, a project and an account (`project-regular`). The account must be invited to the project with the role of `operator`. For more information, see [Create Workspace, Project, Account and Role](../../../quick-start/create-workspace-and-project). +You need to create a workspace, a project and an account (`project-regular`). The account must be invited to the project with the role of `operator`. For more information, see [Create Workspaces, Projects, Accounts and Roles](../../../quick-start/create-workspace-and-project). ## Create a StatefulSet diff --git a/content/en/docs/project-user-guide/application/deploy-app-from-appstore.md b/content/en/docs/project-user-guide/application/deploy-app-from-appstore.md index ea99f1801..03424e810 100644 --- a/content/en/docs/project-user-guide/application/deploy-app-from-appstore.md +++ b/content/en/docs/project-user-guide/application/deploy-app-from-appstore.md @@ -13,7 +13,7 @@ This tutorial demonstrates how to quickly deploy [NGINX](https://www.nginx.com/) ## Prerequisites - You have enabled [OpenPitirx (App Store)](../../../pluggable-components/app-store). -- You need to create a workspace, a project, and a user account (`project-regular`) for this tutorial. The account needs to be a platform regular user invited to the project with the `operator` role. For more information, see [Create Workspace, Project, Account and Role](../../../quick-start/create-workspace-and-project/). +- You need to create a workspace, a project, and a user account (`project-regular`) for this tutorial. The account needs to be a platform regular user invited to the project with the `operator` role. For more information, see [Create Workspaces, Projects, Accounts and Roles](../../../quick-start/create-workspace-and-project/). ## Hands-on Lab diff --git a/content/en/docs/project-user-guide/application/deploy-app-from-template.md b/content/en/docs/project-user-guide/application/deploy-app-from-template.md index 16ceca579..6ba6f1334 100644 --- a/content/en/docs/project-user-guide/application/deploy-app-from-template.md +++ b/content/en/docs/project-user-guide/application/deploy-app-from-template.md @@ -13,7 +13,7 @@ This tutorial demonstrates how to quickly deploy [Grafana](https://grafana.com/) ## Prerequisites - You have enabled [OpenPitirx (App Store)](../../../pluggable-components/app-store). -- You have completed the tutorial of [Create Workspace, Project, Account and Role](../../../quick-start/create-workspace-and-project/). Namely, you must have a workspace, a project and two user accounts (`ws-admin` and `project-regular`). `ws-admin` must be granted the role of `workspace-admin` in the workspace and `project-regular` must be granted the role of `operator` in the project. +- You have completed the tutorial of [Create Workspaces, Projects, Accounts and Roles](../../../quick-start/create-workspace-and-project/). Namely, you must have a workspace, a project and two user accounts (`ws-admin` and `project-regular`). `ws-admin` must be granted the role of `workspace-admin` in the workspace and `project-regular` must be granted the role of `operator` in the project. ## Hands-on Lab diff --git a/content/en/docs/project-user-guide/configuration/configmaps.md b/content/en/docs/project-user-guide/configuration/configmaps.md index f64fec2e0..7db978716 100644 --- a/content/en/docs/project-user-guide/configuration/configmaps.md +++ b/content/en/docs/project-user-guide/configuration/configmaps.md @@ -16,7 +16,7 @@ This tutorial demonstrates how to create a ConfigMap in KubeSphere. ## Prerequisites -You need to create a workspace, a project and an account (`project-regular`). The account must be invited to the project with the role of `operator`. For more information, see [Create Workspace, Project, Account and Role](../../../quick-start/create-workspace-and-project). +You need to create a workspace, a project and an account (`project-regular`). The account must be invited to the project with the role of `operator`. For more information, see [Create Workspaces, Projects, Accounts and Roles](../../../quick-start/create-workspace-and-project). ## Create a ConfigMap diff --git a/content/en/docs/project-user-guide/configuration/image-registry.md b/content/en/docs/project-user-guide/configuration/image-registry.md index 42205dddb..f1512f0c3 100644 --- a/content/en/docs/project-user-guide/configuration/image-registry.md +++ b/content/en/docs/project-user-guide/configuration/image-registry.md @@ -12,7 +12,7 @@ This tutorial demonstrates how to create Secrets for different image registries. ## Prerequisites -You need to create a workspace, a project and an account (`project-regular`). The account must be invited to the project with the role of `operator`. For more information, see [Create Workspace, Project, Account and Role](../../../quick-start/create-workspace-and-project). +You need to create a workspace, a project and an account (`project-regular`). The account must be invited to the project with the role of `operator`. For more information, see [Create Workspaces, Projects, Accounts and Roles](../../../quick-start/create-workspace-and-project). ## Create a Secret diff --git a/content/en/docs/project-user-guide/configuration/secrets.md b/content/en/docs/project-user-guide/configuration/secrets.md index e47f2625b..942366f4a 100644 --- a/content/en/docs/project-user-guide/configuration/secrets.md +++ b/content/en/docs/project-user-guide/configuration/secrets.md @@ -16,7 +16,7 @@ This tutorial demonstrates how to create a Secret in KubeSphere. ## Prerequisites -You need to create a workspace, a project and an account (`project-regular`). The account must be invited to the project with the role of `operator`. For more information, see [Create Workspace, Project, Account and Role](../../../quick-start/create-workspace-and-project). +You need to create a workspace, a project and an account (`project-regular`). The account must be invited to the project with the role of `operator`. For more information, see [Create Workspaces, Projects, Accounts and Roles](../../../quick-start/create-workspace-and-project). ## Create a Secret diff --git a/content/en/docs/project-user-guide/custom-application-monitoring/examples/monitor-mysql.md b/content/en/docs/project-user-guide/custom-application-monitoring/examples/monitor-mysql.md index 719d13999..5b97db688 100644 --- a/content/en/docs/project-user-guide/custom-application-monitoring/examples/monitor-mysql.md +++ b/content/en/docs/project-user-guide/custom-application-monitoring/examples/monitor-mysql.md @@ -13,7 +13,7 @@ This tutorial walks you through an example of how to monitor MySQL metrics and v ## Prerequisites - Please make sure you [enable the OpenPitrix system](https://kubesphere.io/docs/pluggable-components/app-store/). MySQL and MySQL exporter will be deployed from the App Store. -- You need to create a workspace, a project, and a user account for this tutorial. For more information, see [Create Workspace, Project, Account and Role](../../../../quick-start/create-workspace-and-project/). The account needs to be a platform regular user and to be invited as the project operator with the `operator` role. In this tutorial, you log in as `project-operator` and work in the project `demo` in the workspace `demo-workspace`. +- You need to create a workspace, a project, and a user account for this tutorial. For more information, see [Create Workspaces, Projects, Accounts and Roles](../../../../quick-start/create-workspace-and-project/). The account needs to be a platform regular user and to be invited as the project operator with the `operator` role. In this tutorial, you log in as `project-operator` and work in the project `demo` in the workspace `demo-workspace`. ## Hands-on Lab diff --git a/content/en/docs/project-user-guide/custom-application-monitoring/examples/monitor-sample-web.md b/content/en/docs/project-user-guide/custom-application-monitoring/examples/monitor-sample-web.md index d5463dd4c..f74e67f1c 100644 --- a/content/en/docs/project-user-guide/custom-application-monitoring/examples/monitor-sample-web.md +++ b/content/en/docs/project-user-guide/custom-application-monitoring/examples/monitor-sample-web.md @@ -12,7 +12,7 @@ This section walks you through monitoring a sample web application. The applicat ## Prerequisites - Please make sure you [enable the OpenPitrix system](../../../../pluggable-components/app-store/). -- You need to create a workspace, a project, and a user account for this tutorial. For more information, see [Create Workspace, Project, Account and Role](../../../../quick-start/create-workspace-and-project/). The account needs to be a platform regular user and to be invited as the workspace self provisioner with the `self-provisioner` role. Namely, create an account `workspace-self-provisioner` of the `self-provisioner` role, and use this account to create a project (e.g. `test`). In this tutorial, you log in as `workspace-self-provisioner` and work in the project `test` in the workspace `demo-workspace`. +- You need to create a workspace, a project, and a user account for this tutorial. For more information, see [Create Workspaces, Projects, Accounts and Roles](../../../../quick-start/create-workspace-and-project/). The account needs to be a platform regular user and to be invited as the workspace self provisioner with the `self-provisioner` role. Namely, create an account `workspace-self-provisioner` of the `self-provisioner` role, and use this account to create a project (e.g. `test`). In this tutorial, you log in as `workspace-self-provisioner` and work in the project `test` in the workspace `demo-workspace`. - Knowledge of Helm Chart and [PromQL](https://prometheus.io/docs/prometheus/latest/querying/examples/). diff --git a/content/en/docs/project-user-guide/grayscale-release/blue-green-deployment.md b/content/en/docs/project-user-guide/grayscale-release/blue-green-deployment.md index b39bf9b57..e8f2230ae 100644 --- a/content/en/docs/project-user-guide/grayscale-release/blue-green-deployment.md +++ b/content/en/docs/project-user-guide/grayscale-release/blue-green-deployment.md @@ -16,7 +16,7 @@ The blue-green release provides a zero downtime deployment, which means the new ## Prerequisites - You need to enable [KubeSphere Service Mesh](../../../pluggable-components/service-mesh/). -- You need to create a workspace, a project and an account (`project-regular`). The account must be invited to the project with the role of `operator`. For more information, see [Create Workspace, Project, Account and Role](../../../quick-start/create-workspace-and-project). +- You need to create a workspace, a project and an account (`project-regular`). The account must be invited to the project with the role of `operator`. For more information, see [Create Workspaces, Projects, Accounts and Roles](../../../quick-start/create-workspace-and-project). - You need to enable **Application Governance** and have an available app so that you can implement the blue-green deployment for it. The sample app used in this tutorial is Bookinfo. For more information, see [Deploy Bookinfo and Manage Traffic](../../../quick-start/deploy-bookinfo-to-k8s/). ## Create Blue-green Deployment Job diff --git a/content/en/docs/project-user-guide/grayscale-release/canary-release.md b/content/en/docs/project-user-guide/grayscale-release/canary-release.md index ea24703e0..9a822ea6a 100644 --- a/content/en/docs/project-user-guide/grayscale-release/canary-release.md +++ b/content/en/docs/project-user-guide/grayscale-release/canary-release.md @@ -16,7 +16,7 @@ This method serves as an efficient way to test performance and reliability of a ## Prerequisites - You need to enable [KubeSphere Service Mesh](../../../pluggable-components/service-mesh/). -- You need to create a workspace, a project and an account (`project-regular`). The account must be invited to the project with the role of `operator`. For more information, see [Create Workspace, Project, Account and Role](../../../quick-start/create-workspace-and-project). +- You need to create a workspace, a project and an account (`project-regular`). The account must be invited to the project with the role of `operator`. For more information, see [Create Workspaces, Projects, Accounts and Roles](../../../quick-start/create-workspace-and-project). - You need to enable **Application Governance** and have an available app so that you can implement the canary release for it. The sample app used in this tutorial is Bookinfo. For more information, see [Deploy Bookinfo and Manage Traffic](../../../quick-start/deploy-bookinfo-to-k8s/). ## Create Canary Release Job diff --git a/content/en/docs/project-user-guide/grayscale-release/traffic-mirroring.md b/content/en/docs/project-user-guide/grayscale-release/traffic-mirroring.md index 0b8aba2f4..58e88c807 100644 --- a/content/en/docs/project-user-guide/grayscale-release/traffic-mirroring.md +++ b/content/en/docs/project-user-guide/grayscale-release/traffic-mirroring.md @@ -12,7 +12,7 @@ Traffic mirroring, also called shadowing, is a powerful, risk-free method of tes ## Prerequisites - You need to enable [KubeSphere Service Mesh](../../../pluggable-components/service-mesh/). -- You need to create a workspace, a project and an account (`project-regular`). The account must be invited to the project with the role of `operator`. For more information, see [Create Workspace, Project, Account and Role](../../../quick-start/create-workspace-and-project). +- You need to create a workspace, a project and an account (`project-regular`). The account must be invited to the project with the role of `operator`. For more information, see [Create Workspaces, Projects, Accounts and Roles](../../../quick-start/create-workspace-and-project). - You need to enable **Application Governance** and have an available app so that you can mirror the traffic of it. The sample app used in this tutorial is Bookinfo. For more information, see [Deploy Bookinfo and Manage Traffic](../../../quick-start/deploy-bookinfo-to-k8s/). ## Create Traffic Mirroring Job diff --git a/content/en/docs/project-user-guide/image-builder/binary-to-image.md b/content/en/docs/project-user-guide/image-builder/binary-to-image.md index d04f58686..101658f43 100644 --- a/content/en/docs/project-user-guide/image-builder/binary-to-image.md +++ b/content/en/docs/project-user-guide/image-builder/binary-to-image.md @@ -26,7 +26,7 @@ For demonstration and testing purposes, here are some example artifacts you can - You have enabled the [KubeSphere DevOps System](../../installation/install-devops). - You need to create a [Docker Hub](http://www.dockerhub.com/) account. GitLab and Harbor are also supported. -- You need to create a workspace, a project and an account (`project-regular`). The account must be invited to the project with the role of `operator`. For more information, see [Create Workspace, Project, Account and Role](../../../quick-start/create-workspace-and-project). +- You need to create a workspace, a project and an account (`project-regular`). The account must be invited to the project with the role of `operator`. For more information, see [Create Workspaces, Projects, Accounts and Roles](../../../quick-start/create-workspace-and-project). - Set a CI dedicated node for building images. This is not mandatory but recommended for the development and production environment as it caches dependencies and reduces build time. For more information, see [Set a CI Node for Dependency Caching](../../../devops-user-guide/how-to-use/set-ci-node/). ## Create a Service Using Binary-to-Image (B2I) diff --git a/content/en/docs/project-user-guide/image-builder/source-to-image.md b/content/en/docs/project-user-guide/image-builder/source-to-image.md index 19e175c92..cd59aa238 100644 --- a/content/en/docs/project-user-guide/image-builder/source-to-image.md +++ b/content/en/docs/project-user-guide/image-builder/source-to-image.md @@ -16,7 +16,7 @@ This tutorial demonstrates how to use S2I to import source code of a Java sample - You need to enable the [KubeSphere DevOps System](../../../pluggable-components/devops/) as S2I is integrated into it. - You need to create a [GitHub](https://github.com/) account and a [Docker Hub](http://www.dockerhub.com/) account. GitLab and Harbor are also supported. This tutorial uses a GitHub repository to provide the source code for building and pushes an image to Docker Hub. -- You need to create a workspace, a project and an account (`project-regular`). The account must be invited to the project with the role of `operator`. For more information, see [Create Workspace, Project, Account and Role](../../../quick-start/create-workspace-and-project). +- You need to create a workspace, a project and an account (`project-regular`). The account must be invited to the project with the role of `operator`. For more information, see [Create Workspaces, Projects, Accounts and Roles](../../../quick-start/create-workspace-and-project). - Set a CI dedicated node for building images. This is not mandatory but recommended for the development and production environment as it caches dependencies and reduces build time. For more information, see [Set a CI Node for Dependency Caching](../../../devops-user-guide/how-to-use/set-ci-node/). ## Use Source-to-Image (S2I) diff --git a/content/en/docs/project-user-guide/storage/volume-snapshots.md b/content/en/docs/project-user-guide/storage/volume-snapshots.md index e9310e9f1..990c2af5f 100644 --- a/content/en/docs/project-user-guide/storage/volume-snapshots.md +++ b/content/en/docs/project-user-guide/storage/volume-snapshots.md @@ -12,7 +12,7 @@ This tutorial demonstrates how to create and use a volume snapshot. ## Prerequisites -- You need to create a workspace, a project and an account (`project-regular`). The account must be invited to the project with the role of `operator`. For more information, see [Create Workspace, Project, Account and Role](../../../quick-start/create-workspace-and-project). +- You need to create a workspace, a project and an account (`project-regular`). The account must be invited to the project with the role of `operator`. For more information, see [Create Workspaces, Projects, Accounts and Roles](../../../quick-start/create-workspace-and-project). - Kubernetes version 1.17+. diff --git a/content/en/docs/project-user-guide/storage/volumes.md b/content/en/docs/project-user-guide/storage/volumes.md index e86de0a33..9e3ee00e3 100644 --- a/content/en/docs/project-user-guide/storage/volumes.md +++ b/content/en/docs/project-user-guide/storage/volumes.md @@ -14,7 +14,7 @@ This tutorial demonstrates how to create a volume, mount a volume and use volume ## Prerequisites -- You need to create a workspace, a project and an account (`project-regular`). The account must be invited to the project with the role of `operator`. For more information, see [Create Workspace, Project, Account and Role](../../../quick-start/create-workspace-and-project). +- You need to create a workspace, a project and an account (`project-regular`). The account must be invited to the project with the role of `operator`. For more information, see [Create Workspaces, Projects, Accounts and Roles](../../../quick-start/create-workspace-and-project). - If you want to dynamically provision a volume, you need to [configure a storage class](../../../cluster-administration/persistent-volume-and-storage-class/) that supports dynamic provisioning. diff --git a/content/en/docs/quick-start/_index.md b/content/en/docs/quick-start/_index.md index b9f8e6f6f..a68f97bdf 100644 --- a/content/en/docs/quick-start/_index.md +++ b/content/en/docs/quick-start/_index.md @@ -21,7 +21,7 @@ Learn how to install KubeSphere on Linux with a minimal installation package. Th Learn how to install KubeSphere on existing Kubernetes clusters with a minimal installation package. Your Kubernetes clusters can be hosted on cloud or on-premises. -## [Create Workspace, Project, Account and Role](../quick-start/create-workspace-and-project/) +## [Create Workspaces, Projects, Accounts and Roles](../quick-start/create-workspace-and-project/) Understand how you can take advantage of multi-tenant system in KubeSphere for fine-grained access control at different levels. diff --git a/content/en/docs/quick-start/create-workspace-and-project.md b/content/en/docs/quick-start/create-workspace-and-project.md index ea66f1b2f..541112584 100644 --- a/content/en/docs/quick-start/create-workspace-and-project.md +++ b/content/en/docs/quick-start/create-workspace-and-project.md @@ -1,16 +1,12 @@ --- -title: "Create Workspace, Project, Account and Role" +title: "Create Workspaces, Projects, Accounts and Roles" keywords: 'KubeSphere, Kubernetes, Multi-tenant, Workspace, Account, Role, Project' -description: 'Create Workspace, Project, Account and Role' - -linkTitle: "Create Workspace, Project, Account and Role" +description: 'Create Workspaces, Projects, Accounts and Roles' +linkTitle: "Create Workspaces, Projects, Accounts and Roles" weight: 2300 --- - -## Objective - -This guide demonstrates how to create workspace, roles and user accounts which are required for the following tutorials. Meanwhile, you will learn how to create projects and DevOps projects within your workspace where your workloads are running. After this tutorial, you will become familiar with KubeSphere multi-tenant management system. +This quickstart demonstrates how to create workspaces, roles and user accounts which are required for the other tutorials. Meanwhile, you will learn how to create projects and DevOps projects within your workspace where your workloads are running. After this tutorial, you will become familiar with the multi-tenant management system of KubeSphere. ## Prerequisites @@ -22,38 +18,38 @@ About 15 minutes. ## Architecture -The multi-tenant system of KubeSphere features **three** levels of hierarchical structure which are cluster, workspace and project. A project in KubeSphere is a Kubernetes namespace. +The multi-tenant system of KubeSphere features **three** levels of hierarchical structure which are cluster, workspace and project. A project in KubeSphere is a Kubernetes [namespace](https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/). -You are required to create a new [workspace](../../workspace-administration/workspace-overview/) to work on instead of tackling the system workspace where system resources are running and most of them are viewable only. In addition, it is strongly recommended you work with platform-regular role in your own workspace in terms of security consideration. +You are required to create a new [workspace](../../workspace-administration/what-is-workspace/) to work with instead of using the system workspace where system resources are running and most of them are viewable only. In addition, it is strongly recommended different tenants work with corresponding roles in a workspace for security considerations. You can create multiple workspaces within a KubeSphere cluster. Under each workspace, you can also create multiple projects. Each level has multiple built-in roles. Besides, KubeSphere allows you to create roles with customized authorization as well. The KubeSphere hierarchy is applicable for enterprise users with different teams or groups, and different roles within each team. ## Hands-on Lab -### Task 1: Create an Account +### Step 1: Create an account -After KubeSphere is installed, you need to add different users with varied roles to the platform so that they can work at different levels on various resources. Initially, you only have one default account, which is `admin`, granted the role `platform-admin`. In the first task, you will create an account `user-manager` and further create more accounts as `user-manager`. +After KubeSphere is installed, you need to add different users with varied roles to the platform so that they can work at different levels on various resources. Initially, you only have one default account, which is `admin`, granted the role `platform-admin`. In the first step, you create an account `user-manager` and further create more accounts as `user-manager`. 1. Log in to the web console as `admin` with the default account and password (`admin/P@88w0rd`). {{< notice tip >}} -For account security, it is highly recommended that you change your password the first time you log in to the console. To change your password, select **User Settings** in the drop-down menu in the top-right corner. In **Password Setting**, set a new password. You also can change your locale in the User Settings. +For account security, it is highly recommended that you change your password the first time you log in to the console. To change your password, select **User Settings** in the drop-down menu in the top right corner. In **Password Setting**, set a new password. You also can change the console language in **User Settings**. {{}} - ![user-settings](https://ap3.qingstor.com/kubesphere-website/docs/access-control.png) + ![chang-password](/images/docs/quickstart/create-workspaces-projects-accounts/chang-password.jpg) 2. After you log in to the console, click **Platform** in the top-left corner and select **Access Control**. - ![access-control](https://ap3.qingstor.com/kubesphere-website/docs/access-control.png) + ![access-control](/images/docs/quickstart/create-workspaces-projects-accounts/access-control.png) In **Account Roles**, there are four available built-in roles as shown below. The account to be created next will be assigned the role `users-manager`. - | Built-in Roles | Description | - | ------------------ | ------------------------------------------------------------ | - | workspaces-manager | Workspace manager in the platform who manages all workspaces in the platform. | - | users-manager | User manager in the platform who manages all users. | - | platform-regular | Normal user in the platform who has no access to any resources before joining a workspace or cluster. | - | platform-admin | Platform administrator who can manage all resources in the platform. | + | Built-in Roles | Description | + | -------------------- | ------------------------------------------------------------ | + | `workspaces-manager` | The workspace manager on the platform who manages all workspaces on the platform. | + | `users-manager` | The user manager on the platform who manages all users. | + | `platform-regular` | The normal user on the platform who has no access to any resources before joining a workspace or cluster. | + | `platform-admin` | The platform administrator who can manage all resources on the platform. | {{< notice note >}} Built-in roles are created automatically by KubeSphere and cannot be edited or deleted. @@ -61,46 +57,46 @@ Built-in roles are created automatically by KubeSphere and cannot be edited or d 3. In **Accounts**, click **Create**. In the pop-up window, provide all the necessary information (marked with *) and select `users-manager` for **Role**. Refer to the image below as an example. - ![create-account](https://ap3.qingstor.com/kubesphere-website/docs/create-account.jpg) + ![create-account](/images/docs/quickstart/create-workspaces-projects-accounts/create-account.jpg) - Click **OK** after you finish. A newly-created account will display in the account list in **Accounts**. + Click **OK** after you finish. A newly-created account will display in **Accounts**. -4. Log out of the console and log back in with the account `user-manager` to create four accounts that will be used in the following tutorials. +4. Log out of the console and log back in with the account `user-manager` to create four accounts that will be used in other tutorials. {{< notice tip >}} -To log out, click your username in the top-right corner and select **Log Out**. + To log out, click your username in the top-right corner and select **Log Out**. {{}} For detailed information about the four accounts you need to create, refer to the table below. - | Account | Role | Description | - | --------------- | ------------------ | ------------------------------------------------------------ | - | ws-manager | workspaces-manager | Create and manage all workspaces. | - | ws-admin | platform-regular | Manage all resources in a specified workspace (This account is used to invite new members to a workspace in this example). | - | project-admin | platform-regular | Create and manage projects and DevOps projects, and invite new members into the projects. | - | project-regular | platform-regular | `project-regular` will be invited to a project or DevOps project by `project-admin`. This account will be used to create workloads, pipelines and other resources in a specified project. | + | Account | Role | Description | + | ----------------- | -------------------- | ------------------------------------------------------------ | + | `ws-manager` | `workspaces-manager` | Create and manage all workspaces. | + | `ws-admin` | `platform-regular` | Manage all resources in a specified workspace (This account is used to invite new members to a workspace in this example). | + | `project-admin` | `platform-regular` | Create and manage projects and DevOps projects, and invite new members into the projects. | + | `project-regular` | `platform-regular` | `project-regular` will be invited to a project or DevOps project by `project-admin`. This account will be used to create workloads, pipelines and other resources in a specified project. | 5. Verify the four accounts created. - ![account-list](https://ap3.qingstor.com/kubesphere-website/docs/account-list.png) + ![account-list](/images/docs/quickstart/create-workspaces-projects-accounts/account-list.png) -### Task 2: Create a Workspace +### Step 2: Create a workspace -In this task, you need to create a workspace using the account `ws-manager` created in the previous task. As the basic logic unit for the management of projects, DevOps projects and organization members, workspaces underpin multi-tenant system of KubeSphere. +In this step, you create a workspace using the account `ws-manager` created in the previous step. As the basic logic unit for the management of projects, DevOps projects and organization members, workspaces underpin the multi-tenant system of KubeSphere. -1. Log in to KubeSphere as `ws-manager` which has the authorization to manage all workspaces on the platform. Click **Platform** in the top-left corner and select **Access Control**. In **Workspaces**, you can see there is only one default workspace **system-workspace** listed, where system-related components and services run. You are not allowed to delete this workspace. +1. Log in to KubeSphere as `ws-manager` which has the permission to manage all workspaces on the platform. Click **Platform** in the top-left corner and select **Access Control**. In **Workspaces**, you can see there is only one default workspace `system-workspace` listed, where system-related components and services run. You are not allowed to delete this workspace. - ![create-workspace](https://ap3.qingstor.com/kubesphere-website/docs/create-workspace.jpg) + ![create-workspace](/images/docs/quickstart/create-workspaces-projects-accounts/create-workspace.jpg) 2. Click **Create** on the right, name the new workspace `demo-workspace` and set the user `ws-admin` as the workspace manager shown in the screenshot below: - ![create-workspace](https://ap3.qingstor.com/kubesphere-website/docs/create-workspace.png) + ![create-workspace](/images/docs/quickstart/create-workspaces-projects-accounts/create-workspace.png) Click **Create** after you finish. 3. Log out of the console and log back in as `ws-admin`. In **Workspace Settings**, select **Workspace Members** and click **Invite Member**. - ![invite-member](https://ap3.qingstor.com/kubesphere-website/docs/20200827111048.png) + ![invite-member](/images/docs/quickstart/create-workspaces-projects-accounts/invite-member.png) 4. Invite both `project-admin` and `project-regular` to the workspace. Grant them the role `workspace-self-provisioner` and `workspace-viewer` respectively. @@ -108,71 +104,71 @@ In this task, you need to create a workspace using the account `ws-manager` crea The actual role name follows a naming convention: `-`. For example, in this workspace named `demo-workspace`, the actual role name of the role `viewer` is `demo-workspace-viewer`. {{}} - ![invite-member](https://ap3.qingstor.com/kubesphere-website/docs/20200827113124.png) + ![invite-member-and-grant-role](/images/docs/quickstart/create-workspaces-projects-accounts/invite-member-and-grant-role.png) 5. After you add both `project-admin` and `project-regular` to the workspace, click **OK**. In **Workspace Members**, you can see three members listed. - | Account | Role | Description | - | --------------- | -------------------------- | ------------------------------------------------------------ | - | ws-admin | workspace-admin | Manage all resources under the workspace (We use this account to invite new members to the workspace). | - | project-admin | workspace-self-provisioner | Create and manage projects and DevOps projects, and invite new members to join the projects. | - | project-regular | workspace-viewer | `project-regular` will be invited by `project-admin` to join a project or DevOps project. The account can be used to create workloads, pipelines, etc. | + | Account | Role | Description | + | ----------------- | ---------------------------- | ------------------------------------------------------------ | + | `ws-admin` | `workspace-admin` | Manage all resources under the workspace (Use this account to invite new members to the workspace). | + | `project-admin` | `workspace-self-provisioner` | Create and manage projects and DevOps projects, and invite new members to join the projects. | + | `project-regular` | `workspace-viewer` | `project-regular` will be invited by `project-admin` to join a project or DevOps project. The account can be used to create workloads, pipelines, etc. | -### Task 3: Create a Project +### Step 3: Create a project -In this task, you need to create a project using the account `project-admin` created in the previous task. A project in KubeSphere is the same as a namespace in Kubernetes, which provides virtual isolation for resources. For more information, see [Namespaces](https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/). +In this step, you create a project using the account `project-admin` created in the previous step. A project in KubeSphere is the same as a namespace in Kubernetes, which provides virtual isolation for resources. For more information, see [Namespaces](https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/). 1. Log in to KubeSphere as `project-admin`. In **Projects**, click **Create**. - ![kubesphere-projects](https://ap3.qingstor.com/kubesphere-website/docs/kubesphere-projects.png) + ![kubesphere-projects](/images/docs/quickstart/create-workspaces-projects-accounts/kubesphere-projects.png) 2. Enter the project name (e.g. `demo-project`) and click **OK** to finish. You can also add an alias and description for the project. - ![demo-project](https://ap3.qingstor.com/kubesphere-website/docs/demo-project.png) + ![demo-project](/images/docs/quickstart/create-workspaces-projects-accounts/demo-project.png) 3. In **Projects**, click the project created just now to view its detailed information. - ![click-demo-project](https://ap3.qingstor.com/kubesphere-website/docs/click-demo-project.png) + ![click-demo-project](/images/docs/quickstart/create-workspaces-projects-accounts/click-demo-project.png) -4. In the overview page of the project, the project quota remains unset by default. You can click **Set** and specify resource requests and limits based on your needs (e.g. 1 core for CPU and 1000Gi for memory). +4. On the **Overview** page of the project, the project quota remains unset by default. You can click **Set** and specify resource requests and limits based on your needs (e.g. 1 core for CPU and 1000Gi for memory). - ![project-overview](https://ap3.qingstor.com/kubesphere-website/docs/quota.png) + ![quota](/images/docs/quickstart/create-workspaces-projects-accounts/quota.png) - ![set-quota](https://ap3.qingstor.com/kubesphere-website/docs/20200827134613.png) + ![specify-project-quota](/images/docs/quickstart/create-workspaces-projects-accounts/specify-project-quota.png) -5. Invite `project-regular` to this project and grant this user the role `operator`. Please refer to the image below for specific steps. +5. Invite `project-regular` to this project and grant this user the role `operator`. Refer to the image below for specific steps. - ![invite-memeber](https://ap3.qingstor.com/kubesphere-website/docs/20200827135424.png) + ![invite-project-member](/images/docs/quickstart/create-workspaces-projects-accounts/invite-project-member.png) {{< notice info >}} The user granted the role `operator` will be a project maintainer who can manage resources other than users and roles in the project. {{}} -6. Before creating a route which is [Ingress](../../project-user-guide/application-workloads/ingress/) in Kubernetes, you need to enable a gateway for this project. The gateway is an [NGINX Ingress controller](https://github.com/kubernetes/ingress-nginx) running in the project. To set a gateway, go to **Advanced Settings** in **Project Settings** and click **Set Gateway**. The account `project-admin` is still used in this step. +6. Before creating a [Route](../../project-user-guide/application-workloads/ingress/) which is [Ingress](https://kubernetes.io/docs/concepts/services-networking/ingress/) in Kubernetes, you need to enable a gateway for this project. The gateway is an [NGINX Ingress controller](https://github.com/kubernetes/ingress-nginx) running in the project. To set a gateway, go to **Advanced Settings** in **Project Settings** and click **Set Gateway**. The account `project-admin` is still used in this step. - ![set-gateway](https://ap3.qingstor.com/kubesphere-website/docs/20200827141823.png) + ![set-gateway](/images/docs/quickstart/create-workspaces-projects-accounts/set-gateway.png) 7. Choose the access method **NodePort** and click **Save**. - ![nodeport](https://ap3.qingstor.com/kubesphere-website/docs/20200827141958.png) + ![nodeport](/images/docs/quickstart/create-workspaces-projects-accounts/nodeport.png) -8. Under **Internet Access**, it can be seen that the Gateway Address and the NodePort of http and https all display in the page. +8. Under **Internet Access**, it can be seen that the Gateway Address and the NodePort of http and https all display on the page. {{< notice note >}} -If you want to expose services using the type `LoadBalancer`, you need to use the LoadBalancer plugin of cloud providers. If your Kubernetes cluster is running in a bare metal environment, it is recommended you use [Porter](https://github.com/kubesphere/porter) as the LoadBalancer plugin. +If you want to expose services using the type `LoadBalancer`, you need to use the LoadBalancer plugin of cloud providers. If your Kubernetes cluster is running in a bare metal environment, it is recommended that you use [Porter](https://github.com/kubesphere/porter) as the LoadBalancer plugin. {{}} - ![NodePort-setting-done](https://ap3.qingstor.com/kubesphere-website/docs/20200827142411.png) + ![nodeport-setting](/images/docs/quickstart/create-workspaces-projects-accounts/nodeport-setting.png) -### Task 4: Create a Role +### Step 4: Create a role -After you finish the above tasks, you know that users can be granted different roles at different levels. The roles used in previous tasks are all built-in ones created by KubeSphere itself. In this task, you will learn how to define a role yourself to meet the needs in your work. +After you finish the above steps, you know that users can be granted different roles at different levels. The roles used in previous steps are all built-in ones created by KubeSphere itself. In this step, you will learn how to define a customized role to meet the needs in your work. 1. Log in to the console as `admin` again and go to **Access Control**. 2. In **Account Roles**, there are four system roles listed which cannot be deleted or edited. Click **Create** and set a **Role Identifier**. In this example, a role named `roles-manager` will be created. - ![create-role](https://ap3.qingstor.com/kubesphere-website/docs/20200827153339.png) + ![customized-role](/images/docs/quickstart/create-workspaces-projects-accounts/customized-role.png) {{< notice note >}} It is recommended you enter a description for the role as it explains what the role is used for. The role created here will be responsible for role management only, including adding and deleting roles. @@ -182,46 +178,46 @@ It is recommended you enter a description for the role as it explains what the r 3. In **Access Control**, select the authorization that you want this role to contain. For example, **Users View**, **Roles Management** and **Roles View** are selected for this role. Click **OK** to finish. - ![edit-authorization](https://ap3.qingstor.com/kubesphere-website/docs/20200827153651.png) + ![edit-authorization](/images/docs/quickstart/create-workspaces-projects-accounts/edit-authorization.png) {{< notice note >}} -**Depend on** means the major authorization (the one listed after **Depend on**) needs to be selected first so that the affiliated authorization can be assigned. + **Depend on** means the major authorization (the one listed after **Depend on**) needs to be selected first so that the affiliated authorization can be assigned. {{}} 4. Newly-created roles will be listed in **Account Roles**. You can click the three dots on the right to edit it. - ![roles-manager](https://ap3.qingstor.com/kubesphere-website/docs/20200827154723.png) + ![roles-manager](/images/docs/quickstart/create-workspaces-projects-accounts/roles-manager.png) 5. In **Accounts**, you can add a new account and grant it the role `roles-manager` or change the role of an existing account to `roles-manager` by editing it. - ![edit-role](https://ap3.qingstor.com/kubesphere-website/docs/20200827155205.png) + ![edit-role](/images/docs/quickstart/create-workspaces-projects-accounts/edit-role.png) {{< notice note >}} -The role of `roles-manager` overlaps with `users-manager` while the latter is also capable of user management. This example is only for demonstration purpose. You can create customized roles based on your needs. + The role of `roles-manager` overlaps with `users-manager` while the latter is also capable of user management. This example is only for demonstration purposes. You can create customized roles based on your needs. {{}} -### Task 5: Create a DevOps Project (Optional) +### Step 5: Create a DevOps project (Optional) {{< notice note >}} -To create a DevOps project, you need to install KubeSphere DevOps system in advance, which is a pluggable component providing CI/CD pipelines, Binary-to-image, Source-to-image features, and more. For more information about how to enable DevOps, see [KubeSphere DevOps System](../../pluggable-components/devops/). +To create a DevOps project, you must install the KubeSphere DevOps system in advance, which is a pluggable component providing CI/CD pipelines, Binary-to-image, Source-to-image, and more. For more information about how to enable DevOps, see [KubeSphere DevOps System](../../pluggable-components/devops/). {{}} -1. Log in to the console as `project-admin` for this task. In **DevOps Projects**, click **Create**. +1. Log in to the console as `project-admin`. In **DevOps Projects**, click **Create**. - ![devops-project](https://ap3.qingstor.com/kubesphere-website/docs/20200827145521.png) + ![devops](/images/docs/quickstart/create-workspaces-projects-accounts/devops.png) 2. Enter the DevOps project name (e.g. `demo-devops`) and click **OK**. You can also add an alias and description for the project. - ![devops-project](https://ap3.qingstor.com/kubesphere-website/docs/20200827145755.png) + ![devops-project](/images/docs/quickstart/create-workspaces-projects-accounts/devops-project.png) 3. In **DevOps Projects**, click the project created just now to view its detailed information. - ![new-devops-project](https://ap3.qingstor.com/kubesphere-website/docs/20200827150523.png) + ![new-devops-project](/images/docs/quickstart/create-workspaces-projects-accounts/new-devops-project.png) 4. Go to **Project Management** and select **Project Members**. Click **Invite Member** to grant `project-regular` the role of `operator`, who is allowed to create pipelines and credentials. - ![devops-invite-member](https://ap3.qingstor.com/kubesphere-website/docs/20200827150704.png) + ![devops-invite-member](/images/docs/quickstart/create-workspaces-projects-accounts/devops-invite-member.png) -Congratulations! You are now familiar with the multi-tenant management system of KubeSphere. In the next several tutorials, the account `project-regular` will also be used to demonstrate how to create applications and resources in a project or DevOps project. +You are now familiar with the multi-tenant management system of KubeSphere. In other tutorials, the account `project-regular` will also be used to demonstrate how to create applications and resources in a project or DevOps project. diff --git a/content/en/docs/quick-start/deploy-bookinfo-to-k8s.md b/content/en/docs/quick-start/deploy-bookinfo-to-k8s.md index f6fa8c969..10b11d6d3 100644 --- a/content/en/docs/quick-start/deploy-bookinfo-to-k8s.md +++ b/content/en/docs/quick-start/deploy-bookinfo-to-k8s.md @@ -23,7 +23,7 @@ In this tutorial, you will learn how to deploy a sample application Bookinfo com - You need to enable [KubeSphere Service Mesh](../../pluggable-components/service-mesh/). -- You need to finish all tasks in [Create Workspace, Project, Account and Role](../create-workspace-and-project/). +- You need to finish all tasks in [Create Workspaces, Projects, Accounts and Roles](../create-workspace-and-project/). - You need to enable **Application Governance**. To do so, follow the steps below: diff --git a/content/en/docs/quick-start/wordpress-deployment.md b/content/en/docs/quick-start/wordpress-deployment.md index 895296e1c..5d481a3e6 100644 --- a/content/en/docs/quick-start/wordpress-deployment.md +++ b/content/en/docs/quick-start/wordpress-deployment.md @@ -19,7 +19,7 @@ This tutorial demonstrates how to create an application (WordPress as an example ## Prerequisites -An account `project-regular` is needed with the role `operator` assigned in one of your projects (the user has been invited to the project). For more information, see [Create Workspace, Project, Account and Role](../create-workspace-and-project/). +An account `project-regular` is needed with the role `operator` assigned in one of your projects (the user has been invited to the project). For more information, see [Create Workspaces, Projects, Accounts and Roles](../create-workspace-and-project/). ## Estimated Time diff --git a/content/en/docs/workspace-administration/app-repository/import-helm-repository.md b/content/en/docs/workspace-administration/app-repository/import-helm-repository.md index 7b528cf4b..fbd94d65f 100644 --- a/content/en/docs/workspace-administration/app-repository/import-helm-repository.md +++ b/content/en/docs/workspace-administration/app-repository/import-helm-repository.md @@ -17,7 +17,7 @@ This tutorial demonstrates how to add an app repository to KubeSphere. - You need to enable [KubeSphere App Store (OpenPitrix)](../../../pluggable-components/app-store/). - You need to have an app repository. Refer to [the official documentation of Helm](https://v2.helm.sh/docs/developing_charts/#the-chart-repository-guide) to create repositories or [upload your own apps to the public repository of KubeSphere](../upload-app-to-public-repository/). Alternatively, use the example repository in the steps below, which are only for demonstration purposes. -- You need to create a workspace and a user account (`ws-admin`). The account must be granted the role of `workspace-admin` in the workspace. For more information, refer to [Create Workspace, Project, Account and Role](../../../quick-start/create-workspace-and-project/). +- You need to create a workspace and a user account (`ws-admin`). The account must be granted the role of `workspace-admin` in the workspace. For more information, refer to [Create Workspaces, Projects, Accounts and Roles](../../../quick-start/create-workspace-and-project/). ## Add App Repository diff --git a/content/en/docs/workspace-administration/role-and-member-management.md b/content/en/docs/workspace-administration/role-and-member-management.md index 287287ede..db4bbb921 100644 --- a/content/en/docs/workspace-administration/role-and-member-management.md +++ b/content/en/docs/workspace-administration/role-and-member-management.md @@ -19,7 +19,7 @@ In workspace scope, you can grant the following resources' permissions to a role ## Prerequisites -At least one workspace has been created, such as `demo-workspace`. Besides, you need an account of the `workspace-admin` role (e.g. `ws-admin`) at the workspace level. See [Create Workspace, Project, Account and Role](../../quick-start/create-workspace-and-project/) if they are not ready yet. +At least one workspace has been created, such as `demo-workspace`. Besides, you need an account of the `workspace-admin` role (e.g. `ws-admin`) at the workspace level. See [Create Workspaces, Projects, Accounts and Roles](../../quick-start/create-workspace-and-project/) if they are not ready yet. {{< notice note >}} diff --git a/content/en/docs/workspace-administration/upload-helm-based-application.md b/content/en/docs/workspace-administration/upload-helm-based-application.md index 6e7ed3f97..c5843f6da 100644 --- a/content/en/docs/workspace-administration/upload-helm-based-application.md +++ b/content/en/docs/workspace-administration/upload-helm-based-application.md @@ -13,7 +13,7 @@ This tutorial demonstrates how to develop an app template by uploading a package ## Prerequisites - You need to enable [KubeSphere App Store (OpenPitrix)](../../pluggable-components/app-store/). -- You need to create a workspace and a user account (`project-admin`). The account must be invited to the workspace with the role of `workspace-self-provisioner`. For more information, refer to [Create Workspace, Project, Account and Role](../../quick-start/create-workspace-and-project/). +- You need to create a workspace and a user account (`project-admin`). The account must be invited to the workspace with the role of `workspace-self-provisioner`. For more information, refer to [Create Workspaces, Projects, Accounts and Roles](../../quick-start/create-workspace-and-project/). ## Hands-on Lab diff --git a/content/en/docs/workspace-administration/what-is-workspace.md b/content/en/docs/workspace-administration/what-is-workspace.md index 6395af6e4..9818fbd32 100644 --- a/content/en/docs/workspace-administration/what-is-workspace.md +++ b/content/en/docs/workspace-administration/what-is-workspace.md @@ -15,7 +15,7 @@ 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/). +You have an account granted the role of `workspaces-manager`, such as `ws-manager` in [Create Workspaces, Projects, Accounts and Roles](../../quick-start/create-workspace-and-project/). ## Create a Workspace diff --git a/content/en/docs/workspace-administration/workspace-network-isolation.md b/content/en/docs/workspace-administration/workspace-network-isolation.md index e56e508ec..014527de2 100644 --- a/content/en/docs/workspace-administration/workspace-network-isolation.md +++ b/content/en/docs/workspace-administration/workspace-network-isolation.md @@ -10,7 +10,7 @@ weight: 9500 - You have already enabled [Network Policies](../../pluggable-components/network-policy/). -- Use an account of the `workspace-admin` role. For example, use the account `ws-admin` created in [Create Workspace, Project, Account and Role](../../quick-start/create-workspace-and-project/). +- Use an account of the `workspace-admin` role. For example, use the account `ws-admin` created in [Create Workspaces, Projects, Accounts and Roles](../../quick-start/create-workspace-and-project/). {{< notice note >}} diff --git a/content/zh/docs/quick-start/all-in-one-on-linux.md b/content/zh/docs/quick-start/all-in-one-on-linux.md index fcbb94ac8..5a85b0bdf 100644 --- a/content/zh/docs/quick-start/all-in-one-on-linux.md +++ b/content/zh/docs/quick-start/all-in-one-on-linux.md @@ -152,13 +152,13 @@ chmod +x kk 执行该命令后，您将看到以下表格，用于环境检查。有关详细信息，请参见[节点要求](#节点要求)和[依赖项要求](#依赖项要求)。输入 `yes` 继续安装流程。 -![environment-check](https://ap3.qingstor.com/kubesphere-website/docs/environment-check.png) +![environment-check](/images/docs/zh-cn/quickstart/all-in-one-on-linux/environment-check.png) ## 步骤 4：验证安装结果 当您看到以下输出时，表明安装已经完成。 -![installation-complete](https://ap3.qingstor.com/kubesphere-website/docs/Installation-complete.png) +![Installation-complete](/images/docs/zh-cn/quickstart/all-in-one-on-linux/Installation-complete.png) 输入以下命令以检查安装结果。 @@ -198,7 +198,7 @@ https://kubesphere.io 20xx-xx-xx xx:xx:xx 登录至控制台后，您可以在**服务组件**中查看各个组件的状态。如果要使用相关服务，您可能需要等待部分组件启动并运行。您也可以使用 `kubectl get pod --all-namespaces` 来检查 KubeSphere 相关组件的运行状况。 -![components](/images/docs/quickstart/kubesphere-components.png) +![service-components](/images/docs/zh-cn/quickstart/all-in-one-on-linux/service-components.jpg) ## 启用可插拔组件（可选） diff --git a/static/images/docs/quickstart/create-workspaces-projects-accounts/access-control.png b/static/images/docs/quickstart/create-workspaces-projects-accounts/access-control.png new file mode 100644 index 000000000..d3d16d3d0 Binary files /dev/null and b/static/images/docs/quickstart/create-workspaces-projects-accounts/access-control.png differ diff --git a/static/images/docs/quickstart/create-workspaces-projects-accounts/account-list.png b/static/images/docs/quickstart/create-workspaces-projects-accounts/account-list.png new file mode 100644 index 000000000..4f50b033b Binary files /dev/null and b/static/images/docs/quickstart/create-workspaces-projects-accounts/account-list.png differ diff --git a/static/images/docs/quickstart/create-workspaces-projects-accounts/chang-password.jpg b/static/images/docs/quickstart/create-workspaces-projects-accounts/chang-password.jpg new file mode 100644 index 000000000..f19b4ea44 Binary files /dev/null and b/static/images/docs/quickstart/create-workspaces-projects-accounts/chang-password.jpg differ diff --git a/static/images/docs/quickstart/create-workspaces-projects-accounts/click-demo-project.png b/static/images/docs/quickstart/create-workspaces-projects-accounts/click-demo-project.png new file mode 100644 index 000000000..62f1cf355 Binary files /dev/null and b/static/images/docs/quickstart/create-workspaces-projects-accounts/click-demo-project.png differ diff --git a/static/images/docs/quickstart/create-workspaces-projects-accounts/create-account.jpg b/static/images/docs/quickstart/create-workspaces-projects-accounts/create-account.jpg new file mode 100644 index 000000000..fea0ece76 Binary files /dev/null and b/static/images/docs/quickstart/create-workspaces-projects-accounts/create-account.jpg differ diff --git a/static/images/docs/quickstart/create-workspaces-projects-accounts/create-workspace.jpg b/static/images/docs/quickstart/create-workspaces-projects-accounts/create-workspace.jpg new file mode 100644 index 000000000..2e56062e6 Binary files /dev/null and b/static/images/docs/quickstart/create-workspaces-projects-accounts/create-workspace.jpg differ diff --git a/static/images/docs/quickstart/create-workspaces-projects-accounts/create-workspace.png b/static/images/docs/quickstart/create-workspaces-projects-accounts/create-workspace.png new file mode 100644 index 000000000..d7f82b0b0 Binary files /dev/null and b/static/images/docs/quickstart/create-workspaces-projects-accounts/create-workspace.png differ diff --git a/static/images/docs/quickstart/create-workspaces-projects-accounts/customized-role.png b/static/images/docs/quickstart/create-workspaces-projects-accounts/customized-role.png new file mode 100644 index 000000000..9ba0e1f2a Binary files /dev/null and b/static/images/docs/quickstart/create-workspaces-projects-accounts/customized-role.png differ diff --git a/static/images/docs/quickstart/create-workspaces-projects-accounts/demo-project.png b/static/images/docs/quickstart/create-workspaces-projects-accounts/demo-project.png new file mode 100644 index 000000000..98a14a8e0 Binary files /dev/null and b/static/images/docs/quickstart/create-workspaces-projects-accounts/demo-project.png differ diff --git a/static/images/docs/quickstart/create-workspaces-projects-accounts/devops-invite-member.png b/static/images/docs/quickstart/create-workspaces-projects-accounts/devops-invite-member.png new file mode 100644 index 000000000..f7a263aad Binary files /dev/null and b/static/images/docs/quickstart/create-workspaces-projects-accounts/devops-invite-member.png differ diff --git a/static/images/docs/quickstart/create-workspaces-projects-accounts/devops-project.png b/static/images/docs/quickstart/create-workspaces-projects-accounts/devops-project.png new file mode 100644 index 000000000..85eec1fb3 Binary files /dev/null and b/static/images/docs/quickstart/create-workspaces-projects-accounts/devops-project.png differ diff --git a/static/images/docs/quickstart/create-workspaces-projects-accounts/devops.png b/static/images/docs/quickstart/create-workspaces-projects-accounts/devops.png new file mode 100644 index 000000000..6ffca8d14 Binary files /dev/null and b/static/images/docs/quickstart/create-workspaces-projects-accounts/devops.png differ diff --git a/static/images/docs/quickstart/create-workspaces-projects-accounts/edit-authorization.png b/static/images/docs/quickstart/create-workspaces-projects-accounts/edit-authorization.png new file mode 100644 index 000000000..272c5405a Binary files /dev/null and b/static/images/docs/quickstart/create-workspaces-projects-accounts/edit-authorization.png differ diff --git a/static/images/docs/quickstart/create-workspaces-projects-accounts/edit-role.png b/static/images/docs/quickstart/create-workspaces-projects-accounts/edit-role.png new file mode 100644 index 000000000..7b9a72d50 Binary files /dev/null and b/static/images/docs/quickstart/create-workspaces-projects-accounts/edit-role.png differ diff --git a/static/images/docs/quickstart/create-workspaces-projects-accounts/invite-member-and-grant-role.png b/static/images/docs/quickstart/create-workspaces-projects-accounts/invite-member-and-grant-role.png new file mode 100644 index 000000000..d18085faa Binary files /dev/null and b/static/images/docs/quickstart/create-workspaces-projects-accounts/invite-member-and-grant-role.png differ diff --git a/static/images/docs/quickstart/create-workspaces-projects-accounts/invite-member.png b/static/images/docs/quickstart/create-workspaces-projects-accounts/invite-member.png new file mode 100644 index 000000000..6ee992588 Binary files /dev/null and b/static/images/docs/quickstart/create-workspaces-projects-accounts/invite-member.png differ diff --git a/static/images/docs/quickstart/create-workspaces-projects-accounts/invite-project-member.png b/static/images/docs/quickstart/create-workspaces-projects-accounts/invite-project-member.png new file mode 100644 index 000000000..324416af9 Binary files /dev/null and b/static/images/docs/quickstart/create-workspaces-projects-accounts/invite-project-member.png differ diff --git a/static/images/docs/quickstart/create-workspaces-projects-accounts/kubesphere-projects.png b/static/images/docs/quickstart/create-workspaces-projects-accounts/kubesphere-projects.png new file mode 100644 index 000000000..eadb04774 Binary files /dev/null and b/static/images/docs/quickstart/create-workspaces-projects-accounts/kubesphere-projects.png differ diff --git a/static/images/docs/quickstart/create-workspaces-projects-accounts/new-devops-project.png b/static/images/docs/quickstart/create-workspaces-projects-accounts/new-devops-project.png new file mode 100644 index 000000000..b59fcddd5 Binary files /dev/null and b/static/images/docs/quickstart/create-workspaces-projects-accounts/new-devops-project.png differ diff --git a/static/images/docs/quickstart/create-workspaces-projects-accounts/nodeport-setting.png b/static/images/docs/quickstart/create-workspaces-projects-accounts/nodeport-setting.png new file mode 100644 index 000000000..2044da1f2 Binary files /dev/null and b/static/images/docs/quickstart/create-workspaces-projects-accounts/nodeport-setting.png differ diff --git a/static/images/docs/quickstart/create-workspaces-projects-accounts/nodeport.png b/static/images/docs/quickstart/create-workspaces-projects-accounts/nodeport.png new file mode 100644 index 000000000..40c4eeaab Binary files /dev/null and b/static/images/docs/quickstart/create-workspaces-projects-accounts/nodeport.png differ diff --git a/static/images/docs/quickstart/create-workspaces-projects-accounts/quota.png b/static/images/docs/quickstart/create-workspaces-projects-accounts/quota.png new file mode 100644 index 000000000..50faa6ae0 Binary files /dev/null and b/static/images/docs/quickstart/create-workspaces-projects-accounts/quota.png differ diff --git a/static/images/docs/quickstart/create-workspaces-projects-accounts/roles-manager.png b/static/images/docs/quickstart/create-workspaces-projects-accounts/roles-manager.png new file mode 100644 index 000000000..788b2bb39 Binary files /dev/null and b/static/images/docs/quickstart/create-workspaces-projects-accounts/roles-manager.png differ diff --git a/static/images/docs/quickstart/create-workspaces-projects-accounts/set-gateway.png b/static/images/docs/quickstart/create-workspaces-projects-accounts/set-gateway.png new file mode 100644 index 000000000..dfaaaee03 Binary files /dev/null and b/static/images/docs/quickstart/create-workspaces-projects-accounts/set-gateway.png differ diff --git a/static/images/docs/quickstart/create-workspaces-projects-accounts/specify-project-quota.png b/static/images/docs/quickstart/create-workspaces-projects-accounts/specify-project-quota.png new file mode 100644 index 000000000..13f8e1f39 Binary files /dev/null and b/static/images/docs/quickstart/create-workspaces-projects-accounts/specify-project-quota.png differ diff --git a/static/images/docs/zh-cn/quickstart/all-in-one-on-linux/Installation-complete.png b/static/images/docs/zh-cn/quickstart/all-in-one-on-linux/Installation-complete.png new file mode 100644 index 000000000..077812916 Binary files /dev/null and b/static/images/docs/zh-cn/quickstart/all-in-one-on-linux/Installation-complete.png differ diff --git a/static/images/docs/zh-cn/quickstart/all-in-one-on-linux/environment-check.png b/static/images/docs/zh-cn/quickstart/all-in-one-on-linux/environment-check.png new file mode 100644 index 000000000..0e2a6b935 Binary files /dev/null and b/static/images/docs/zh-cn/quickstart/all-in-one-on-linux/environment-check.png differ diff --git a/static/images/docs/zh-cn/quickstart/all-in-one-on-linux/service-components.jpg b/static/images/docs/zh-cn/quickstart/all-in-one-on-linux/service-components.jpg new file mode 100644 index 000000000..df542bebe Binary files /dev/null and b/static/images/docs/zh-cn/quickstart/all-in-one-on-linux/service-components.jpg differ