This is an automated email from the ASF dual-hosted git repository. dockerzhang pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/inlong-website.git
The following commit(s) were added to refs/heads/master by this push: new 273e357864 [INLONG-808][Doc] Add document of multiple tenant (#809) 273e357864 is described below commit 273e3578643d30694f0327de17009c27d76cd32a Author: vernedeng <deng...@pku.edu.cn> AuthorDate: Mon Jul 24 11:35:25 2023 +0800 [INLONG-808][Doc] Add document of multiple tenant (#809) Co-authored-by: vernedeng <verned...@apache.rog> --- docs/administration/img/create_tenant_1.png | Bin 0 -> 76166 bytes docs/administration/img/create_tenant_2.png | Bin 0 -> 88349 bytes docs/administration/img/create_tenant_3.png | Bin 0 -> 81334 bytes docs/administration/img/create_tenant_role_1.png | Bin 0 -> 83036 bytes docs/administration/img/create_tenant_role_2.png | Bin 0 -> 83891 bytes docs/administration/img/create_tenant_role_3.png | Bin 0 -> 91628 bytes docs/administration/multiple_tenant.md | 48 +++++++++++++++++++++ .../current/administration/img/create_tenant_1.png | Bin 0 -> 68727 bytes .../current/administration/img/create_tenant_2.png | Bin 0 -> 81427 bytes .../current/administration/img/create_tenant_3.png | Bin 0 -> 71948 bytes .../administration/img/create_tenant_role_1.png | Bin 0 -> 76503 bytes .../administration/img/create_tenant_role_2.png | Bin 0 -> 78236 bytes .../administration/img/create_tenant_role_3.png | Bin 0 -> 65591 bytes .../current/administration/multiple_tenant.md | 48 +++++++++++++++++++++ 14 files changed, 96 insertions(+) diff --git a/docs/administration/img/create_tenant_1.png b/docs/administration/img/create_tenant_1.png new file mode 100644 index 0000000000..b06136978e Binary files /dev/null and b/docs/administration/img/create_tenant_1.png differ diff --git a/docs/administration/img/create_tenant_2.png b/docs/administration/img/create_tenant_2.png new file mode 100644 index 0000000000..4f879b3fad Binary files /dev/null and b/docs/administration/img/create_tenant_2.png differ diff --git a/docs/administration/img/create_tenant_3.png b/docs/administration/img/create_tenant_3.png new file mode 100644 index 0000000000..91c016ee6e Binary files /dev/null and b/docs/administration/img/create_tenant_3.png differ diff --git a/docs/administration/img/create_tenant_role_1.png b/docs/administration/img/create_tenant_role_1.png new file mode 100644 index 0000000000..a8d4177416 Binary files /dev/null and b/docs/administration/img/create_tenant_role_1.png differ diff --git a/docs/administration/img/create_tenant_role_2.png b/docs/administration/img/create_tenant_role_2.png new file mode 100644 index 0000000000..5032517e19 Binary files /dev/null and b/docs/administration/img/create_tenant_role_2.png differ diff --git a/docs/administration/img/create_tenant_role_3.png b/docs/administration/img/create_tenant_role_3.png new file mode 100644 index 0000000000..4dc45dc53d Binary files /dev/null and b/docs/administration/img/create_tenant_role_3.png differ diff --git a/docs/administration/multiple_tenant.md b/docs/administration/multiple_tenant.md new file mode 100644 index 0000000000..67d33af8ea --- /dev/null +++ b/docs/administration/multiple_tenant.md @@ -0,0 +1,48 @@ +--- +title: Tenant Management +sidebar_position: 3 +--- + +## Overview + +Multi-tenancy is a software architecture pattern that allows a single application to serve multiple independent users or organizations (called "tenants") simultaneously. +In this model, each tenant is logically isolated from one another but shares the same underlying software infrastructure and resources. +This means that a single application instance can serve multiple tenants without the need to deploy and maintain the application separately for each tenant. +In order to address the requirements for permissions and resource isolation in multi-user scenarios, InLong introduced a multi-tenant architecture in version 1.8.0. + +For the implementation of InLong multi-tenancy, please refer to: +https://github.com/apache/inlong/issues/7914 + +:::caution +- Resources and permissions are isolated between different tenants, and users can only see resources under their tenant. +- After upgrading from a lower version to version 1.8.0, all resources will be migrated to the `public` tenant. +::: + +## Create a tenant + +Currently, only **InLong Admins** are allowed to create and modify tenants. +- Select `Tenant Management`, and click `Create`. +  +- Choose to `Create` a new tenant. +  +- Complete the `Tenant Name` and description, click `OK` to finish creating the tenant. +  + The tenant has been created at this point. + +:::caution +Currently only `InLong administrators` are allowed to create and modify tenants. +::: + +## Create tenant role + +- Select `Tenant Management`, and click `Create`. +  +- Choose the target `Tenant Name`, `User Name`, and the `Tenant Role` you want to grant (if the tenant does not exist, please refer to [Create a tenant](#create-a-tenant)). +  +- After successful creation, you can see the tenants and their corresponding user roles in the `Tenant Management`. +  + +## Tenant switching + +- Click the `Tenant` field in the upper right corner and choose the tenant you switch to. +  \ No newline at end of file diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/administration/img/create_tenant_1.png b/i18n/zh-CN/docusaurus-plugin-content-docs/current/administration/img/create_tenant_1.png new file mode 100644 index 0000000000..88eda522fb Binary files /dev/null and b/i18n/zh-CN/docusaurus-plugin-content-docs/current/administration/img/create_tenant_1.png differ diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/administration/img/create_tenant_2.png b/i18n/zh-CN/docusaurus-plugin-content-docs/current/administration/img/create_tenant_2.png new file mode 100644 index 0000000000..d6b7b2c839 Binary files /dev/null and b/i18n/zh-CN/docusaurus-plugin-content-docs/current/administration/img/create_tenant_2.png differ diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/administration/img/create_tenant_3.png b/i18n/zh-CN/docusaurus-plugin-content-docs/current/administration/img/create_tenant_3.png new file mode 100644 index 0000000000..3cb03f544f Binary files /dev/null and b/i18n/zh-CN/docusaurus-plugin-content-docs/current/administration/img/create_tenant_3.png differ diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/administration/img/create_tenant_role_1.png b/i18n/zh-CN/docusaurus-plugin-content-docs/current/administration/img/create_tenant_role_1.png new file mode 100644 index 0000000000..35e2455f0e Binary files /dev/null and b/i18n/zh-CN/docusaurus-plugin-content-docs/current/administration/img/create_tenant_role_1.png differ diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/administration/img/create_tenant_role_2.png b/i18n/zh-CN/docusaurus-plugin-content-docs/current/administration/img/create_tenant_role_2.png new file mode 100644 index 0000000000..023c1e63f7 Binary files /dev/null and b/i18n/zh-CN/docusaurus-plugin-content-docs/current/administration/img/create_tenant_role_2.png differ diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/administration/img/create_tenant_role_3.png b/i18n/zh-CN/docusaurus-plugin-content-docs/current/administration/img/create_tenant_role_3.png new file mode 100644 index 0000000000..a5a666b083 Binary files /dev/null and b/i18n/zh-CN/docusaurus-plugin-content-docs/current/administration/img/create_tenant_role_3.png differ diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/administration/multiple_tenant.md b/i18n/zh-CN/docusaurus-plugin-content-docs/current/administration/multiple_tenant.md new file mode 100644 index 0000000000..fa33f2aa53 --- /dev/null +++ b/i18n/zh-CN/docusaurus-plugin-content-docs/current/administration/multiple_tenant.md @@ -0,0 +1,48 @@ +--- +title: 租户管理 +sidebar_position: 3 +--- + +## 总览 + +多租户(Multi-tenancy)是一种软件架构模式,允许一个应用程序同时为多个独立的用户或组织(称为“租户”)提供服务。 +在这种模式下,每个租户在逻辑上是相互隔离的,但共享相同的底层软件基础设施和资源。 +这意味着同一个应用程序实例可以为多个租户提供服务,而无需为每个租户单独部署和维护应用程序。 +为了解决多用户场景下对于权限和资源隔离性的要求,InLong 在 1.8.0 版本引入了多租户架构。 + +InLong多租户实现可以参考: +https://github.com/apache/inlong/issues/7914 + +:::caution +- 不同租户之间资源和权限互相隔离,用户只能看到该租户下的资源。 +- 从低版本升级至 1.8.0 版本后,所有资源会被迁移到公共租户 `public` 下。 +::: + +## 创建租户 + +- 选择`租户管理`,点击`新建角色` + +- 选择`新建租户` + +- 完善`租户名称`和`描述`,点击`确定`,则完成租户的创建 + +至此完成了租户的创建 + +:::caution +目前只允许 `InLong 管理员`来进行租户的创建和修改操作。 +::: + +## 创建租户角色 + +- 选择`租户管理`,点击`新建角色` + +- 选则`目标租户`,`用户名称`,和想要授予的`租户角色`(如果租户不存在,请参考 [创建租户](#创建租户)) + +- 创建成功后,可以在`租户管理`界面看到名下的租户以及对应的用户角色 + + +## 租户切换 + +- 点击右上角`租户`字段,可以选择切换到名下拥有的租户 + +