archer

基于inception的自动化SQL操作平台

开发语言和推荐环境：

python：3.4
django：1.8
mysql : 5.6及以上
linux : 64位linux操作系统均可

主要功能：

• 自动审核：
  发起SQL上线，工单提交，由inception自动审核，审核通过后需要由审核人进行人工审核
• 人工审核：
  工单DBA人工审核、审核通过自动执行SQL.
  为什么要有人工审核？
  这是遵循运维领域线上操作的流程意识，一个工程师要进行线上数据库SQL更新，最好由另外一个工程师来把关.
  很多时候DBA并不知道SQL的业务含义，所以人工审核最好由其他研发工程师或研发经理来审核. 这是archer的设计理念.
• 历史工单展示
• 回滚数据展示
• 主库集群配置
• 用户权限配置
  工程师角色（engineer）与审核角色（review_man）:工程师可以发起SQL上线，在通过了inception自动审核之后，需要由人工审核点击确认才能执行SQL.
  还有一个特殊的超级管理员即可以上线、审核，又可以登录admin界面进行管理.
• 历史工单管理
• 可通过django admin进行匹配SQL关键字的工单搜索
• 发起SQL上线，可配置的邮件提醒审核人进行审核

主要配置文件：

• archer/archer/settings.py

安装步骤：

1. 环境准备：
   (1)克隆代码到本地: git clone https://github.com/jly8866/archer.git 或 下载zip包
   (2)安装mysql 5.6实例，请注意保证mysql数据库默认字符集为utf8或utf8mb4
   (3)安装inception
   
2. 安装python3：
   tar -xzvf Python-3.4.1.tar.gz
   cd Python-3.4.1
   ./configure --prefix=/path/to/python3 && make && make install 或者rpm、yum、binary等其他安装方式
3. 安装所需相关模块： (1)django：
   tar -xzvf Django-1.8.17 && cd Django-1.8.17 && python3 setup.py install (2)Crypto:
   pip3 install Crypto
4. 给python3安装MySQLdb模块:
   pip3 install pymysql
   记得确保settings.py里有如下两行：
   import pymysql
   pymysql.install_as_MySQLdb()
   由于python3使用的pymysql模块里并未兼容inception返回的server信息，因此需要编辑/path/to/python3/lib/python3.4/site-packages/pymysql/connections.py：
   在if int(self.server_version.split('.', 1)[0]) >= 5: 这一行之前加上以下这一句并保存，记得别用tab键用4个空格缩进：
   self.server_version = '5.6.24-72.2-log'
   最后看起来像这样：
   
   
5. 创建archer本身的数据库表：
   (1)修改archer/archer/settings.py所有的地址信息,包括DATABASES和INCEPTION_XXX部分
   (2)通过model创建archer本身的数据库表, 记得先去archer数据库里CREATE DATABASE
   python3 manage.py makemigrations sql
   python3 manage.py migrate
   
6. mysql授权:
   记得登录到archer/archer/settings.py里配置的各个mysql里给用户授权
   (1)archer数据库授权
   (2)远程备份库授权
   
7. 创建admin系统root用户（该用户可以登录django admin来管理model）：
   cd archer && python3 manage.py createsuperuser
   
8. 启动：
   用django内置runserver启动服务,需要修改debug.sh里的ip和port
   cd archer && bash debug.sh
   如果要用gunicorn启动服务的话，可以使用pip3 install gunicorn安装并用startup.sh启动，但需要配合nginx处理静态资源.
9. 创建archer系统登录用户：
   使用浏览器（推荐chrome或火狐）访问debug.sh里的地址：http://X.X.X.X:port/admin/sql/users/ ，如果未登录需要用到步骤7创建的admin系统用户来登录。
   点击右侧Add users，用户名密码自定义，至少创建一个工程师和一个审核人（步骤7创建的用户也可以登录）后续新的工程师和审核人用户请用LDAP导入sql_users表或django admin增加
   
10. 配置主库地址：
    使用浏览器访问http://X.X.X.X:port/admin/sql/master_config/ ，点击右侧Add master_config
    这一步是为了告诉archer你要用inception去哪些mysql主库里执行SQL，所用到的用户名密码、端口等。
    
11. 正式访问：
    以上步骤完毕，就可以使用步骤9创建的用户登录archer系统啦, 首页地址 http://X.X.X.X:port/
    

系统展示截图：

1. 工单展示页：
   
   
2. 提交SQL工单：
   
   
3. SQL自动审核、人工审核、执行结果详情页：
   
   
4. 用户登录页：
   
   
5. 用户、集群、工单管理：
   
   

联系方式：

[email protected]