# Codis 使用文档 Codis 是一个分布式 Redis 解决方案, 对于上层的应用来说, 连接到 Codis Proxy 和连接原生的 Redis Server 没有显著区别 ([不支持的命令列表](unsupported_cmds.md)), 上层应用可以像使用单机的 Redis 一样使用, Codis 底层会处理请求的转发, 不停机的数据迁移等工作, 所有后边的一切事情, 对于前面的客户端来说是透明的, 可以简单的认为后边连接的是一个内存无限大的 Redis 服务。 Codis 3.x 由以下组件组成： * **Codis Server**：基于 redis-2.8.21 分支开发。增加了额外的数据结构，以支持 slot 有关的操作以及数据迁移指令。具体的修改可以参考文档 [redis 的修改](redis_change_zh.md)。 * **Codis Proxy**：客户端连接的 Redis 代理服务, 实现了 Redis 协议。 除部分命令不支持以外([不支持的命令列表](unsupported_cmds.md))，表现的和原生的 Redis 没有区别（就像 Twemproxy）。 + 对于同一个业务集群而言，可以同时部署多个 codis-proxy 实例； + 不同 codis-proxy 之间由 codis-dashboard 保证状态同步。 * **Codis Dashboard**：集群管理工具，支持 codis-proxy、codis-server 的添加、删除，以及据迁移等操作。在集群状态发生改变时，codis-dashboard 维护集群下所有 codis-proxy 的状态的一致性。 + 对于同一个业务集群而言，同一个时刻 codis-dashboard 只能有 0个或者1个； + 所有对集群的修改都必须通过 codis-dashboard 完成。 * **Codis Admin**：集群管理的命令行工具。 + 可用于控制 codis-proxy、codis-dashboard 状态以及访问外部存储。 * **Codis FE**：集群管理界面。 + 多个集群实例共享可以共享同一个前端展示页面； + 通过配置文件管理后端 codis-dashboard 列表，配置文件可自动更新。 * **Codis HA**：为集群提供高可用。 + 依赖 codis-dashboard 实例，自动抓取集群各个组件的状态； + 会根据当前集群状态自动生成主从切换策略，并在需要时通过 codis-dashboard 完成主从切换。 * **Storage**：为集群状态提供外部存储。 + 提供 Namespace 概念，不同集群的会按照不同 product name 进行组织； + 目前仅提供了 Zookeeper 和 Etcd 两种实现，但是提供了抽象的 interface 可自行扩展。 ## 0. 下载与编译 #### 1. 安装 Go 运行环境 [参考这里](https://golang.org/doc/install) 安装完成后可以运行下列命令进行检测： ```bash $ go version go version go1.5.2 linux/amd64 ``` #### 2. 设置编译环境 **注意 `$GOPATH` 是本机所有第三方库 go 项目所在目录，Codis 仅是其中之一。** 添加 `$GOPATH/bin` 到 `$PATH`，例如：`PATH=$PATH:$GOPATH/bin`，并安装 godep 工具。 ```bash $ go env GOPATH /home/codis/gopath $ go get -u github.com/tools/godep && which godep /home/codis/gopath/bin/godep ``` #### 3. 下载 Codis 源代码 下载完成后，Codis 源码会出现在 `$GOPATH/src/github.com/CodisLabs/codis` 路径下： ```bash $ go get -u -d github.com/CodisLabs/codis ``` #### 4. 编译 Codis 源代码 * Codis 编译过程使用了 godep，请确定编译之前 godep 能正常工作。 * 直接通过 make 进行编译，会看到如下输出： ```bash $ cd $GOPATH/src/github.com/CodisLabs/codis $ make make -j -C extern/redis-2.8.21/ ... ... >>>> godep: Checking dependency ... ... >>>> godep: Checking dependency ... ... ... ... godep go build -i -o bin/codis-dashboard ./cmd/dashboard godep go build -i -o bin/codis-proxy ./cmd/proxy godep go build -i -o bin/codis-admin ./cmd/admin godep go build -i -o bin/codis-ha ./cmd/ha godep go build -i -o bin/codis-fe ./cmd/fe $ ls bin/ total 69124 drwxr-xr-x 4 codis codis 4096 Jan 4 14:55 assets -rwxr-xr-x 1 codis codis 17600752 Jan 4 14:55 codis-admin -rwxr-xr-x 1 codis codis 18416320 Jan 4 14:55 codis-dashboard -rwxr-xr-x 1 codis codis 9498040 Jan 4 14:55 codis-fe -rwxr-xr-x 1 codis codis 9956328 Jan 4 14:55 codis-ha -rwxr-xr-x 1 codis codis 11057280 Jan 4 14:55 codis-proxy -rwxr-xr-x 1 codis codis 4234432 Jan 4 14:55 codis-server -rw-r--r-- 1 codis codis 148 Jan 4 14:55 version $ cat bin/version version = 2016-01-03 14:53:22 +0800 @51f06ae3b58a256a58f857f590430977638846a3 compile = 2016-01-04 15:00:17 +0800 by go version go1.5.2 linux/amd64 ``` #### 网络访问受限 1. 在有网络环境的机器上，Codis 源码目录中执行命令 `make godep`； + 该操作会将 Codis 编译所依赖的第三方源码下载到 `Godeps/_workspace` 目录下； 2. 在目标环境中，按照之前步骤配置好编译环境； + 离线安装 go 以及 godep 工具； 3. 将处理过的 Codis 目录完整复制到访问受限的服务器的正确的路径下，执行 `make` 进行源码编译。 #### 离线安装 godep 方法： 1. 运行 `git clone https://github.com/tools/godep.git` 下载 godep 源码； 2. 将 godep 目录移动到 `$GOPATH/src/github.com/tools/godep`，并进入该目录； 3. 运行命令 `go install ./`，该命令会将 godep 生成到 `$GOPATH/bin` 下。 ## 1. 快速启动 源码中提供了可供本地测试使用的脚本 `scripts/demo.sh`，该脚本会生成一个本地集群。 **注意：脚本依赖 etcd 作为外部存储，启动时会创建一个占用 2379 端口的 etcd 实例；如果本地已经存在该实例，会导致可能污染该实例（写入测试程序所需配置文件）并最终启动失败。** + 脚本会输出每一个进程的 PID，并将每个实例的日志会输出到 `tmp` 目录下； + 启动后，可以通过 http://127.0.0.1:8080 来访问 codis-fe。 ```bash $ which etcd &>/dev/null || go get github.com/coreos/etcd $ bash demo.sh etcd.pid=81455 codis-server-16379.pid=81456 ... ... proxy-11080x19000.pid=81465 ... ... dashboard.pid=81473 fe.pid=81475 done Mon Jan 4 15:10:44 CST 2016 Mon Jan 4 15:11:14 CST 2016 ... ... ``` ## 2. 启动及参数 **注意：请按照顺序逐步完成操作。默认使用 `zookeeper` 作为外部存储。** **注意：Codis 3.x 支持 AUTH，但是要求所有组件使用的 AUTH 必须完全相同。** #### 2.1 Codis Dashboard ##### 2.1.1 启动命令： ```bash $ nohup ./bin/codis-dashboard --ncpu=4 --config=dashboard.toml \ --log=dashboard.log --log-level=WARN & ``` 默认配置文件 `dashboard.toml` 可由 codis-dashboard 生成。 ##### 2.1.2 详细说明： + 启动参数说明： ```bash $ ./bin/codis-dashboard -h Usage: codis-dashboard [--ncpu=N] [--config=CONF] [--log=FILE] [--log-level=LEVEL] [--host-admin=ADDR] codis-dashboard --default-config codis-dashboard --version Options: --ncpu=N 最大使用 CPU 个数 -c CONF, --config=CONF 指定启动配置文件 -l FILE, --log=FILE 设置 log 输出文件 --log-level=LEVEL 设置 log 输出等级：INFO,WARN,DEBUG,ERROR；默认INFO，推荐WARN ``` 参数 `--host-admin` 请参见与 Docker 有关章节。 + 默认配置文件： ```bash $ ./bin/codis-dashboard --default-config | tee dashboard.toml ################################################## # # # Codis-Dashboard # # # ################################################## # Set Coordinator, only accept "zookeeper" & "etcd" coordinator_name = "zookeeper" coordinator_addr = "127.0.0.1:2181" # Set Codis Product {Name/Auth}. product_name = "codis-demo" product_auth = "" # Set bind address for admin(rpc), tcp only. admin_addr = "0.0.0.0:18080" ``` | 参数 | 说明 | |:----------------- |:---------------------------------- | | coordinator\_name | 外部存储类型，接受 zookeeper/etcd | | coordinator\_addr | 外部存储地址 | | product\_name | 集群名称，满足正则 `\w[\w\.\-]*` | | product\_auth | 集群密码，默认为空 | | admin\_addr | RESTful API 端口 | #### 2.2 Codis Proxy ##### 2.2.1 启动命令： ```bash $ nohup ./bin/codis-proxy --ncpu=4 --config=proxy.toml \ --log=proxy.log --log-level=WARN & ``` 默认配置文件 `proxy.toml` 可由 codis-proxy 生成。 codis-proxy 启动后，处于 `waiting` 状态，监听 `proxy_addr` 地址，但是不会 `accept` 连接，添加到集群并完成集群状态的同步，才能改变状态为 `online`。添加的方法有以下两种： + 通过 codis-fe 添加：通过 `Add Proxy` 按钮，将 `admin_addr` 加入到集群中； + 通过 codis-admin 命令行工具添加，方法如下： ```bash $ ./bin/codis-admin --dashboard=127.0.0.1:18080 --create-proxy -x 127.0.0.1:11080 ``` 其中 `127.0.0.1:18080` 以及 `127.0.0.1:11080` 分别为 dashboard 和 proxy 的 `admin_addr` 地址； 添加过程中，dashboard 会完成如下一系列动作： + 获取 proxy 信息，对集群 name 以及 auth 进行验证，并将其信息写入到外部存储中； + 同步 slots 状态； + 标记 proxy 状态为 `online`，此后 proxy 开始 `accept` 连接并开始提供服务； ##### 2.2.2 详细说明： + 启动参数说明： ```bash $ ./bin/codis-proxy -h Usage: codis-proxy [--ncpu=N] [--config=CONF] [--log=FILE] [--log-level=LEVEL] [--host-admin=ADDR] [--host-proxy=ADDR] [--ulimit=NLIMIT] codis-proxy --default-config codis-proxy --version Options: --ncpu=N 最大使用 CPU 个数 -c CONF, --config=CONF 指定启动配置文件 -l FILE, --log=FILE 设置 log 输出文件 --log-level=LEVEL 设置 log 输出等级：INFO,WARN,DEBUG,ERROR；默认INFO，推荐WARN --ulimit=NLIMIT 检查 ulimit -n 的结果，确保运行时最大文件描述不少于 NLIMIT ``` 参数 `--host-proxy` 以及 `--host-admin` 请参见与 Docker 有关章节。 + 默认配置文件： ```bash $ ./bin/codis-proxy --default-config | tee proxy.toml ################################################## # # # Codis-Proxy # # # ################################################## # Set Codis Product {Name/Auth}. product_name = "codis-demo" product_auth = "" # Set bind address for admin(rpc), tcp only. admin_addr = "0.0.0.0:11080" # Set bind address for proxy, proto_type can be "tcp", "tcp4", "tcp6", "unix" or "unixpacket". proto_type = "tcp4" proxy_addr = "0.0.0.0:19000" # Set jodis address & session timeout. jodis_addr = "" jodis_timeout = 10 # Proxy will ping-pong backend redis periodly to keep-alive backend_ping_period = 5 # If there is no request from client for a long time, the connection will be droped. Set 0 to disable. session_max_timeout = 1800 # Buffer size for each client connection. session_max_bufsize = 131072 # Number of buffered requests for each client connection. # Make sure this is higher than the max number of requests for each pipeline request, or your client may be blocked. session_max_pipeline = 1024 # Set period between keep alives. Set 0 to disable. session_keepalive_period = 60 ``` | 参数 | 说明 | |:--------------------------- |:-------------------------------------------------------- | | product\_name | 集群名称，参考 dashboard 参数说明 | | product\_auth | 集群密码，默认为空 | | admin\_addr | RESTful API 端口 | | proto\_type | Redis 端口类型，接受 tcp/tcp4/tcp6/unix/unixpacket | | proxy\_addr | Redis 端口地址或者路径 | | jodis\_addr | Jodis 注册 zookeeper 地址 | | jodis\_timeout | Jodis 注册 session timeout 时间，单位 second | | backend\_ping\_period | 与 codis-server 探活周期，单位 second，0 表示禁止 | | session\_max\_timeout | 与 client 连接最大读超时，单位 second，0 表示禁止 | | session\_max\_bufsize | 与 client 连接读写缓冲区大小，单位 byte | | session\_max\_pipeline | 与 client 连接最大的 pipeline 大小 | | session\_keepalive\_period | 与 client 的 tcp keepalive 周期，仅 tcp 有效，0 表示禁止 | #### 2.3 Codis Server + 启动 ./bin/codis-server，与启动普通 redis 的方法一致。 + 启动完成后，可以通过 codis-fe 提供的界面或者 codis-admin 命令行工具添加到集群中。 #### 2.4 Codis FE（可选组件） ##### 2.4.1 启动命令： ```bash $ nohup ./bin/codis-fe --ncpu=4 --log=fe.log --log-level=WARN \ --dashboard-list=codis.json --listen=127.0.0.1:8080 & ``` ##### 2.4.2 详细说明： + 启动参数说明： ```bash $ ./bin/codis-fe -h Usage: codis-fe [--ncpu=N] [--log=FILE] [--log-level=LEVEL] --dashboard-list=LIST --listen=ADDR codis-fe --version Options: --ncpu=N 最大使用 CPU 个数 -d LIST, --dashboard-list=LIST 配置文件，能够自动刷新 -l FILE, --log=FILE 设置 log 输出文件 --log-level=LEVEL 设置 log 输出等级：INFO,WARN,DEBUG,ERROR；默认INFO，推荐WARN --listen=ADDR HTTP 服务端口 ``` 配置文件 codis.json 可以手动编辑，也可以通过 codis-admin 从外部存储中拉取，例如： ```bash $ ./bin/codis-admin --dashboard-list --zookeeper=127.0.0.1:2181 | tee codis.json [ { "name": "codis-demo", "dashboard": "127.0.0.1:18080" }, { "name": "codis-demo2", "dashboard": "127.0.0.1:28080" } ] ``` #### 2.5 Codis HA（可选组件） ##### 2.5.1 启动命令： ```bash $ nohup ./bin/codis-fe --log=ha.log --log-level=WARN --dashboard=127.0.0.1:18080 & ``` ##### 2.5.2 详细说明： ```bash $ ./bin/codis-ha -h Usage: codis-ha [--log=FILE] [--log-level=LEVEL] --dashboard=ADDR codis-ha --version Options: -l FILE, --log=FILE 设置 log 输出文件 --log-level=LEVEL 设置 log 输出等级：INFO,WARN,DEBUG,ERROR；默认INFO，推荐WARN ``` ##### 2.5.3 工作原理： **注意：Codis HA 工具仅仅是 Codis 集群 HA 的一部分，单独工作能力有限。** + 以 5s 为周期，codis-ha 会从 codis-dashboard 中拉取集群状态，并根据集群状态生成主从切换策略； + 当集群中 codis-server 出现故障时，codis-ha 会根据之前确定的替换策略，向 codis-dashboard 发出主从切换指令； + codis-ha 在以下状态下会退出： 1. 从 codis-dashboard 获取集群状态失败时； 2. 向 codis-dashboard 发送主从切换指令失败时； + codis-ha 在以下状态下无法为 group 生成替换策略： 1. group 中没有健康的 codis-server 时； 2. group 中所有健康的 codis-server 都不满足如下条件时： + `slave.master == group.master && slave.master_status == up` + codis-ha 在以下状态下无法应用替换策略： 1. 存在 proxy 状态异常； + 因为主从切换需要全部 proxy 确认，因此如果 proxy 状态异常必然导致主从切换失败； 2. 故障 codis-server 所在 group 没有可靠替换策略时； **注意：因此，应用 codis-ha 时还需要结合对 codis-proxy 和 codis-server 的可用性监控，否则 codis-ha 无法保证可靠性。** #### 2.6 Codis Admin（命令行工具） **注意：使用 codis-admin 是十分危险的。** ##### 2.6.1 codis-dashboard 异常退出的修复 当 codis-dashboard 启动时，会在外部存储上存放一条数据，用于存储 dashboard 信息，同时作为 LOCK 存在。当 codis-dashboard 安全退出时，会主动删除该数据。当 codis-dashboard 异常退出时，由于之前 LOCK 未安全删除，重启往往会失败。因此 codis-admin 提供了强制删除工具： 1. 确认 codis-dashboard 进程已经退出（**很重要**）； 2. 运行 codis-admin 删除 LOCK： ```bash $ ./bin/codis-admin --remove-lock --product=codis-demo --zookeeper=127.0.0.1:2181 ``` ##### 2.6.2 codis-proxy 异常退出的修复 通常 codis-proxy 都是通过 codis-dashboard 进行移除，移除过程中 codis-dashboard 为了安全会向 codis-proxy 发送 `offline` 指令，成功后才会将 proxy 信息从外部存储中移除。如果 codis-proxy 异常退出，该操作会失败。此时可以使用 codis-admin 工具进行移除： 1. 确认 codis-proxy 进城已经退出（**很重要**）； 2. 运行 codis-admin 删除 proxy： ```bash $ ./bin/codis-admin --dashboard=127.0.0.1:18080 --remove-proxy --addr=127.0.0.1:11080 --force ``` 选项 `--force` 表示，无论 `offline` 操作是否成功，都从外部存储中将该节点删除。所以操作前，一定要确认该 codis-proxy 进程已经退出。 ## 3. Jodis 与 HA 因为 codis-proxy 是无状态的，可以比较容易的搭多个实例，达到高可用性和横向扩展。 对 Java 用户来说，可以使用基于 Jedis 的实现 [Jodis](https://github.com/CodisLabs/jodis) ，来实现 proxy 层的 HA： + 它会通过监控 zookeeper 上的注册信息来实时获得当前可用的 proxy 列表，既可以保证高可用性； + 也可以通过轮流请求所有的proxy实现负载均衡。 如果需要异步请求，可以使用我们基于Netty开发的 [Nedis](https://github.com/CodisLabs/nedis)。 对下层的 redis 实例来说，当一个 group 的 master 挂掉的时候，应该让管理员清楚，并手动的操作，因为这涉及到了数据一致性等问题（redis的主从同步是最终一致性的）。因此 codis 不会自动的将某个 slave 升级成 master。关于外部 codis-ha 工具（具体可以参考之前的章节），这是一个通过 codis-dashboard 开放的 RESTful API 实现自动切换主从的工具。该工具会在检测到 master 挂掉的时候主动应用主从切换策略，提升单个 slave 成为新的 master。 需要注意，codis 将其中一个 slave 升级为 master 时，该组内其他 slave 实例是不会自动改变状态的，这些 slave 仍将试图从旧的 master 上同步数据，因而会导致组内新的 master 和其他 slave 之间的数据不一致。因此当出现主从切换时，需要管理员手动创建新的 sync action 来完成新 master 与 slave 之间的数据同步（codis-ha 不提供自动操作的工具，因为这样太不安全了）。 ## 4. Docker 部署 Codis 3.x 起，开始正式支持 Docker 部署。这就需要 codis-dashboard 以及 codis-proxy 能够外部的 `listen` 地址暴露出来并保存在外部存储中。 + codis-proxy 增加了 `--host-admin` 以及 `--host-proxy` 参数； + codis-dashboard 增加了 `--host-admin` 参数； 以 codis-proxy 的 Docker 为例： ```bash $ docker run --name "Codis-Proxy" -d -p 29000:19000 -p 21080:11080 codis-image \ codis-proxy -c proxy.toml --host-admin 100.0.1.100:29000 --host-proxy 100.0.1.100:21080 ``` codis-proxy 在启动后，会使用 `--host-admin` 和 `--host-proxy` 参数所指定的实际地址替换 Docker 内监听的地址，向 codis-dashboard 注册。这样，例如使用 Jodis 的过程中，客户端就能够通过 `100.0.1.100:29000` 来访问 proxy 实例。 codis-dashboard 也是相同的道理，会使用 `--host-admin` 地址向外部存储注册，这样 codis-fe 也能通过该地址正确的对 codis-dashboard 进行操作。 具体样例可以参考 `scripts/docker.sh`。 ## 5. 从Codis 2.x 升级 Codis 3.x 修改了 codis-dashboard 与 codis-proxy 之间的通信方式，因此 Codis 2.x 并不兼容。但是我们提供了手动升级方案。 **注意1：升级时，需要保证所有 slot 都处在 `online` 状态。即没有任何数据迁移操作正在进行。** **注意2：升级完成后，需要手动关闭 Codis 2.x 的所有 proxy 和 config 组件。** #### step 1. 导出配置文件 ```bash $ ./bin/codis-admin --config-dump --product=codis_v2.0 --zookeeper=127.0.0.1:2181 -1 | tee codis_v2.0.json ``` 该命令会从 zookeeper 上拉取 `/zk/codis/db_codis_v2.0` 下全部的文件，并组织成 json 格式并输出。 选项 `-1` 表示配置文件是 Codis 1.x 版本，缺省是 Codis 3.x 版本。 #### step 2. 转换配置文件 ```bash $ ./bin/codis-admin --config-convert codis_v2.0.json | tee codis_v3.0.json ``` 该命令会将 Codis 1.x 版本的配置文件中有效信息提取出来，并转成 Codis 3.x 版本的配置文件并输出。 #### step 3. 更新配置文件 **注意：更新配置文件时，请确保 Codis 3.x 中该集群不存在，否则可能导致更新失败或者集群状态异常。** ```bash $ ./bin/codis-admin --config-restore=codis_v3.0.json --product=codis_v3.0 --zookeeper=127.0.0.1:2181 --confirm ``` 该命令会将 Codis 3.x 版本的配置文件提交到 `/codis3/codis_v3.0` 目录下。 选项 `--confirm` 选项表示确认提交，缺省时该命令仅仅打印配置文件作为调试。 #### step 4. 启动 Codis 3.x dashboard 以及 proxy 过程参考之前章节。因为集群信息已经存在，所以可以安全启动 codis-dashboard，并逐一添加 codis-proxy 到集群中。 #### step 5. 关闭 Codis 2.x dashboard 以及 proxy Codis 3.x 的组件兼容 Jodis 协议。 因为 Codis 2.x 与 Codis 3.x 在外部存储中的组织结构不同，所以可以安全的 `kill` 掉全部 Codis 2.x 组件。 **注意：关闭过程请不要使用 `kill -9`，因为旧组件在退出时会自动清理部分注册信息。**