3.2. SSMパラメータストアの作成 (接続情報: /handson-cli/connection/redmine/dbinstance-handson-cli-ap-northeast-1-database-yml)

作業の目的 [why]

SSMパラメータ"/handson-cli/connection/redmine/dbinstance-handson-cli-ap-northeast-1-database-yml"を作成します。

ここでは、デフォルトのKMSキーを使用して暗号化します。

完了条件/事前条件 [設計者用情報]

完了条件 [after]

主処理は、以下を満たしたときに成功したものとします。

完了条件1
SSMパラメータ"/handson-cli/connection/redmine/dbinstance-handson-cli-ap-northeast-1-database-yml"が存在する。

事前条件 [before]

主処理の実施は、以下の状態であることを前提とします。

事前条件1
SSMパラメータ"/handson-cli/connection/redmine/dbinstance-handson-cli-ap-northeast-1-database-yml"が存在しない。
事前条件2
接続情報"${HOME}/tmp/dbinstance-handson-cli-ap-northeast-1-database-yml"が存在する。

作業対象 [what]

  • SSMサービス

標準時間(合計)

8分

パラメータ設定

パラメータ設定の標準時間:2分

作業に必要なモノ・情報 [resource]

作業開始には、以下が全て揃っていることが必要です。

リソース1: 一時ファイル用ディレクトリ

一時ファイル用ファイルが存在するディレクトリ"${HOME}/tmp"です。

リソース2: 接続権限の識別子

  • パラメータストアに登録する接続情報ファイルの接続権限の識別子です。
  • SSMパラメータ名に利用します。
  • 今回は"redmine"とします。

リソース3: 接続情報の識別子

  • パラメータストアに登録する接続情報ファイルの接続情報の識別子です。
  • SSMパラメータ名に利用します。
  • 今回は"dbinstance-handson-cli-ap-northeast-1-database-yml"とします。

リソース4: SSMパラメータ名プレフィクス

  • 作成するSSMパラメータ名のプレフィクスです。
  • パラメータへのアクセス制御のために利用します。
  • 今回は"handson-cli"とします。

リソース5: SSMパラメータの説明

  • 作成するSSMパラメータの説明です。
  • 今回は"ハンズオン用RedmineDB接続情報"とします。

パラメータの指定

作業に必要なパラメータを変数に格納をします。

0.0. リージョンの指定

変数の設定

export AWS_DEFAULT_REGION='<リージョン名>'

0.1. 一時ファイル用ディレクトリの指定

変数の設定:

DIR_TMP="${HOME}/tmp"

0.2. 接続対象の識別子

パラメータに登録する接続対象の識別子を指定します。

変数の設定:

CONNECTION_IDENT="redmine"

0.3. 接続対象の識別子

パラメータに登録する接続対象の識別子を指定します。

変数の設定:

CONNECTION_TARGET="dbinstance-handson-cli-ap-northeast-1-database-yml"

0.4. SSMパラメータ名のプレフィックス指定

パラメータ名のプレフィックスを指定します。

変数の設定:

SSM_PARAMETER_PREFIX='handson-cli'

0.5. SSMパラメータの説明

SSMパラメータの説明を指定します。

変数の設定:

SSM_PARAMETER_DESC='ハンズオン用RedmineDB接続情報'

パラメータの保存

設定されている変数の保存先となるファイル名を指定します。

変数の設定:

DIR_PARAMETER="${HOME}/tmp/parameter-handson-cli"
FILE_PARAMETER="${DIR_PARAMETER}/$(date +%Y-%m-%d)-ssm-parameter_connection-create.env" \
  && echo ${FILE_PARAMETER}

結果(例):

${HOME}/tmp/parameter-handson-cli/2019-04-30-ssm-parameter_connection-create.env

各変数に正しいパラメータ値が格納されていることを確認しながら保存します。

変数の確認:

cat << EOF > ${FILE_PARAMETER}

  # 0.0. AWS_DEFAULT_REGION:"<リージョン名>"
         AWS_DEFAULT_REGION="${AWS_DEFAULT_REGION}"

  # 0.1. DIR_TMP:"${HOME}/tmp"
         DIR_TMP="${DIR_TMP}"
  # 0.2. CONNECTION_IDENT:"redmine"
         CONNECTION_IDENT="${CONNECTION_IDENT}"
  # 0.3. CONNECTION_TARGET:"dbinstance-handson-cli-ap-northeast-1-database-yml"
         CONNECTION_TARGET="${CONNECTION_TARGET}"
  # 0.4. SSM_PARAMETER_PREFIX:"handson-cli"
         SSM_PARAMETER_PREFIX="${SSM_PARAMETER_PREFIX}"
  # 0.5. SSM_PARAMETER_DESC:"ハンズオン用RedmineDB接続情報"
         SSM_PARAMETER_DESC="${SSM_PARAMETER_DESC}"

EOF

cat ${FILE_PARAMETER}

下段の変数が入っていない、もしくは上段と同等の値が入っていない場合は、それぞれの手順番号に戻って変数の設定を行います。

タスクの実施

タスク標準時間:6分

1. 前処理

1.1. 状態確認に必要な情報の取得

SSMパラメータ名の指定

変数の設定:

SSM_PARAMETER_NAME="/${SSM_PARAMETER_PREFIX}/connection/${CONNECTION_IDENT}/${CONNECTION_TARGET}" \
  && echo ${SSM_PARAMETER_NAME}

結果(例):

/handson-cli/connection/redmine/dbinstance-handson-cli-ap-northeast-1-database-yml

接続情報ァイル名の指定

接続情報ファイル名を指定します。

変数の設定:

FILE_DATA="${DIR_TMP}/${CONNECTION_TARGET}" \
  && echo ${FILE_DATA}

結果(例):

${HOME}/tmp/dbinstance-handson-cli-ap-northeast-1-database-yml

1.2. 処理対象の状態確認

主処理の実施は、以下の状態であることを前提とします。

前提と異なることが判明した場合、直ちに処理を中止します。

事前条件1: SSMパラメータ"/handson-cli/connection/redmine/dbinstance-handson-cli-ap-northeast-1-database-yml"が存在しない。

「SSMパラメータ"/handson-cli/connection/redmine/dbinstance-handson-cli-ap-northeast-1-database-yml"が存在しない。」ことを確認します。

コマンド:

aws ssm describe-parameters \
  --filters "Key=Name,Values=${SSM_PARAMETER_NAME}" \
  --query 'Parameters[].Name' \
  --output text

結果(例):

(出力なし)

事前条件2: 接続情報"${HOME}/tmp/dbinstance-handson-cli-ap-northeast-1-database-yml"が存在する。

「接続情報"${HOME}/tmp/dbinstance-handson-cli-ap-northeast-1-database-yml"が存在する。」ことを確認します。

コマンド:

ls ${FILE_DATA}

結果:

${HOME}/tmp/dbinstance-handson-cli-ap-northeast-1-database-yml

2. 主処理

SSMパラメータの作成

変数の確認:

cat << ETX

  SSM_PARAMETER_NAME:"/handson-cli/connection/redmine/dbinstance-handson-cli-ap-northeast-1-database-yml"
  SSM_PARAMETER_NAME="${SSM_PARAMETER_NAME}"
  SSM_PARAMETER_DESC:"ハンズオン用RedmineDB接続情報"
  SSM_PARAMETER_DESC="${SSM_PARAMETER_DESC}"
  FILE_DATA:"${HOME}/tmp/dbinstance-handson-cli-ap-northeast-1-database-yml"
  FILE_DATA="${FILE_DATA}"

ETX

コマンド:

aws ssm put-parameter \
  --name ${SSM_PARAMETER_NAME} \
  --description ${SSM_PARAMETER_DESC} \
  --type SecureString \
  --value file:///${FILE_DATA}

結果(例):

{
  "Version": 1
}

3. 後処理

完了条件の確認

主処理は、以下を満たしたときに成功したものとします。

完了条件1: SSMパラメータ"/handson-cli/connection/redmine/dbinstance-handson-cli-ap-northeast-1-database-yml"が存在する。

「SSMパラメータ"/handson-cli/connection/redmine/dbinstance-handson-cli-ap-northeast-1-database-yml"が存在する。」ことを確認します。

コマンド:

aws ssm describe-parameters \
  --filters "Key=Name,Values=${SSM_PARAMETER_NAME}" \
  --query 'Parameters[].Name' \
  --output text

結果(例):

/handson-cli/connection/redmine/dbinstance-handson-cli-ap-northeast-1-database-yml

3.3. 後処理に必要な作業

後処理に必要な作業があれば実施します。

情報識別子ファイルの削除

コマンド:

rm ${FILE_DATA}

結果(例):

(出力なし)

完了