サーバーの構成をどう記録しておくか

レン

半年前に自分で設定したのに、何をどうしたのか全然思い出せない…

プロクラ

あるあるだね。しかも困るのは、たいてい急いでいるときなんだ。記録を残すのは他人のためだけじゃなく、未来の自分のためでもあるよ。

何を書くか

プロクラ

全部を細かく書こうとすると続かない。困ったときに知りたくなることだけに絞ろう。

• 何が動いているか（サービスの一覧と、その役割)
• 設定ファイルの場所
• 定期実行の内容と、その目的
• バックアップの取得先と、戻す手順
• 外部サービスとの連携（何と繋がっているか)
• 普通と違うことをした箇所と、その理由

プロクラ

6つめが特に価値があるよ。「なぜこうしたのか」は、後から調べても分からない。当時の判断を書き残しておくと、変えていいかどうかを判断できる。

どこに置くか

• そのサーバーの中だけに置かない（失われたときに一緒に消える)
• 手元のメモアプリ、クラウドの文書、バージョン管理のいずれか
• 認証情報は書かない（置き場所だけを書く)
• 自分が確実に見つけられる場所にする

プロクラ

3つめは徹底しよう。記録に認証情報を書くと、その記録自体が守るべき対象になる。パスワードは管理ツールへ、記録には「管理ツールに入っている」とだけ書けばいい。

続けるための工夫

プロクラ

きれいな文書を作ろうとすると続かない。箇条書きで十分だし、後から読めれば形式は問わないよ。

• 作業した直後に、1行だけ書き足す
• 日付を入れる（いつの情報かが分かる）
• 設定ファイルを変えたら、その理由をコメントとしても残す
• 半年に一度、実際の構成と食い違っていないかを見直す

プロクラ

3つめは特に効果的だよ。設定ファイルの中にコメントで理由を書いておけば、そのファイルを開いた時点で目に入る。別の文書を探しに行く必要が無い。

レン

なぜそうしたか、を書き残す。それが一番思い出せない部分だもんね。

記録の代わりになるもの

プロクラ

文書を書くのが苦手なら、実行できる形で残すという手もあるよ。構築の手順をそのまま書いておけば、記録にもなるし、作り直しにも使える。

• 構築の手順を、スクリプトとして残す
• 設定ファイルをバージョン管理に入れる（変更の履歴が残る）
• 変更のたびに、その理由をコメントとして書く
• 実際に動かせるので、内容が古くなっているかも分かる

プロクラ

4つめが文書との違いだね。文書は古くなっても気づけないけれど、実行できる形なら、動かした時点で食い違いが分かる。

最低限これだけは

• 契約している事業者と、管理画面への入り方
• バックアップの場所と、戻す手順
• ドメインとDNSの管理場所
• この3つだけでも、サーバーが飛んだときの復旧速度がまるで違う