1 Star 0 Fork 4

Ethan_LY / GreatSQLHA

forked from 万里数据库 / GreatSQLHA 
加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
GPL-2.0

GreatSQLHA

[toc]

0. 简介

MGR集群高可用方案,基于VIP漂移机制。

适用于Python 3.6环境,已在CentOS 7.x/8.x + Python 3.6环境下验证通过。

支持 GreatSQL 5.7 & 8.0,同样也支持 MySQL 以及 Percona Server相应版本。

本项目fork自八怪的HAIPMGR

1. 运行环境要求

  1. 安装Python 3.6
$ yum install -y python3 python3-pip
  1. 安装psutil>=5.4.3 和 PyMySQL>=1.0.2 模块
$ pip3 install --user psutil==5.4.3 PyMySQL==1.0.2
  1. 如果连接mysql的账户采用 caching_sha2_password 加密方式,则还需要安装 cryptography>=36.0.1 模块。如果还是采用 mysql_native_password 则无需安装此模块。
$ pip3 install --user cryptography>=36.0.1

2. 运行前修改配置

修改配置文件 config.py 里的相关参数,例如:

vars = {"vip":"172.16.130.200", \
        "mgr_seeds":{"172.16.130.197":"ens3","172.16.130.198":"ens3","172.16.130.199":"ens3"}, \
        "gateway":"172.16.130.1", \
        "mysql_port":"3306", \
        "mgr_port":"33061", \
        "user":"yejr", \
        "passwd":"yejr", \
        "sleeptime":3, \
        "logdir":"/tmp/", \
        "lock_file": "/tmp/GreatSQLHA.lock", \
        "stat_file": "/tmp/GreatSQLHA.stat", \
        "log_level":"INFO"}

上述参数的作用分别是:

  • vip => 高可用绑定的VIP地址
  • mgr_seeds => MGR各节点的IP+对应绑定的网卡(务必填写IP地址格式,不能填写主机名)
  • gateway => 网关IP地址,用于检测绑定VIP后是否能ping通网关
  • mysql_port => MySQL运行端口,用于检测连通性
  • mgr_port => MGR服务运行的端口
  • user,passwd => 连接MySQL的账号密码
  • sleeptime => 代表循环检测时间,单位为秒
  • logdir => 程序日志目录
  • log_level => 记录log等级,可选值有 DEBUG|INFO|WARNING|ERROR|CRITICAL

提醒 上面配置的连接MySQL的账号、密码要先自行测试,并且要提前授权,至少要能连接以及对performance_schema & sys的只读权限,可参考下面的做法:

mysql> create user yejr identified by 'yejr';
mysql> grant select on performance_schema.* to yejr;
mysql> grant select on sys.* to yejr;

此外,还需要提前设置好正确的hostname、ip信息,例如:

# 设置hostname
$ hostnamectl set-hostname mgr1

# 读取hostname
$ hostname
mgr1

因为程序运行时需要通过hostname获取ip地址,可以尝试运行下面的小程序确认设置是否正确:

# 运行python3
$ python3
Python 3.6.8 (default, Sep 10 2021, 09:13:53)
[GCC 8.5.0 20210514 (Red Hat 8.5.0-3)] on linux
Type "help", "copyright", "credits" or "license" for more information.
>>> import socket
>>> print(socket.gethostbyname(socket.gethostname()))
172.16.130.197
>>>

这样就表示可以了,如果不能获取到正确的ip地址,请检查是否已正确设置了。

3. 安装和启动程序

# 1. 假定将程序安装到 /data/GreatSQLHA 目录下
# 假定程序包放在 /root/GreatSQLHA 目录下
$ cd /root/GreatSQLHA
$ ls
config.py  global_vars  handler.py  logger  GreatSQLHA.py  my_exception  __pycache__  README.md  TODO.txt  tool.py  vipha.py
# 2. 参考上面说明修改配置文件 config.py

# 3. 执行安装程序install.sh(在各个节点都要安装一遍)
# 根据输出提醒进行安装即可
# 安装完毕后,会自行加入systemd中并启动服务
$ ./install.sh
$ ps -ef | grep GreatSQLHA
root       22056       1  0 16:43 ?        00:00:01 /usr/bin/python3 /data/GreatSQLHA/GreatSQLHA.py

如果启动没报错,则 /tmp/GreatSQLHA.log 文件中会记录详细运行结果输出信息,例如:

INFO - Longger System Create Finish
INFO - vars_init: All options [INIT] complete!! is:
INFO - options log_level values is INFO
INFO - options logger values is <Logger GreatSQLHA (INFO)>
INFO - options vip values is 172.16.130.200
INFO - options mgr_seeds values is {'172.16.130.197': 'ens3', '172.16.130.198': 'ens3', '172.16.130.199': 'ens3'}
INFO - options gateway values is 172.16.130.1
INFO - options mysql_port values is 3306
INFO - options mgr_port values is 33061
INFO - options user values is yejr
INFO - options sleeptime values is 3
INFO - options logdir values is /tmp/
INFO - options lock_file values is /tmp/GreatSQLHA.lock
INFO - options stat_file values is /tmp/GreatSQLHA.stat
INFO - ==============================GreatSQLHA stat check loop begin==============================
INFO - check_localip_in_mgr: local ip:[('172.16.130.198', 'ens3')]
INFO - check_localip_in_mgr: local ip:172.16.130.198 in mgr_seeds
INFO - check_stat:[STAGE1] local_ip:172.16.130.198 check succ!
INFO - check_mysqld_alived: mysqld connect succ!
INFO - check_stat:[STAGE2] mysqld 172.16.130.198:3306 connect scuess!
INFO - check_mgr_primary: node:wldb3 ONLINE
INFO - check_mgr_primary: node:172.16.130.198 not Primary, Primary node is:172.16.130.197
INFO - check_stat:[STAGE3] 172.16.130.198 not mgr primary...
INFO - check_vip_local_bound: vip:172.16.130.200 not bound
INFO - check_vip: vip should not be bound...
INFO - check_vip:vip 172.16.130.200 not on this node, do nothing
INFO - set_vip: do nothing
...

一般而言,INFO级别的日志不用处理,只有WARNING级别以上的日志才需要关注。

运行过程中会生成几个文件:

  • /tmp/GreatSQLHA.lock,文件锁,【请不要】手动更改本文件
  • /tmp/GreatSQLHA.log,运行日志文件
  • /tmp/GreatSQLHA.stat,状态文件,用于监控是否发生了VIP切换,【请不要】手动更改本文件。文件内容不同值分别表示:
    • 0 关闭GreatSQLHA
    • 2 为启动GreatSQLHA,且将会在20*sleeptime后重置为1

4. 关闭程序

直接 ctrl+c 终止程序,或直接kill进程ID即可。 若当前节点是Primary Node,关闭或启动程序都不会导致现有VIP切换。

5. 程序限制

本程序有以下几项限制条件:

  • 只能用于Linux环境下,已在CentOS 7.x/8.x环境中验证通过,其他Linux发行版请自行测试验证。
  • 要求MGR运行再单主模式下(group_replication_single_primary_mode=ON)。
  • 要求每个服务器上运行MGR单实例的场景,且各节点的MySQL和MGR Paxos通信端口都一样。
  • 要求每个MGR实例上都要设置report-host,并且以IP地址的方式上报,例如:report-host=172.16.130.197,因为在逻辑判断中采用IP地址方式。

6. 高可用VIP切换与否逻辑过程

在MGR单主模式下,各个判断逻辑如下:

阶段1[stage1]

通过初始化参数cluser_ip中的配置判断本节点是否在集群中

阶段2[stage2]

检查是否能够连接上MYSQLD服务器进程,主要检查mysqld(已经取消端口检测)可以连接(密码错误算可以连接)

阶段3[stage3]

判断内部通信端口是否启动,检查本机是否在MGR中且为online,检查本节点是否是MGR的主节点

阶段4[stage4]

通过检查网关的方式,来避免网络隔离出现2个主节点启动两个VIP的情况

经过上面四个阶段的逻辑判断后,将会返回:

  • 0,表示状态检查通过,需要开启VIP
  • 1,表示状态检查未通过,需要关闭VIP

阶段5[stage5]

根据上面四个阶段的返回值来判断是否启动和关闭VIP,于是又有如下几个判断

  • 如果需要启动
    • 虚拟VIP是否在本地
      • 如果在本地
        • 则维持现状return 1
      • 如果不在本地
        • 如果还能ping通VIP则本次循环维持现状,等待下次循环检测 return 1
        • 如果不能ping通VIP则做2次检查将阶段1到4再次检查一遍
          • 如果检查失败 return1 维持现状
          • 如果检查成功 return2 启动VIP
  • 如果需要关闭
    • 虚拟VIP是否在本地关闭
      • 如果在本地
        • 做二次检查阶段1到4再次检查一遍
          • 如果检查失败 return1 维持现状
          • 如果检查成功 return0 关闭VIP
      • 如果不在本地
        • 维持现状 return0

处理完毕后,本阶段将返:

  • 0 关闭VIP
  • 1 维持现状不启动也不关闭vip
  • 2 启动VIP

阶段6[stage6]

根据阶段5的返回值做出相应的VIP各种处理(启动、关闭、保持不变)。

7. 高可用切换测试

正式上线前,可以分别模拟下面几种情况,测试GreatSQLHA高可用切换是否能正常工作:

    1. 关闭服务器
    1. 关闭数据库
    1. 关闭MGR
    1. 连接账号授权不足或密码错误(可能会导致 check_mgr_primary() 函数执行失败而退出程序)
    1. MySQL负载太高导致状态检查超时失败
    1. 网卡意外宕机
    1. 主节点发生网络分区
GNU GENERAL PUBLIC LICENSE Version 2, June 1991 Copyright (C) 1989, 1991 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. Preamble The licenses for most software are designed to take away your freedom to share and change it. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change free software--to make sure the software is free for all its users. This General Public License applies to most of the Free Software Foundation's software and to any other program whose authors commit to using it. (Some other Free Software Foundation software is covered by the GNU Lesser General Public License instead.) You can apply it to your programs, too. When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for this service if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs; and that you know you can do these things. To protect your rights, we need to make restrictions that forbid anyone to deny you these rights or to ask you to surrender the rights. These restrictions translate to certain responsibilities for you if you distribute copies of the software, or if you modify it. For example, if you distribute copies of such a program, whether gratis or for a fee, you must give the recipients all the rights that you have. You must make sure that they, too, receive or can get the source code. And you must show them these terms so they know their rights. We protect your rights with two steps: (1) copyright the software, and (2) offer you this license which gives you legal permission to copy, distribute and/or modify the software. Also, for each author's protection and ours, we want to make certain that everyone understands that there is no warranty for this free software. If the software is modified by someone else and passed on, we want its recipients to know that what they have is not the original, so that any problems introduced by others will not reflect on the original authors' reputations. Finally, any free program is threatened constantly by software patents. We wish to avoid the danger that redistributors of a free program will individually obtain patent licenses, in effect making the program proprietary. To prevent this, we have made it clear that any patent must be licensed for everyone's free use or not licensed at all. The precise terms and conditions for copying, distribution and modification follow. GNU GENERAL PUBLIC LICENSE TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 0. This License applies to any program or other work which contains a notice placed by the copyright holder saying it may be distributed under the terms of this General Public License. The "Program", below, refers to any such program or work, and a "work based on the Program" means either the Program or any derivative work under copyright law: that is to say, a work containing the Program or a portion of it, either verbatim or with modifications and/or translated into another language. (Hereinafter, translation is included without limitation in the term "modification".) Each licensee is addressed as "you". Activities other than copying, distribution and modification are not covered by this License; they are outside its scope. The act of running the Program is not restricted, and the output from the Program is covered only if its contents constitute a work based on the Program (independent of having been made by running the Program). Whether that is true depends on what the Program does. 1. You may copy and distribute verbatim copies of the Program's source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice and disclaimer of warranty; keep intact all the notices that refer to this License and to the absence of any warranty; and give any other recipients of the Program a copy of this License along with the Program. You may charge a fee for the physical act of transferring a copy, and you may at your option offer warranty protection in exchange for a fee. 2. You may modify your copy or copies of the Program or any portion of it, thus forming a work based on the Program, and copy and distribute such modifications or work under the terms of Section 1 above, provided that you also meet all of these conditions: a) You must cause the modified files to carry prominent notices stating that you changed the files and the date of any change. b) You must cause any work that you distribute or publish, that in whole or in part contains or is derived from the Program or any part thereof, to be licensed as a whole at no charge to all third parties under the terms of this License. c) If the modified program normally reads commands interactively when run, you must cause it, when started running for such interactive use in the most ordinary way, to print or display an announcement including an appropriate copyright notice and a notice that there is no warranty (or else, saying that you provide a warranty) and that users may redistribute the program under these conditions, and telling the user how to view a copy of this License. (Exception: if the Program itself is interactive but does not normally print such an announcement, your work based on the Program is not required to print an announcement.) These requirements apply to the modified work as a whole. If identifiable sections of that work are not derived from the Program, and can be reasonably considered independent and separate works in themselves, then this License, and its terms, do not apply to those sections when you distribute them as separate works. But when you distribute the same sections as part of a whole which is a work based on the Program, the distribution of the whole must be on the terms of this License, whose permissions for other licensees extend to the entire whole, and thus to each and every part regardless of who wrote it. Thus, it is not the intent of this section to claim rights or contest your rights to work written entirely by you; rather, the intent is to exercise the right to control the distribution of derivative or collective works based on the Program. In addition, mere aggregation of another work not based on the Program with the Program (or with a work based on the Program) on a volume of a storage or distribution medium does not bring the other work under the scope of this License. 3. You may copy and distribute the Program (or a work based on it, under Section 2) in object code or executable form under the terms of Sections 1 and 2 above provided that you also do one of the following: a) Accompany it with the complete corresponding machine-readable source code, which must be distributed under the terms of Sections 1 and 2 above on a medium customarily used for software interchange; or, b) Accompany it with a written offer, valid for at least three years, to give any third party, for a charge no more than your cost of physically performing source distribution, a complete machine-readable copy of the corresponding source code, to be distributed under the terms of Sections 1 and 2 above on a medium customarily used for software interchange; or, c) Accompany it with the information you received as to the offer to distribute corresponding source code. (This alternative is allowed only for noncommercial distribution and only if you received the program in object code or executable form with such an offer, in accord with Subsection b above.) The source code for a work means the preferred form of the work for making modifications to it. For an executable work, complete source code means all the source code for all modules it contains, plus any associated interface definition files, plus the scripts used to control compilation and installation of the executable. However, as a special exception, the source code distributed need not include anything that is normally distributed (in either source or binary form) with the major components (compiler, kernel, and so on) of the operating system on which the executable runs, unless that component itself accompanies the executable. If distribution of executable or object code is made by offering access to copy from a designated place, then offering equivalent access to copy the source code from the same place counts as distribution of the source code, even though third parties are not compelled to copy the source along with the object code. 4. You may not copy, modify, sublicense, or distribute the Program except as expressly provided under this License. Any attempt otherwise to copy, modify, sublicense or distribute the Program is void, and will automatically terminate your rights under this License. However, parties who have received copies, or rights, from you under this License will not have their licenses terminated so long as such parties remain in full compliance. 5. You are not required to accept this License, since you have not signed it. However, nothing else grants you permission to modify or distribute the Program or its derivative works. These actions are prohibited by law if you do not accept this License. Therefore, by modifying or distributing the Program (or any work based on the Program), you indicate your acceptance of this License to do so, and all its terms and conditions for copying, distributing or modifying the Program or works based on it. 6. Each time you redistribute the Program (or any work based on the Program), the recipient automatically receives a license from the original licensor to copy, distribute or modify the Program subject to these terms and conditions. You may not impose any further restrictions on the recipients' exercise of the rights granted herein. You are not responsible for enforcing compliance by third parties to this License. 7. If, as a consequence of a court judgment or allegation of patent infringement or for any other reason (not limited to patent issues), conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot distribute so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not distribute the Program at all. For example, if a patent license would not permit royalty-free redistribution of the Program by all those who receive copies directly or indirectly through you, then the only way you could satisfy both it and this License would be to refrain entirely from distribution of the Program. If any portion of this section is held invalid or unenforceable under any particular circumstance, the balance of the section is intended to apply and the section as a whole is intended to apply in other circumstances. It is not the purpose of this section to induce you to infringe any patents or other property right claims or to contest validity of any such claims; this section has the sole purpose of protecting the integrity of the free software distribution system, which is implemented by public license practices. Many people have made generous contributions to the wide range of software distributed through that system in reliance on consistent application of that system; it is up to the author/donor to decide if he or she is willing to distribute software through any other system and a licensee cannot impose that choice. This section is intended to make thoroughly clear what is believed to be a consequence of the rest of this License. 8. If the distribution and/or use of the Program is restricted in certain countries either by patents or by copyrighted interfaces, the original copyright holder who places the Program under this License may add an explicit geographical distribution limitation excluding those countries, so that distribution is permitted only in or among countries not thus excluded. In such case, this License incorporates the limitation as if written in the body of this License. 9. The Free Software Foundation may publish revised and/or new versions of the General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. Each version is given a distinguishing version number. If the Program specifies a version number of this License which applies to it and "any later version", you have the option of following the terms and conditions either of that version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of this License, you may choose any version ever published by the Free Software Foundation. 10. If you wish to incorporate parts of the Program into other free programs whose distribution conditions are different, write to the author to ask for permission. For software which is copyrighted by the Free Software Foundation, write to the Free Software Foundation; we sometimes make exceptions for this. Our decision will be guided by the two goals of preserving the free status of all derivatives of our free software and of promoting the sharing and reuse of software generally. NO WARRANTY 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. END OF TERMS AND CONDITIONS How to Apply These Terms to Your New Programs If you develop a new program, and you want it to be of the greatest possible use to the public, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms. To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively convey the exclusion of warranty; and each file should have at least the "copyright" line and a pointer to where the full notice is found. <one line to give the program's name and a brief idea of what it does.> Copyright (C) <year> <name of author> This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Also add information on how to contact you by electronic and paper mail. If the program is interactive, make it output a short notice like this when it starts in an interactive mode: Gnomovision version 69, Copyright (C) year name of author Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. This is free software, and you are welcome to redistribute it under certain conditions; type `show c' for details. The hypothetical commands `show w' and `show c' should show the appropriate parts of the General Public License. Of course, the commands you use may be called something other than `show w' and `show c'; they could even be mouse-clicks or menu items--whatever suits your program. You should also get your employer (if you work as a programmer) or your school, if any, to sign a "copyright disclaimer" for the program, if necessary. Here is a sample; alter the names: Yoyodyne, Inc., hereby disclaims all copyright interest in the program `Gnomovision' (which makes passes at compilers) written by James Hacker. <signature of Ty Coon>, 1 April 1989 Ty Coon, President of Vice This General Public License does not permit incorporating your program into proprietary programs. If your program is a subroutine library, you may consider it more useful to permit linking proprietary applications with the library. If this is what you want to do, use the GNU Lesser General Public License instead of this License.

简介

MGR集群高可用方案,基于VIP漂移机制。 展开 收起
Python
GPL-2.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
Python
1
https://gitee.com/ethan-ly/GreatSQLHA.git
git@gitee.com:ethan-ly/GreatSQLHA.git
ethan-ly
GreatSQLHA
GreatSQLHA
master

搜索帮助