技术

对容器云平台的理解 Prometheus 源码分析 并发的成本 基础设施优化 hashicorp raft源码学习 docker 架构 mosn细节 与微服务框架整合 Java动态代理 编程范式 并发通信模型 《网络是怎样连接的》笔记 go细节 codereview mat使用 jvm 线程实现 go打包机制 go interface及反射 如何学习Kubernetes 《编译原理之美》笔记——后端部分 《编译原理之美》笔记——前端部分 Pilot MCP协议分析 go gc 内存管理玩法汇总 软件机制 istio流量管理 Pilot源码分析 golang io 学习Spring mosn源码浅析 MOSN简介 《datacenter as a computer》笔记 学习JVM Tomcat源码分析 Linux可观测性 MVCC 学习存储 学计算 Gotty源码分析 kubernetes operator kaggle泰坦尼克问题实践 kubernetes自动扩容缩容 神经网络模型优化 直觉上理解机器学习 knative入门 如何学习机器学习 神经网络系列笔记 TIDB源码分析 《阿里巴巴云原生实践15讲》笔记 Alibaba Java诊断工具Arthas TIDB存储——TIKV 《Apache Kafka源码分析》——简介 netty中的线程池 guava cache 源码分析 Springboot 启动过程分析 Spring 创建Bean的年代变迁 Linux内存管理 自定义CNI IPAM 扩展Kubernetes 副本一致性 spring redis 源码分析 kafka实践 spring kafka 源码分析 Linux进程调度 让kafka支持优先级队列 Codis源码分析 Redis源码分析 C语言学习 《趣谈Linux操作系统》笔记 docker和k8s安全机制 jvm crash分析 Kubernetes监控 Kubernetes 控制器模型 Prometheus 学习 容器日志采集 容器狂占cpu怎么办? Kubernetes资源调度——scheduler 时序性数据库介绍及对比 influxdb入门 maven的基本概念 《Apache Kafka源码分析》——server Kubernetes objects之编排对象 源码分析体会 《数据结构与算法之美》——算法新解 Kubernetes源码分析——controller mananger Kubernetes源码分析——apiserver Kubernetes源码分析——kubelet Kubernetes介绍 ansible学习 Kubernetes源码分析——从kubectl开始 jib源码分析之Step实现 kubernetes实践 jib源码分析之细节 线程排队 跨主机容器通信 jib源码分析及应用 为容器选择一个合适的entrypoint kubernetes yaml配置 《持续交付36讲》笔记 mybatis学习 程序猿应该知道的 无锁数据结构和算法 CNI 为什么很多业务程序猿觉得数据结构和算法没用? 串一串一致性协议 当我在说PaaS时,我在说什么 《数据结构与算法之美》——数据结构笔记 PouchContainer技术分享体会 harbor学习 用groovy 来动态化你的代码 《深入剖析kubernetes》笔记 精简代码的利器——lombok 学习 编程语言的动态性 rxjava3——背压 rxjava2——线程切换 spring cloud 初识 《深入拆解java 虚拟机》笔记 《how tomcat works》笔记 hystrix 学习 rxjava1——概念 Redis 学习 TIDB 学习 分布式计算系统的那些套路 Storm 学习 AQS1——论文学习 Unsafe Spark Stream 学习 linux vfs轮廓 mysql 批量操作优化 《自己动手写docker》笔记 java8 实践 中本聪比特币白皮书 细读 区块链泛谈 比特币 大杂烩 总纲——如何学习分布式系统 hbase 泛谈 forkjoin 泛谈 看不见摸不着的cdn是啥 《jdk8 in action》笔记 程序猿视角看网络 bgp初识 calico学习 AQS2——粗略的代码分析 我们能用反射做什么 web 跨域问题 《clean code》笔记 硬件对软件设计的影响 《Elasticsearch权威指南》笔记 mockito简介及源码分析 2017软件开发小结—— 从做功能到做系统 《Apache Kafka源码分析》——clients dns隐藏的一个坑 《mysql技术内幕》笔记2 《mysql技术内幕》笔记1 log4j学习 为什么netty比较难懂? 回溯法 apollo client源码分析及看待面向对象设计 学习并发 docker 环境(主要运行java项目)常见问题 Scala的一些梗 OpenTSDB 入门 spring事务小结 事务一致性 javascript应用在哪里 《netty in action》读书笔记 netty对http2协议的解析 ssl证书是什么东西 http那些事 苹果APNs推送框架pushy apple 推送那些事儿 编写java框架的几大利器 java内存模型 java exception Linux IO学习 network channel network byte buffer 测试环境docker化实践 netty(七)netty在框架中的使用套路 Nginx简单使用 《Linux内核设计的艺术》小结 Go并发机制及语言层工具 Macvlan Linux网络源代码学习——数据包的发送与接收 《docker源码分析》小结 docker中涉及到的一些linux知识 hystrix学习 Linux网络源代码学习——整体介绍 zookeeper三重奏 数据库的一些知识 Spark 泛谈 链式处理的那些套路 netty(六)netty回顾 Thrift基本原理与实践(二) Thrift基本原理与实践(一) 回调 异步执行抽象——Executor与Future Docker0.1.0源码分析 java gc Jedis源码分析 Redis概述 机器学习泛谈 Linux网络命令操作 JTA与TCC 换个角度看待设计模式 Scala初识 向Hadoop学习NIO的使用 以新的角度看数据结构 并发控制相关的硬件与内核支持 systemd 简介 异构数据库表在线同步 quartz 源码分析 基于docker搭建测试环境(二) spring aop 实现原理简述 自己动手写spring(八) 支持AOP 自己动手写spring(七) 类结构设计调整 分析log日志 自己动手写spring(六) 支持FactoryBean 自己动手写spring(九) 总结 自己动手写spring(五) bean的生命周期管理 自己动手写spring(四) 整合xml与注解方式 自己动手写spring(三) 支持注解方式 自己动手写spring(二) 创建一个bean工厂 自己动手写spring(一) 使用digester varnish 简单使用 关于docker image的那点事儿 基于docker搭建测试环境 分布式配置系统 JVM内存与执行 git spring rmi和thrift maven/ant/gradle使用 再看tcp 缓存系统 java nio的多线程扩展 《Concurrency Models》笔记 回头看Spring IOC IntelliJ IDEA使用 Java泛型 vagrant 使用 Go常用的一些库 Python初学 Goroutine 调度模型 虚拟网络 《程序员的自我修养》小结 VPN(Virtual Private Network) Kubernetes存储 Kubernetes 其它特性 访问Kubernetes上的Service Kubernetes副本管理 Kubernetes pod 组件 使用etcd + confd + nginx做动态负载均衡 如何通过fleet unit files 来构建灵活的服务 CoreOS 安装 CoreOS 使用 Go学习 JVM类加载 硬币和扑克牌问题 LRU实现 virtualbox 使用 ThreadLocal小结 docker快速入门

标签


使用etcd + confd + nginx做动态负载均衡

2015年02月14日

简介

原文地址:[How To Use Confd and Etcd to Dynamically Reconfigure Services in CoreOS](https://www.digitalocean.com/community/tutorials/how-to-use-confd-and-etcd-to-dynamically-reconfigure-services-in-coreos “”),有删改。

CoreOS可以让我们在一个集群中很方便的运行docker contaienr 服务。我们通常启动一个或多个实例,并将这些实例注册到etcd中(etcd是CoreOS使用的一种分布式存储系统)。利用这个过程,相关的服务可以获取到架构的状态信息,今儿改变自己的行为。也就是说,当etcd中的数据改变时,相关服务可以动态的改变自己的配置。

在这个guide中,我们将讨论使用一个叫做confd的工具,专为监听分布式键-值存储系统的变化。它运行在一个container中,用来改变配置和重启服务。

Creating the Nginx Container

Installing the Software

通过docker run -i -t ubuntu:14.04 /bin/bash启动一个新的contaienr。更新apt缓存,安装Nginx和curl。同时,从github中获取confd的安装包。

apt-get update
apt-get install nginx curl -y

通过浏览器进入github,浏览confd的release page,找到最新的版本,撰写本文时,confd最新为v.0.5.0,右键复制链接地址。回到docker container中,使用复制的链接下载confd,并将其放在/usr/local/bin目录下。为confd文件添加可执行权限,同时在/etc下为confd创建configuration structure:

mkdir -p /etc/confd/conf.d
mkdir -p /etc/confd/templates

Create a Confd Configuration File to Read Etcd Values

现在,我们所需的应用已经安装完毕了,我们开始配置confd,创建一个配置文件或是模板文件。

confd的配置文件是建立一个服务,监控特定的etcd的键值以及当值发生变化时执行某些操作。其文件格式是TOML,易于使用,(其规则)跟人的直觉也相近。

首先我们先创建一个名为nginx.toml的配置文件vi /etc/confd/conf.d/nginx.toml,文件内容如下:

[template]
# The name of the template that will be used to render the application's configuration file
# Confd will look in `/etc/conf.d/templates` for these files by default
src = "nginx.tmpl"

# The location to place the rendered configuration file
dest = "/etc/nginx/sites-enabled/app.conf"

# The etcd keys or directory to watch.  This is where the information to fill in
# the template will come from.
keys = [ "/services/apache" ]

# File ownership and mode information
owner = "root"
mode = "0644"

# These are the commands that will be used to check whether the rendered config is
# valid and to reload the actual service once the new config is in place
check_cmd = "/usr/sbin/nginx -t"
reload_cmd = "/usr/sbin/service nginx reload"
Directive Required? Type Description
src Yes String The name of the template that will be used to render the information. If this is located outside of "/etc/confd/templates", the entire path is should be used.
dest Yes String The file location where the rendered configuration file should be placed.
keys Yes Array of strings The etcd keys that the template requires to be rendered correctly. This can be a directory if the template is set up to handle child keys.
owner No String The username that will be given ownership of the rendered configuration file.
group No String The group that will be given group ownership of the rendered configuration file.
mode No String The octal permissions mode that should be set for the rendered file.
check_cmd No String The command that should be used to check the syntax of the rendered configuration file.
reload_cmd No String The command that should be used to reload the configuration of the application.
prefix No String A part of the etcd hierarchy that comes before the keys in the keys directive. This can be used to make the .toml file more flexible.

这个文件指出了我们的confd如何工作,我们的Nginx contaienr使用/etc/confd/templates/nginx.tmpl来渲染并生成/etc/nginx/sites-enabled/app.conf,文件的权限的0644,所有者为root。

confd将监控/services/apache(etcd路径)的变化。当发生变化时,confd将查询/services/apache节点的信息,并为Nginx渲染一个新的配置文件,检查该配置文件的语法并重启Nginx服务(以应用新的配置文件)。 接下来,我们创建一个实际的confd template文件。(confd)用它来渲染Nginx配置文件。

Create a Confd Template File

创建我们在/etc/confd/conf.d/nginx.toml提到的模板文件,将其放在/etc/confd/templates目录下。vi /etc/confd/templates/nginx.tmpl

在这个文件中,我们只是简单的重写了一个标准的Nginx反向代理配置文件。但是,我们使用一些Go 模板语法来代替confd从etcd中拉取的信息。

首先,我们配置”upstream” servers block(代码块,配置块)。这个小节定义了Nginx可以发送请求的服务器池。格式如下

upstream pool_name {
    server server_1_IP:port_num;
    server server_2_IP:port_num;
    server server_3_IP:port_num;
}

This allows us to pass requests to the pool_name and Nginx will select one of the defined servers to hand the request to.

对于template文件来说,不是静态的定义upstream servers,这些信息在渲染时再动态的填充(我们从etcd中获取apache服务器的ip地址和端口)。我们先用Go template来表示这些动态内容。

upstream apache_pool {
{ { range getvs "/services/apache/*" } }
    server { { . } };
{ { end } }
}

我们定义了一个upstream pool of servers 叫做apache_pool,在这个快内,我们用双大括号表示里面填充的是Go代码。

在大括号里,我们指定了我感兴趣的信息所在的etcd节点,并使用range来遍历它们。(具体可以参见GO语法)

设置完server pool之后,我们可以设置一个proxy pass将所有的请求导向这个pool。于是一个标准的反向代理的server block就好了。

upstream apache_pool {
{ { range getvs "/services/apache/*" } }
    server { { . } };
{ { end } }
}

server {
    listen 80 default_server;
    listen [::]:80 default_server ipv6only=on;

    access_log /var/log/nginx/access.log upstreamlog;

    location / {
        proxy_pass http://apache_pool;
        proxy_redirect off;
        proxy_set_header Host $host;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
    }
}

同时还要记着移除默认的nginx文件

rm /etc/nginx/sites-enabled/default

同时还要配置下日志的格式(我们在template文件中有引用到),这必须在http block中配置(在/etc/nginx/nginx.conf文件中)。

我们将添加一个log_format的directive来定义我们想要记录信息。它记录了客户端请求以及处理请求的服务端的信息,以及处理请求耗费的时间。

. . .
http {
    ##
    # Basic Settings
    ##
    log_format upstreamlog '[$time_local] $remote_addr passed to: $upstream_addr: $request Upstream Response Time: $upstream_response_time Request time: $request_time';

    sendfile on;
    . . .

Creating a Script to Run Confd

我们需要创建一个脚本文件,以在合适的时机触发confd来操作template resource文件和template文件。

这个脚本必须做两件事:

  • 在nginx根据后端(提供服务的所有server)情况启动之前运行
  • 必须能够持续监控etcd的变化,重新配置nginx,以确保为nginx配置的后端server都是可用的。

我们将该文件命名为confd-watch,跟confd 可执行文件放在一个目录下(/usr/local/bin)。

首先,我们制定bash作为解释器,并为bash设置一些参数,确保其如果执行时发生错误,会立即退出,并返回最后执行指令的返回值。

接下来,我们设置一些变量。通过使用bash parameter substitution(参数替换),我们先设置默认值,当执行脚本时再替换硬编码的值。 This will basically just set up each component of the connection address independently and then group them together to get the full address needed.

The parameter substitution is created with this syntax: ${var_name:-default_value}. This has the property of using the value of var_name if it is given and not null, otherwise defaulting to the default_value.

我们设置了etcd的默认值,这样,脚本没有其他信息(执行时不输入参数)也可以正常工作。当然,必要的时候,也可以自定义参数的值。

#!/bin/bash

set -eo pipefail

export ETCD_PORT=${ETCD_PORT:-4001}
export HOST_IP=${HOST_IP:-172.17.42.1}
export ETCD=$HOST_IP:$ETCD_PORT

echo "[nginx] booting container. ETCD: $ETCD."

# Try to make initial configuration every 5 seconds until successful
until confd -onetime -node $ETCD -config-file /etc/confd/conf.d/nginx.toml; do
    echo "[nginx] waiting for confd to create initial nginx configuration."
    sleep 5
done

# Put a continual polling `confd` process into the background to watch
# for changes every 10 seconds
confd -interval 10 -node $ETCD -config-file /etc/confd/conf.d/nginx.toml &
echo "[nginx] confd is now monitoring etcd for changes..."

# Start the Nginx service using the generated config
echo "[nginx] starting nginx service..."
service nginx start

# Follow the logs to allow the script to continue running
tail -f /var/log/nginx/*.log

接下来,从etcd中读取数据,并使用cond实例化nginx的配置文件。我们会使用一个until循环来不停的执行这个操作。

为了防止etcd突然失效或者nginx 容器先于后端运行,这个循环是必要的。有了这个循环,脚本将不停的从etcd拉取数据直到可以(为nginx)构建一个有效的初始化配置为止。

单就confd而言,confd 命令执行一次就退出了(指的是onetime参数)。两次运行的间隔为5秒,为后端的服务器(将服务注册到etcd)留一点时间。我们连接etcd(指的是-node参数),其值可以是默认或者我们通过参数指定的。我们使用模板文件来描述我们想做什么(指的是-config-file参数)。

初始化配置完毕后,接下来是实现一个持久拉取数据的机制。我们要确保及时发现(后端)所有的变化并更新nginx。

我们再一次调用confd,这一次,我们设定一个轮询间隔,并让这条命令后台运行(这样它就可以一直运行)。因为(跟初始化过程的)目标的一样,我们为其配置了同样的etcd节点和template source文件。

之后,我们可以安全的启动nginx了。因为这个脚本由docker run命令触发(nginx和confd运行在一个容器中),我需要它保持运行( running in the foreground)以防容器退出。tail -f /var/log/nginx/*.log可以很好的做到这一点(我们也可以方便的查看日志信息)。

接着,便是为文件添加执行权限了。

chmod +x /usr/local/bin/confd-watch

Commit and Push the Container

将上述步骤制作的镜像(ubuntu + nginx + confd + 相关文件和脚本)制作成镜像并提交。

Build the Nginx Static Unit File

接下来就是为这个container 创建unit文件,然后通过fleet来控制它(从而提供负载均衡服务),unit文件命名为nginx_lb.service

[Unit]
Description=Nginx load balancer for web server backends

# Requirements
Requires=etcd.service
Requires=docker.service

# Dependency ordering
After=etcd.service
After=docker.service

[Service]
# Let the process take awhile to start up (for first run Docker containers)
TimeoutStartSec=0

# Change killmode from "control-group" to "none" to let Docker remove
# work correctly.
KillMode=none

# Get CoreOS environmental variables
EnvironmentFile=/etc/environment

# Pre-start and Start
## Directives with "=-" are allowed to fail without consequence
ExecStartPre=-/usr/bin/docker kill nginx_lb
ExecStartPre=-/usr/bin/docker rm nginx_lb
ExecStartPre=/usr/bin/docker pull user_name/nginx_lb
ExecStart=/usr/bin/docker run --name nginx_lb -p ${COREOS_PUBLIC_IPV4}:80:80 \
user_name/nginx_lb /usr/local/bin/confd-watch

# Stop
ExecStop=/usr/bin/docker stop nginx_lb

[X-Fleet]
Conflicts=nginx.service
Conflicts=apache@*.service

(unit小节略过),在service小节中,设置timeout和killmode,把/etc/environment文件拉进来(因为unit文件接下来的内容会用到)。然后依次是配置ExecStartPre,ExecStart和ExecStop。

在X-Fleet小节,为了让其有效的分派负载,我们要求该容器运行在没有运行负载平衡和后端服务器的主机上。

Running the Nginx Load Balancer

接下来便是,fleet如何控制其运行了。