後始末1.3. OpenSSH 設定ファイルの更新 (ホスト別対応削除)¶
作業の目的 [why]¶
OpenSSHの設定ファイルから、ホスト別設定を削除します。
完了条件/事前条件 [設計者用情報]
完了条件 [after]
主処理は、以下を満たしたときに成功したものとします。
- 完了条件1
- OpenSSH confgファイル"${HOME}/.ssh/config"にディレクトリ"${HOME}/.ssh/conf.d/hosts"を対象としたインクルード文が存在しない。
- 完了条件2
- OpenSSH設定用ディレクトリ"${HOME}/.ssh/conf.d/hosts"が存在しない。
事前条件 [before]
主処理の実施は、以下の状態であることを前提とします。
- 事前条件1
- OpenSSH confgファイル"${HOME}/.ssh/config"にディレクトリ"${HOME}/.ssh/conf.d/hosts"を対象としたインクルード文が存在する。
- 事前条件2
- OpenSSH設定用ディレクトリ"${HOME}/.ssh/conf.d/hosts"が存在する。
作業対象 [what]¶
- OpenSSH環境
標準時間(合計)¶
8分
パラメータ設定¶
| パラメータ設定の標準時間: | 2分 |
|---|
作業に必要なモノ・情報 [resource]¶
作業開始には、以下が全て揃っていることが必要です。
リソース1: SSH configファイル
- OpenSSHクライアントの設定ファイルです。
- 今回は"${HOME}/.ssh/config"とします。
リソース2: SSH設定ファイル用ディレクトリ
- SSHの設定ファイルを保存しているディレクトリ名です。
- 今回は"${HOME}/.ssh/conf.d/hosts"とします。
パラメータの指定¶
作業に必要なパラメータを変数に格納をします。
0.1. OpenSSH confgファイル名の指定¶
変数の設定:
DIR_SSH="${HOME}/.ssh"
OpenSSH confgファイル名を指定します。
変数の設定:
FILE_SSH_CONFIG="${DIR_SSH}/config" \ && echo ${FILE_SSH_CONFIG}
結果(例):
${HOME}/.ssh/config
0.2. OpenSSH設定用ディレクトリの相対パスの指定¶
SSH設定用ディレクトリの("${HOME}/.ssh"からの)相対パスを指定します。
変数の設定:
STRING_PATH_SSH_CONFIG='conf.d/hosts'
0.3. OpenSSH設定用ディレクトリの絶対パスの指定¶
SSH設定用ディレクトリ(絶対パス)を指定します。
変数の設定:
DIR_SSH_CONFIG="${DIR_SSH}/${STRING_PATH_SSH_CONFIG}" \ && echo ${DIR_SSH_CONFIG}
結果(例):
${HOME}/.ssh/conf.d/hosts
パラメータの保存¶
設定されている変数の保存先となるファイル名を指定します。
変数の設定:
DIR_PARAMETER="${HOME}/tmp/parameter-handson-cli-conf-codecommit" FILE_PARAMETER="${DIR_PARAMETER}/$(date +%Y-%m-%d)-openssh-config-delete-expand-confd-host.env" \ && echo ${FILE_PARAMETER}
結果(例):
${HOME}/tmp/parameter-handson-cli-conf-codecommit/2019-07-09-openssh-config-delete-expand-confd-host.env
各変数に正しいパラメータ値が格納されていることを確認しながら保存します。
変数の確認:
cat << EOF > ${FILE_PARAMETER} # 0.1. FILE_SSH_CONFIG:"${HOME}/.ssh/config" FILE_SSH_CONFIG="${FILE_SSH_CONFIG}" # 0.2. STRING_PATH_SSH_CONFIG:"conf.d/hosts" STRING_PATH_SSH_CONFIG="${STRING_PATH_SSH_CONFIG}" # 0.3. DIR_SSH_CONFIG:"${HOME}/.ssh/conf.d/hosts" DIR_SSH_CONFIG="${DIR_SSH_CONFIG}" EOF cat ${FILE_PARAMETER}
下段の変数が入っていない、もしくは上段と同等の値が入っていない場合は、それぞれの手順番号に戻って変数の設定を行います。
タスクの実施¶
| タスク標準時間: | 6分 |
|---|
1. 前処理¶
処理対象の状態確認¶
主処理の実施は、以下の状態であることを前提とします。
前提と異なることが判明した場合、直ちに処理を中止します。
事前条件1: OpenSSH confgファイル"${HOME}/.ssh/config"にディレクトリ"${HOME}/.ssh/conf.d/hosts"を対象としたインクルード文が存在する。
「OpenSSH confgファイル"${HOME}/.ssh/config"にディレクトリ"${HOME}/.ssh/conf.d/hosts"を対象としたインクルード文が存在する。」ことを確認します。
OpenSSH confgファイル"${HOME}/.ssh/config"にディレクトリ"${HOME}/.ssh/conf.d/hosts"を対象としたインクルード文が存在しないことを確認します。
コマンド:
cat ${FILE_SSH_CONFIG} \ | grep '^Include' \ | grep "${STRING_PATH_SSH_CONFIG}"
結果(例):
Include conf.d/hosts/*
事前条件2: OpenSSH設定用ディレクトリ"${HOME}/.ssh/conf.d/hosts"が存在する。
「OpenSSH設定用ディレクトリ"${HOME}/.ssh/conf.d/hosts"が存在する。」ことを確認します。
コマンド:
ls -d ${DIR_SSH_CONFIG}
結果(例):
${HOME}/.ssh/conf.d/hosts
2. 主処理¶
2.1. OpenSSH configファイルの更新¶
変数の確認
cat << EOF # FILE_SSH_CONFIG:"${HOME}/.ssh/config" FILE_SSH_CONFIG="${FILE_SSH_CONFIG}" EOF
コマンド:
mv ${FILE_SSH_CONFIG} ${FILE_SSH_CONFIG}.tmp
結果(例):
(出力なし)
コマンド:
cat ${FILE_SSH_CONFIG}.tmp \ | grep -v "^Include * ${STRING_PATH_SSH_CONFIG}" \ > ${FILE_SSH_CONFIG}
コマンド:
diff ${FILE_SSH_CONFIG} ${FILE_SSH_CONFIG}.tmp
結果(例):
0a1 > Include conf.d/hosts/*
差分確認ができたら一時ファイルを削除します。
コマンド:
rm ${FILE_SSH_CONFIG}.tmp
結果(例):
(出力なし)
2.2. OpenSSH設定用ディレクトリの削除¶
変数の確認:
cat << EOF # DIR_SSH_CONFIG:"${HOME}/.ssh/conf.d/hosts" DIR_SSH_CONFIG="${DIR_SSH_CONFIG}" EOF
コマンド:
rmdir ${DIR_SSH_CONFIG}
結果(例):
(出力なし)
3. 後処理¶
完了条件の確認¶
主処理は、以下を満たしたときに成功したものとします。
完了条件1: OpenSSH confgファイル"${HOME}/.ssh/config"にディレクトリ"${HOME}/.ssh/conf.d/hosts"を対象としたインクルード文が存在しない。
「OpenSSH confgファイル"${HOME}/.ssh/config"にディレクトリ"${HOME}/.ssh/conf.d/hosts"を対象としたインクルード文が存在しない。」ことを確認します。
OpenSSH confgファイル"${HOME}/.ssh/config"にディレクトリ"${HOME}/.ssh/conf.d/hosts"を対象としたインクルード文が存在しないことを確認します。
コマンド:
! cat ${FILE_SSH_CONFIG} \ | grep '^Include' \ | grep "${STRING_PATH_SSH_CONFIG}"
結果(例):
(出力なし)
完了条件2: OpenSSH設定用ディレクトリ"${HOME}/.ssh/conf.d/hosts"が存在しない。
「OpenSSH設定用ディレクトリ"${HOME}/.ssh/conf.d/hosts"が存在しない。」ことを確認します。
コマンド:
! ls -d ${DIR_SSH_CONFIG}
結果(例):
ls: ${HOME}/.ssh/conf.d/hosts No such file or directory
3.3. 後処理に必要な作業¶
conf.dディレクトリの削除
${HOME}/.ssh/conf.dディレクトリが空の場合は削除します。
コマンド:
if [ -z $( ls ${HOME}/.ssh/conf.d/ ) ]; then rmdir ${HOME}/.ssh/conf.d; fi
結果(例):
(出力なし)
configファイルの削除
${HOME}/.ssh/configに設定行が無い場合は削除します。
コマンド:
if [ -z $( cat ~/.ssh/config |grep -v ^# ) ]; then rm ~/.ssh/config ; fi
結果(例):
(出力なし)