Skip to content

Ktor アプリケーションを AWS Elastic Beanstalk にデプロイする ​

初期プロジェクト: embedded-server または engine-main

最終プロジェクト: aws-elastic-beanstalk

このチュートリアルでは、Ktor アプリケーションを準備し、Amazon Web Services (AWS) Elastic Beanstalk にデプロイする方法を学びます。 Ktor サーバーの作成方法に応じて、以下のいずれかの初期プロジェクトを使用できます。

AWS Elastic Beanstalk への Java アプリケーションのデプロイについての詳細は、Elastic Beanstalk のドキュメントを参照してください。

前提条件 ​

このチュートリアルを開始する前に、AWS アカウントを作成する必要があります。

サンプルアプリケーションのクローン ​

サンプルアプリケーションを開くには、以下の手順に従います。

  1. Ktor ドキュメントリポジトリをクローンし、codeSnippets プロジェクトを開きます。
  2. embedded-server または engine-main サンプルを開きます。これらのサンプルは、コード内または設定ファイルを使用する、Ktor サーバーの作成と設定の異なるアプローチを示しています。これらのプロジェクトのデプロイにおける唯一の違いは、受信リクエストをリッスンするために使用するポートの指定方法です。

アプリケーションの準備 ​

ステップ 1: ポートの設定 ​

まず、受信リクエストをリッスンするために使用するポートを指定する必要があります。Elastic Beanstalk はポート 5000 でアプリケーションにリクエストを転送します。必要に応じて、PORT 環境変数を設定することでデフォルトのポートをオーバーライドできます。Ktor サーバーの設定方法に応じて、次のいずれかの方法でポートを設定できます。

  • コード内でサーバー設定を指定する embedded-server サンプルを選択した場合、System.getenv を使用して環境変数の値を取得するか、環境変数が指定されていない場合はデフォルト値の 5000 を使用できます。src/main/kotlin/com/example フォルダにある Application.kt ファイルを開き、以下のように embeddedServer 関数の port パラメーター値を変更します。

    kotlin
    fun main() {
       embeddedServer(Netty, port = (System.getenv("PORT")?:"5000").toInt()) {
       // ...
       }.start(wait = true)
    }
  • application.conf ファイルでサーバー設定を指定する engine-main サンプルを選択した場合、${ENV} 構文を使用して port パラメーターに環境変数を割り当てることができます。src/main/resources にある application.conf ファイルを開き、以下のように更新します。

    ktor {
        deployment {
            port = 5000
            port = ${?PORT}
        }
    }

ステップ 2: Ktor プラグインの適用 ​

このチュートリアルでは、fat JAR を使用して AWS Elastic Beanstalk にアプリケーションをデプロイする方法を示します。fat JAR を生成するには、Ktor プラグインを適用する必要があります。

build.gradle.kts ファイルを開き、plugins {} ブロックにプラグインを追加します。

groovy
plugins {
    alias(ktorLibs.plugins.ktor)
}
上記のコードスニペットでは、Ktor の依存関係を指定するために Ktor バージョンカタログを使用しています。

次に、メインアプリケーションクラスが設定されていることを確認します。

kotlin
application {
    mainClass.set("io.ktor.server.netty.EngineMain")
}

Fat JAR のビルド ​

Fat JAR をビルドするには、ターミナルを開き、Ktor プラグインによって提供される buildFatJar タスクを実行します。

./gradlew :aws-elastic-beanstalk:buildFatJar
gradlew.bat :aws-elastic-beanstalk:buildFatJar

このビルドが完了すると、build/libs ディレクトリに aws-elastic-beanstalk-all.jar ファイルが生成されます。

アプリケーションのデプロイ ​

アプリケーションをデプロイするには、AWS マネジメントコンソールにサインインし、以下の手順に従います。

  1. AWS サービスグループにある Elastic Beanstalk サービスを開きます。
  2. 開いたページで、Create Application をクリックします。
  3. 以下のアプリケーション設定を指定します。
    • Application name: アプリケーション名を指定します(例: Sample Ktor app)。
    • Platform: リストから Java を選択します。
    • Platform branch: Corretto 11 running on 64bit Amazon Linux 2 を選択します。
    • Application code: Upload your code を選択します。
    • Source code origin: Local file を選択します。次に、Choose file ボタンをクリックし、前のステップで生成された Fat JAR を選択します。ファイルのアップロードが完了するまで待ちます。
  4. Create application ボタンをクリックし、Beanstalk が環境を作成してアプリケーションを公開するまで数分待ちます。
    INFO    Instance deployment completed successfully.
    INFO    Application available at Samplektorapp-env.eba-bnye2kpu.us-east-2.elasticbeanstalk.com.
    INFO    Successfully launched environment: Samplektorapp-env