1 背景
1.1 租户类型及特点
目前OBServer中存在三种类型的租户:
- sys租户:是集群默认创建的租户,与集群生命周期一致,是集群和其它租户的管理者,“位高权重”。
- 用户租户:就是平常说的业务租户或普通租户,由用户创建,跑用户业务,对外提供完整的数据库功能。
- meta租户:是数据库内部自管理租户,与用户租户一一对应,用于存储和管理用户租户的集群私有数据。
可见,sys租户和meta租户都具有“角色关键,但不跑业务”的特点,因此,用户在运维中也往往不会刻意关注这些租户,而是将重点放在用户租户上。
1.2 tenant=all已知缺陷
目前,租户级配置项修改命令支持tenant=all
语法,即alter system set xxx=yyy tenant=all
,语义是对所有租户,包括sys、meta租户,都生效。这种设计存在两个问题。
一是易用性问题,即可能使用户做出不符合本身意愿的误操作。当用户使用tenant=all
时,可能仅仅是想对所有用户租户生效,也没有清楚而深刻地认识到“我这个动作,已经顺带把sys租户和meta租户的配置项一起改了,这可能会有问题,我需要特别留心这一点”。
二是稳定性问题,即可能会引发observer故障。如果有些配置项对sys租户很重要,不可轻易修改,那么,一旦这些配置项被tenant=all
“顺带”修改了,就可能引发ObServer的故障,并增加问题排查的难度。
以cpu_quota_concurrency
为例说明,sys租户默认配置成10,其余租户默认值为4,如果用户执行了alter system set cpu_quota_concurrency=5 tenant=all;
,可能导致sys租户出现问题。而用户很可能仅仅是想改跑业务的用户租户的配置项,sys、meta被连带修改,非用户本意。
1.3 解决方案
变更tenant=all
的语义,彻底杜绝用户误操作的风险,同时新增语法兼容旧语义,详见下文变更细节。
2 tenant=all语义变更
2.1 变更细节
首先,修改tenant=all
语义,改为“仅包括所有用户租户,排除sys和meta租户”,以彻底杜绝用户误操作风险,提升产品稳定性。
除了配置项修改语法,其它使用tenant=all
的语法,如合并转储相关语法,也要一起修改,为了保持产品行为统一,避免用户疑惑。
其次,新增语法,tenant=all_user
,tenant=all_meta
,分别对应所有用户租户和所有meta租户。理由是兼容原有语义,提供更细粒度的控制,在保证操作安全的前提下尽量方便用户使用。如果用户想使操作对所有用户租户生效,可以使用tenant=all_user
,而不必一一列举租户名称;如果用户确实想要使操作对所有租户都生效,可以依次使用tenant=all_user
,tenant=all_meta
,tenant=sys
,详见使用说明。
修改后,tenant=all
和tenant=all_user
的语义完全相同,后面会在恰当时机废弃tenant=all
。
2.2 影响到的模块和命令
模块 | 命令 |
配置项修改 | alter system set xxx=yyy tenant=all |
合并转储 | alter system {major|minor} freeze tenant=allalter system {suspend|resume} merge tenant=allalter system clear merge error tenant=all |
2.3 性能影响
无影响。本特性只是缩小了tenant=all
的生效范围,同时新增了两个与tenant=all
类似的命令,即(tanant=all_user
和tenant=all_meta
),且实现上没有新增开销大的操作,因此不会增加额外的运行负担,对数据库性能无影响。
3 使用说明及特性限制
- 仅支持在sys租户下使用
tenant=sys
,tenant=all_user
,tenant=all_meta
。 - 对配置项修改语法和合并转储语法,均不建议再使用
tenant=all
。 - 如果只想对sys租户生效,使用
tenant=sys
;如果只想对所有的用户租户生效,使用tenant=all_user
;如果只想对所有的meta租户生效,使用tenant=all_meta
。 - 如果确实想对所有的租户生效,则需依次使用
tenant=sys
,tenant=all_user
,tenant=all_meta
。 - 对于配置项设置语法,tenant后不支持list形式;对于合并转储语法,all_user和all_meta只能单独使用,其它名称可以组合成list形式使用。
- sys不能大写,因为sys是租户名,是区分大小写的。而all_user和all_meta是关键字,不区分大小写。
# 配置项设置示例
# 以下三句实现原有all语义
alter system set ob_compaction_schedule_interval = '10s' tenant = sys; # sys不能大写
alter system set ob_compaction_schedule_interval = '10s' tenant = all_user;
alter system set ob_compaction_schedule_interval = '10s' tenant = all_meta;
# 以下示例不可以,tenant后只能是单个名称,不能是list
obclient> alter system set ob_compaction_schedule_interval = '10s' tenant = mysql,sys;
ERROR 1064 (42000): You have an error in your SQL syntax; check the manual that corresponds to your OceanBase version for the right syntax to use near 'sys' at line 1
obclient> alter system set ob_compaction_schedule_interval = '10s' tenant = all_user,all_meta;
ERROR 1064 (42000): You have an error in your SQL syntax; check the manual that corresponds to your OceanBase version for the right syntax to use near 'all_meta' at line 1
obclient> alter system set ob_compaction_schedule_interval = '10s' tenant = mysql,all_user;
ERROR 1064 (42000): You have an error in your SQL syntax; check the manual that corresponds to your OceanBase version for the right syntax to use near 'all_user' at line 1
obclient> alter system set ob_compaction_schedule_interval = '10s' tenant = mysql,all_meta;
ERROR 1064 (42000): You have an error in your SQL syntax; check the manual that corresponds to your OceanBase version for the right syntax to use near 'all_meta' at line 1
# 合并转储示例
# 以下三句实现原有all语义
alter system major freeze tenant = sys; # sys不能大写
alter system major freeze tenant = all_user;
alter system major freeze tenant = all_meta;
# 以下示例不可以,all_user/all_meta只能单独使用
obclient> alter system major freeze tenant = all_user,all_meta;
ERROR 1235 (0A000): all/all_user/all_meta in combination with other names is not supported
obclient> alter system major freeze tenant = mysql,all_user;
ERROR 1235 (0A000): all/all_user/all_meta in combination with other names is not supported
obclient> alter system major freeze tenant = mysql,all_meta;
ERROR 1235 (0A000): all/all_user/all_meta in combination with other names is not supported
# 以下示例是可以的,all_user/all_meta外的名称可以组合使用
alter system major freeze tenant = tt1,sys;
在使用该特性的过程中,存在一些限制。
第一,不能再创建名为all_user或者all_meta(不区分大小写)的租户,因为all_user和all_meta变成保留字了。
第二,低版本升级4.2.1版本前,需要先检查集群中是否有名为all_user或者all_meta(不区分大小写)的租户,如有,需要先重命名租户再升级。
第三,因为没有实际风险,故以下语法中tenant=all
语义暂未变更,且暂无计划在未来版本做变更,会维持原有语义不变,且不支持tenant=all_user
或tenant=all_meta
。
# 升级相关命令,不显示指定TENANT,或指定TENANT = ALL,都会对所有租户生效,无风险
ALTER SYSTEM RUN UPGRADE JOB "CMD" [TENANT = ALL|tenant_list];
# 这里TENANT = ALL只包含用户租户,sys租户和meta租户没有对应功能
ALTER SYSTEM ARCHIVELOG|NOARCHIVELOG TENANT = ALL;