修改租户 | OceanBase 文档中心

修改租户

更新时间：2023-07-19 13:03:07

本节主要介绍如何修改租户的配置信息。

通过 SQL 语句修改租户

租户创建成功后，您可以通过 SQL 语句修改租户的信息，包括修改租户的副本数、Zone 列表、主 Zone 以及系统变量值等。

修改租户的语法如下：

 ALTER TENANT {tenant_name | ALL}
    [SET] [tenant_option_list] [opt_global_sys_vars_set]

tenant_option_list:
    tenant_option [, tenant_option ...]

tenant_option:
            COMMENT [=]'string' 
            |PRIMARY_ZONE [=] zone 
            |RESOURCE_POOL_LIST [=](poolname [, poolname...]) 
            |DEFAULT TABLEGROUP [=] {NULL | tablegroupname}
      |LOCALITY [=] 'locality description';
      
opt_global_sys_vars_set:
      VARIABLES system_var_name = expr [,system_var_name = expr] ...

语句说明：

仅 sys 租户的管理员可以执行，如 root@sys。
ALL 表示修改所有租户。
PRIMARY_ZONE 用于指定租户的 Primary Zone。
RESOURCE_POOL_LIST 表示资源池列表，每次仅支持添加或删除一个资源池。

不支持直接替换租户的资源池。假设租户原来使用的资源池为 pool1，通过以下命令直接将租户的资源池替换为 pool2 时，系统会报错。
```
obclient> ALTER TENANT tenant1 resource_pool_list=('pool2');
ERROR 1210 (HY000): Incorrect arguments to resource pool list
```
DEFAULT TABLEGROUP 表示设置租户的默认表组信息，NULL 表示取消数据库默认表组。
LOCALITY 用于描述副本在 Zone 间的分布情况，例如：F@z1,F@z2,F@z3,R@z4 表示 z1、z2 和 z3 为全功能型副本，z4 为只读副本。

示例：

修改租户 tenant1 的 Primary Zone 为 zone2。

obclient> ALTER TENANT tenant1 primary_zone='zone2';

修改租户 tenant1 的 Locality，增加副本数。

其中 F 表示副本类型为全功能型副本，B_4 为新增的 Zone 名称。
```
obclient> ALTER TENANT tenant1 locality="F@B_1,F@B_2,F@B_3,F@B_4"
```

更多 ALTER TENANT 语句的信息请参见 ALTER TENANT。

通过 OCP 修改租户的白名单和资源规格

通过 OCP 可以修改租户的白名单、密码和资源规格。同时租户的扩容和缩容也可以通过修改租户来实现。

前提条件

在修改租户前，请确认当前 OCP 用户具备系统管理员角色、OCP 租户管理员角色或其他拥有管理该集群权限的角色。如果没有相应权限的角色，请联系管理员为您添加，具体操作方法请参见 OCP 《用户指南》文档中的 编辑用户。

租户扩容缩容说明

租户级别的扩容和缩容是通过修改租户的资源规格来实现的。租户扩容常用于租户资源无法满足当前租户的需求，比如 CPU、内存资源紧张的情况。通过对租户的扩容可以整体动态的调整租户对集群资源的占用。

说明

对租户进行扩容的情况需要保证整体资源占用不超过上限。如果集群和节点的 CPU、内存资源已经完全分配给所有的租户，此时无法对任何租户进行扩容，需要进行对某些租户的缩容，释放资源后再对目标租户进行扩容。

如果所有租户不能缩容，并且资源分配已满，此时不能进行租户扩容，必须进行集群级别的扩容（添加节点）。

修改租户的白名单和资源规格

登录 OCP。
在左侧导航栏中单击租户。
在 租户列表 中找到指定租户，并单击租户名称。

进行以下操作：

在 副本详情 区域，选择需要修改资源规格的副本，在对应的操作列中，单击编辑后，修改副本的类型、Unit 规格以及 Unit 数量，单击确定。

说明

Unit 数量不能超过该 Zone 下 Server 的个数。

在 白名单 区域右上角单击修改，然后在弹出的对话框中，请根据页面说明和配置说明，重新设置白名单，白名单设置的字符数不超 128 个字符，完成后单击确定。

其中：

默认配置 ：所有 IP 都可访问。

自定义 ：指定允许登录的客户端列表，支持的格式有 IP 地址、子网/掩码、模糊匹配、多种格式混合和特殊说明。示例如下：

格式	示例
IP地址	`10.10.10.10,10.10.10.11`
子网/掩码	`10.10.10.0/24`
模糊匹配	`10.10.10.%` 或 `10.10.10._`
多种格式混合	`10.10.10.10,10.10.10.11,10.10.10.%,10.10.10._,10.10.10.0/24`
特殊说明	`%` 表示所有客户端都可以连接

修改白名单