Cloud Foundry中DEA启动应用实例时环境变量的使用

        在Cloud Foundry v2中，当应用用户须要启动应用的实例时。用户通过cf CLI向cloud controller发送请求，而cloud controller通过NATS向DEA转发启动请求。真正运行启动事宜的是DEA，DEA主要做的工作为启动一个warden container, 并将droplet等内容拷贝进入container内部。最后配置完指定的环境变量，在这些环境变量下启动应用的启动脚本。

        本文将从阐述Cloud Foundry中DEA怎样为应用实例的启动配置环境变量。

DEA接收应用启动请求及其运行流程

        在这部分，通过代码的形式来说明DEA对于应用启动请求的运行流程。

1. 首先DEA订阅对应主题的消息，主题为“dea.#{bootstrap.uuid}.start”，含义为“自身DEA的应用启动消息”：

         subscribe("dea.#{bootstrap.uuid}.start") do |message|
           bootstrap.handle_dea_directed_start(message)
         end

2. 当收到订阅主题之后，运行bootstrap.handle_dea_directed_start(message)，含义为“通过bootstrap类实例来处理应用的启动请求”：

       def handle_dea_directed_start(message)
         start_app(message.data)
       end

3. 能够觉得处理的入口。即为以上代码中的start_app方法：

       def start_app(data)
         instance = instance_manager.create_instance(data)
         return unless instance
   
         instance.start
       end

4. 在start_app方法中。首先通过instance_manager类实例来创建一个instance对象。通过运行instance实例的类方法start，能够看到自始至终。传递的參数的原始来源都是通过NATS消息传递来的message。也就是1中的message：

       def start(&callback)
         p = Promise.new do
           ……
           [
             promise_droplet,
             promise_container
           ].each(&:run).each(&:resolve)
           [
             promise_extract_droplet,
             promise_exec_hook_script('before_start'),
             promise_start
           ].each(&:resolve)
           ……
           p.deliver
         end

5. 当中真正关于应用启动的运行在promise_start方法中实现：

       def promise_start
         Promise.new do |p|
           env = Env.new(StartMessage.new(@raw_attributes), self)
           if staged_info
             command = start_command || staged_info['start_command']
             unless command
               p.fail(MissingStartCommand.new)
               next
             end
             start_script =
               Dea::StartupScriptGenerator.new(
                 command,
                 env.exported_user_environment_variables,
                 env.exported_system_environment_variables
               ).generate
           else
             start_script = env.exported_environment_variables + "./startup;
   exit"
           end
           response = container.spawn(start_script,
                                      container.resource_limits(self.file_descriptor_limit, NPROC_LIMIT))
           attributes['warden_job_id'] = response.job_id
           container.update_path_and_ip
           bootstrap.snapshot.save
           p.deliver
         end
       end

        能够看到在第5步中。DEA涉及到了应用的ENV环境变量等信息。最后通过container.spawn方法实现了应用的启动。

DEA环境变量的配置

        在以上步骤的第5步，首先创建了环境变量env = Env.new(StartMessage.new(@raw_attributes), self)。Env类的初始化方法例如以下：

    def initialize(message, instance_or_staging_task=nil)
      @strategy_env = if message.is_a? StagingMessage
        StagingEnv.new(message, instance_or_staging_task)
      else
        RunningEnv.new(message, instance_or_staging_task)
      end
    end

        可见。实际是创建了一个RunningEnv类的实例。參数主要为cloud controller发送来的信息。

        在promise_start方法中，创建env变量之后，通过推断staged_info来选择start_script变量的构建。

        如今分析staged_info的代码实现：

    def staged_info
      @staged_info ||= begin
        Dir.mktmpdir do |destination_dir|
          staging_file_name = 'staging_info.yml'
          copied_file_name = "#{destination_dir}/#{staging_file_name}"
          copy_out_request("/home/vcap/#{staging_file_name}", destination_dir)
          YAML.load_file(copied_file_name) if File.exists?(copied_file_name)
        end
      end
    end

        主要是通过指定路径，然后从路径中提取出变量。以下以一个ruby的应用为例，其staging_info.yml文件的内容为：

---
detected_buildpack: Ruby/Rack
start_command: bundle exec rackup config.ru -p $PORT

        因此，终于@staged_info的内容如上。在instance.start方法中，command为bundle exec rackup config.ru -p $PORT。

有了command变量之后，接着是构建start_script变量：

          start_script =
            Dea::StartupScriptGenerator.new(
              command,
              env.exported_user_environment_variables,
              env.exported_system_environment_variables
            ).generate

         能够看到，DEA通过StartupScriptGenerator类来创建start_script，当中參数为三个。第一个为刚才涉及到的command，后两个均须要通过env变量来生成。

        如今看exported_user_environment_variables方法的实现：

    def exported_user_environment_variables
      to_export(translate_env(message.env))
    end

        该方法实现从message中提取中属性为env的信息，作为用户的环境变量。

       

        进入env.exported_system_environment_variables的方法实现：

    def exported_system_environment_variables
      env = [
        ["VCAP_APPLICATION",  Yajl::Encoder.encode(vcap_application)],
        ["VCAP_SERVICES",     Yajl::Encoder.encode(vcap_services)],
        ["MEMORY_LIMIT", "#{message.mem_limit}m"]
      ]
      env << ["DATABASE_URL", DatabaseUriGenerator.new(message.services).database_uri] if message.services.any?

      to_export(env + strategy_env.exported_system_environment_variables)
    end

        可见在生成系统的环境变量的时候，首先创建一个env数组变量，当中有信息VCAP_APPLICATION, VCAP_SERVICES, MEMORY_LIMIT三种。当中VCAP_APPLICATION的信息例如以下：

    def vcap_application
      @vcap_application ||=
        begin
          hash = strategy_env.vcap_application

          hash["limits"] = message.limits
          hash["application_version"] = message.version
          hash["application_name"] = message.name
          hash["application_uris"] = message.uris
          # Translate keys for backwards compatibility
          hash["version"] = hash["application_version"]
          hash["name"] = hash["application_name"]
          hash["uris"] = hash["application_uris"]
          hash["users"] = hash["application_users"]

          hash
        end
    end

 
        这部分信息中包括了应用的name，uris，users，version等一系列内容。当中须要特别注意的是代码hash = strategy_env.vcap_application，该代码的作用为调用了RunningEnv类中vcap_application方法，例如以下：

   def vcap_application
      hash = {}
      hash["instance_id"] = instance.attributes["instance_id"]
      hash["instance_index"] = message.index
      hash["host"] = HOSTStartupScriptGenerator
      hash["port"] = instance.instance_container_port
      started_at = Time.at(instance.state_starting_timestamp)
      hash["started_at"] = started_at
      hash["started_at_timestamp"] = started_at.to_i
      hash["start"] = hash["started_at"]
      hash["state_timestamp"] = hash["started_at_timestamp"]
      hash
    end

        可见在以上代码中，vcap_application信息中记录了非常多关于应用实例的信息，包含instance_id, instance_index, host, port, started_at, started_at_timestamp, start, state_timestamp等。

        VCAP_SERVICES的信息例如以下：

     WHITELIST_SERVICE_KEYS = %W[name label tags plan plan_option credentials syslog_drain_url].freeze
    def vcap_services
      @vcap_services ||=
        begin
          services_hash = Hash.new { |h, k| h[k] = [] }

          message.services.each do |service|
            service_hash = {}
            WHITELIST_SERVICE_KEYS.each do |key|
              service_hash[key] = service[key] if service[key]
            end

            services_hash[service["label"]] << service_hash
          end

          services_hash
        end
    end

       这部分内容主要从message中寻找是否存在和WHITELIST_SERVICES_KEYS中值作为键的值，若存在的话，增加services_hash该变量。

        随后，DEA在执行代码env << ["DATABASE_URL", DatabaseUriGenerator.new(message.services).database_uri] if message.services.any?，该部分代码的作用主要要理解DatabaseUriGenerator的含义，这部分笔者仍不是非常清楚。

        再后来。DEA运行代码to_export(env + strategy_env.exported_system_environment_variables)，这部分的内容很重要，主要要进入strategy_env对象所在的类中查看exported_system_environment_variables方法：

    def exported_system_environment_variables
      env = [
        ["HOME", "$PWD/app"],
        ["TMPDIR", "$PWD/tmp"],
        ["VCAP_APP_HOST", HOST],
        ["VCAP_APP_PORT", instance.instance_container_port],
      ]
      env << ["PORT", "$VCAP_APP_PORT"]
      env
    end

        能够看到，这里主要包括执行信息的环境变量，比方说HOME文件夹，TMP暂时文件夹，应用实例执行的host地址，应用实例执行的port号。当中最为重要的就是应用实例执行的port号。在我的还有一篇博文Cloud Foundry中DEA与warden通信完毕应用port监听 中。有涉及到怎样通过warden server来开辟port，终于为DEA所用，并通过环境变量的形式传递给应用实例的启动脚本。当中VCAP_APP_PORT和PORT都是warden container开启那个port号。

        分析完了StartupScriptGenerator的三个參数，须要进入StartupScriptGenerator类的generate方法：

    def generate
      script = []
      script << "umask 077"
      script << @system_envs
      script << EXPORT_BUILDPACK_ENV_VARIABLES_SCRIPT
      script << @user_envs
      script << "env > logs/env.log"
      script << START_SCRIPT % @start_command
      script.join("
")
    end

        以上的代码即为创建启动脚本的过程。当中@system_envs为之前分析的env.exported_system_environment_variables, @user_envs为env.exported_user_environment_variables。

还有两个脚本是EXPORT_BUILDPACK_ENV_VARIABLES_SCRIPT和START_SCRIPT。EXPORT_BUILDPACK_ENV_VARIABLES_SCRIPT脚本的代码例如以下，其意为运行某路径下的全部sh脚本：

    EXPORT_BUILDPACK_ENV_VARIABLES_SCRIPT = strip_heredoc(<<-BASH).freeze
      unset GEM_PATH
      if [ -d app/.profile.d ]; then
        for i in app/.profile.d/*.sh; do
          if [ -r $i ]; then
            . $i
          fi
        done
        unset i
      fi
    BASH

        而START_SCRIPT代码例如以下：

    START_SCRIPT = strip_heredoc(<<-BASH).freeze
      DROPLET_BASE_DIR=$PWD
      cd app
      (%s) > >(tee $DROPLET_BASE_DIR/logs/stdout.log) 2> >(tee $DROPLET_BASE_DIR/logs/stderr.log >&2) &
      STARTED=$!
      echo "$STARTED" >> $DROPLET_BASE_DIR/run.pid

      wait $STARTED
    BASH

        以上即创建完了start_script，回到instance.rb中的promise_start方法中，即运行

response = container.spawn(start_script,
                                   container.resource_limits(self.file_descriptor_limit, NPROC_LIMIT))

        即完毕应用实例的启动工作。详情能够进入container类中的spawn方法实现。

关于作者：

孙宏亮。DAOCLOUD软件project师。两年来在云计算方面主要研究PaaS领域的相关知识与技术。坚信轻量级虚拟化容器的技术，会给PaaS领域带来深度影响，甚至决定未来PaaS技术的走向。

转载请注明出处。

本文很多其它出于我本人的理解，肯定在一些地方存在不足和错误。希望本文可以对接触DEA环境变量的人有些帮助，假设你对这方面感兴趣，并有更好的想法和建议，也请联系我。

我的邮箱：allen.sun@daocloud.io

新浪微博：@莲子弗如清