シンプルなcode-server環境を作るためのCloudFormationテンプレートです。
本テンプレートではAWS環境の他にPinggyを使いHTTPSアクセスを実現します。
このテンプレートはAWS Cloud9の代替を意図して作成しました。
主な用途としてAWS Workshopsやコミュニティイベントのハンズオン等での 一時的な 利用を想定しています。
Warning
このテンプレートは永続的な開発環境として使うことを意図していません
永続的な開発環境が必要な場合はCoderを使用してください。
本テンプレートは新規にVPCとcode-serverがインストールされた1台のEC2インスタンスを作成します。
ただし、通常のcode-server-cfnと異なりセキュリティグループが全てのインバウンド通信を拒否する様になっています。
このテンプレートではPinggyを使い一時的な公開URL(無料版だと60分間利用可能)を発行し、そのURLにアクセスすることでcode-serverを使用します。
以下の環境でテスト済みです。
- AWS 東京リージョン (ap-northeast-1)
- Amazon Linux 2023 : 2023.5.20240730.0
- code-server : v4.91.1
VPC、EC2、IAMロールを作成可能な権限を持つユーザーで作業してください。
東京リージョンでAWS CloudShellを起動し以下のコマンドを実行して環境を構築します。
#
# 東京リージョンのAWS CloudShellで以下のコマンドを実行します
#
# 本リポジトリをclone
git clone https://github.com/stknohg/code-server-cfn.git --depth 1
cd code-server-cfn/
# CloudFormationスタックを作成
aws cloudformation create-stack --stack-name temp-code-server-pinggy \
--template-body file://./Pinggy/code-server-pinggy.yaml \
--capabilities CAPABILITY_NAMED_IAMCloudFormationスタックがエラー無く完了すればセットアップは完了です。
code-serverへアクセスする際にパスワードが必要になります。
このパスワードはEC2インスタンスのOS内部に保存されており、SSM Sessionでインスタンス内部に接続してから次のコマンドを実行して取得してください。
#
# SSM Sessionを使いEC2インスタンスに接続して次のコマンドを実行します
#
# code-serverのパスワードを取得
sudo cat /home/ec2-user/.config/code-server/config.yaml | grep password:
このパスワードは後で使用します。
続けて以下のコマンドを実行してPinggyの一時URLを発行します。
#
# SSM Sessionを使いEC2インスタンスに接続して次のコマンドを実行します
#
ssh -p 443 -R0:localhost:8080 a.pinggy.io初回実行時はホストキーの確認が出るのでyesを入力して処理を続行してください。
The authenticity of host '[a.pinggy.io]:443 ([xx.xx.xx.xx]:443)' can't be established.
RSA key fingerprint is SHA256:xxxxxxxxxxxxxxxxxx/xxxxxxxxxxxxxxxxxxxxxxx.
This key is not known by any other names
Are you sure you want to continue connecting (yes/no/[fingerprint])?
最終的に下図の形になればOKです。
SSM Sessionはこのままの状態にしておきます。
次にブラウザから発行された一時URLhttps://<ランダムな文字列>.a.free.pinggy.linkにアクセスし、「Enter site」をクリックします。
code-serverのログイン画面に遷移するので、先ほど取得したパスワードを入力し「SUBMIT」ボタンをクリックします。
初期設定を済ませて後は自由にWeb IDEを利用してください。
Web IDEの利用を終えた後はEC2インスタンスを停止し、CloudFormationスタックを削除して環境を削除します。
東京リージョンでAWS CloudShellを起動し以下のコマンドを実行すると環境を削除できます。
#
# 東京リージョンのAWS CloudShellで以下のコマンドを実行します
#
# CloudFormationスタックの削除
aws cloudformation delete-stack --stack-name temp-code-server-pinggy