Capify-EC2 技术文档

本文档将帮助用户安装、使用以及详细了解 Capify-EC2 项目。Capify-EC2 是一个用于从亚马逊 EC2 实例标签动态生成 Capistrano 命名空间和任务的工具。

1. 安装指南

Capify-EC2 可以通过以下两种方式安装：

通过 Gem 安装

运行以下命令安装 Capify-EC2：

gem install capify-ec2

或者将 gem 添加到项目的 Gemfile 中。

然后，在 deploy.rb 文件中添加以下代码：

require "capify-ec2/capistrano"

配置

创建一个 YML 配置文件（默认路径为 ./config/ec2.yml），内容如下：

:aws_access_key_id: "你的访问密钥"
:aws_secret_access_key: "你的密钥"
:aws_params:
  :region: 'eu-west-1'
:load_balanced: true
:project_tag: "你的应用名称"

可以在 deploy.rb 文件中设置 ec2.yml 文件的路径：

set :ec2_config, 'location/of/my/ec2.yml'

注意：aws_access_key_id 和 aws_secret_access_key 是必填项，除非通过其他方式提供或使用 IAM 角色认证。region 也是必填项。其他设置是可选的。

2. 项目的使用说明

Capify-EC2 使用 AWS EC2 实例标签生成 Capistrano 命名空间和任务，动态构建部署列表。

使用示例

假设有三个 EC2 实例，名称和标签如下：

'名称' 标签	'角色' 标签	'选项' 标签
server-1	web	cron,resque
server-2	db
server-3	web,db,app

在 deploy.rb 文件中添加以下代码：

ec2_roles :name => :web

这将生成以下任务：

task :server-1 do
  role :web, SERVER-1_EC2_PUBLIC_DNS_HERE, :cron=>true, :resque=>true
end

task :server-3 do
  role :web, SERVER-3_EC2_PUBLIC_DNS_HERE
end

task :web do
  role :web, SERVER-1_EC2_PUBLIC_DNS_HERE, :cron=>true, :resque=>true
  role :web, SERVER-3_EC2_PUBLIC_DNS_HERE
end

3. 项目 API 使用文档

Capify-EC2 的主要接口是通过 ec2_roles 方法。以下是一些使用示例：

• 指定角色：

  ec2_roles :name => :web
  

• 指定多个角色：

  ec2_roles :web
  ec2_roles :db
  

• 指定角色变量：

  ec2_roles :name=>"web", :variables => {:rails_env => 'staging'}
  

• 使用简写定义角色：

  ec2_roles :web
  

4. 项目安装方式

请参考上述 "安装指南" 部分。

通过本文档，用户应能够顺利安装并使用 Capify-EC2 项目，实现从 EC2 实例标签生成 Capistrano 命名空间和任务的需求。