デプロイ
Code example: deployment-ktor-plugin
このトピックでは、Ktorアプリケーションをデプロイする方法の概要について説明します。
サーバーKtorアプリケーションのデプロイプロセスを簡素化するために、以下の機能を提供するGradle用Ktorプラグインを使用できます。
- Fat JARのビルド
- アプリケーションのDocker化
Ktorデプロイの仕様
サーバーKtorアプリケーションのデプロイプロセスは、以下の仕様によって異なります。
- アプリケーションを自己完結型のパッケージとしてデプロイするのか、それともサーブレットコンテナ内にデプロイするのか。
- サーバーの作成と設定にどちらのアプローチを使用するか。
自己完結型アプリ vs サーブレットコンテナ
Ktorを使用すると、アプリケーション内で直接、希望するネットワークエンジン(Netty、Jetty、Tomcatなど)を含むサーバーを作成して起動できます。この場合、エンジンはアプリケーションの一部となります。アプリケーションはエンジンの設定、接続、およびSSLオプションを制御できます。アプリケーションをデプロイするには、Fat JARまたは実行可能JVMアプリケーションとしてパッケージ化できます。
上記のアプローチとは対照的に、サーブレットコンテナではコンテナ側がアプリケーションのライフサイクルと接続設定を制御する必要があります。Ktorは、アプリケーションの制御をサーブレットコンテナに委任する特別なServletApplicationEngineエンジンを提供します。サーブレットコンテナ内にデプロイするには、WARアーカイブを生成する必要があります。
設定:コード vs 設定ファイル
自己完結型のKtorアプリケーションをデプロイ用に設定する方法は、サーバーの作成と設定に使用したアプローチ(コード内で行うか、設定ファイルを使用するか)によって異なる場合があります。例えば、ホスティングプロバイダーによっては、受信リクエストをリッスンするために使用するポートの指定を要求する場合があります。この場合、コードまたはapplication.conf/application.yamlのいずれかでポートを設定する必要があります。
パッケージ化
アプリケーションをデプロイする前に、以下のいずれかの方法でパッケージ化する必要があります。
Fat JAR
Fat JARは、すべてのコード依存関係を含む実行可能なJARです。Fat JARをサポートする任意のクラウドサービスにデプロイできます。また、GraalVM用のネイティブバイナリを生成する必要がある場合にもFat JARが必要です。Fat JARを作成するには、Gradle用KtorプラグインまたはMaven用Assemblyプラグインを使用できます。
実行可能JVMアプリケーション
実行可能JVMアプリケーションは、コードの依存関係と生成された起動スクリプトを含むパッケージ化されたアプリケーションです。Gradleの場合、Applicationプラグインを使用してアプリケーションを生成できます。
WAR
WARアーカイブを使用すると、TomcatやJettyなどのサーブレットコンテナ内にアプリケーションをデプロイできます。
GraalVM
Ktorサーバーアプリケーションでは、さまざまなプラットフォーム用のネイティブイメージを取得するためにGraalVMを利用できます。
コンテナ化
アプリケーションをパッケージ化(例えば、実行可能JVMアプリケーションまたはFat JARに)した後、このアプリケーションを含むDockerイメージを準備できます。このイメージは、Kubernetes、Swarm、または必要なクラウドサービスのコンテナインスタンスでアプリケーションを実行するために使用できます。
公開
以下のチュートリアルでは、特定のクラウドプロバイダーにKtorアプリケーションをデプロイする方法を示しています。
SSL
Ktorサーバーがリバースプロキシ(NginxやApacheなど)の背後に配置されている場合、またはサーブレットコンテナ(TomcatやJetty)内で実行されている場合、SSL設定はリバースプロキシまたはサーブレットコンテナによって管理されます。必要に応じて、Java KeyStoreを使用して直接SSLを提供するようにKtorを設定できます。
Ktorアプリケーションがサーブレットコンテナ内にデプロイされている場合、SSL設定は有効にならないことに注意してください。
