Chef-Deploy 项目技术文档

1. 安装指南

安装依赖

在安装 chef-deploy 之前，请确保系统中已经安装了以下依赖：

• Ruby 环境
• Chef 客户端
• Git 或 Subversion（根据项目需求）

安装步骤

1. 使用 gem 命令安装 chef-deploy：

   gem install chef-deploy
   

2. 安装完成后，可以通过以下命令验证安装是否成功：

   gem list chef-deploy
   

2. 项目的使用说明

基本使用

chef-deploy 是一个用于通过 Chef 部署 Ruby Web 应用的 gem。它使用与 Capistrano 相同的目录布局，并从 Capistrano 中借鉴了 Git 远程缓存部署策略，并将其适配为在 Chef 下工作。

示例代码

以下是一个基本的部署示例：

require 'chef-deploy'

deploy "/data/myrackapp" do
  repo "git://github.com/engineyard/rack-app.git"
  branch "HEAD"
  user "ez"
  role "app_master"
  enable_submodules true
  migrate true
  migration_command "rake db:migrate"
  environment "production"
  shallow_clone true
  revision '0xbeadbeef'
  restart_command "touch tmp/restart.txt" # "monit restart all -g foo", etc.
  action :deploy # 或 :rollback
end

部署钩子

chef-deploy 支持在应用的 APP_ROOT/deploy 目录中放置钩子文件，这些文件将在部署过程中的特定时间点触发。钩子文件的命名和触发时机如下：

• before_migrate.rb
• before_symlink.rb
• before_restart.rb
• after_restart.rb

钩子文件中的代码将在 chef-deploy 资源的上下文中执行，因此可以使用 run 和 sudo 命令，以及一些预定义的变量，如 release_path、shared_path 和 current_path。

使用 Subversion

如果使用 Subversion 进行部署，可以在 deploy 块中添加 scm 'subversion'，并根据需要提供 svn_username 和 svn_password。

3. 项目API使用文档

主要API

• deploy(path, &block): 定义一个部署任务，path 是部署的目标路径。
• repo(url): 指定代码库的 URL。
• branch(name): 指定要部署的分支。
• user(name): 指定部署时使用的用户。
• role(name): 指定部署的角色。
• enable_submodules(bool): 是否启用子模块。
• migrate(bool): 是否执行迁移。
• migration_command(cmd): 指定迁移命令。
• environment(name): 指定部署环境。
• shallow_clone(bool): 是否使用浅克隆。
• revision(hash): 指定要部署的修订版本。
• restart_command(cmd): 指定重启命令。
• action(type): 指定部署动作，可以是 :deploy 或 :rollback。

钩子API

• run(command): 执行 shell 命令，以当前用户身份运行。
• sudo(command): 执行 shell 命令，以 root 身份运行。
• release_path: 当前发布的完整路径。
• shared_path: 共享目录的路径。
• current_path: 当前符号链接的发布路径。
• node: 完整的 Chef 节点对象，包含通过 Ohai 收集的所有 JSON 数据。

4. 项目安装方式

通过 Gem 安装

chef-deploy 可以通过 RubyGems 安装：

gem install chef-deploy

在 Chef 中使用

在 Chef 的 Recipe 中，可以通过 require 'chef-deploy' 引入 chef-deploy，然后使用 deploy 资源进行部署。

示例

require 'chef-deploy'

deploy "/data/myrackapp" do
  repo "git://github.com/engineyard/rack-app.git"
  branch "HEAD"
  user "ez"
  role "app_master"
  enable_submodules true
  migrate true
  migration_command "rake db:migrate"
  environment "production"
  shallow_clone true
  revision '0xbeadbeef'
  restart_command "touch tmp/restart.txt"
  action :deploy
end

通过以上步骤，您可以成功安装并使用 chef-deploy 进行 Ruby Web 应用的部署。