カスタムビルドイメージとライブパッケージのアップデート

カスタムビルドイメージ

カスタムビルドイメージを使用すると、カスタマイズされた Amplify アプリのビルド環境を提供できます。Amplifyのデフォルトのコンテナを使用して、ビルド中に特定の依存関係をインストールするのに長い時間がかかる場合は、独自の Docker イメージを作成してビルド中に参照することができます。イメージは Docker Hub、またはパブリックの Amazon Elastic Container Registry Public でホストできます。

注記

ビルド設定は、アプリが継続的デプロイ用に設定され、git リポジトリに接続されている場合にのみ、Amplify コンソールのアプリ設定メニューに表示されます。この種類のデプロイの手順については、「既存のコードを使い始める」を参照してください。

カスタムビルドイメージの要件

カスタムビルドイメージを Amplify ビルドイメージとして動作させるには、次の要件を満たしている必要があります。

1. x86-64 アーキテクチャ用にコンパイルされた Amazon Linux などの GNU C ライブラリ (glibc) をサポートする Linux 配信。

2. cURL: カスタムイメージを起動すると、ビルドランナーがコンテナにダウンロードされるため、cURL が必要です。この依存関係が欠落している場合は、build-runner で出力を生成できないため、ビルドは何も出力することなく即座に失敗します。

3. Git: Git リポジトリのクローンを作成するには、Git をイメージにインストールする必要があります。この依存関係が欠落している場合、「リポジトリのクローンを作成する」ステップは失敗します。

4. OpenSSH: リポジトリのクローンを安全に作成するには、OpenSSH を使用して、ビルド中に一時的に SSH キーを設定する必要があります。OpenSSH パッケージは、ビルドランナーがこれを行うために必要なコマンドを提供します。

5. Bash と Bourne Shell: これらの 2 つのユーティリティは、ビルド時にコマンドを実行するために使用されます。これらがインストールされていない場合、ビルドが開始する前に失敗する可能性があります。

6. Node.JS+NPM: ビルドランナーは Node をインストールしません。代わりに、Node（ノード）と NPM がイメージにインストールされていることを前提としています。これは、NPM パッケージまたはノード固有のコマンドを必要とするビルドにのみ必要です。ただし、これらが存在している場合、Amplify ビルドランナーがこれらのツールを使用してビルドの実行を改善できるため、インストールすることを強くお勧めします。Amplify のパッケージオーバーライド機能は、Hugo 用にオーバーライドを設定する際に、NPM を使用して Hugo 拡張パッケージをインストールします。

次のパッケージは必須ではありませんが、インストールすることを強くお勧めします。

1. NVM (Node Version Manager): Node の異なるバージョンを処理する必要がある場合は、このバージョンマネージャーをインストールすることをお勧めします。オーバーライドを設定すると、Amplify のパッケージオーバーライド機能は NVM を使用して、各ビルドの前に Node.js のバージョンを変更します。

2. Wget: Amplify は、ビルドプロセス中に Wget ユーティリティを使用してファイルをダウンロードできます。カスタムイメージにインストールすることをお勧めします。

3. Tar: Amplify は、ビルドプロセス中に Tar ユーティリティを使用して、ダウンロードされたファイルを解凍できます。カスタムイメージにインストールすることをお勧めします。

カスタムビルドイメージの設定

Amazon ECR でホストされているカスタムビルドイメージを設定するには

1. Docker イメージを使用して Amazon ECR パブリックリポジトリをセットアップするには、Amazon ECR パブリックユーザーガイドの「はじめに」を参照してください。

2. AWS Management Console にサインインし Amplify コンソール を開きます。

3. カスタムビルドイメージを設定したいアプリを選択します。

4. ナビゲーションペインで [アプリ設定] の [ビルド設定] を選択します。

5. 「ビルド設定」 ページの「ビルドイメージ設定」セクションで、「編集」を選択します。

6. 「ビルドイメージ設定の編集」のダイアログで、「ビルドイメージ」メニューを展開し、「ビルドイメージ」を選択します。

7. ステップ 1で作成した Amazon ECR パブリックリポジトリの名前を入力します。ビルドイメージはここでホストされます。例えば、リポジトリの名前がecr-examplerepoの場合、public.ecr.aws/xxxxxxxx/ecr-examplerepoと入力します。

8. [Save (保存)] を選択します。

ライブパッケージのアップデート

ライブパッケージのアップデートを使用すると、Amplifyのデフォルトのビルドイメージで使用するパッケージのバージョンと依存関係を指定できます。デフォルトのビルドイメージには、いくつかのパッケージと依存関係がプリインストールされています (例: Hugo、Amplify CLI、Yarn)。ライブパッケージのアップデートを使用すると、これらの依存関係のバージョンを上書きして特定のバージョンを指定するか、常に最新バージョンがインストールされていることを確認できます。

ライブパッケージのアップデートが有効になっている場合は、ビルドが実行される前に、ビルドランナーは最初に指定された依存関係を更新 (またはダウングレード) します。これにより、依存関係の更新にかかる時間に比例してビルド時間が長くなりますが、同じバージョンの依存関係を使用してアプリをビルドできるというメリットがあります。

警告

Node.js バージョンを最新に設定すると、ビルドが失敗します。代わりに、18、21.5、v0.1.2 などの特定の Node.js バージョンを指定する必要があります。

ライブパッケージアップデートの設定

ライブパッケージアップデートを設定するには

1. AWS Management Console にサインインし Amplify コンソールを開きます。

2. ライブパッケージアップデートを設定したいアプリを選択します。

3. ナビゲーションペインで [設定] の [全般設定] を選択します。

4. 「ビルド設定」 ページの「ビルドイメージ設定」セクションで、「編集」を選択します。

5. ビルドイメージ設定の編集のダイアログボックスで、「パッケージバージョンオーバーライドを追加」リストを展開し、変更するパッケージを選択します。

   次のスクリーンショットは、「パッケージバージョンオーバーライドを追加」リストが展開された「ビルドイメージ設定の編集」のダイアログボックスを示しています。

   

6. Version には、デフォルトを最新のままにするか、依存関係の特定のバージョンを入力します。最新を使用すると、依存関係は利用可能なバージョンに常にアップグレードされます。

7. [保存] を選択します。