Elastic Beanstalk でのアプリケーションの依存関係の設定

アプリケーションには、require() ステートメントで指定したモジュールなど、いくつかの Node.js モジュールに対する依存関係がある可能性があります。これらのモジュールは node_modules ディレクトリに保存されます。アプリケーションが実行されると、Node.js でこのディレクトリからモジュールを読み込みます。詳細については、Node.js ドキュメントの「node_modules フォルダからの読み込み」を参照してください。

これらのモジュールの依存関係は、package.json ファイルを使用して指定できます。Elastic Beanstalk がこのファイルを検出し、node_modules ディレクトリが存在しない場合、Elastic Beanstalk は webapp ユーザーとして npm install を実行します。この npm install コマンドでは、Elastic Beanstalk であらかじめ作成した node_modules ディレクトリに依存関係をインストールします。この npm install コマンドでは、パブリック npm レジストリまたは他のロケーションから package.json ファイルにリストされているパッケージにアクセスします。詳細については、npm ドキュメントのウェブサイトを参照してください。

Elastic Beanstalk で node_modules ディレクトリを検出した場合、package.json ファイルが存在していても Elastic Beanstalk で npm install を実行することはありません。Elastic Beanstalk では、依存関係パッケージは node_modules ディレクトリ内において Node.js でアクセスして読み込めることを前提としています。

次のセクションでは、アプリケーションにおける Node.js モジュールの依存関係の確立に関する詳細を確認できます。

package.json ファイルを使用した Node.js の依存関係の指定

プロジェクトの出典のルートに package.json ファイルを含めることにより、依存関係パッケージを指定し、スタートコマンドを指定します。package.json ファイルが存在し、プロジェクトソースのルートに node_modules ディレクトリが存在しない場合、Elastic Beanstalk は webapp ユーザーとして npm install を実行し、パブリック npm レジストリから依存関係をインストールします。また、Elastic Beanstalk で start コマンドを使用してアプリケーションを開始します。package.json ファイルの詳細については、npm ドキュメントのウェブサイトで「package.json ファイルでの依存関係の指定」を参照してください。

scripts キーワードを使用して、スタートコマンドを指定します。現在は、aws:elasticbeanstalk:container:nodejs 名前空間の古い NodeCommand オプションの代わりに scripts キーワードが使用されています。

{
    "name": "my-app",
    "version": "0.0.1",
    "private": true,
    "dependencies": {
      "ejs": "latest",
      "aws-sdk": "latest",
      "express": "latest",
      "body-parser": "latest"
    },
    "scripts": {
      "start": "node app.js"
    }
  }

本番モードと開発の依存関係

package.json ファイル内で依存関係を指定するには、dependencies 属性と devDependencies 属性を使用します。dependencies 属性は、本番環境のアプリケーションに必要なパッケージを指定します。devDependencies 属性は、ローカルの開発とテストにのみ必要なパッケージを指定します。

Elastic Beanstalk は、次のコマンドを使用して webapp ユーザーとして npm install を実行します。コマンドオプションは、アプリケーションが実行されるプラットフォームブランチに含まれる npm バージョンによって異なります。

上記の両方のコマンドは、devDependencies であるパッケージをインストールしません。

devDependencies パッケージをインストールする必要がある場合は、NPM_USE_PRODUCTION 環境プロパティを false に設定します。この設定では、npm install の実行時に上記のオプションを使用しません。これにより、devDependencies パッケージがインストールされます。

SSH と HTTPS

2023 年 3 月 7 日の Amazon Linux 2 プラットフォームリリース以降、SSH および HTTPS プロトコルを使用して Git リポジトリからパッケージを取得することもできます。プラットフォームブランチ Node.js 16 は、SSH プロトコルと HTTPS プロトコルの両方をサポートします。Node.js 14 は HTTPS プロトコルのみをサポートします。

    ...
    "dependencies": {
      "aws-sdk": "https://github.com/aws/aws-sdk-js.git",
      "aws-chime": "git+ssh://git@github.com:aws/amazon-chime-sdk-js.git"
    }

バージョンとバージョン範囲

package.json ファイルで engines キーワードを使用して、アプリケーションで使用する Node.js のバージョンを指定します。npm 表記を使用してバージョニング範囲を指定することもできます。バージョン範囲の構文の詳細については、Node.js のウェブサイトの「npm を使用したセマンティックバージョニング」を参照してください。Node.js package.json ファイルの engines キーワードでは、aws:elasticbeanstalk:container:nodejs 名前空間の古い NodeVersion オプションを置換します。

{
    ...
    "engines": { "node" : "14.16.0" }
  }

{
    ...
    "engines": { "node" : ">=10 <11" }
  }

バージョン範囲が指定されると、Elastic Beanstalk では、プラットフォームにあるバージョンの中から、範囲内で利用可能な最新の Node.js バージョンをインストールします。この例では、範囲は、バージョンがバージョン 10 以上で、バージョン 11 より小さくなければならないことが示されています。その結果、Elastic Beanstalk では、サポートされているプラットフォームで利用可能な最新の Node.js バージョン 10.x.y がインストールされます。

指定できるのは、プラットフォームブランチに対応する Node.js バージョンのみであることに注意してください。例えば、Node.js 16 プラットフォームブランチを使用している場合、16.x.y Node.js バージョンのみを指定できます。npm で support されているバージョン範囲オプションを使用すると、柔軟性が向上します。各プラットフォームブランチにおける有効な Node.js バージョンについては、「AWS Elastic Beanstalk プラットフォームガイド」の「Node.js」を参照してください。

node_modules ディレクトリに Node.js の依存関係を含める

アプリケーションコードとともに依存関係パッケージを環境インスタンスにデプロイするには、プロジェクトソースのルートにある node_modules という名前のディレクトリにそれらを含めます。詳細については、npm ドキュメントのウェブサイトで「パッケージをローカルでダウンロードしてインストールする」を参照してください。

node_modules ディレクトリを AL2023/AL2 Node.js プラットフォームバージョンにデプロイすると、Elastic Beanstalk では独自の依存関係パッケージが提供されていると見なして、package.json ファイルで指定された依存関係をインストールしないようにします。Node.js では node_modules ディレクトリで依存関係を探します。詳細については、Node.js ドキュメントの「node_modules フォルダからの読み込み」を参照してください。