Skip to content

Docker Compose

初期プロジェクト : tutorial-server-db-integration

完成版プロジェクト : tutorial-server-docker-compose

このトピックでは、Docker Compose 上でサーバーKtorアプリケーションを実行する方法を説明します。データベースの統合Exposed SQL ライブラリを使用して Ktor サービスをデータベースリポジトリに接続するプロセスを学びます。チュートリアルで作成したプロジェクトを使用します。このチュートリアルでは、データベースとWebアプリケーションが個別に実行され、Exposed を使用して PostgreSQL データベースに接続します。

アプリケーションの準備

データベース設定の抽出

データベースの統合チュートリアルで作成したプロジェクトでは、データベース接続を確立するためにハードコードされた属性を使用しています。

PostgreSQLデータベースの接続設定をカスタム構成グループ構成ファイルでさまざまなサーバーパラメータを設定する方法について説明します。に抽出しましょう。

  1. src/main/resources にある application.yaml ファイルを開き、次のように ktor グループの外側に storage グループを追加します:

    yaml
    ktor:
      application:
        modules:
          - com.example.ApplicationKt.module
      deployment:
        port: 8080
    storage:
      driverClassName: "org.postgresql.Driver"
      jdbcURL: "jdbc:postgresql://localhost:5432/ktor_tutorial_db"
      user: "postgres"
      password: "password"

    これらの設定は、後で compose.yml ファイルで構成されます。

  2. src/main/kotlin/com/example/plugins/ にある Databases.kt ファイルを開き、設定ファイルからストレージ設定を読み込むように configureDatabases() 関数を更新します:

    kotlin
    fun Application.configureDatabases(config: ApplicationConfig) {
        val url = config.property("storage.jdbcURL").getString()
        val user = config.property("storage.user").getString()
        val password = config.property("storage.password").getString()
    
        Database.connect(
            url,
            user = user,
            password = password
        )
    }

    configureDatabases() 関数が ApplicationConfig を受け取り、config.property を使用してカスタム設定を読み込むようになりました。

  3. src/main/kotlin/com/example/ にある Application.kt ファイルを開き、アプリケーション起動時に接続設定を読み込むように environment.config を configureDatabases() に渡します:

    kotlin
    fun Application.module() {
        val repository = PostgresTaskRepository()
    
        configureSerialization(repository)
        configureDatabases(environment.config)
        configureRouting()
    }

Ktorプラグインの構成

Docker上で実行するには、アプリケーションに必要なすべてのファイルをコンテナにデプロイする必要があります。使用しているビルドシステムに応じて、これを実現するためのさまざまなプラグインがあります:

この例では、Ktorプラグインはすでに build.gradle.kts ファイルに適用されています。

kotlin
plugins {
    application
    alias(libs.plugins.kotlin.jvm)
    alias(ktorLibs.plugins.ktor)
    alias(libs.plugins.kotlin.serialization)
}

Dockerの構成

Dockerイメージの準備

アプリケーションをDocker化するには、プロジェクトのルートディレクトリに新しい Dockerfile を作成し、次のコンテンツを挿入します:

docker
# Stage 1: Cache Gradle dependencies
FROM gradle:latest AS cache
RUN mkdir -p /home/gradle/cache_home
ENV GRADLE_USER_HOME=/home/gradle/cache_home
COPY build.gradle.* gradle.properties /home/gradle/app/
COPY gradle /home/gradle/app/gradle
WORKDIR /home/gradle/app
RUN gradle dependencies --no-daemon

# Stage 2: Build Application
FROM gradle:latest AS build
COPY --from=cache /home/gradle/cache_home /home/gradle/.gradle
COPY --chown=gradle:gradle . /home/gradle/src
WORKDIR /home/gradle/src
# Build the fat JAR, Gradle also supports shadow
# and boot JAR by default.
RUN gradle buildFatJar --no-daemon

# Stage 3: Create the Runtime Image
FROM amazoncorretto:22 AS runtime
EXPOSE 8080
RUN mkdir /app
COPY --from=build /home/gradle/src/build/libs/*.jar /app/ktor-docker-sample.jar
ENTRYPOINT ["java","-jar","/app/ktor-docker-sample.jar"]
このマルチステージビルドの仕組みの詳細については、Dockerイメージの準備を参照してください。

この例ではAmazon Corretto Dockerイメージを使用していますが、以下のような他の適切な代替手段に置き換えることもできます:

Docker Composeの構成

プロジェクトのルートディレクトリに新しい compose.yml ファイルを作成し、次のコンテンツを追加します:

yaml
services:
  web:
    build: .
    ports:
      - "8080:8080"
    depends_on:
      db:
        condition: service_healthy
  db:
    image: postgres
    volumes:
      - ./tmp/db:/var/lib/postgresql/data
    environment:
      POSTGRES_DB: ktor_tutorial_db
      POSTGRES_HOST_AUTH_METHOD: trust
    ports:
      - "5432:5432"
    healthcheck:
      test: [ "CMD-SHELL", "pg_isready -U postgres" ]
      interval: 1s
  • web サービスは、イメージ 内にパッケージ化されたKtorアプリケーションを実行するために使用されます。
  • db サービスは、postgres イメージを使用して、タスクを保存するための ktor_tutorial_db データベースを作成します。

サービスのビルドと実行

  1. 次のコマンドを実行して、Ktorアプリケーションを含む fat JAR を作成します:

    bash
    ./gradlew :tutorial-server-docker-compose:buildFatJar
  2. docker compose up コマンドを使用して、イメージをビルドし、コンテナを起動します:

    bash
    docker compose --project-directory snippets/tutorial-server-docker-compose up
  3. Docker Composeによるイメージのビルドが完了するまで待ちます。
  4. http://localhost:8080/static/index.html にアクセスして、Webアプリケーションを開きます。新しいタスクのフィルタリングと追加のための3つのフォーム、およびタスクのテーブルが表示されたTask Manager Clientページが表示されるはずです。

    A browser window showing the Task Manager Client