サービスの NFS ボリュームマウントを構成する

このページでは、Cloud Run で NFS ファイル共有をボリュームとしてマウントする方法について説明します。オンプレミスまたは Compute Engine VM でホストされている独自の NFS サーバーなど、任意の NFS サーバーを使用できます。NFS サーバーをまだ使用していない場合は、Google Cloud のフルマネージド NFS サービスである Filestore をおすすめします。

NBD、9P、CIFS / Samba、Ceph のネットワークファイルシステムを使用する場合は、NBD、9P、CIFS / Samba、Ceph のネットワークファイルシステムを使用するをご覧ください。

Cloud Run で NFS ファイル共有をボリュームとしてマウントすると、ファイル共有がコンテナファイルシステム内のファイルとして提示されます。ファイル共有をボリュームとしてマウントした後、プログラミング言語のファイルシステムオペレーションとライブラリを使用して、ローカルファイルシステム上のディレクトリと同じようにアクセスします。

使用できないパス

Cloud Run では、/dev、/proc、/sys、またはそのサブディレクトリにボリュームをマウントすることはできません。

制限事項

NFS ボリュームに書き込むには、コンテナを root として実行する必要があります。コンテナでファイルシステムからの読み取りを行うだけの場合は、任意のユーザーとして実行できます。
Cloud Run は NFS ロックをサポートしていません。NFS ボリュームは、ロックなしモードで自動的にマウントされます。

始める前に

Cloud Run で NFS サーバーをボリュームとしてマウントするには、次のものが必要です。

VPC ネットワーク。このネットワークで NFS サーバーまたは Filestore インスタンスが実行されます。
VPC ネットワークで実行される NFS サーバー。ここで、Cloud Run サービスが VPC ネットワークに接続されます。NFS サーバーがまだない場合は、Filestore インスタンスを作成してサーバーを作成します。
Cloud Run サービスは、NFS サーバーが実行されている VPC ネットワークに接続されます。最高のパフォーマンスを得るには、VPC コネクタではなくダイレクト VPC を使用します。
既存のプロジェクトを使用している場合は、VPC ファイアウォール構成で Cloud Run が NFS サーバーにアクセスできることを確認してください（新しいプロジェクトから開始する場合は、デフォルトで true になります）。NFS サーバーとして Filestore を使用している場合は、Filestore のドキュメントに従って下り（外向き）ファイアウォールルールを作成し、Cloud Run が Filestore にアクセスできるようにします。

NFS ボリュームをマウントする

複数の NFS サーバー、Filestore インスタンス、または他のボリュームタイプを異なるマウントパスにマウントできます。

複数のコンテナを使用している場合は、まずボリュームを指定してから、各コンテナのボリュームマウントを指定します。

コンソール

Google Cloud コンソールで、[Cloud Run] に移動します。

Cloud Run に移動
[コンテナをデプロイ] をクリックし、[サービス] を選択して、新しいサービスを構成します。既存のサービスを構成する場合は、サービスをクリックし、[新しいリビジョンの編集とデプロイ] をクリックします。
新しいサービスを構成する場合は、最初のサービス設定のページに入力してから、[コンテナ、ボリューム、ネットワーキング、セキュリティ] をクリックしてサービス構成ページを開きます。
[ボリューム] タブをクリックします。
- [ボリューム] で、次の操作を行います。
  - [ボリュームを追加] をクリックします。
  - [ボリュームのタイプ] プルダウンで、ボリュームタイプとして [NFS] を選択します。
  - [ボリューム名] フィールドに、ボリュームに使用する名前を入力します。
  - [NFS サーバー] フィールドに、NFS ファイル共有のドメイン名または場所（IP_ADDRESS 形式）を入力します。
  - [パス] フィールドに、マウントする NFS サーバーディレクトリのパスを入力します。
  - [完了] をクリックします。
- [コンテナ] タブをクリックし、ボリュームをマウントするコンテナを開いて、コンテナを編集します。
- [ボリュームのマウント] タブをクリックします。
- [ボリュームをマウント] をクリックします。
[作成] または [デプロイ] をクリックします。

gcloud

ボリュームを追加してマウントするには:
```
gcloud run services update SERVICE \
--add-volume=name=VOLUME_NAME,type=nfs,location=IP_ADDRESS:NFS_PATH \
--add-volume-mount=volume=VOLUME_NAME,mount-path=MOUNT_PATH
```
次のように置き換えます。
- SERVICE: 実際のサービスの名前。
- VOLUME_NAME は、ボリュームに付ける名前に置き換えます。
- IP_ADDRESS は、NFS ファイル共有の場所に置き換えます。
- NFS_PATH は、NFS ファイル共有のパスに置き換えます（スラッシュで始まるパス、例: /example-directory）。
- MOUNT_PATH は、ボリュームをマウントする相対パス（/mnt/my-volume など）に置き換えます。
- VOLUME_NAME は、ボリュームに付ける名前に置き換えます。VOLUME_NAME 値は、ボリュームをボリュームマウントにマッピングするために使用されます。
ボリュームを読み取り専用ボリュームとしてマウントするには:
```
--add-volume=name=VOLUME_NAME,type=nfs,location=IP_ADDRESS:NFS_PATH,readonly=true
```

複数のコンテナを使用している場合は、まずボリュームを指定してから、各コンテナのボリュームマウントを指定します。

gcloud run services update SERVICE \
--add-volume=name VOLUME_NAME,type=nfs,location=IP_ADDRESS:NFS_PATH \
--container CONTAINER_1 \
--add-volume-mount volume=VOLUME_NAME,mount-path=MOUNT_PATH \
--container CONTAINER_2 \
--add-volume-mount volume= VOLUME_NAME,mount-path=MOUNT_PATH2

YAML

新しいサービスを作成する場合は、この手順をスキップします。既存のサービスを更新する場合は、その YAML 構成をダウンロードします。
```
gcloud run services describe SERVICE --format export > service.yaml
```
必要に応じて、MOUNT_PATH、VOLUME_NAME、IP_ADDRESS、NFS_PATH を更新します。複数のボリュームをマウントしている場合は、属性はその倍数になります。
```
apiVersion: run.googleapis.com/v1
kind: Service
metadata:
  name: SERVICE
spec:
  template:
    metadata:
      annotations:
        run.googleapis.com/execution-environment: gen2
    spec:
      containers:
      - image: IMAGE_URL
        volumeMounts:
        - name: VOLUME_NAME
          mountPath: MOUNT_PATH
      volumes:
      - name: VOLUME_NAME
        nfs:
          server: IP_ADDRESS
          path: NFS_PATH
          readOnly: IS_READ_ONLY
```
次のように置き換えます。
- SERVICE は、Cloud Run サービスの名前に置き換えます。
- MOUNT_PATH は、ボリュームをマウントする相対パス（/mnt/my-volume など）に置き換えます。
- VOLUME_NAME は、ボリュームに付ける名前に置き換えます。VOLUME_NAME 値は、ボリュームをボリュームマウントにマッピングするために使用されます。
- IP_ADDRESS は、NFS ファイル共有のアドレスに置き換えます。
- NFS_PATH は、NFS ファイル共有のパスに置き換えます（スラッシュで始まるパス、例: /example-directory）。
- ボリュームを読み取り専用にする場合は IS_READ_ONLY を True に置き換えます。書き込み可能にするには False に置き換えます。
次のコマンドを使用して、サービスを作成または更新します。
```
gcloud run services replace service.yaml
```

ボリュームの読み取りと書き込み

Cloud Run のボリュームマウント機能を使用する場合、ローカルファイルシステムでファイルの読み取りと書き込みに使用するプログラミング言語のライブラリを使用して、マウントされたボリュームにアクセスします。

これは、ローカルファイルシステムにデータが保存されることを想定し、通常のファイルシステムオペレーションを使用してデータにアクセスする既存のコンテナを使用している場合に特に便利です。

次のスニペットは、mountPath が /mnt/my-volume に設定されたボリュームマウントを前提としています。

Node.js

ファイルシステムモジュールを使用して、ボリューム /mnt/my-volume に新しいファイルを作成するか、既存のファイルに追加します。

var fs = require('fs');
fs.appendFileSync('/mnt/my-volume/sample-logfile.txt', 'Hello logs!', { flag: 'a+' });

Python

ボリューム /mnt/my-volume に保存されているファイルに書き込みます。

f = open("/mnt/my-volume/sample-logfile.txt", "a")

Go

os パッケージを使用して、ボリューム /mnt/my-volume に新しいファイルを作成します。

f, err := os.Create("/mnt/my-volume/sample-logfile.txt")

Java

Java.io.File クラスを使用して、ボリューム /mnt/my-volume にログファイルを作成します。

import java.io.File;
File f = new File("/mnt/my-volume/sample-logfile.txt");

NFS のトラブルシューティング

問題が発生した場合は、次の点を確認してください。

Cloud Run サービスが、NFS サーバーのある VPC ネットワークに接続されている。
Cloud Run が NFS サーバーにアクセスすることを妨げるファイアウォールルールがない。
コンテナで NFS サーバーに書き込みを行う場合は、root として実行されていること。

コンテナの起動時間と NFS ボリュームのマウント

NFS ボリュームマウントを使用すると、コンテナの起動前にボリュームマウントが開始されるため、Cloud Run コンテナのコールドスタート時間がわずかに長くなる可能性があります。コンテナは、NFS が正常にマウントされた場合にのみ起動します。

NFS は、サーバーとの接続を確立してファイルハンドルを取得した後にのみ、ボリュームを正常にマウントします。ネットワークの遅延は、コンテナの起動時間に影響する可能性があります。Cloud Run がサーバーに接続できない場合、Cloud Run サービスは起動しません。また、Cloud Run のすべてのマウント処理の合計タイムアウトが 30 秒であるため、NFS のマウントに 30 秒以上かかると、Cloud Run サービスの開始に失敗します。

NFS のパフォーマンス特性

複数の NFS ボリュームを作成すると、すべてのボリュームが並列でマウントされます。

NFS はネットワークファイルシステムであるため、帯域幅の制限が適用されるため、帯域幅の制限により、ファイルシステムへのアクセスに影響する可能性があります。

NFS ボリュームに書き込むと、データがフラッシュされるまで書き込みは Cloud Run メモリに保存されます。データは、次の状況でフラッシュされます。

アプリケーションが sync(2)、msync(2)、または fsync(3) を使用してファイルデータを明示的にフラッシュする。
アプリケーションが close(2) でファイルを閉じる。
メモリ不足のため、システムメモリリソースの再利用が強制的に実行される。

詳細については、Linux のドキュメントで NFS の説明をご覧ください。