新人インフラエンジニアに伝えたい商用環境手順書作成指南書

  • 10
    Like
  • 1
    Comment

今回この記事では商用環境で踏むべき手順を簡単にまとめられたら良いと思っています。

手順書の目的の整理

まずこの手順書で何をしたいのかを明確にするべきです。
apacheを構築したいではなく、apacheのmod_proxyの設定を変更したい。
それならhttpd.confの設定を変更し、00-base.confでモデュールを有効にする必要があるなどのtodoに落とし込めます。
だからまずは手順を作る目的を明確にしましょう。

手順書の前提条件を明記

この手順で必要となる前提条件を手順書に書きましょう。
例えば、root権限で実行しましょうであるとか、
他には特定のサーバで実行しましょうなどといった実行環境を特定するような条件を書きましょう。

作業編集後の確認方法の確立

単純なファイルであれば、設定値を変更した後でdiffをとれば問題はないです。
しかし、設定値が反映されたかどうかを確認できるコマンドがないかをいったん調べたうえでdiffのみなのか、
コマンドでも確認するのかを決めてください。
例えば、SELinuxだとgetenforceでSELinuxが有効になっているか無効になっているかが確認できます。
まずは設定ファイルの反映を確認できるコマンドがあるかないかを調べましょう。

手順書の具体的な記載内容

以上のことを踏まえて手順書を作っていきましょう。
格子としては以下の順に記載してあれば問題ないです。
[作業概要]-作業の目的
[前提条件]-作業環境の特定
[事前準備]-バックアップ、バックアップ確認、
[作業]-ファイルの編集、置き換え
[事後作業]-編集差分確認

今までの記載した内容を踏まえると、
自分だとこんな感じです。

作業概要
ipv6を無効にするために、
カーネルパラメータで設定を無効にする。
前提条件
rootユーザで実行すること。
webap01サーバで実施すること。
事前準備
id  -ユーザ確認
pwd -現在地確認
date  -作業実施日確認
uname -n  -ログインサーバ確認
mkdir -p /work/os -作業ディレクトリ作成
cp -p /etc/sysctl.conf /work/os/sysctl.conf_${date +"%Y%m%d"} -バックアップ取得 
ls -l /work/os/sysctl.conf_${date +"%Y%m%d"}  -バックアップ確認
cat /etc/sysctl.conf  -作業対象ファイルの中身確認
ls -l /etc/sysctl.conf  -作業対象ファイルの権限回りの確認
作業
sysctl -a | grep net.ipv6.conf.all.disable_ipv6 -現行の設定を確認
→net.ipv6.conf.all.disable_ipv6 = 0と出力されていること
echo "net.ipv6.conf.all.disable_ipv6 = 1" >> /etc/sysctl.conf -ファイル編集
sysctl -p -カーネルパラメータの反映
sysctl -a | grep net.ipv6.conf.all.disable_ipv6 -変更した設定が反映されているかを確認
→net.ipv6.conf.all.disable_ipv6 = 1と出力されていること
事後確認
cat /etc/sysctl.conf  -作業実施後ファイルの中身確認
ls -l /etc/sysctl.conf  -作業実施によるファイルの権限回りの変更がないか確認
diff /etc/sysctl.conf /work/os/sysctl.conf_${date +"%Y%m%d"} -変更点の確認

インフラエンジニアに成りたての方がいれば参考にしていただけると幸いです。