リリース手順書のテンプレートと例文をご紹介します。
リリース手順書とは？
システムを本番環境にリリースする際に用いるのがリリース手順書です。最近ではCI/CDによって自動化が進められていますが、まだまだ数多くのシステムで手作業によるリリースが行われています。
リリース手順書を用意することで、どのレベルの担当者が行ってもミスのないリリースが実現できます。また、万一の際の対応方法についても記述しておくことで、安心してリリース作業を実施できます。
WEB上で簡単にリリース手順書の作成・管理を行えるツール「NotePM」
リリース手順書の目的
リリース手順書は誰でも問題なく、漏れなくリリース作業が行えるようにするために用意します。熟練の担当者による秘伝のタレ化を防ぎ、知識を全員で共有できます。担当者の異動や退職などに伴う知識の断絶も防ぐ効果があります。
また、リリース作業の中で行われている各手順について説明することで、何を行っているのかを理解できるようになります。不慣れな作業者であっても、行っていることを理解することで、知識の引き上げが期待できるでしょう。
リリース手順書の書き方
リリース手順書は作業を行う前の確認事項に加えて、各手順のステップごとに処理前と処理後の確認を行いながら進めていきます。また、リリース作業が完了後は指定された内容をもって確認をして、終了とします。
対象リソース
サーバーなどのリソースや、クライアント名、プロジェクト名などを記述します。サーバーによって手順が異なる場合があるので、特定できる情報を記述します。
目的
本リリース手順書の目的を記述します。目的が明確でないまま作業を行うとミスが発生しやすいでしょう。何のために行う作業なのか、なぜ必要な作業なのかを明記することで、リリース作業の意義を認識させます。
リリース手順開始前のチェック項目
手順を開始する前に行うチェック項目を記載します。この時点で不可となる項目があれば、リリース作業は停止すべきです。サーバーが違う、設定が違うということであれば、リリース手順も途中で躓く可能性が高いでしょう。
リリース手順開始前の作業
手順を開始する前に行うべき作業を明記します。途中で失敗した場合にロールバックできるようにバックアップを作成したり、以前の作業仕掛品があれば削除すると言った内容になります。
リリース手順
ここからステップごとにリリース手順を記述していきます。
実行前の確認
実行前の確認内容です。たとえばコマンドを実行して、ファイルやフォルダの存在を確認します。この時点でエラーなるようであれば、この時点で作業を中断して問題発生時の対処方法に従って進めます。
実行内容
実行内容です。たとえばコマンドを実行してファイルを移動したり、外部からファイルを取得したりします。
実行後の確認
処理後の確認作業です。実行前と同じく、ファイルやフォルダの存在を確認します。実行内容がうまくいったことを確認するためのコマンドを記述します。
リリース手順後のチェック項目
リリース作業が適切に終わったことを確認するためのチェックリストです。コマンドを実行して確認したり、Webブラウザからアクセスして確認すると言った内容になるでしょう。
問題発生時の対処方法
リリース手順開始前の確認、リリース手順実行中の確認などでエラーが出た場合の対処方法を記述します。主立ったエラーであれば、ここに記述された内容に沿ってリカバリーできるでしょう。
緊急連絡先
リリース手順を実行中にエラーが発生し、解決できない場合の連絡先を記述します。上記の対処方法に書かれていない問題が発生した場合に利用します。
WEB上で簡単にリリース手順書の作成・管理を行えるツール「NotePM」
リリース手順書のサンプル例
##対象リソース
プロジェクトAのサーバーセキュリティパッチ適用手順書
##目的
セキュリティパッチはセキュリティ計画に沿って、定期的にパッチ適用処理を行います。サーバーのセキュリティ品質を維持するために必要な作業になります。
##リリース手順開始前のチェック項目
- アプリケーションサーバBにWebブラウザからアクセスできること
- アプリケーションサーバBにSSHにてログインし、ディスクスペースが5GB以上あるのを確認します
- アプリケーションサーバBにてsudoで管理者ユーザーになれるのを確認します
##リリース手順開始前の作業
アプリケーションサーバBの
/var/logsをバックアップします。$ sudo su – # 管理者ユーザーになります# export date=`date +%Y-%m-%d` # 今日の日付でバックアップを作成します# tar cfz log-$date.tar.gz /var/logs/ # /var/logs を圧縮しますできあがった
log-(今日の日付).tar.gzはクラウドのストレージに移動してください。# s3cmd mv log-$date.tar.gz s3://backup/##リリース手順
###パッケージ管理の更新
####実行前の確認
特にありません。
####実行内容
パッケージ管理を更新します。
# apt-get update####実行後の確認
コマンドがエラーにならないことを確認してください。
###更新項目のチェック
####実行前の確認
特にありません。
####実行内容
チェックコマンドを実行します。
# apt-get check####実行後の確認
エラーがないことを確認してください。
##リリース手順後のチェック項目
apt-get updateにて更新漏れがないことを確認- 圧縮したログファイル
log-(今日の日付).tar.gzが存在しないこと- アプリケーションサーバBにWebブラウザからアクセスできること
- アプリケーションサーバBのSSHからログアウト
##問題発生時の対処方法
ここではよくある問題とその対処法を挙げます。これ以外の問題についてには緊急連絡先にお願いします。
###SSHにてログインできない
公開鍵が設定されていない可能性があります。サーバー管理者（Cさん）に確認してアカウントを作成してもらってください。
###管理者になれない
sudoの権限が付与されていない可能性があります。サーバー管理者（Cさん）に確認してアカウントを作成してもらってください。
##緊急連絡先
本リリース手順書にて問題が発生した場合にはプロジェクトAのプロジェクトマネージャー（現在はD）に連絡してください。
