与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上。