Cloud Foundry中vmc tunnel与caldecott原理

在Cloud Foundry中，用户可以vmc create-service创建一个service instance，但是常规情况下，用户不能手动地进一步对service instance进行设计。以MySQL为例，用户可以创建一个MySQL instance，但是一般情况下，用户不能直接对整个MySQL的database进行schema设计，或者进行增删改查的操作。对于MySQL service instance的内部操作，都是由部署在Cloud Foundry上的app应用程序来完成的。

为了可以使得用户在Cloud Foundry外部，对该用户创建的service instance进行schema设计或者增删改查的操作，Cloud Foundry的指令客户端vmc通过vmc tunnel指令来实现。以MySQL为例，vmc tunnel最直接的功能就是：允许用户在Cloud Foundry外部的MySQL client对MySQL node上的service instance进行schema设计或者增删改查的操作。

该文档主要基于Cloud Foundry v1版本，vmc版本为0.3.18 。

以下是具体实现流程：

上图为vmc与Cloud Foundry的Cloud Controller，DEA，MySQL node等组件的交互图。该图的应用背景为：已经创建完一个MySQL instance，需要通过vmc tunnel来完成用户对该MySQL instance的内部操作。以下为vmc tunnel指令执行过程中所涉及的操作。

步骤1：用户通过vmc向Cloud Foundry部署一个app应用caldecott。vmc获取app应用的配置信息，并与该应用的程序代码发送给Cloud Foundry的Cloud Controller。

步骤2：Cloud Controller接受到用户的vmc请求后，成功在DEA上部署应用caldecott，并启动该应用。

步骤3：vmc发送绑定请求给Cloud Controller，将caldecott应用与需要执行内部操作的MySQL instance进行绑定。

步骤4：Cloud Controller将该MySQL instance的credentials与该应用的脚本，程序代码放在一起重新打包，并在DEA中启动。

以上4个步骤均为简单的vmc push以及vmc bind-service操作，了解的Cloud Foundry应用部署的开发者一定不会感到陌生。

以下是vmc如何通过caldecott应用与MySQL instance进行交互。在介绍实现机制之前，先来了解一下caldecott这个应用程序的功能与框架。

caldecott应用

首先该caldecott应用是一个sinatra框架的应用。在功能上，主要分为两个部分：第一，接收vmc发送来的http请求，并从该应用的环境变量中获取绑定的service instance的信息，并将这些service instance的credentials返回给vmc；第二，接受vmc的caldecott client发送来的建立tunnel请求，本身作为一个caldecott server建立与caldecott client的连接之后，将client发送来的内容再发给mysql server。以下为caldecott应用程序的大部分ruby代码：

# add vcap specific stuff to Caldecott
class VcapHttpTunnel < Caldecott::Server::HttpTunnel
  get '/info' do
    { "version" => '0.0.4' }.to_json
  end

  def self.get_tunnels
    super
  end

  get '/services' do
    services_env = ENV['VMC_SERVICES']
    return "no services env" if services_env.nil? or services_env.empty?
    services_env
  end

  get '/services/:service' do |service_name|
    services_env = ENV['VMC_SERVICES']
    not_found if services_env.nil?

    services = JSON.parse(services_env)
    service = services.find { |s| s["name"] == service_name }
    not_found if service.nil?
    service["options"].to_json
  end
end

VcapHttpTunnel.run!(:port => port, :auth_token => ENV["CALDECOTT_AUTH"])

紧接着步骤4，vmc通过应用caldecott操作MySQL instance：

步骤5：vmc通过restful请求，向caldecott索取已绑定service instance的credentials信息。

步骤6：caldecott从环境变量中读取service的credentials，并将其返回给vmc。

步骤7：vmc在用户的机器上开辟一个端口，并使用该端口，caldecott的url，service instance的host以及port来创建一条tunnel。创建的发起者为caldecott::client，该连接的接受者为caldecott::server，也就是部署在DEA上的caldecott应用的第二个功能，如以上代码继承部分与最后一行。其中vmc端的创建连接代码如下：

def start_tunnel(local_port, conn_info, auth)
      @local_tunnel_thread = Thread.new do
        Caldecott::Client.start({
          :local_port => local_port,
          :tun_url => tunnel_url,
          :dst_host => conn_info['hostname'],
          :dst_port => conn_info['port'],
          :log_file => STDOUT,
          :log_level => ENV["VMC_TUNNEL_DEBUG"] || "ERROR",
          :auth_token => auth,
          :quiet => true
        })
      end

      at_exit { @local_tunnel_thread.kill }
end

步骤8：caldecott应用作为一个caldecott::server，建立一条与MySQL server的TCPConnection。

以上的8个步骤，实现了Cloud Foundry的外部用户通过vmc与部署在Cloud Foundry上的应用caldecott建立与MySQL server的连接。

完成了以上的操作，当用户执行mysql指令时，执行“mysql --protocol=TCP --host=localhost --port=10000 --user=uQQMx1PDleAlh --password=p31HW4mHr7LVd d52a850c9721d4f30b1652fa438bbdc79”。其中10000为本机与caldecott创建tunnel的端口号，所以该请求会通过caldecott::client发给应用caldecott中的caldecott::server，而caldecott::server又会将请求发给MySQL server，最后由MySQL server解析执行并返回结果。

转载清注明出处。

这篇文档更多出于我本人的理解，肯定在一些地方存在不足和错误。希望本文能够对开始接触Cloud Foundry中service的人有些帮助，如果你对这方面感兴趣，并有更好的想法和建议，也请联系我。

我的邮箱：shlallen@zju.edu.cn

新浪微博：@莲子弗如清