5. CodePipelineパイプラインの作成 (handson-cli-pipeline)

作業の目的 [why]

CodePipelineパイプライン"handson-cli-pipeline"を作成します。

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

完了条件 [after]

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

完了条件1
CodePipelineパイプライン"handson-cli-pipeline"が存在する。

事前条件 [before]

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

事前条件1
パイプライン定義ファイル"${HOME}/tmp/conf-handson-cli/handson-cli-pipeline.json"が存在する。
事前条件2
CodePipelineパイプライン"handson-cli-pipeline"が存在しない。

作業対象 [what]

  • CodePipelineサービス

標準時間(合計)

8分

パラメータ設定

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

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

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

リソース1: パイプライン定義ファイル用ディレクトリ

パイプライン定義ファイルを配置したディレクトリ"${HOME}/tmp/conf-handson-cli"です。

リソース2: CodePipelineパイプライン名

  • 作成するCodePipelineパイプラインの名称です。
  • 今回は"handson-cli-pipeline"とします。

パラメータの指定

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

0.0. リージョンの指定

変数の設定

export AWS_DEFAULT_REGION='ap-northeast-1'

0.1. パイプライン定義ファイル用ディレクトリの指定

変数の設定:

DIR_CODEP_PIPELINE="${HOME}/tmp/conf-handson-cli"

0.2. CodePipelineパイプライン名の指定

CodePipelineパイプライン名を指定します。

変数の設定:

CODEP_PIPELINE_NAME='handson-cli-pipeline'

パラメータの保存

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

変数の設定:

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

結果(例):

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

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

変数の確認:

cat << EOF > ${FILE_PARAMETER}

  # 0.0. AWS_DEFAULT_REGION:"ap-northeast-1"
         AWS_DEFAULT_REGION="${AWS_DEFAULT_REGION}"

  # 0.1. DIR_CODEP_PIPELINE:"${HOME}/tmp/conf-handson-cli"
         DIR_CODEP_PIPELINE="${DIR_CODEP_PIPELINE}"
  # 0.2. CODEP_PIPELINE_NAME:"handson-cli-pipeline"
         CODEP_PIPELINE_NAME="${CODEP_PIPELINE_NAME}"

EOF

cat ${FILE_PARAMETER}

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

タスクの実施

タスク標準時間:6分

1. 前処理

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

パイプライン定義ファイル名の指定

変数の設定:

FILE_CODEP_PIPELINE="${DIR_CODEP_PIPELINE}/${CODEP_PIPELINE_NAME}.json" \
  && echo ${FILE_CODEP_PIPELINE}

結果(例):

${HOME}/tmp/conf-handson-cli/handson-cli-pipeline.json

1.2. 処理対象の状態確認

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

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

事前条件1: パイプライン定義ファイル"${HOME}/tmp/conf-handson-cli/handson-cli-pipeline.json"が存在する。

「パイプライン定義ファイル"${HOME}/tmp/conf-handson-cli/handson-cli-pipeline.json"が存在する。」ことを確認します。

コマンド:

ls ${FILE_CODEP_PIPELINE}

結果(例):

${HOME}/tmp/conf-handson-cli/handson-cli-pipeline.json

事前条件2: CodePipelineパイプライン"handson-cli-pipeline"が存在しない。

「CodePipelineパイプライン"handson-cli-pipeline"が存在しない。」ことを確認します。

コマンド:

aws codepipeline list-pipelines \
  --query "pipelines[?name == \`${CODEP_PIPELINE_NAME}\`].name" \
  --output text

結果(例):

(出力なし)

2. 主処理

CodePipelineパイプラインの作成

変数の確認:

cat << ETX

  # FILE_CODEP_PIPELINE:"${HOME}/tmp/conf-handson-cli/handson-cli-pipeline.json"
    FILE_CODEP_PIPELINE="${FILE_CODEP_PIPELINE}"

ETX

コマンド:

aws codepipeline create-pipeline \
  --pipeline file://${FILE_CODEP_PIPELINE}

結果(例):

{
  "pipeline": {

    (パイプラインの定義)

},
"metadata": {
    "pipelineArn": "arn:aws:codepipeline:ap-northeast-1:XXXXXXXXXXXX:handson-cli-pipeline",
    "created": 1550000000.123,
    "updated": 1550000000.123
  }
}

3. 後処理

完了条件の確認

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

完了条件1: CodePipelineパイプライン"handson-cli-pipeline"が存在する。

「CodePipelineパイプライン"handson-cli-pipeline"が存在する。」ことを確認します。

コマンド:

aws codepipeline list-pipelines \
  --query "pipelines[?name == \`${CODEP_PIPELINE_NAME}\`].name" \
  --output text

結果(例):

handson-cli-pipeline

完了