租户管理 - 租户管理操作 - 《OceanBase v2.2.30 官方教程》

背景信息
查看租户
新建租户
修改租户的白名单、密码和资源规格
租户切主
锁定租户
复制租户
删除租户

租户的功能管理可以通过 OCP 来进行统一管理。

背景信息

不同 OCP 版本的操作界面可能不同，本节以 OCP V2.4.4 版本为例提供操作指导，OCP 其他版本的操作请参考对应版本的《OCP 用户指南》文档。

其中，OCP V2.3.0 版本中的实例即为 Oceanbase 数据库的租户。

查看租户

您可以通过 OCP 查看指定租户的详细信息及监控数据。

两种方法进行查看：

方法一：

登录 OCP。
在左侧导航栏中单击 租户。

方法二：

登录 OCP。
在左侧导航栏中单击 集群。
在 集群概览 页面的 集群列表 区域中单击集群名，进入集群详情页。
在左侧导航栏上，单击 租户管理，查看租户的详细信息及监控数据。

新建租户

通常需要新建数据库实例的情况下，可以通过 OCP 创建新的租户。

登录 OCP 。

默认进入 集群概览 页面。
在 集群概览 页面的 集群列表 区域，选择待操作的集群并单击其集群名。
在显示的页面的左侧导航栏上，单击租户**管理**。
在页面右上角单击 新建租户。
填写 基础信息。
1. 集群默认为当前集群。
2. 输入租户名称。
  
  租户名称格式为英文大小写字母、数字和下划线的组合，长度为 2~64 字符。
填写 Zone信息。
1. 为 z1、z2 和 z3 设置副本类型、Unit 规格和 Unit 数量。
  
  集群选定后，页面会根据所选集群的 Zone 信息给出可配置的 Zone 列表；对于无需做副本分布的 Zone，可以通过最右侧的按钮删除该 Zone 条目。
  
  其中：
  - 副本类型支持全功能型副本、只读型副本和日志型副本。
  - OCP 内置了一套 Unit 规格；另外也可以在下拉列表的最下方点击按钮新增自定义规格。
  - 指定该 Zone 下的 Unit 数量。需要注意的是，unit 数量不能超过该 Zone 下 Server个数。
2. 对 Zone 优先级 进行排序。
  
  同时选择多个 Zone 添加到右侧后，可设置为同一优先级。
填写 基本设置。
1. 设置 管理员初始密码。支持随机生成。
  - 对于 MySQL 模式，其管理员账户为 root。
  - 对于 Oracle 模式，其管理员账户为 SYS。密码格式：长度为 8 ~ 32，且至少包含 2 个数字、2 个大写字母、2 个小写字母和 2 个特殊字符，支持的特殊字符为 ._+@#$%。
2. 设置 租户模式。
  - 支持 Oracle 和 MySQL 租户模式。
  - 所选集群的 OceanBase 数据库版本在 V2.1.x 及以上时才支持 Oracle 租户模式。
3. 设置 字符集与编码。
  - 对于 MySQL 模式，可选字符集有：utf8mb4、binary、gbk、gb18030。缺省为 utf8mb4。
  - 对于 Oracle 模式，可选字符集有：utf8mb4、gbk、gb18030。缺省为 utf8mb4。
4. （可选）设置备注。
5. 设置 IP 地址白名单。
  - 此处可以指定该租户允许登录的客户端列表。如果不指定，默认配置为 %，表示允许所有的客户端。自定义白名单列表时需要注意，OCP 机器地址以及所依赖的 OBProxy 地址必须在此名单中，否则 OCP 将无法管理此租户。
    - 默认配置：所有 IP 都可访问。
    - 自定义：设置 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
      
      特殊说明：% 表示所有客户端都可以连接。
单击提交。

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

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

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

说明

对租户进行扩容的情况需要保证整体资源占用不操作上限。如果集群和节点的 CPU、内存资源已经完全分配给所有的租户。
此时无法对任何租户进行扩容。需要进行对某些租户的缩容，释放资源后在对目标租户进行扩容。
如果所有租户不能缩容，并且资源非配已满，此时不能进行租户扩容，必须进行集群级别的扩容（添加节点）。

修改租户操作步骤：

登录 OCP。
在左侧导航栏中单击租户。
在 租户列表 中找到指定租户，并单击租户名称。
进行以下操作：
- 在页面右上角展开隐藏菜单，并单击 修改密码，在弹出的对话框中，输入 2 次新密码后，单击确定。
- 在 白名单 区域右上角单击修改，然后在弹出的对话框中，请根据页面说明和配置说明，重新设置白名单，白名单设置的字符数不超 128 个字符，完成后单击确定。
- 在 副本详情 区域，选择需要修改资源规格的副本，在对应的操作列中，单击编辑后，修改副本的类型、Unit 规格以及 Unit 数量，单击 确定。
  
  说明
  
  Unit 数量不能超过该 Zone 下 Server 的个数。