1. ソースクレデンシャルの登録 (GitHub: personal access token)¶
作業の目的 [why]¶
GitHubのpersonal access tokenをCodeBuildに登録します。
完了条件/事前条件 [設計者用情報]
完了条件 [after]
主処理は、以下を満たしたときに成功したものとします。
- 完了条件1
- GitHubのpersonal access tokenがCodeBuildに登録されている。
事前条件 [before]
主処理の実施は、以下の状態であることを前提とします。
- 事前条件1
- GitHubのpersonal access tokenがCodeBuildに登録されていない。
作業対象 [what]¶
- CodeBuildサービス
標準時間(合計)¶
8分
パラメータ設定¶
| パラメータ設定の標準時間: | 2分 |
|---|
作業に必要なモノ・情報 [resource]¶
作業開始には、以下が全て揃っていることが必要です。
リソース1: ソースクレデンシャルサーバタイプ
- CodeBuildに登録するソースクレデンシャルのサーバタイプです。
- 今回は"GITHUB"とします。
リソース2: ソースクレデンシャル認証タイプ
- CodeBuildに登録するソースクレデンシャルの認証タイプです。
- 今回は"PERSONAL_ACCESS_TOKEN"とします。
リソース3: GitHubアカウント
- CodeBuildに登録するソースクレデンシャルの発行元となるGitHubアカウントです。
パラメータの指定¶
作業に必要なパラメータを変数に格納をします。
0.2. ソースクレデンシャル認証タイプの指定¶
ソースクレデンシャル認証タイプを指定します。
変数の設定:
CODEB_SOURCE_AUTH_TYPE='PERSONAL_ACCESS_TOKEN'
0.3. ソースクレデンシャル認証タイプの指定¶
GitHubのPersonal access tokenを取得し、その値を指定します。
トークン作成画面へのアクセス
- Githubのメニューバー右上の自分のアイコンをクリックします。
- "Settings"をクリックします。
- Public profile(画面)が表示されます。
Public profile(画面)
- 左ペインの"Developer settings"をクリックします。
- Developer settings(画面)が表示されます。
Developer settings(画面)
- 左ペインの"Personal access tokens"をクリックします。
- Personal access tokens(画面)が表示されます。
Personal access tokensの作成
- "Generate new token"(ボタン)をクリックします。
- 以下を入力します。
Token description: handson-cli-codebuild
- 以下のチェックをオンにします。
- public_repo
- "Generate token"(ボタン)をクリックします。
- トークン文字列をコピーします。
警告
トークン文字列はこの画面でしか取得できません。
トークン文字列の指定
変数の設定:
CODEB_SOURCE_CREDENTIALS_TOKEN='<トークン文字列>'
パラメータの保存¶
設定されている変数の保存先となるファイル名を指定します。
変数の設定:
DIR_PARAMETER="${HOME}/tmp/parameter-handson-cli" FILE_PARAMETER="${DIR_PARAMETER}/$(date +%Y-%m-%d)-codebuild-source_credentials-create.env" \ && echo ${FILE_PARAMETER}
結果(例):
${HOME}/tmp/parameter-handson-cli/2019-04-30-codebuild-source_credentials-create.env
各変数に正しいパラメータ値が格納されていることを確認しながら保存します。
変数の確認:
cat << EOF > ${FILE_PARAMETER} # 0.0. AWS_DEFAULT_REGION:"ap-northeast-1" AWS_DEFAULT_REGION="${AWS_DEFAULT_REGION}" # 0.1. CODEB_SOURCE_SERVER_TYPE:"GITHUB" CODEB_SOURCE_SERVER_TYPE="${CODEB_SOURCE_SERVER_TYPE}" # 0.2. CODEB_SOURCE_AUTH_TYPE:"PERSONAL_ACCESS_TOKEN" CODEB_SOURCE_AUTH_TYPE="${CODEB_SOURCE_AUTH_TYPE}" # 0.3. CODEB_SOURCE_CREDENTIALS_TOKEN:"<トークン文字列>" CODEB_SOURCE_CREDENTIALS_TOKEN="${CODEB_SOURCE_CREDENTIALS_TOKEN}" EOF cat ${FILE_PARAMETER}
下段の変数が入っていない、もしくは上段と同等の値が入っていない場合は、それぞれの手順番号に戻って変数の設定を行います。
タスクの実施¶
| タスク標準時間: | 6分 |
|---|
1. 前処理¶
処理対象の状態確認¶
主処理の実施は、以下の状態であることを前提とします。
前提と異なることが判明した場合、直ちに処理を中止します。
事前条件1: GitHubのpersonal access tokenがCodeBuildに登録されていない。
「GitHubのpersonal access tokenがCodeBuildに登録されていない。」ことを確認します。
コマンド:
aws codebuild list-source-credentials \ --query "sourceCredentialsInfos[? \ serverType == \`${CODEB_SOURCE_SERVER_TYPE}\` \ && authType == \`${CODEB_SOURCE_AUTH_TYPE}\` \ ].arn" \ --output text
結果(例):
(出力なし)
2. 主処理¶
ソースクレデンシャルの登録¶
パラメータの確認:
cat << ETX # CODEB_SOURCE_SERVER_TYPE:"GITHUB" CODEB_SOURCE_SERVER_TYPE="${CODEB_SOURCE_SERVER_TYPE}" # CODEB_SOURCE_AUTH_TYPE:"PERSONAL_ACCESS_TOKEN" CODEB_SOURCE_AUTH_TYPE="${CODEB_SOURCE_AUTH_TYPE}" # CODEB_SOURCE_CREDENTIALS_TOKEN:"<トークン文字列>" CODEB_SOURCE_CREDENTIALS_TOKEN="${CODEB_SOURCE_CREDENTIALS_TOKEN}" ETX
コマンド:
aws codebuild import-source-credentials \ --server-type ${CODEB_SOURCE_SERVER_TYPE} \ --auth-type ${CODEB_SOURCE_AUTH_TYPE} \ --token ${CODEB_SOURCE_CREDENTIALS_TOKEN}
結果(例):
{ "arn": "arn:aws:codebuild:ap-northeast-1:XXXXXXXXXXXX:token/github" }
3. 後処理¶
完了条件の確認¶
主処理は、以下を満たしたときに成功したものとします。
完了条件1: GitHubのpersonal access tokenがCodeBuildに登録されている。
「GitHubのpersonal access tokenがCodeBuildに登録されている。」ことを確認します。
コマンド:
aws codebuild list-source-credentials \ --query "sourceCredentialsInfos[? \ serverType == \`${CODEB_SOURCE_SERVER_TYPE}\` \ && authType == \`${CODEB_SOURCE_AUTH_TYPE}\` \ ].arn" \ --output text
結果(例):
arn:aws:codebuild:ap-northeast-1:XXXXXXXXXXXX:token/github