部署Node.js的应用

原创：作者 mashihua

最近Node.js很火，让很多的前端看到了可以直接从前端写到后端的希望。但是每次部署一个Node.js的应用却让前端苦恼不已。每次登陆服务器，用自己不熟悉的方式从版本控制仓库中拖下源代码，kill掉应用的进程，重起一个应用的守护进程。如果能够自动化的部署一个Node.js应用，而不需要去接触这些前端不太熟悉的Unix系统命令和管理。对于大家来说就是提升了生产力。Capistrano是一个强大的自动化部署工具，所以我们选用他来做自动化部署。并且我已经把做好了的一个部署脚本<a href=“https://github.com/mashihua/Nodebot”>Nodebot</a>提交到github上去，供大家参考。 <br/> <br/>首先我们需要一个环境，分为两个环境：部署客户端环境和服务器环境。 <br/><h3>部署客户端系统需求：</h3> <br/>你可以用任何系统了，系统只要具备下面的4个软件就可。 <br/><ol> <br/> <li>安装ruby。去<a href=“http://www.ruby-lang.org/en/downloads/”>http://www.ruby-lang.org/en/downloads/</a>下载适合你系统的ruby版本。</li> <br/> <li>安装rubygem。去<a href=“http://rubyforge.org/projects/rubygems/”>http://rubyforge.org/projects/rubygems/</a>下载最新版的RubyGems，解压后运行以下命令安装。 sudo ruby setup.rb</li> <br/> <li>安装Capistrano和Capistrano-etx。运行以下的命令安装。sudo gem install capistrano capistrano-ext</li> <br/></ol> <br/>这样你就拥有了在机器部署node.js应用的软件。然后你需要能够不使用密码直接登陆到服务器上。运行下面的命令： <br/><pre># Create a local ssh key <br/>ssh-keygen <br/>#Copy key to server <br/>cat ~/.ssh/id_rsa.pub | ssh user@domain.com “cat >> .ssh/authorized_keys” <br/></pre> <br/>这样你就可以不需要密码直接登陆到服务器。 <br/><h3>服务器端系统需求：</h3> <br/>当然要Unix一类的系统了，Nodebot需要具备upstart的系统（一个基于事件的守护进程管理系统）。虽然Node.js能跑在window上，但是那只适合开发环境，不适合生产环境。还要有下面的软件，你也可以下载Nodebot并在部署客户端运行命令cap  nodebot:setup 来自动化安装。 <br/><ol> <br/> <li>安装scm软件。比如git，svn或hg，取决于你的node.js应用源代码管理软件。</li> <br/> <li>安装Node.js。没什么好说的，地球人都知道这是什么。</li> <br/> <li>安装npm。Node.js的一个包管理软件</li> <br/> <li>安装node-jake。一个javascript的代码构建工具，有点像make和rake。用来安装应用的依赖。</li> <br/> <li>具备upstart的系统，比如Ubantu。来做应用的守护进程。参看 <a href=“http://upstart.ubuntu.com/”>http://upstart.ubuntu.com/</a></li> <br/></ol> <br/>部署的登陆用户需要sudo权限，并且不需要提示输入密码。参考命令： <br/><pre>#Add a sudoer <br/>sudo useradd -m foo <br/>#edit sudoer privilege <br/>sudo visudo <br/></pre> <br/>出现编辑器时，插入下面一行，foo就是你新建的用户： <br/><pre>foo ALL=(ALL) NOPASSWD: ALL</pre> <br/>然后在deploy.rb文件（下面会提到）里配置foo为部署用户。 <br/><h3>部署客户端脚本</h3> <br/>环境有了，那就要开工了。我们希望在服务器上的Node.js应用运行几个不同的环境：测试环境，开发环境，产品环境等。运行cap .命令会在当前的目录下产生一个文件和一个目录。在目录里有个deploy.rb，这是我们需要修改的文件。由于我们需要多个环境，所以我们引入了Capistrano-etx。 <br/><pre>set :stages, %w[staging production] <br/>set :default_stage, ‘staging’ <br/>require ‘capistrano/ext/multistage’ <br/></pre> <br/>我们设定了两个环境：staging和production，默认是staging环境。我们再在config目录下建一个deploy目录，里面放的两个.rb文件对应不同的环境配置.最后部署环境的目录下是这样的一个结构： <br/><pre>. <br/>├── Capfile <br/>└── config <br/> ├── deploy <br/> │   ├── production.rb <br/> │   └── staging.rb <br/> ├── deploy.rb <br/> └── node.rb</pre> <br/>deploy.rb文件看起来像这样。你需要设定host, repository,user和admin_user ： <br/><pre>## <br/># Capistrano tasks for Ubantu. <br/># <br/># Author: Shihua Ma http://f2eskills.com/ <br/> <br/>set :stages, %w[staging production] <br/>set :default_stage, ‘staging’ <br/>require ‘capistrano/ext/multistage’ <br/>#application name <br/>set :application, “example” <br/>#start server script <br/>set :node_file, “app.js” <br/>#deploy host <br/>set :host, “hostname” <br/>#user name,must be a sudoer without prompting for password <br/>set :user, “username” <br/>set :admin_runner, user <br/> <br/> <br/>set :repository, “git@git@github.com:mashihua/Nodebot.git” <br/>set :scm, :git <br/>set :deploy_via, :remote_cache <br/>role :app, host <br/>set :use_sudo, true <br/> <br/>namespace :deploy do <br/>
<br/> desc “Start node server”
<br/> task :start, :roles => :app, :except => { :no_release => true } do
<br/> run “sudo start #{application}#{node_env}"
<br/> end
<br/>
<br/> desc “Stop node server”
<br/> task :stop, :roles => :app, :except => { :no_release => true } do
<br/> run "sudo stop #{application}#{node_env}”
<br/> end
<br/>
<br/> desc “Restart node server”
<br/> task :restart, :roles => :app, :except => { :no_release => true } do
<br/> run “sudo restart #{application}#{node_env} || sudo start #{application}#{node_env}”
<br/> end
<br/>
<br/> desc “Check required packages and install if packages are not installed”
<br/> task :check_packages, roles => :app do
<br/> run “cd #{release_path} && jake depends”
<br/> end
<br/>
<br/> task :create_deploy_to_with_sudo, :roles => :app do
<br/> run “sudo mkdir -p #{deploy_to}”
<br/> run “sudo chown #{admin_runner}:#{admin_runner} #{deploy_to}”
<br/> end
<br/>
<br/> desc “Update submodules”
<br/> task :update_submodules, :roles => :app do
<br/> run “cd #{release_path}; git submodule init && git submodule update”
<br/> end
<br/>
<br/> task :write_upstart_script, :roles => :app do
<br/> upstart_script = <> #{shared_path}/log/#{node_env}.log 2>&1"
<br/>end script
<br/>respawn
<br/>UPSTART
<br/>
<br/> put upstart_script, “/tmp/#{application}_upstart.conf”
<br/> run “sudo mv /tmp/#{application}upstart.conf /etc/init/#{application}#{node_env}.conf”
<br/> end
<br/>
<br/>end
<br/>
<br/>before ‘deploy:setup’, ‘deploy:create_deploy_to_with_sudo’
<br/>after ‘deploy:setup’, ‘deploy:write_upstart_script’
<br/>after “deploy:finalize_update”, “deploy:update_submodules”, “deploy:check_packages”
<br/></pre>
<br/>staging.rb环境文件看起来像这样。设定了应用的环境，git的branch，应用的监听端口和部署目录：
<br/><pre>set :node_env, “staging”
<br/>#git repos branch
<br/>set :branch, “master”
<br/>#listing port
<br/>set :application_port, “1603”
<br/>#deploy path
<br/>set :deploy_to, “/srv/www/apps/#{application}/#{node_env}”
<br/></pre>
<br/>production.rb环境文件看起来像这样：
<br/><pre>set :node_env, “production”
<br/>#git repos branch
<br/>set :branch, “production”
<br/>#listing port
<br/>set :application_port, “1604”
<br/>#deploy path
<br/>set :deploy_to, “/srv/www/apps/#{application}/#{node_env}”
<br/></pre>
<br/> 
<br/><h3>主要命令：</h3>
<br/><ul>
<br/> <li>cap -T 查看所有的task</li>
<br/> <li>cap deploy:setup   设置staging环境，比如创建部署的目录等。staging是默认环境，命令等同于cap staging deploy:setup。调用production环境的命令cap production deploy:setup，第一个参数是环境名，第二个参数是任务名。</li>
<br/> <li>cap nodebot:setup  安装系统一些软件和配置守护进程。上面已经介绍过。</li>
<br/> <li>cap production deploy   部署 production环境的Node.js应用。包括从仓库取最新的代码，链接最新的代码到一个目录。重起应用的Server。</li>
<br/> <li>cap deploy:stop, cap deploy:start和cap deploy:restart   停止，启动和重起staging环境的Server。</li>
<br/></ul>
<br/><h3>简单的Node.js应用：</h3>
<br/>我们用一个简单的Node.js应用来说明实际的效果，应用的目录结构就像这样：
<br/><pre>.
<br/>├── Jakefile.js
<br/>├── app.js
<br/>├── config
<br/>│   └── requirements.json
<br/>└── log</pre>
<br/>
<br/>log 应用日志的输出目录
<br/>
<br/>app.js 就是应用的启动脚本
<br/><pre>var express = require(‘express’);
<br/>
<br/>var app = express.createServer();
<br/>
<br/>app.get(’/’, function(req, res){
<br/> //the log will out put to log/{node_env}.log
<br/> console.log(“Method:” + req.method);
<br/> //send text to agent
<br/> res.send(‘Hello World. NODE_ENV=’ + process.env.NODE_ENV);
<br/>});
<br/>
<br/>
<br/>//listening on application_port where set by capistrano
<br/>app.listen(process.argv[2] || 3000);
<br/></pre>
<br/>Jakefile.js jake构建工具调用的脚本，在本例子中用来安装express
<br/><pre>var fs = require(‘fs’);
<br/>
<br/>desc(‘Check and install required packages’);
<br/>task(‘depends’, [], function (arg) {
<br/> var npm = require(‘npm’);
<br/> npm.load({}, function (err) {
<br/> if (err) return commandFailed(err);
<br/> npm.on(“log”, function (message) { if(arg) console.log(message) })
<br/> var requirements = JSON.parse(fs.readFileSync(‘config/requirements.json’));
<br/> npm.commands.install(requirements, function (err, data) {
<br/> if (err) return commandFailed(err);
<br/> });
<br/> });
<br/>}, true);
<br/></pre>
<br/>config/requirements.json 应用依赖的定义
<br/><pre>[ “express@2.4.7”]</pre>
<br/>
<br/>实际部署的效果： <a href=“http://xiaoya.me:1603/”>staging环境</a>， <a href=“http://xiaoya.me:1604/”>production环境</a>
<br/><h2>结论：</h2>
<br/>使用<a href=“https://github.com/mashihua/Nodebot”>Nodebot</a>你可以轻松的部署你的Node.js应用。把你的焦点放到实际的需求中，而不用关心部署环境的建立和部署应用的麻烦，只许在部署客户端轻松的输入简单的命令。