Step1: クラウド1

仮想サーバを初めて使う方や、Linux の上で Python アプリケーションを動かした経験がない方向けのコマンド例集です。以下の手順を参考に実行することで、sns-camp-api を仮想サーバ上で動作させるところまで到達できます。

sns-camp-api は Python 3.12 以上で動作します。まずローカルで、ダウンロードした sns-camp-api.zip を展開して自分の GitHub リポジトリに push します。その後、仮想サーバ上でそのリポジトリを git clone して配置します。GitHub を使った経験がある方は以下の手順で git clone、まだ GitHub を触っていない方は末尾の「（参考）GitHub を使わずに zip を転送する方法」で進めてください。GitHub の使い方は Git／GitHub 章で学べます。

GitHub リポジトリへの push（ローカルで実施）

GitHub にログインして、新しいリポジトリを作成しておいてください。プライベート・公開のどちらでも構いません。初期ファイル（README や .gitignore）は作成しない設定を推奨します。

ダウンロードした zip をローカルで展開します。

Windowsの場合:

Expand-Archive sns-camp-api.zip -DestinationPath sns-camp-api

Macの場合:

unzip sns-camp-api.zip -d sns-camp-api

展開したフォルダに移動します。

cd sns-camp-api

Git リポジトリを初期化します。

git init -b main

ファイルをステージングしてコミットします。

git add .

git commit -m "Initial commit"

GitHub で作成したリポジトリをリモートとして設定します。<自分のGitHubリポジトリURL> は作成したリポジトリの URL（例: https://github.com/<ユーザ名>/sns-camp-api.git）に置き換えてください。

git remote add origin <自分のGitHubリポジトリURL>

リモートに push します。

git push -u origin main

Git のインストール

ここからは仮想サーバ側での操作です。Amazon Linux 2023 の場合は、以下のコマンドで Git をインストールできます。

sudo dnf install -y git

Python 3.12 のインストール

Amazon Linux 2023 の場合は、以下のコマンドで Python 3.12 をインストールできます。

sudo dnf install -y python3.12 python3.12-pip

サンプルアプリケーションの配置

ホームディレクトリに移動します。

cd ~

自分の GitHub リポジトリから clone します。

git clone <自分のGitHubリポジトリURL> sns-camp-api

clone したディレクトリに移動します。

cd sns-camp-api

依存関係のインストール

requirements.txt に記載された依存関係をインストールします。

sudo pip3.12 install -r requirements.txt

サーバの起動

uvicorn app.main:app --host 0.0.0.0 --port 8080

ポート 8080 でサーバが起動します。別のターミナルから以下のコマンドでヘルスチェックのレスポンスが返れば起動確認完了です。

curl http://localhost:8080/health

バックグラウンドでの常駐化

SSH 接続を切ってもサーバが動き続けるようにするには、systemd サービスとして登録します。/etc/systemd/system/sns-camp-api.service を以下の内容で作成してください。

[Unit]
Description=SNS Camp API
After=network.target

[Service]
Type=simple
User=ec2-user
WorkingDirectory=/home/ec2-user/sns-camp-api
ExecStart=/usr/local/bin/uvicorn app.main:app --host 0.0.0.0 --port 8080
Restart=on-failure

[Install]
WantedBy=multi-user.target

以下のコマンドでサービスを有効化・起動します。

sudo systemctl daemon-reload
sudo systemctl enable --now sns-camp-api

（参考）GitHub を使わずに zip を転送する方法

GitHub がすぐに使えない場合は、ローカルの sns-camp-api.zip を SCP で仮想サーバに転送し、仮想サーバ上で unzip して展開する方法でも代替できます。

ローカルで実施

ローカルから仮想サーバに zip を転送します。<鍵ファイル> は仮想サーバ作成時にダウンロードした .pem ファイル、<仮想サーバのパブリックIP> は仮想サーバのパブリック IP アドレスに置き換えてください。

scp -i <鍵ファイル> sns-camp-api.zip ec2-user@<仮想サーバのパブリックIP>:~/

仮想サーバで実施

unzip をインストールします。

sudo dnf install -y unzip

ホームディレクトリに移動し、zip を展開します。

cd ~

unzip sns-camp-api.zip -d sns-camp-api

cd sns-camp-api

Auto Scaling グループでは、スケールアウトや障害復旧のタイミングで新しい EC2 インスタンスが自動的に起動します。このとき、新しいインスタンスに毎回 SSH で接続して手作業でセットアップしていては、スケーリングの自動化が成立しません。Launch Template の「ユーザデータ」にセットアップスクリプトを設定しておくと、新しいインスタンスの初回起動時に自動実行され、アプリケーションが動く状態まで仕上がります。

以下のスクリプトを Launch Template の「ユーザデータ」に設定してください。<自分のGitHubリポジトリURL> は自分のリポジトリ URL に書き換えてください。

#!/bin/bash
set -eux

# Git と Python のインストール
dnf install -y git python3.12 python3.12-pip

# アプリケーションの clone
cd /home/ec2-user
sudo -u ec2-user git clone <自分のGitHubリポジトリURL> sns-camp-api

# 依存関係のインストール
cd sns-camp-api
pip3.12 install -r requirements.txt

# systemd サービスの作成
cat > /etc/systemd/system/sns-camp-api.service <<EOF
[Unit]
Description=SNS Camp API
After=network.target

[Service]
Type=simple
User=ec2-user
WorkingDirectory=/home/ec2-user/sns-camp-api
ExecStart=/usr/local/bin/uvicorn app.main:app --host 0.0.0.0 --port 8080
Restart=on-failure

[Install]
WantedBy=multi-user.target
EOF

# サービスの有効化・起動
systemctl daemon-reload
systemctl enable --now sns-camp-api

ユーザデータは EC2 の初回起動時に root ユーザとして実行されます。実行ログは EC2 インスタンス内の /var/log/cloud-init-output.log で確認できます。