使用准备
在正式使用Yearning前,你需要先设置如下setup(请务必花几分钟时间阅读!)。
- 创建用户并确认其角色
- 创建权限组并将权限组赋予给对应的用户
- 添加数据源信息
- 为数据源创建自定义审核规则
- 在设置页面配置各项配置信息
- 根据需求调整自定义审核规则
创建用户并确认其角色
创建用户
在Yearning中用户可以通过以下方式创建:
- 在 管理->用户 页面admin用户自行创建用户。
- 打开 管理->设置 页面中的允许注册配置并保存。 由注册人自行点击yearning登录页面左上角注册按钮进行注册。
- 配置 管理->设置 页面中的Ldap的信息并保存。 ldap用户可在yearning登录页面中勾选ldap登录进行用户注册/登录操作。
角色
Yearning的用户角色分别为:提交人，操作人，超级管理员(仅admin用户) 三类。
提交人: 仅拥有提交的工单,查询的功能
操作人: 在提交人权限的基础上,拥有审核/执行工单的功能
超级管理员: 在前两者的权限基础上,拥有平台管理/配置/审核规则设置等管理员权限。
注意: 角色是粗粒度的，其目的是为了划分出多个不同属性的用户群从而对不同的用户展示处不同的前端页面导航信息。而更细粒度的权限(例如:允许用户查询哪个数据源,允许用户提交哪个数据源的工单)则通过权限组来进行赋权。
对于除了admin用户以外的所有用户，在创建账号时(通过注册/ldap登录)统一为提交人角色。如需更改角色应由admin用户通过 管理->用户 页面进行更改。
创建权限组并将权限组赋予给对应的用户
通过管理->权限组 页面，admin可以创建/编辑/删除权限组。权限组提供了多种细粒度的权限管控(yearning目前权限管控仅下沉到数据源级别)如下所示:
- 允许DDL工单提交的数据源范围
- 允许DML工单提交的数据源范围
- 允许查询工单提交的数据源范围
- 查询的上级审核人范围
创建完权限组后请通过管理->用户页面，选择你需要赋予权限组的用户点击该用户对应的权限按钮进行权限组赋权。
一个用户可以被赋予多个权限组,多权限组下该用户会集成2个权限组的全部权限
一个权限组也可以对多个用户进行赋权
添加数据源信息
通过管理->数据库 页面，admin可以创建/编辑/删除数据源。数据源为一个Mysql实例，数据库共分为读/写/读写三大种类。如果希望该数据源既可处理DDL/DML工单又能进行查询则该数据源应设置为读写，反之根据自己的需求可以设置为读/写。
尤其要注意: Yearning不支持一些特殊字符串例如@，这是由于转义以及可能会带来的pt-osc执行错误而不得不规避的问题，建议用户单独创建一个新的mysql用户用来对接Yearning平台
为环境创建自定义审核规则
通过管理->流程 页面，admin可以编辑环境的流程。
Yearning以环境为单元，可对不同的环境配置不同的审核流程。
Yearning 最多支持7层的审核流程，但必须注意的是流程的开头必然是提交人阶段，流程的结束必然是执行阶段。否则将会导致流程错乱！
更改流程时请确保该环境下的工单都已处理完毕，否则可能会引起流程错乱！
如没有将对应环境配置流程则用户无法对这个环境进行任何DDL/DML工单提交操作
在设置页面配置各项配置信息
通过管理->设置 页面，admin可以配置Yearning的多项配置。
这里将介绍几个重点配置:
- 查询limit上限: 该设置为 全局查询 最大的limit限制，默认为1000.这意味着通过Yearning进行的查询最多只会查询1000条，如需提高此阀值可直接修改这个配置。(DML/DDL的影响行数上限不受此规则限制，如需对DML/DDL影响行数上限进行修改请前往审核规则页面进行配置)
- 添加环境: 默认Yearning仅提供aws/aliyun 两个环境，用户可自行添加或删除环境，添加完对应的环境后请及时前往流程模板页面添加该新环境的流程模板。
更多的注意事项可通过本文档的 各模块注意事项->管理员模块->设置 查看
根据需求调整自定义审核规则
通过管理->审核规则 页面，admin可以设置Yearning多达几十项的审核规则且每一项审核规则都有详细的描述。
对于PT-OSC的设置请参考具体生产实践经验或访问官方文档 https://www.percona.com/doc/percona-toolkit/3.0/pt-online-schema-change.html