cetus/doc/cetus-install.md

125 lines
5.7 KiB
Markdown
Raw Normal View History

2018-03-06 15:34:44 +08:00
# Cetus 安装说明
## 安装依赖
2018-03-06 17:46:44 +08:00
编译安装Cetus存在以下依赖
2018-03-06 15:34:44 +08:00
- cmake
- gcc
- glib2-devel
- flex
2018-04-18 10:52:52 +08:00
- mysql-develmariadb-devel
2018-05-16 10:10:43 +08:00
- gperftools-libs (由于malloc存在着潜在的内存碎片问题建议采用gperftools-libs中的tcmalloc)
2018-03-06 15:34:44 +08:00
2018-09-13 11:01:46 +08:00
centos系统可使用yum install cmake gcc glib2-devel flex mysql-devel gperftools-libs -y 安装依赖包请确保在编译安装Cetus前已安装好相应的依赖。
2018-03-06 15:34:44 +08:00
## 安装步骤
2018-03-06 17:46:44 +08:00
Cetus利用自动化建构系统CMake进行编译安装其中描述构建过程的构建文件CMakeLists.txt已经在源码中的主目录和子目录中下载源码并解压后具体安装步骤如下
2018-03-06 15:34:44 +08:00
- 创建编译目录在源码主目录下创建独立的目录build并转到该目录下
```
mkdir build/
cd build/
```
- 编译利用cmake进行编译指令如下
```
2018-03-23 17:13:25 +08:00
读写分离版本:
2018-11-09 10:35:23 +08:00
CFLAGS='-g -Wpointer-to-int-cast' cmake ../ -DCMAKE_BUILD_TYPE=Debug -DCMAKE_INSTALL_PREFIX=/home/user/cetus_install -DSIMPLE_PARSER=ON
2018-03-23 17:13:25 +08:00
分库版本:
2018-11-09 10:35:23 +08:00
CFLAGS='-g -Wpointer-to-int-cast' cmake ../ -DCMAKE_BUILD_TYPE=Debug -DCMAKE_INSTALL_PREFIX=/home/user/cetus_install -DSIMPLE_PARSER=OFF
2018-03-23 17:13:25 +08:00
2018-03-06 15:34:44 +08:00
```
2018-11-09 10:35:23 +08:00
其中CFLAGS='-g -Wpointer-to-int-cast'在可执行程序中包含标准调试信息CMAKE_BUILD_TYPE变量可以选择生成 debug 版和或release 版的程序CMAKE_INSTALL_PREFIX变量确定软件的实际安装目录的绝对路径安装目录建议以/home/user/日期.编译版本.分支.commit_id的方式命名SIMPLE_PARSER变量确定软件的编译版本设置为ON则编译读写分离版本否则编译分库版本。
2018-03-06 15:34:44 +08:00
2018-03-06 17:46:44 +08:00
该过程会检查您的系统是否缺少一些依赖库和依赖软件,可以根据错误代码安装相应依赖。
2018-03-06 15:34:44 +08:00
- 安装执行make install进行安装
```
make install
```
- 配置Cetus运行前还需要编辑配置文件
```
cd /home/user/cetus_install/conf/
cp XXX.json.example XXX.json
cp XXX.conf.example XXX.conf
vi XXX.json
vi XXX.conf
```
配置文件在make insatll后存在示例文件以.example结尾目录为/home/user/cetus_install/conf/包括用户设置文件users.json、变量处理配置文件variables.json、分库版本的分片规则配置文件sharding.json、读写分离版本的启动配置文件proxy.conf和分库版本的启动配置文件shard.conf
根据具体编译安装的版本编辑相关配置文件若使用读写分离功能则需配置users.json和proxy.conf若使用sharding功能则需配置users.json、sharding.json和shard.conf其中两个版本的variables.json均可选配。
配置文件的具体说明见[Cetus 读写分离版配置文件说明](https://github.com/Lede-Inc/cetus/blob/master/doc/cetus-rw-profile.md)和[Cetus 分库(sharding)版配置文件说明](https://github.com/Lede-Inc/cetus/blob/master/doc/cetus-shard-profile.md)。
2018-03-06 15:34:44 +08:00
- 启动Cetus可以利用bin/cetus启动
```
2018-05-16 10:10:43 +08:00
读写分离版本:
bin/cetus --defaults-file=conf/proxy.conf [--conf-dir/home/user/cetus_install/conf/]
分库版本:
bin/cetus --defaults-file=conf/shard.conf [--conf-dir/home/user/cetus_install/conf/]
2018-03-06 15:34:44 +08:00
```
2018-05-16 10:10:43 +08:00
其中Cetus启动时可以添加命令行选项--defaults-file选项用来加载启动配置文件proxy.conf或者shard.conf且在启动前保证启动配置文件的权限为660--conf-dir是可选项用来加载其他配置文件(.json文件)默认为当前目录下conf文件夹。
2018-03-06 15:34:44 +08:00
2018-03-06 17:46:44 +08:00
Cetus可起动守护进程后台运行也可在进程意外终止自动启动一个新进程可通过启动配置选项进行设置。
2018-09-04 16:18:38 +08:00
## 注意事项
发现在某些最新版本的操作系统上例如centos:7.5.1804虽然成功安装了tcmalloc库但是有可能cetus仍然没有正确的链接该库。以下方法可以检测cetus是否已经成功链接了tcmalloc库
- cmake阶段
```
## cmake结束后如果检测到系统安装有tcmalloc会打印以下信息
-- Looking for malloc in tcmalloc
-- Looking for malloc in tcmalloc - found
## 如果检测不到tcmalloc则会打印以下信此时需要检测tcmalloc安装是否正确
-- Looking for malloc in tcmalloc
-- Looking for malloc in tcmalloc - not found
```
- make install 阶段
```
## make install命令执行之后编译出cetus可执行文件会被拷贝到安装目录可以检测该执行文件的动态库是否动态链接了tcmalloc库
ldd ${cetus_install_path}/libexec/cetus|grep tcmalloc
```
如果发现已经安装过了tcmalloc相应的发行包但是cetus却没有正确链接tcmalloc库极大可能是没有找到libtcmalloc.so动态库此时应该手动建立软链接。建立方法
```
## 以64位 centos7.5 为例
2018-11-10 19:43:36 +08:00
ls -alh /usr/lib64/|grep tcmalloc
2018-09-04 16:18:38 +08:00
lrwxrwxrwx 1 root root 20 Sep 4 00:58 libtcmalloc.so.4 -> libtcmalloc.so.4.4.5
-rwxr-xr-x 1 root root 295K Apr 11 01:41 libtcmalloc.so.4.4.5
lrwxrwxrwx 1 root root 33 Sep 4 00:58 libtcmalloc_and_profiler.so.4 -> libtcmalloc_and_profiler.so.4.4.5
-rwxr-xr-x 1 root root 315K Apr 11 01:41 libtcmalloc_and_profiler.so.4.4.5
lrwxrwxrwx 1 root root 26 Sep 4 00:58 libtcmalloc_debug.so.4 -> libtcmalloc_debug.so.4.4.5
-rwxr-xr-x 1 root root 351K Apr 11 01:41 libtcmalloc_debug.so.4.4.5
lrwxrwxrwx 1 root root 28 Sep 4 00:58 libtcmalloc_minimal.so.4 -> libtcmalloc_minimal.so.4.4.5
-rwxr-xr-x 1 root root 152K Apr 11 01:41 libtcmalloc_minimal.so.4.4.5
lrwxrwxrwx 1 root root 34 Sep 4 00:58 libtcmalloc_minimal_debug.so.4 -> libtcmalloc_minimal_debug.so.4.4.5
-rwxr-xr-x 1 root root 208K Apr 11 01:41 libtcmalloc_minimal_debug.so.4.4.5
## 发现没有 libtcmalloc.so建立软链接
ln -s /usr/lib64/libtcmalloc.so.4.4.5 /usr/lib64/libtcmalloc.so
## 重新cmake
rm -rf CMakeCache.txt
根据所需的cetus版本执行对应cmake命令
2018-09-13 11:01:46 +08:00
```