Software Engineer and Web Developer's Diary

1年後の自分に向けて

Fabric を選んだ理由

すべて以下エントリーの受け売り。せっかく自分でまとめるので良い感じに変更しようと思ったけど元エントリーが良すぎてほぼ同じ内容のエントリーになった。

複数プロジェクトを抱えるチームでのデプロイ自動化

Fabric を選んだ理由

もともとはシェルスクリプトで自動化されてた。大きな問題はなかったけど、シェルスクリプトが得意な人がメンテするという感じになってたのでもっと気軽にだれでも修正できるようにしたかった。 Capistrano とどっちにするかという問題は今いる会社が Python メインで Ruby さわれる人がほぼいないので消去法で Fabric を選択。

戦略

元のエントリーにも書いてあるけど、Fabric でめんどくさいのはベースのフレームワークがないので自分で一から書かないとダメなところ。最小のフレームワークを作ってチームに提供することにした。

├── README.md
├── lib
│   ├── git.py
│   └── hipchat.py
├── projectA
│   ├── README.md
│   ├── config
│   │   ├── common.py
│   │   ├── develop.py
│   │   ├── production.py
│   │   └── staging.py
│   └── fabfile.py
├── projectB
├── projectC

プロジェクト毎にディレクトリを作って、共通化できるものは lib ディレクトリで管理するようにする。元エントリと違うのは common ディレクトリが lib という名前に変わってるのと、環境毎に異なる設定を config ディレクトリで吸収するようにした。

用語の統一

属人性を排除するためにプロジェクトが異なってもインターフェースは統一する。

ノーマルなデプロイ

fab -H host1,host2 develop deploy

ブランチを指定したデプロイ

fab -H host1,host2 develop deploy:feat/ABC

ロールバック

fab -H host1,host2 develop rollback

環境依存ファイル

Fabric 標準の load_settings() だと文字列しか扱えなかったので、以下のようにして辞書とかリストも使えるようにした。ちょっとコードは増えたけど拡張性は高くなった。

fabfile.py

@task
def develop(user='vagrant'):
    """開発環境"""
    config.develop.develop(user)

@task
def staging(user=''):
    """ステージング環境"""
    config.staging.staging(user)

@task
def production(user=''):
    """本番環境"""
    config.production.production(user)

@task
def deploy():
    """デプロイする"""
    ここに処理を書く

config/develop.py

def develop(user='vagrant'):
    """開発環境"""
    env.environment = 'develop'
    env.user = user
    …
    …

優しさ

失敗する前提でデプロイする - hitode909の日記

ほんと丸パクリで申し訳ないけど、この通りにしたいと思う。マニュアル見る運用はできるだけ少なくしたい。

慌てないように

ロールバックコマンドを教えてあげる

ヒント:戻すときは以下のコマンドを実行しましょう
fab -H host1,host2 production rollback

必要ないことは出力しない

必要ない事は出力しない

出力してもいいけど、デプロイする人が次に何をすればいいかコメントを見ればわかるようにしたい。はじめてデプロイする人でも迷わないぐらいがいい。

fab -l

Fabric の標準コマンド。きちんとコメントを書いて利用者に安心して使ってもらう。

% fab -l
Available commands:

    deploy      デプロイする
    develop     開発環境
    production  本番環境
    rollback    ロールバックする
    staging     ステージング環境

わかりやすい README.md を書く

Confluence に書くのもいいけど GIT で管理するようなものなら README に書いて Confluence へはリンクを貼るようにしたい。

わかりやすいREADME.mdを書く

Name
====

Overview

## Description

## Demo

## VS. 

## Requirement

## Usage

## Install

## Contribution

## Licence

[MIT](https://github.com/tcnksm/tool/blob/master/LICENCE)

## Author

[tcnksm](https://github.com/tcnksm)

社内プロジェクトの場合は以下も書く

## Document

## Ticket

## Deploy

## Test

これらを書くことで初めてプロジェクトに参加したメンバーが迷うことがなくなる.レポジトリのみで全てが完結すればよいが,歴史のあるプロジェクトはドキュメントが各地に散っていることがある.長くそのプロジェクトに関わっているメンバーであれば問題ないが,新しく参加したメンバーには負担になる.どんなメンバーであってもスムーズにプロジェクトに参加できるように整備しておきたい.

まとめ

Capistrano も使ってみたかったけど現状の問題をスムーズに解決しようと思うとこんな形になった。この仕組が一年後に生き残ってるかが楽しみ。

参考