はじめに
概要
このところ AWS CodeStar を使った開発を行っています。
CodeStarはざっくりいうとCI/CDサービスとダッシュボードをまとめたサービスという理解でいます。
CI/CDツールもパッケージ化して作成してくれるので書いたコードがすぐに反映されるのでちゃちゃっと試したいときに便利なものではあります。
ただ作り込んでいくと(AWS初心者の私は)権限周りで躓くことが結構ありました。
今後S3アクセスやLambdaのVPC配置、EC2プロジェクトについても随時更新していく予定です。
まずはローカルのテキストエディタでコードを編集・Pushして変更を確認するところまで。
前提
- 作業日時:2020/4/11
- ローカル環境
- PC:Mac
- OS:Catalina
- インストール済みコマンド:Git CLI, AWS CLI
- AWS環境
- ユーザー:root
- AWSリージョン:東京(ap-northeast-1)
※ 2020/4/11時点で東京リージョンのCodeStarは開発環境としてのCloud9をサポートしてないのでご注意ください
CodeStarプロジェクト 作成手順
4.今回プロジェクト名は「hello-world-codestar」、プロジェクトIDは「codestar-test」とし、リポジトリはCodeCommitを使用します
※ プロジェクトIDは編集可能15文字まで、かつこのIDが後述のCodeStarが作成するサービスの各所(URLやサービス名、ARN)に響いてくる上に変更不可なので要注意
5.「AWS CodeStarが、〜(略)〜」のチェックボックスにチェックが付いている状態で「プロジェクトを作成」を押します
※ 押すとすぐに関連サービスのデプロイが行われるので要注意
※ かつPublicなURLが公開される点も注意
※ CodeStarのプロジェクト作成により7-8個のサービスが自動で作成されるので、むやみに作ると環境が一気にごちゃごちゃします・・
6.リポジトリ作成中...(リポジトリ作成が終わるとCodeCommit内に作られたリポジトリのURLが表示されます、)「スキップ」を選択
※ コードの編集環境の設定は後ででも行えます
8.この状態でダッシュボード中「アプリケーションのエンドポイント」にアクセスすると初期テンプレートのLambdaからの応答を確認できます
ローカルPCでのコード編集 ~テキストエディタ編~
-
作成したプロジェクトのダッシュボード画面から「ツールに接続」を選択し、リポジトリURLをコピー
※ 対象ユーザーGit credentials
-
ローカルマシンのCLIでコピーしたURLをclone、初回Cloneの場合Git credentialsのユーザー名/パスワードの入力が必要です
-
Cloneしたコードの階層は下記のようになっています、今回は「index.py」を編集してLambdaの応答が変化することを確認します
※ ここでは深く触れませんがbuidspec.ymlやtemplate.yml、またIAMのロール/ポリシーを適切に設定することで、Lambdaのbuildテストやデプロイ設定のアップデートが可能です
-
index.pyを編集・保存します、下の例ではoutputのvalueに「CodeStar!」を付け加えています
import json
import datetime
def handler(event, context):
data = {
# 'output': 'Hello World',
'output': 'Hello World CodeStar!',
'timestamp': datetime.datetime.utcnow().isoformat()
}
return {'statusCode': 200,
'body': json.dumps(data),
'headers': {'Content-Type': 'application/json'}}
5.add → commit → pushでリモートリポジトリに変更を反映させます
※ このときAWS CLIのconfigurationがcloneしたリポジトリの存在する環境じゃないとpushに失敗します、設定方法はこちらを参照
6.pushが成功するとCodeStarのダッシュボードでPipeLineのステータスが更新されていきます
7.Deployも完了し全フェーズのステータスがGreenとなったこと確認し、アプリのエンドポイントにアクセスし、コードの変更が反映されていることを確認します
さいごに
- CodeStarプロジェクトの作成方法とテキストエディタでのコード編集方法について下記ましたが、IDEでのコード編集&pushも可能です
- 振り返るとローカルで編集してpushするだけでも意外と工程があるなぁと思い知らされました
(備考)CodeStarのプロジェクトIDについて
開くとプロジェクト詳細とCodeStarによって作成されたリソースの一覧が表示されます
見て分かる通り作成手順4で設定したプロジェクトIDが至るところで使用されています、前述の通りプロジェクトIDは変更ができないため注意が必要なのはこのためです
(プロジェクトIDの変更手順をご存知の方いらっしゃいましたらお教えください!)