介绍
nginx-upsync-module
是由王晓开用C开发的nginx模块,用于从consul或其它同步upstream模块配置,动态修改后端服务属性(weight、max_fails等等)。修改这些信息后,不像未使用该模块的nginx一样需要reload下nginx。
nginx在作为负载均衡角色时,对于单台nginx,增加、删除后端服务,对于进行单台的nginx,修改nginx配置文件后,要想配置文件生效,必须reload下nginx,这是很方便的。但是对于一个十几台或者几十台的nginx集群,要实现这是一个很大的一个工作量。并且reload nginx会增加系统负载也会暂时降低性能。
nginx-upsync-module
可以很容易解决上面所提到的问题,并且也不会影响性能。 该模块现在仍处于开发,不过已经准备用于生产环境。建议和后端健康检测模块nginx_upstream_check_module
配合使用。
兼容性
master分支兼容1.9版本及以上的nginx。nginx-upsync-1.8.x兼容1.8版本的nginx。
优势
该模块提供了发现后端的方法。支持通过consul动态添加和删除后端服务和调整后端服务的weight
、fail_timeout
、max_fails
等属性。也会从consul
获取新的后端服务并同步到nginx的IP路由表。该模块具有以下优势:
- 及时性
会发送给consul
带有索引的key,consul会将该索引和consul的索引进行对比,如果索引没有改变,链接会挂起5分钟,在这期间,对该key-value的任何操作,都会立马得到反馈。 - 几乎无性能损失
从consul获取后端服务器列表,对于nginx来说就相当于一个请求。更新nginx的IP路由表,不需要reload nginx,因此只会对nginx的性能有一点影响。 - 稳定
如果这次获取服务器失败,在下一个同步间隔仍会获取服务器列表。这样就保证了后端服务提供服务的稳定性。同时,支持将最近的配置文件备份到本地,即使consul故障宕机了,nginx仍可以随时可以reload配置。 - 健康检测
该模块支持对后端服务的健康检测,不过需要nginx_upstream_check_module
。因此建议nginx-upsync-module
和nginx_upstream_check_module
配合使用。
配置参数
- upsync
语法:upsync $consul.api.com:$port/v1/kv/upstreams/$upstream_name [upsync_type=consul] [upsync_interval=seconds/minutes] [upsync_timeout=seconds/minutes] [strong_dependency=off/on]; 默认:upsync_interval=5s upsync_timeout=6m strong_dependency=off 位置:upstream 功能:从consul或etcd获取服务列表
参数解释
upsync_interval:
从consul获取服务列表的间隔时间
upsync_timeout
从consul获取服务列表的请求超时时间
upsync_type
指定从什么类型的服务(consul或etcd)获取服务列表。
strong_dependency
nginx启动是否强制依赖upsync_type指定的服务的开关。如果upsync_type指定的是consul,在nginx启动是,consul并未运行,那么nginx启动会失败。 - upsync_dump_path
语法: upsync_dump_path $path; 默认:/tem/servers_$host.conf 位置:upstream 功能:备份upstream配置的后端服务器到指定的路径下
- upsync_lb
语法:upsync_lb round_robin/ip_hash/hash 默认:round_robin 位置:upstream 功能:指定使用的调度方法
- upstream_show
语法:upstream_show; 默认:None 位置:location 功能:列出指定的upstream配置的所有后端服务器
更多精彩请关注微信公众号: