AWS CloudShell を利用したデプロイ方法の確立 (#669)

* fix

* fix

* fix

* fix

* Update DEPLOY_ON_CLOUDSHELL.md

---------

Co-authored-by: Taichiro Suzuki <[email protected]>

Author: tbrand

README.md

@@ -111,6 +111,7 @@ Generative AI（生成 AI）は、ビジネスの変革に革新的な可能性
 
 GenU のデプロイには [AWS Cloud Development Kit](https://aws.amazon.com/jp/cdk/)（以降 CDK）を利用します。Step-by-Step の解説、あるいは、別のデプロイ手段を利用する場合は以下を参照してください。
 - [Workshop](https://catalog.workshops.aws/generative-ai-use-cases-jp)
+- [AWS CloudShell を利用したデプロイ方法 (手元の環境を用意することが難しい場合)](/docs/DEPLOY_ON_CLOUDSHELL.md)
 - [動画によるデプロイ手順の紹介](https://www.youtube.com/watch?v=9sMA17OKP1k)
 
 まず、以下のコマンドを実行してください。全てのコマンドはリポジトリのルートで実行してください。
@@ -171,7 +172,6 @@ npm run cdk:deploy
  - [アップデート方法](/docs/UPDATE.md)
  - [ローカル開発環境構築手順](/docs/DEVELOPMENT.md)
  - [リソースの削除方法](/docs/DESTROY.md)
- - [AWS 上で完結するデプロイ方法 (手元に環境を用意することが難しい場合)](/docs/DEPLOY_ON_AWS.md)
  - [ネイティブアプリのように利用する方法](/docs/PWA.md)
  - [ブラウザ拡張機能を利用する](/browser-extension/README.md)
 

deploy.sh

@@ -0,0 +1,63 @@
+#!/bin/bash
+
+set -e
+
+echo "--------------------------"
+echo "  _____            _    _ "
+echo " / ____|          | |  | |"
+echo "| |  __  ___ _ __ | |  | |"
+echo "| | |_ |/ _ \ '_ \| |  | |"
+echo "| |__| |  __/ | | | |__| |"
+echo " \_____|\___|_| |_|\____/ "
+echo "--------------------------"
+
+# コマンド引数の処理
+while [[ $# -gt 0 ]]; do
+    case "$1" in
+        -c|--cdk-context)
+            cdk_context_path="$2"
+            shift 2
+            ;;
+        -h|--help)
+            echo "-c, --cdk-context ... Path to the cdk.json file"
+            echo "-h, --help        ... Show this message"
+            exit 0
+            ;;
+        *)
+            echo "Unknown option: $1"
+            exit 1
+            ;;
+    esac
+done
+
+pushd /tmp
+
+# /tmp に存在するリポジトリを念の為削除
+rm -rf generative-ai-use-cases-jp
+
+# GenU を clone
+git clone https://github.com/aws-samples/generative-ai-use-cases-jp
+
+pushd generative-ai-use-cases-jp
+
+# npm パッケージのインストール
+npm ci
+
+# cdk.json が指定されている場合は上書きする
+if [[ -n "$cdk_context_path" ]]; then
+    echo "Overwrite the cdk.json by $cdk_context_path"
+    cp -f $cdk_context_path packages/cdk/cdk.json
+fi
+
+# CDK の bootstrap
+npx -w packages/cdk cdk bootstrap
+
+# デプロイの実行
+npm run cdk:deploy
+
+# デプロイした CloudFront の url を取得
+weburl=`aws cloudformation describe-stacks --stack-name GenerativeAiUseCasesStack --output json | jq -r ".Stacks[0].Outputs[] | select(.OutputKey==\"WebUrl\") | .OutputValue"`
+
+echo "*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*"
+echo "Welcome to GenU: $weburl"
+echo "*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*"

docs/DEPLOY_ON_AWS.md

@@ -1,4 +1,9 @@
-# AWS 上で完結するデプロイ方法 (手元に環境を用意することが難しい場合)
+# (DEPRECATED) AWS 上で完結するデプロイ方法 (手元に環境を用意することが難しい場合)
+
+> [!Caution]
+> この手順は AWS Cloud9 が新規のお客様向けアクセスを閉じたことを受け、非推奨手順となりました。
+> AWS 上で完結するデプロイ方法については [CloudShell を利用したデプロイ方法](/docs/DEPLOY_ON_CLOUDSHELL.md) をご参照ください。
+> また、AWS Cloud9 からの移行については [こちら](https://aws.amazon.com/jp/blogs/news/how-to-migrate-from-aws-cloud9-to-aws-ide-toolkits-or-aws-cloudshell/) のブログをご参照ください。
 
 AWS CloudShell と AWS Cloud9 を利用することで、手元の環境に依存しないデプロイが可能です。(デプロイが AWS 上で完結します。)
 

docs/DEPLOY_ON_CLOUDSHELL.md

@@ -0,0 +1,47 @@
+# AWS CloudShell を利用したデプロイ方法 (手元の環境を用意することが難しい場合)
+
+## cdk.json の編集
+
+GenU では cdk.json の context 以下をカスタマイズすることで、デプロイオプションを指定できます。
+利用可能なデプロイオプションについては [デプロイオプション](/docs/DEPLOY_OPTION.md) をご参照ください。
+一旦、[デフォルトの cdk.json](/packages/cdk/cdk.json) で構わないという場合は、こちらの手順をスキップしていただいて構いません。
+
+デプロイオプションを指定する場合は、[デフォルトの cdk.json](/packages/cdk/cdk.json) をダウンロード (GitHub ページ右上のダウンロードボタンからファイルをダウンロードできます) し、context 以下を変更してファイルを保存してください。
+
+## CloudShell の起動
+
+[CloudShell](https://console.aws.amazon.com/cloudshell/home) を起動します。
+前述した手順で cdk.json をカスタマイズした場合は、右上 Actions の Upload file からカスタマイズした cdk.json をアップロードしてください。
+
+## deploy.sh のダウンロードと実行権限の付与
+
+CloudShell 上で以下のコマンドを実行し、`deploy.sh` というスクリプトをダウンロードします。
+また、ダウンロード後に deploy.sh に実行権限を付与しています。
+
+```bash
+wget https://raw.githubusercontent.com/aws-samples/generative-ai-use-cases-jp/refs/heads/main/deploy.sh -O deploy.sh
+chmod +x deploy.sh
+```
+
+## deploy.sh の実行
+
+以下のコマンドで `deploy.sh` を実行します。
+なお、`--cdk-context` オプションでカスタマイズした cdk.json へのパスを指定しています。(特に何もせず前述した手順で Upload files した場合はこのパスになります。)
+cdk.json が別のパスにある場合は、適宜引数の値を変更してください。
+
+```bash
+./deploy.sh --cdk-context ~/cdk.json
+```
+
+なお、cdk.json のカスタマイズが必要ない場合は `--cdk-context` の指定は不要です。
+その場合、[デフォルトの cdk.json](/packages/cdk/cdk.json) の設定でデプロイされます。
+
+```bash
+./deploy.sh
+```
+
+デプロイ途中に確認プロンプトが表示されるので、`y` と入力して Enter して進めてください。
+デプロイ完了時に CloudFront の URL が表示されます。その URL をブラウザで開くことで GenU にアクセスできます。
+
+なお、これらの手順を実行する場合も [Amazon Bedrock の Model access](https://console.aws.amazon.com/bedrock/home#/modelaccess) から利用するモデルの有効化が必要です。
+デフォルトの cdk.json を使っている場合は、[デフォルトの cdk.json](/packages/cdk/cdk.json) の modelRegion において modelIds と imageGenerationModelIds で指定されたモデルが有効化されているかを確認してください。

docs/UPDATE.md

@@ -3,6 +3,8 @@
 GenU は頻繁にアップデートされています。
 機能追加・改善に加え、セキュリティ文脈のアップデートが入ることもありますので、定期的にリポジトリの main ブランチを pull して再デプロイすることをお勧めします。
 
+[AWS CloudShell を利用したデプロイ方法](/docs/DEPLOY_ON_CLOUDSHELL.md) を利用している場合、常に最新の main ブランチをデプロイするため、再度 `deploy.sh` を実行するとアップデートされます。(以下の手順は不要です。)
+
 ## main ブランチを pull する
 
 すでにリポジトリを clone 済みで、初回デプロイが完了していることを想定しています。