Gradle: Git で管理されているアプリケーションをデプロイ

Table of Contents

Gradle を使って、 Git で管理されているアプリケーションをデプロイするスクリプトを書きました。 Gradle でなくても良かったのですが、偶然 Gradle でやったことがあったので、 Gradle で書きました。

前提

今回前提としたデプロイは、単純に git pull をしてコードを更新した後、サーバを再起動するものです。サーバから Git のリモートリポジトリへの認証は、鍵ファイルを使って行っているものとします。

また Rails を前提としているので、 Rails 専用の処理もあります。他の言語でも応用できます。

応用次第で、 git で管理されているコードの中の一部をサーバにコピーすることもできます。

環境

Gradle 3.2.1

準備

gradle をインストールして、 gradle init を実行します。そうすると、 gradle のテンプレートが用意されます。そこにデプロイのタスクを書いていきます。

コード

次のようになりました。

import groovy.json.JsonSlurper
buildscript {
repositories {
mavenCentral()
jcenter()
}
dependencies {
classpath 'org.hidetake:gradle-ssh-plugin:2.8.0'
}
}
apply plugin: 'org.hidetake.ssh'
ssh.settings {
dryRun = project.hasProperty('dryRun')
}
repositories {
mavenCentral()
}
def setupServer(serverRole) {
// read and set servers
JsonSlurper slurper = new JsonSlurper()
def deployConfig = slurper.parse(new File('deploy_config.json'))
deployConfig.hosts.each {
if (it.role != serverRole) return;
def serverHost = it.host
remotes.create(serverHost) {
role serverRole
host = serverHost
user = deployConfig.user
identity = file(deployConfig.key)
passphrase = deployConfig.pass_phrase
}
}
}
/**
* deploy
*/
task deploy << {
// set target server role
if (!project.hasProperty("serverRole")) return
def serverRole = project.properties['serverRole']
JsonSlurper slurper = new JsonSlurper()
def deployConfig = slurper.parse(new File('deploy_config.json'))
def gitUserName = deployConfig.git.user_name
def gitPassword = deployConfig.git.password
setupServer serverRole
ssh.settings {
knownHosts = allowAnyHosts
}
def railsRoot = "/program_root_path"
def backupRoot = "/backup_root_path"
ssh.run {
session(remotes) {
def exitFlag = false
execute("df -h") { result ->
def loop = true
while (loop) {
println "Continue? Y or N: "
switch (System.in.newReader().readLine()) {
case ~/^[Yy]$/:
loop = false
break
case ~/^[Nn]$/:
loop = false
exitFlag = true
break
}
}
}
if (exitFlag) return
execute "rm -rf ${backupRoot}"
execute "cp -prv ${railsRoot} ${backupRoot}"
execute "cd ${railsRoot}; git checkout -- db/schema.rb"
execute("cd ${railsRoot}; git pull")
execute "rake db:migrate RAILS_ENV=production"
executeSudo("apachectl -k graceful; echo $?") { result ->
switch (result) {
case "0":
println "Success"
break
default:
println "Failed"
}
}
}
}
}

import groovy.json.JsonSlurper

buildscript {

repositories {

mavenCentral()

jcenter()

}

dependencies {

classpath 'org.hidetake:gradle-ssh-plugin:2.8.0'

}

apply plugin: 'org.hidetake.ssh'

ssh.settings {

dryRun = project.hasProperty('dryRun')

}

repositories {

mavenCentral()

}

def setupServer(serverRole) {

// read and set servers

JsonSlurper slurper = new JsonSlurper()

def deployConfig = slurper.parse(new File('deploy_config.json'))

deployConfig.hosts.each {

if (it.role != serverRole) return;

def serverHost = it.host

remotes.create(serverHost) {

role serverRole

host = serverHost

user = deployConfig.user

identity = file(deployConfig.key)

passphrase = deployConfig.pass_phrase

}

/**

* deploy

task deploy << {

// set target server role

if (!project.hasProperty("serverRole")) return

def serverRole = project.properties['serverRole']

JsonSlurper slurper = new JsonSlurper()

def deployConfig = slurper.parse(new File('deploy_config.json'))

def gitUserName = deployConfig.git.user_name

def gitPassword = deployConfig.git.password

setupServer serverRole

ssh.settings {

knownHosts = allowAnyHosts

}

def railsRoot = "/program_root_path"

def backupRoot = "/backup_root_path"

ssh.run {

session(remotes) {

def exitFlag = false

execute("df -h") { result ->

def loop = true

while (loop) {

println "Continue? Y or N: "

switch (System.in.newReader().readLine()) {

case ~/^[Yy]$/:

loop = false

break

case ~/^[Nn]$/:

loop = false

exitFlag = true

break

}

if (exitFlag) return

execute "rm -rf ${backupRoot}"

execute "cp -prv ${railsRoot} ${backupRoot}"

execute "cd ${railsRoot}; git checkout -- db/schema.rb"

execute("cd ${railsRoot}; git pull")

execute "rake db:migrate RAILS_ENV=production"

executeSudo("apachectl -k graceful; echo $?") { result ->

switch (result) {

case "0":

println "Success"

break

default:

println "Failed"

}

処理説明

デプロイ部分の処理は次の通りです。現場によって変えて使う部分です。

ssh でサーバに接続します。
dfコマンドで空き容量をチェックします。ここで Y または N をタイプして、後続の処理を実行するか否か決定します。
古いコードをコピーします。
git pull で新しいソースコードを取得・デプロイします。
rake db:migrate を実行します。この部分は Rails 固有の処理です。
Apache を再起動します。このときの終了ステータスに応じて “Success” または “Failed” を表示します。

注意点

git pull のためにサーバ側に秘密鍵を登録しておく必要があります。 SSH でのエージェントフォワードもできるので、自分の秘密鍵を使って git pull を行うこともできます。

SSH のエージェントフォワードをする場合は次の記述をリモートセッションの実行前に追加します。

ssh.settings {
knownHosts = allowAnyHosts
agent = true
}

ssh.settings {

knownHosts = allowAnyHosts

agent = true

}

sshのキーは ssh-add で登録しておきます。これで git で使用する秘密鍵を登録しておけばその鍵を使って git pull が行われます。

GitHub

GitHub で公開しています。 gradle-deploy

この記事を見た人は次の記事も見ています

git: SSL が有効でない場合の clone

The Life

Gradle: Git で管理されているアプリケーションをデプロイ

前提

環境

準備

コード

処理説明

注意点

GitHub

関連記事

この記事を見た人は次の記事も見ています

A Life Summary of an Gypsy