Cloud Foundry buildpack開發部署實例解析

與service broker相比，buildpack的實務操作就容易多了，單就通用概念來說，其實用不着單寫一篇，但是處女座強迫症發作，所以還是寫一下，使CF這個框架對外擴展的兩個維度（代碼使用的服務和代碼運行的環境）是完整的。這篇主要會寫buildpack的基本實現邏輯，然後舉三個需要修改buildpack的需求，進行實際操作描述。

基本原理

CF運行應用的基本過程是將用戶發佈的應用程序包解壓開，然後將自己的所有buildpack拿來，按照指定順序與程序包進行匹配，直到找到第一個能夠運行這些代碼的buildpack，然後將buildpack也解開，與這些應用代碼打成一個包（即droplet），在按照指定的運行環境參數生成容器，將droplet扔進去，按照buildpack指定的啓動命令，啓動應用。在上面的過程中，buildpack實現了三步功能：
第一步，detect：檢查當前應用程序包是否能夠用本buildpack支持運行，比如，java buildpack發現WEB-INF路徑就認爲自己能夠運行它。
第二步，compile：將應用程序包與buildpack包水乳交融一下，比如將java程序包放到tomcat的應用目錄下，然後替換某些參數，比如將當前dea裏的隨機端口賦予這個tomcat實例。
第三部，release：將droplet啓動，比如運行tomcat的startup.sh。
任何一個buildpack都有一個bin路徑，放着三個指定名字（detect、compile、release）的腳本（任何dea的os能執行的腳本都可以），然後具體的實現邏輯就從這裏觸發了。下面將以java buildpack爲例，通過三個實際需求，介紹buildpack的開發和使用。

自定義buildpack

更新java應用的默認時區和編碼

需求

國際軟件都使用格林尼治時間作爲系統中的默認時間，所以咱們寫出的日誌或者使用程序代碼獲取的系統時間（其實都是dea的系統時間）都是+0000的，而我們需要+0800的，當然，可以從代碼裏自行處理。但是我的用戶們不爽，他們說我這程序還要本地測視呢，太亂了，你得給我處理。
tomcat裏的默認編碼應該都是utf8，可是，在某些場景下，比如tomcat上運行的rest服務，其報文中包含中文，是無法被正常接收的。CF的java buildpack裏包含的就是默認的tomcat，所以爲了解決這個問題，可以使用下面的命令進行設置，但是畢竟不大爽，還是直接改掉buildpack比較友好。

cf set-env appname CATALINA_OPTS "$CATALINA_OPTS -Dfile.encoding=UTF-8"

解決方案

java buildpack是ruby寫的，所以如果不是原則性的上的變動，大可以通過將壓縮包打開，修改ruby代碼，然後再壓縮上的辦法。不過，winrar似乎有些莫名其妙的問題，如果是解壓開再壓縮會有問題，但是如果直接將修改後的同名文件拖動到winrar的窗口中進行替換，就可以工作。爲了達到時區和編碼這兩個需求，需要做的文件修改如下：

在java-buildpack-offline-v#.#.#\lib\java_buildpack\component\java_opts.rb
中增加兩個方法：

# @return [JavaOpts]              +self+-Duser.timezone 
def add_timezone(value)
    self << "-Duser.timezone=#{value}"
    self
end
# @return [JavaOpts]              +self+-Dfile.encoding 
def add_fileencode(value)
    self << "-Dfile.encoding=#{value}"
    self
end

在java-buildpack-offline-v#.#.#\lib\java_buildpack\jre\open_jdk_like.rb中，修改release方法，增加add_timezone和add_fileencode調用

@droplet.java_opts
    .add_system_property('java.io.tmpdir', '$TMPDIR')
    .add_option('-XX:OnOutOfMemoryError', killjava)
    .add_timezone('GMT+08')
    .add_fileencode('UTF-8')
    .concat memory

修改後，將這兩個文件替換到原來的離線buildpack包裏，然後將其發佈到CF中，查看當前buildpack情況：

cf buidlpacks

然後，創建新的buildpack，其中最後一個參數決定了cf查看buildpack符合應用的順序，需要根據實際情況調整。

cf create-buildpack java_buildpack_with_gmt0800_offline d:\somedir\java-buildpack-with-gmt0800-offline-v2.4.zip 1   

如果是更新的話，使用cf update-buildpack。

使用應用程序包的tomcat

需求

有些應用，尤其是做產品的公司做的，會對tomcat進行一定的剪裁，這樣的應用遷移到cf上時，非常痛苦。簡單的辦法就是，自己做個buildpack，提供的只是jre。

解決方案

假定這個產品的標識是LiveBOS，在程序包的第一層路徑下就有一個LiveBOS文件夾：

在java-buildpack-with-livebos-offline-v#.#\lib\java_buildpack\container\裏添加一個libe_bos.rb：

# Encoding: utf-8
# Cloud Foundry Java Buildpack
# Copyright 2013 the original author or authors.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#      http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

require 'java_buildpack/container'
require 'java_buildpack/container/dist_zip_like'
require 'java_buildpack/util/dash_case'

module JavaBuildpack
    module Container

        # Encapsulates the detect, compile, and release functionality for +LiveBOS+ style applications.
        class LiveBOS < JavaBuildpack::Container::DistZipLike
            # Creates an instance
            #
            # @param [Hash] context a collection of utilities used the component
            def initialize(context)
                super(context)
            end

            # (see JavaBuildpack::Component::BaseComponent#compile)
            def compile
                startup.chmod 0755
            end

            # (see JavaBuildpack::Component::BaseComponent#release)
            def release
              @droplet.java_opts.add_system_property 'http.port', '$PORT'

                [
                    @droplet.java_home.as_env_var,
                    @droplet.java_opts.as_env_var,
                    qualify_path(catalina, @droplet.root), 
                    'run'
                ].flatten.compact.join(' ')
            end

            protected

            # (see JavaBuildpack::Container::DistZipLike#id)
            def id
                LiveBOS.to_s.dash_case
            end

            # (see JavaBuildpack::Container::DistZipLike#supports?)
            def supports?
                livebos? && catalina.exist?
            end

            private

            def startup
                candidates = (root + 'bin/startup.sh').glob
                candidates.size == 1 ? candidates.first : nil
            end

            def catalina
                candidates = (root + 'bin/catalina.sh').glob
                candidates.size == 1 ? candidates.first : nil
            end

            def livebos?
                (root + 'LiveBos').exist?
            end

        end

    end
end

在java-buildpack-with-livebos-offline-v2.4\config\components.yml的containers下面添加：

- "JavaBuildpack::Container::LiveBOS"

後面就是打包發佈了。

更換buildpack中的jre

需求

有些應用只能使用特定版本的jre，如果這jre比較新還好辦，但是如果是舊的，比如1.6，那現在cf中能找到的buildpack就全不支持了。另外，也有可能應用要求使用oracle jre（cf中默認是open jre）。

解決方案

開始之前，建議大家不要在windows上嘗試這個編譯過程，基本沒有成功的可能，隨便找個能上網能運行ruby的linux吧。

修改java-buildpack-offline-v2.4\config\components.yml，將不使用的jre註釋掉：

  - "JavaBuildpack::Jre::OpenJdkJRE"
# - "JavaBuildpack::Jre::OracleJRE"

修改java-buildpack-offline-v2.4\config\oracle_jre.yml，將下面這行裏的內容更新爲一個本地tomcat的地址：

repository_root: http://localhost:8080/myapp

在本地的myapp下放一個index.yml文件，其中放上類似下列內容的oracle jre下載地址，如果oracle網站上已經找不到了，就也放在本地tomcat上吧。

---
1.7.0_01: http://download.run.pivotal.io/openjdk/centos6/x86_64/openjdk-1.7.0_01.tar.gz
......
1.8.0_M6: http://download.run.pivotal.io/openjdk/centos6/x86_64/openjdk-1.8.0_M6.tar.gz

然後，就可以編譯打包了。

bundle install
bundle exec rake package OFFLINE=true
...
Creating build/java-buildpack-offline-cfd6b17.zip

最後，當然還是發佈到cf上。