Quickstarts

Create Workspace, Project, Account and Role

Objective

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.

Prerequisites

KubeSphere needs to be installed in your machine.

Estimated Time

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.

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.

Hands-on Lab

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 user-manager.

  1. Log in the web console as admin with the default account and password (admin/[email protected]).

Tip

For account security, it is highly recommended that you change your password the first time you log in 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.
  1. After you log in the console, click Platform in the top-left corner and select Access Control.

    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 users-manager.

Built-in RolesDescription
workspaces-managerWorkspace manager in the platform who manages all workspaces in the platform.
users-managerUser manager in the platform who manages all users.
platform-regularNormal user in the platform who has no access to any resources before joining a workspace or cluster.
platform-adminPlatform administrator who can manage all resources in the platform.

Note

Built-in roles are created automatically by KubeSphere and cannot be edited or deleted.
  1. 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

Click OK after you finish. A newly-created account will display in the account list in Accounts.

  1. 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.

Tip

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.

AccountRoleDescription
ws-managerworkspaces-managerCreate and manage all workspaces.
ws-adminplatform-regularManage all resources in a specified workspace (This account is used to invite new members to a workspace in this example).
project-adminplatform-regularCreate and manage projects and DevOps projects, and invite new members into the projects.
project-regularplatform-regularproject-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.
  1. Verify the four accounts created.

account-list

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.

  1. Log in KubeSphere as ws-manager which 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.

create-workspace

  1. 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

Click Create after you finish.

  1. Log out of the console and log back in as ws-admin. In Workspace Settings, select Workspace Members and click Invite Member.

invite-member

  1. Invite both project-admin and project-regular to the workspace. Grant them the role workspace-self-provisioner and workspace-viewer respectively.

Note

The actual role name follows a naming convention: workspace name-role name. For example, in this workspace named demo, the actual role name of the role workspace-viewer is demo-workspace-viewer.

invite-member

  1. After you add both project-admin and project-regular to the workspace, click OK. In Workspace Members, you can see three members listed.
AccountRoleDescription
ws-adminworkspace-adminManage all resources under the workspace (We use this account to invite new members to the workspace).
project-adminworkspace-self-provisionerCreate and manage projects and DevOps projects, and invite new members to join the projects.
project-regularworkspace-viewerproject-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

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.

  1. Log in KubeSphere as project-admin. In Projects, click Create.

kubesphere-projects

  1. 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

  1. In Projects, click the project created just now to view its detailed information.

click-demo-project

  1. 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-overview

set-quota

  1. Invite project-regular to this project and grant this user the role operator. Please refer to the image below for specific steps.

Info

The user granted the role operator will be a project maintainer who can manage resources other than users and roles in the project.

Set Gateway

Before creating a route, you need to enable a gateway for this project. The gateway is an NGINX Ingress controller running in the project.

Info

A route refers to Ingress in Kubernetes, which is an API object that manages external access to the services in a cluster, typically HTTP.
  1. 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

  1. Choose the access method NodePort and click Save.

nodeport

  1. Under Internet Access, it can be seen that the Gateway Address and the NodePort of http and https all display in the page.

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 as the LoadBalancer plugin.

NodePort-setting-done

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.

  1. Log in 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

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.

Click Edit Authorization to continue.

  1. 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.

edit-authorization

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.
  1. Newly-created roles will be listed in Account Roles. You can click the three dots on the right to edit it.

roles-manager

  1. 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

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.

Task 5: Create a DevOps Project (Optional)

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.
  1. Log in the console as project-admin for this task. In DevOps Projects, click Create.

devops-project

  1. 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

  1. In DevOps Projects, click the project created just now to view its detailed information.

new-devops-project

  1. 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

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.