Finch のインストール AWS SAM CLI を使用した Finch の設定インストールの検証 Finch の停止トラブルシューティング次の手順

CLI AWS SAM で使用する Finch のインストール

Finch は AWS、に代わるコンテナ開発ツールでありDocker、特に macOS および Linux システムにとって有益です。詳細については、GitHub の「Finch on GitHub」を参照してください。 AWS SAM を使用するとFinch、はのようなローカル環境をコンテナ AWS Lambda として提供して、サーバーレスアプリケーションを構築、テスト、デバッグできます。

注記

アプリケーションのローカルテスト、--use-container オプションを使用したデプロイパッケージの構築、OCI イメージ関数の構築には Finch が必要です。CLI AWS SAM バージョン 1.145.0 以降、 AWS SAM CLI はの代替コンテナランタイムFinchとしてをサポートしていますDocker。

Finch のインストール

お使いのオペレーティングシステムに Finch をインストールするには、次の手順に従ってください。

前提条件

注記

Finch CLI AWS SAM での統合は、macOS および Linux システムで使用できます。Windows ユーザーが Finch 機能を利用するには、仮想マシンまたは Linux 環境の使用を検討してください。

macOS バージョン

macOS 15 Sequoia
macOS 14 Sonoma

注記

Finch は、macOS の 2 つの最新バージョンをサポートしています。

Linux ：

Linux カーネル v4.x 以降

Finch のインストール

macOS で Finch をインストールするには

brew CLI を使用して Finch をインストールします。プロンプトが表示されたら、macOS のパスワードを入力します。
```
$ brew install finch
```
インストールされている Finch バージョンを確認します。
```
$ finch --version
```
Finch 仮想マシンを初期化します (初回セットアップ)。
```
$ finch vm init
```
Finch 仮想マシンを起動します。
```
$ finch vm start
```
Finch 仮想マシンのステータスを確認します。
```
$ finch vm status
```
Finch が正しく実行されることを確認します。
```
$ finch --info
$ finch ps
```

詳細については、「Installing Finch on macOS」を参照してください。

Finch は、Amazon Linux、Ubuntu、または一般的なインストール方法を使用してインストールできます。詳細については、「Installing Finch on Linux」を参照してください。

AWS SAM CLI を使用した Finch の設定

をインストールするとFinch、 CLI AWS SAM Dockerはが実行されない場合、コンテナランタイムFinchとしてを自動的に検出して使用します。

注記

Finch は Docker のフォールバックとして機能します。Docker との両方Finchをインストールして実行している場合、 AWS SAM CLI Docker はデフォルトで優先順位を付けます。

管理者環境設定構成 (macOS)

管理者設定ファイルを作成することで、特定のコンテナランタイムをデフォルトとして使用するように AWS SAM CLI を設定できます。このシステム全体の環境設定は、デフォルトのフォールバック動作を上書きします。

利用可能な設定オプション

Finch を優先コンテナランタイムとして設定します。


$ sudo /usr/libexec/PlistBuddy -c "Add :DefaultContainerRuntime string finch" /Library/Preferences/com.amazon.samcli.plist

Docker を優先コンテナランタイムとして設定します。


$ sudo /usr/libexec/PlistBuddy -c "Add :DefaultContainerRuntime string docker" /Library/Preferences/com.amazon.samcli.plist

環境設定を削除します (デフォルトの動作に戻す)。


$ sudo /usr/libexec/PlistBuddy -c "Remove :DefaultContainerRuntime" /Library/Preferences/com.amazon.samcli.plist

注記

管理者設定が設定されていない場合、 AWS SAM CLI はDockerデフォルトでを使用します。 Dockerは、が実行されていないときのフォールバックFinchとしてを使用します。

ディレクトリマウントの違い (macOS)

macOS では、ホームディレクトリ (~) またはの外部でプロジェクトを見つけた場合、 AWS SAM ローカルコマンドは失敗します/Volumes。この設計は、セキュリティ上の理由からディレクトリの自動マウントを制限しますが、ユーザーには通知されません。

緩和オプション

オプション 1: テキストエディタで Finch 設定 ~/.finch/finch.yaml を開き、additional_directories セクションの下にプロジェクトパスを追加して、Finch 仮想マシンを再起動します。詳細については、「Finch ドキュメント」を参照してください。
```
$ finch vm stop
$ finch vm start
```
オプション 2: プロジェクトをホームディレクトリに移動します。

インストールの検証

をインストールして起動したらFinch、 CLI AWS SAM で動作することを確認します。

基本的な検証

次のコマンドを実行して、CLI AWS SAM がを使用できることを確認しますFinch。


$ sam build --use-container

を使用してコンテナ環境でアプリケーションFinchを構築する AWS SAM CLI が表示されます。

注記

Finch は Docker のフォールバックとして機能します。Docker が実行されている場合、 AWS SAM CLI はDockerデフォルトで優先順位を付けます。

フォールバックとしての Finch のテスト

Docker の実行時におけるフォールバックとして Finch をテストするには、まず Docker を停止する必要があります。

Finch フォールバック機能をテストする

オペレーティングシステムに適したコマンドを使用して Docker を停止します。

macOS:
```
$ docker stop $(docker ps -q)
$ pkill -f "Docker Desktop"
```
Docker が停止していることを確認します。
```
$ docker ps
```
Linux ：
```
$ docker stop $(docker ps -q)
$ sudo systemctl stop docker
```
Docker が停止していることを確認します。
```
$ sudo systemctl status docker
```
sam build --use-container コマンドを実行して、CLI AWS SAM がフォールバックFinchとしてを自動的に使用することを確認します。

Finch の停止

Finch を停止する必要がある場合は、次のコマンドを使用します。

macOS:


$ finch vm stop
$ sudo pkill -f finch

Finch が停止していることを確認します。


$ finch vm status

Linux ：


$ sudo systemctl stop finch
$ sudo pkill -f finch

Finch が停止していることを確認します。


$ sudo systemctl status finch

トラブルシューティング

Finch で問題が発生した場合は、以下を実行します。

オペレーティングシステムが前提条件を満たしていることを確認します。
システムで仮想化が有効になっていることを確認します。
macOS の場合は、仮想マシンに十分なディスク容量があることを確認します。
Linux の場合は、systemctl コマンドを実行するための適切な許可があることを確認します。
マルチアーキテクチャイメージを Amazon Elastic Container Registry (Amazon ECR) にプッシュするときに「メディアタイプがサポートされていない」エラーで CloudFormation デプロイに失敗した場合、マルチアーキテクチャイメージを使用する代わりに 1 つのイメージアーティファクトを作成します。この問題は、Finch がイメージインデックスとイメージの両方を Amazon ECR にプッシュする一方で、Docker がイメージのみをプッシュするために発生します。
ターゲット関数のアーキテクチャが Linux 上のホストマシンのアーキテクチャと一致しないときにクロスプラットフォーム構築が失敗する場合は、sudo finch run --privileged --rm tonistiigi/binfmt:master --install all を実行してクロスプラットフォームエミュレーションを有効にします。

その他のトラブルシューティングについては、「Finch ドキュメント」、または「AWS SAMCLI トラブルシューティング」を参照してください。

次の手順

Finch をインストールしたら、 CLI AWS SAM でこれを使用して以下を実行できます。

sam build --use-container とコンテナを使用してサーバーレスアプリケーションを構築する。詳細については、「sam build」を参照してください。
sam local invoke を使用して Lambda 関数をローカルでテストする。詳細については、「sam local invoke」を参照してください。
sam local start-api を使用してローカル API Gateway を起動する。詳細については、「sam local start-api」を参照してください。
sam local start-lambda を使用してローカル Lambda エンドポイントを起動する。詳細については、「sam local start-lambda」を参照してください。

コンテナで CLI AWS SAM を使用する方法の詳細については、「」を参照してくださいを使用したデフォルトのビルド AWS SAM。

ブラウザで JavaScript が無効になっているか、使用できません。

AWS ドキュメントを使用するには、JavaScript を有効にする必要があります。手順については、使用するブラウザのヘルプページを参照してください。

ドキュメントの表記規則

Docker のインストール

イメージリポジトリ