Create Workspace, Project, Account and Role
This guide demonstrates how to create 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.
KubeSphere needs to be installed in your machine.
About 15 minutes.
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.
You can create multiple workspaces within a Kubernetes 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.
Task 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
- Log in the web console as
adminwith the default account and password (
After you log in the console, click Platform in the top-left corner and select Access Control.
In Account Roles, there are four available built-in roles as shown below. The account to be created next will be assigned the role
|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.|
- In Accounts, click Create. In the pop-up window, provide all the necessary information (marked with *) and select
users-managerfor Role. Refer to the image below as an example.
Click OK after you finish. A newly-created account will display in the account list in Accounts.
- Log out of the console and log back in with the account
user-managerto create four accounts that will be used in the following tutorials.
For detailed information about the four accounts you need to create, refer to the table below.
|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.|
- Verify the four accounts created.
Task 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.
- Log in KubeSphere as
ws-managerwhich has the authorization to manage all workspaces on the platform. Click Platform in the top-left corner. 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.
- Click Create on the right, name the new workspace
demo-workspaceand set the user
ws-adminas the workspace manager shown in the screenshot below:
Click Create after you finish.
- Log out of the console and log back in as
ws-admin. In Workspace Settings, select Workspace Members and click Invite Member.
- Invite both
project-regularto the workspace. Grant them the role
workspace name-role name. For example, in this workspace named
demo, the actual role name of the role
- After you add both
project-regularto the workspace, click OK. In Workspace Members, you can see three members listed.
|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.|
Task 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.
- Log in KubeSphere as
project-admin. In Projects, click Create.
- Enter the project name (e.g.
demo-project) and click OK to finish. You can also add an alias and description for the project.
- In Projects, click the project created just now to view its detailed information.
- 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).
project-regularto this project and grant this user the role
operator. Please refer to the image below for specific steps.
operatorwill be a project maintainer who can manage resources other than users and roles in the project.
Before creating a route, you need to enable a gateway for this project. The gateway is an NGINX Ingress controller running in the project.
- To set a gateway, go to Advanced Settings in Project Settings and click Set Gateway. The account
project-adminis still used in this step.
- Choose the access method NodePort and click Save.
- Under Internet Access, it can be seen that the Gateway Address and the NodePort of http and https all display in the page.
Task 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.
- Log in the console as
adminagain and go to Access Control.
- 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-managerwill be created.
Click Edit Authorization to continue.
- In Access Control, select the authorization that you want the user granted this role to have. For example, Users View, Roles Management and Roles View are selected for this role. Click OK to finish.
- Newly-created roles will be listed in Account Roles. You can click the three dots on the right to edit it.
- In Accounts, you can add a new account and grant it the role
roles-manageror change the role of an existing account to
roles-managerby editing it.
users-managerwhile the latter is also capable of user management. This example is only for demonstration purpose. You can create customized roles based on your needs.
Task 5: Create a DevOps Project (Optional)
- Log in the console as
project-adminfor this task. In DevOps Projects, click Create.
- Enter the DevOps project name (e.g.
demo-devops) and click OK. You can also add an alias and description for the project.
- In DevOps Projects, click the project created just now to view its detailed information.
- Go to Project Management and select Project Members. Click Invite Member to grant
project-regularthe role of
operator, who is allowed to create pipelines and credentials.
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.